Atlassian · Schema

ContentPropertyUpdate

CodeCollaborationPlatformProductivitySoftware Development

Properties

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

JSON Schema

atlassian-contentpropertyupdate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ContentPropertyUpdate",
  "title": "ContentPropertyUpdate",
  "required": [
    "value",
    "version"
  ],
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "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": [
        "number"
      ],
      "type": "object",
      "nullable": true,
      "additionalProperties": true,
      "properties": {
        "number": {
          "oneOf": [
            {
              "type": "integer"
            },
            {
              "type": "string"
            }
          ],
          "description": "The new version for the updated content property. Set this to the\ncurrent version number incremented by one. To get the current\nversion number, use 'Get content property' and retrieve\n`version.number`.",
          "format": "int32"
        },
        "minorEdit": {
          "type": "boolean",
          "description": "If `minorEdit` is set to 'true', no notification email or activity\nstream will be generated for the change.",
          "default": true
        }
      },
      "description": "The version number of the property.",
      "example": "example_value"
    }
  }
}