Atlassian · Schema

comment

CodeCollaborationPlatformProductivitySoftware Development
View JSON Schema on GitHub

JSON Schema

atlassian-comment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/comment",
  "title": "comment",
  "allOf": [
    {
      "$ref": "#/components/schemas/object"
    },
    {
      "type": "object",
      "title": "Comment",
      "description": "The base type for all comments. This type should be considered abstract. Each of the \"commentable\" resources defines its own subtypes (e.g. `issue_comment`).",
      "properties": {
        "id": {
          "type": "integer"
        },
        "created_on": {
          "type": "string",
          "format": "date-time"
        },
        "updated_on": {
          "type": "string",
          "format": "date-time"
        },
        "content": {
          "type": "object",
          "properties": {
            "raw": {
              "type": "string",
              "description": "The text as it was typed by a user."
            },
            "markup": {
              "type": "string",
              "description": "The type of markup language the raw content is to be interpreted in.",
              "enum": [
                "markdown",
                "creole",
                "plaintext"
              ]
            },
            "html": {
              "type": "string",
              "description": "The user's content rendered as HTML."
            }
          },
          "additionalProperties": false
        },
        "user": {
          "$ref": "#/components/schemas/account"
        },
        "deleted": {
          "type": "boolean"
        },
        "parent": {
          "$ref": "#/components/schemas/comment"
        },
        "inline": {
          "type": "object",
          "properties": {
            "from": {
              "type": "integer",
              "description": "The comment's anchor line in the old version of the file.",
              "minimum": 1
            },
            "to": {
              "type": "integer",
              "description": "The comment's anchor line in the new version of the file. If the 'from' line is also provided, this value will be removed.",
              "minimum": 1
            },
            "path": {
              "type": "string",
              "description": "The path of the file this comment is anchored to."
            }
          },
          "required": [
            "path"
          ],
          "additionalProperties": false
        },
        "links": {
          "type": "object",
          "properties": {
            "self": {
              "type": "object",
              "title": "Link",
              "description": "A link to a resource related to this object.",
              "properties": {
                "href": {
                  "type": "string",
                  "format": "uri"
                },
                "name": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "html": {
              "type": "object",
              "title": "Link",
              "description": "A link to a resource related to this object.",
              "properties": {
                "href": {
                  "type": "string",
                  "format": "uri"
                },
                "name": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "code": {
              "type": "object",
              "title": "Link",
              "description": "A link to a resource related to this object.",
              "properties": {
                "href": {
                  "type": "string",
                  "format": "uri"
                },
                "name": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": true
    }
  ]
}