Atlassian · Schema

ContentProperty

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
id string
key string
value object The value of the content property. This can be empty or a complex object.
version object
_links object
_expandable object
View JSON Schema on GitHub

JSON Schema

atlassian-contentproperty-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ContentProperty",
  "title": "ContentProperty",
  "required": [
    "_links",
    "id",
    "key",
    "value"
  ],
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "id": {
      "type": "string",
      "example": "abc123"
    },
    "key": {
      "type": "string",
      "example": "example_value"
    },
    "value": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        {
          "type": "boolean"
        },
        {
          "type": "object",
          "additionalProperties": true,
          "properties": {}
        },
        {
          "type": "string"
        }
      ],
      "description": "The value of the content property. This can be empty or a complex object.",
      "example": "example_value"
    },
    "version": {
      "required": [
        "message",
        "minorEdit",
        "number",
        "when"
      ],
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "when": {
          "type": "string",
          "format": "date-time"
        },
        "message": {
          "type": "string"
        },
        "number": {
          "type": "integer",
          "format": "int32"
        },
        "minorEdit": {
          "type": "boolean"
        },
        "contentTypeModified": {
          "type": "boolean",
          "description": "True if content type is modifed in this version (e.g. page to blog)"
        }
      },
      "example": "example_value"
    },
    "_links": {
      "$ref": "#/components/schemas/GenericLinks"
    },
    "_expandable": {
      "type": "object",
      "properties": {
        "content": {
          "type": "string"
        },
        "additionalProperties": {
          "type": "string"
        }
      },
      "example": "example_value"
    }
  }
}