Atlassian · Schema

Relation

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
name string
relationData object
source object
target object
_expandable object
_links object
View JSON Schema on GitHub

JSON Schema

atlassian-relation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Relation",
  "title": "Relation",
  "required": [
    "_links",
    "name"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "Example Title"
    },
    "relationData": {
      "$ref": "#/components/schemas/RelationData"
    },
    "source": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/Content"
        },
        {
          "$ref": "#/components/schemas/User"
        },
        {
          "$ref": "#/components/schemas/Space"
        }
      ],
      "example": "example_value"
    },
    "target": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/Content"
        },
        {
          "$ref": "#/components/schemas/User"
        },
        {
          "$ref": "#/components/schemas/Space"
        }
      ],
      "example": "example_value"
    },
    "_expandable": {
      "type": "object",
      "properties": {
        "relationData": {
          "type": "string"
        },
        "source": {
          "type": "string"
        },
        "target": {
          "type": "string"
        }
      },
      "example": "example_value"
    },
    "_links": {
      "$ref": "#/components/schemas/GenericLinks"
    }
  }
}