Documentation Atlassian_document

Description  Schema for Atlassian Document Format.


{
  "$ref": "#/definitions/doc_node",
  "description": "Schema for Atlassian Document Format.",
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Name	Occurrence
version type content	required required required


 "doc_node": {
  "type": "object",
  "additionalProperties": false,
  "required": [
    "version",
    "type",
    "content"
  ],
  "properties": {
    "version": {
      "enum": [1]
    },
    "type": {
      "enum": ["doc"]
    },
    "content": {
      "type": "array",
      "items": {}
    }
  }
}


 "version": {
  "enum": [1]
}


 "type": {
  "enum": ["doc"]
}

Unique Items : false


 "content": {
  "type": "array",
  "items": {
    "anyOf": [
      {"$ref": "#/definitions/codeBlock_with_no_marks_node"},
      {"$ref": "#/definitions/codeBlock_with_marks_node"},
      {"$ref": "#/definitions/blockCard_node"},
      {"$ref": "#/definitions/paragraph_with_no_marks_node"},
      {"$ref": "#/definitions/paragraph_with_alignment_node"},
      {"$ref": "#/definitions/paragraph_with_indentation_node"},
      {"$ref": "#/definitions/bulletList_node"},
      {"$ref": "#/definitions/mediaSingle_full_node"},
      {"$ref": "#/definitions/mediaSingle_caption_node"},
      {"$ref": "#/definitions/orderedList_node"},
      {"$ref": "#/definitions/heading_with_no_marks_node"},
      {"$ref": "#/definitions/heading_with_alignment_node"},
      {"$ref": "#/definitions/heading_with_indentation_node"},
      {"$ref": "#/definitions/panel_node"},
      {"$ref": "#/definitions/blockquote_node"},
      {"$ref": "#/definitions/rule_node"},
      {"$ref": "#/definitions/mediaGroup_node"},
      {"$ref": "#/definitions/decisionList_node"},
      {"$ref": "#/definitions/taskList_node"},
      {"$ref": "#/definitions/extension_with_marks_node"},
      {"$ref": "#/definitions/embedCard_node"},
      {"$ref": "#/definitions/table_node"},
      {"$ref": "#/definitions/expand_with_no_mark_node"},
      {"$ref": "#/definitions/expand_with_breakout_mark_node"},
      {"$ref": "#/definitions/bodiedExtension_with_marks_node"},
      {"$ref": "#/definitions/layoutSection_full_node"}
    ]
  }
}


 "items": {
  "anyOf": [
    {"$ref": "#/definitions/codeBlock_with_no_marks_node"},
    {"$ref": "#/definitions/codeBlock_with_marks_node"},
    {"$ref": "#/definitions/blockCard_node"},
    {"$ref": "#/definitions/paragraph_with_no_marks_node"},
    {"$ref": "#/definitions/paragraph_with_alignment_node"},
    {"$ref": "#/definitions/paragraph_with_indentation_node"},
    {"$ref": "#/definitions/bulletList_node"},
    {"$ref": "#/definitions/mediaSingle_full_node"},
    {"$ref": "#/definitions/mediaSingle_caption_node"},
    {"$ref": "#/definitions/orderedList_node"},
    {"$ref": "#/definitions/heading_with_no_marks_node"},
    {"$ref": "#/definitions/heading_with_alignment_node"},
    {"$ref": "#/definitions/heading_with_indentation_node"},
    {"$ref": "#/definitions/panel_node"},
    {"$ref": "#/definitions/blockquote_node"},
    {"$ref": "#/definitions/rule_node"},
    {"$ref": "#/definitions/mediaGroup_node"},
    {"$ref": "#/definitions/decisionList_node"},
    {"$ref": "#/definitions/taskList_node"},
    {"$ref": "#/definitions/extension_with_marks_node"},
    {"$ref": "#/definitions/embedCard_node"},
    {"$ref": "#/definitions/table_node"},
    {"$ref": "#/definitions/expand_with_no_mark_node"},
    {"$ref": "#/definitions/expand_with_breakout_mark_node"},
    {"$ref": "#/definitions/bodiedExtension_with_marks_node"},
    {"$ref": "#/definitions/layoutSection_full_node"}
  ]
}


 "codeBlock_with_no_marks_node": {
  "allOf": [
    {"$ref": "#/definitions/codeBlock_node"},
    {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "marks": {
          "type": "array",
          "maxItems": 0
        }
      }
    }
  ]
}

Name	Occurrence
type content marks attrs	required optional optional optional


 "codeBlock_node": {
  "type": "object",
  "additionalProperties": false,
  "required": ["type"],
  "properties": {
    "type": {
      "enum": ["codeBlock"]
    },
    "content": {
      "type": "array",
      "items": {}
    },
    "marks": {"type": "array"},
    "attrs": {
      "type": "object",
      "additionalProperties": false,
      "properties": {}
    }
  }
}


 "type": {
  "enum": ["codeBlock"]
}

Unique Items : false


 "content": {
  "type": "array",
  "items": {
    "allOf": [
      {"$ref": "#/definitions/text_node"},
      {
        "type": "object",
        "additionalProperties": true,
        "properties": {
          "marks": {
            "type": "array",
            "maxItems": 0
          }
        }
      }
    ]
  }
}


 "items": {
  "allOf": [
    {"$ref": "#/definitions/text_node"},
    {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "marks": {
          "type": "array",
          "maxItems": 0
        }
      }
    }
  ]
}

Name	Occurrence
type text marks	required required optional


 "text_node": {
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "text"
  ],
  "properties": {
    "type": {
      "enum": ["text"]
    },
    "text": {
      "type": "string",
      "minLength": 1
    },
    "marks": {"type": "array"}
  }
}


 "type": {
  "enum": ["text"]
}


 "text": {
  "type": "string",
  "minLength": 1
}

Unique Items : false


 "marks": {"type": "array"}


{"$ref": "#/definitions/text_node"}

Name	Occurrence
marks	optional


{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "marks": {
      "type": "array",
      "maxItems": 0
    }
  }
}

Unique Items : false


 "marks": {
  "type": "array",
  "maxItems": 0
}

Unique Items : false


 "marks": {"type": "array"}

Name	Occurrence
language	optional


 "attrs": {
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "language": {"type": "string"}
  }
}


 "language": {"type": "string"}


{"$ref": "#/definitions/codeBlock_node"}

Name	Occurrence
marks	optional


{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "marks": {
      "type": "array",
      "maxItems": 0
    }
  }
}

Unique Items : false


 "marks": {
  "type": "array",
  "maxItems": 0
}


{"$ref": "#/definitions/codeBlock_with_no_marks_node"}


 "codeBlock_with_marks_node": {
  "allOf": [
    {"$ref": "#/definitions/codeBlock_node"},
    {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "marks": {
          "type": "array",
          "items": {"$ref": "#/definitions/breakout_mark"}
        }
      }
    }
  ]
}


{"$ref": "#/definitions/codeBlock_node"}

Name	Occurrence
marks	optional


{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "marks": {
      "type": "array",
      "items": {}
    }
  }
}

Unique Items : false


 "marks": {
  "type": "array",
  "items": {"$ref": "#/definitions/breakout_mark"}
}

Name	Occurrence
type attrs	required required


 "breakout_mark": {
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "attrs"
  ],
  "properties": {
    "type": {
      "enum": ["breakout"]
    },
    "attrs": {
      "type": "object",
      "additionalProperties": false,
      "required": ["mode"],
      "properties": {}
    }
  }
}


 "type": {
  "enum": ["breakout"]
}

Name	Occurrence
mode	required


 "attrs": {
  "type": "object",
  "additionalProperties": false,
  "required": ["mode"],
  "properties": {
    "mode": {
      "enum": [
        "wide",
        "full-width"
      ]
    }
  }
}

Values

wide

full-width


 "mode": {
  "enum": [
    "wide",
    "full-width"
  ]
}


 "items": {"$ref": "#/definitions/breakout_mark"}


{"$ref": "#/definitions/codeBlock_with_marks_node"}

Name	Occurrence
type attrs	required required


 "blockCard_node": {
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "attrs"
  ],
  "properties": {
    "type": {
      "enum": ["blockCard"]
    },
    "attrs": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": ["url"],
          "properties": {
            "url": {"type": "string"}
          }
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": ["data"],
          "properties": {
            "data": {}
          }
        }
      ]
    }
  }
}


 "type": {
  "enum": ["blockCard"]
}


 "attrs": {
  "anyOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "required": ["url"],
      "properties": {
        "url": {"type": "string"}
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": ["data"],
      "properties": {
        "data": {}
      }
    }
  ]
}

Name	Occurrence
url	required


{
  "type": "object",
  "additionalProperties": false,
  "required": ["url"],
  "properties": {
    "url": {"type": "string"}
  }
}


 "url": {"type": "string"}

Name	Occurrence
data	required


{
  "type": "object",
  "additionalProperties": false,
  "required": ["data"],
  "properties": {
    "data": {}
  }
}


{"$ref": "#/definitions/blockCard_node"}


 "paragraph_with_no_marks_node": {
  "allOf": [
    {"$ref": "#/definitions/paragraph_node"},
    {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "marks": {
          "type": "array",
          "maxItems": 0
        }
      }
    }
  ]
}

Name	Occurrence
type content marks	required optional optional


 "paragraph_node": {
  "type": "object",
  "additionalProperties": false,
  "required": ["type"],
  "properties": {
    "type": {
      "enum": ["paragraph"]
    },
    "content": {
      "type": "array",
      "items": {}
    },
    "marks": {"type": "array"}
  }
}


 "type": {
  "enum": ["paragraph"]
}

Unique Items : false


 "content": {
  "type": "array",
  "items": {"$ref": "#/definitions/inline_node"}
}


 "inline_node": {
  "anyOf": [
    {"$ref": "#/definitions/hardBreak_node"},
    {"$ref": "#/definitions/mention_node"},
    {"$ref": "#/definitions/emoji_node"},
    {"$ref": "#/definitions/inlineExtension_with_marks_node"},
    {"$ref": "#/definitions/date_node"},
    {"$ref": "#/definitions/placeholder_node"},
    {"$ref": "#/definitions/inlineCard_node"},
    {"$ref": "#/definitions/status_node"},
    {"$ref": "#/definitions/mediaInline_node"},
    {"$ref": "#/definitions/formatted_text_inline_node"},
    {"$ref": "#/definitions/code_inline_node"}
  ]
}

Name	Occurrence
type attrs	required optional


 "hardBreak_node": {
  "type": "object",
  "additionalProperties": false,
  "required": ["type"],
  "properties": {
    "type": {
      "enum": ["hardBreak"]
    },
    "attrs": {
      "type": "object",
      "additionalProperties": false,
      "properties": {}
    }
  }
}


 "type": {
  "enum": ["hardBreak"]
}

Name	Occurrence
text	optional


 "attrs": {
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "text": {
      "enum": ["\n"]
    }
  }
}


 "text": {
  "enum": ["\n"]
}


{"$ref": "#/definitions/hardBreak_node"}

Name	Occurrence
type attrs	required required


 "mention_node": {
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "attrs"
  ],
  "properties": {
    "type": {
      "enum": ["mention"]
    },
    "attrs": {
      "type": "object",
      "additionalProperties": false,
      "required": ["id"],
      "properties": {}
    }
  }
}

Schema

mention_node


 "type": {
  "enum": ["mention"]
}

Name	Occurrence
id text userType accessLevel	required optional optional optional

Schema

mention_node


 "attrs": {
  "type": "object",
  "additionalProperties": false,
  "required": ["id"],
  "properties": {
    "id": {"type": "string"},
    "text": {"type": "string"},
    "userType": {
      "enum": [
        "APP",
        "SPECIAL",
        "DEFAULT"
      ]
    },
    "accessLevel": {"type": "string"}
  }
}


 "id": {"type": "string"}


 "text": {"type": "string"}

Values

APP

SPECIAL

DEFAULT


 "userType": {
  "enum": [
    "APP",
    "SPECIAL",
    "DEFAULT"
  ]
}


 "accessLevel": {"type": "string"}


{"$ref": "#/definitions/mention_node"}

Name	Occurrence
type attrs	required required


 "emoji_node": {
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "attrs"
  ],
  "properties": {
    "type": {
      "enum": ["emoji"]
    },
    "attrs": {
      "type": "object",
      "additionalProperties": false,
      "required": ["shortName"],
      "properties": {}
    }
  }
}


 "type": {
  "enum": ["emoji"]
}

Name	Occurrence
id shortName text	optional required optional


 "attrs": {
  "type": "object",
  "additionalProperties": false,
  "required": ["shortName"],
  "properties": {
    "id": {"type": "string"},
    "shortName": {"type": "string"},
    "text": {"type": "string"}
  }
}


 "id": {"type": "string"}


 "shortName": {"type": "string"}


 "text": {"type": "string"}


{"$ref": "#/definitions/emoji_node"}

Showing: