Atlassian · Schema

Space

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
id integer
key string
name string
icon object
description object
homepage object
type string
metadata object
operations array
permissions array
status string
settings object
theme object
lookAndFeel object
history object
_expandable object
_links object
View JSON Schema on GitHub

JSON Schema

atlassian-space-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Space",
  "title": "Space",
  "required": [
    "_expandable",
    "_links",
    "key",
    "name",
    "status",
    "type"
  ],
  "nullable": true,
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": "abc123"
    },
    "key": {
      "type": "string",
      "example": "example_value"
    },
    "name": {
      "type": "string",
      "example": "Example Title"
    },
    "icon": {
      "$ref": "#/components/schemas/Icon"
    },
    "description": {
      "type": "object",
      "properties": {
        "plain": {
          "$ref": "#/components/schemas/SpaceDescription"
        },
        "view": {
          "$ref": "#/components/schemas/SpaceDescription"
        },
        "_expandable": {
          "type": "object",
          "properties": {
            "view": {
              "type": "string"
            },
            "plain": {
              "type": "string"
            }
          }
        }
      },
      "example": "A sample description."
    },
    "homepage": {
      "$ref": "#/components/schemas/Content"
    },
    "type": {
      "type": "string",
      "example": "example_value"
    },
    "metadata": {
      "type": "object",
      "properties": {
        "labels": {
          "$ref": "#/components/schemas/LabelArray"
        },
        "_expandable": {
          "type": "object"
        }
      },
      "example": "example_value"
    },
    "operations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OperationCheckResult"
      },
      "example": []
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SpacePermission"
      },
      "example": []
    },
    "status": {
      "type": "string",
      "example": "example_value"
    },
    "settings": {
      "$ref": "#/components/schemas/SpaceSettings"
    },
    "theme": {
      "$ref": "#/components/schemas/Theme"
    },
    "lookAndFeel": {
      "$ref": "#/components/schemas/LookAndFeel"
    },
    "history": {
      "required": [
        "createdDate"
      ],
      "type": "object",
      "properties": {
        "createdDate": {
          "type": "string",
          "format": "date-time"
        },
        "createdBy": {
          "$ref": "#/components/schemas/User"
        }
      },
      "example": "example_value"
    },
    "_expandable": {
      "type": "object",
      "properties": {
        "settings": {
          "type": "string"
        },
        "metadata": {
          "type": "string"
        },
        "operations": {
          "type": "string"
        },
        "lookAndFeel": {
          "type": "string"
        },
        "permissions": {
          "type": "string"
        },
        "icon": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "theme": {
          "type": "string"
        },
        "history": {
          "type": "string"
        },
        "homepage": {
          "type": "string"
        },
        "identifiers": {
          "type": "string"
        }
      },
      "example": "example_value"
    },
    "_links": {
      "$ref": "#/components/schemas/GenericLinks"
    }
  }
}