Atlassian · Schema

ContentBlueprintDraft

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
version object The version for the new content.
title string The title of the content. If you don't want to change the title, set this to the current title of the draft.
type string The type of content. Set this to `page`.
status string The status of the content. Set this to `current` or omit it altogether.
space object The space for the content.
ancestors array The new ancestor (i.e. parent page) for the content. If you have specified an ancestor, you must also specify a `space` property in the request body for the space that the ancestor is in. Note, if you
View JSON Schema on GitHub

JSON Schema

atlassian-contentblueprintdraft-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ContentBlueprintDraft",
  "title": "ContentBlueprintDraft",
  "required": [
    "title",
    "type",
    "version"
  ],
  "type": "object",
  "properties": {
    "version": {
      "required": [
        "number"
      ],
      "type": "object",
      "properties": {
        "number": {
          "type": "integer",
          "description": "The version number. Set this to `1`.",
          "format": "int32"
        }
      },
      "additionalProperties": true,
      "description": "The version for the new content.",
      "example": "example_value"
    },
    "title": {
      "maxLength": 255,
      "type": "string",
      "description": "The title of the content. If you don't want to change the title,\nset this to the current title of the draft.",
      "example": "Example Title"
    },
    "type": {
      "type": "string",
      "description": "The type of content. Set this to `page`.",
      "enum": [
        "page"
      ],
      "example": "page"
    },
    "status": {
      "type": "string",
      "description": "The status of the content. Set this to `current` or omit it altogether.",
      "default": "current",
      "enum": [
        "current"
      ],
      "example": "current"
    },
    "space": {
      "required": [
        "key"
      ],
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "description": "The key of the space",
          "format": "int32"
        }
      },
      "additionalProperties": true,
      "description": "The space for the content.",
      "example": "example_value"
    },
    "ancestors": {
      "type": "array",
      "description": "The new ancestor (i.e. parent page) for the content. If you have\nspecified an ancestor, you must also specify a `space` property\nin the request body for the space that the ancestor is in.\n\nNote, if you specify more than one ancestor, the last ID in the array\nwill be selected as the parent page for the content.",
      "items": {
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The content ID of the ancestor."
          }
        }
      },
      "nullable": true,
      "example": []
    }
  },
  "additionalProperties": true
}