Atlassian · Schema

SpaceSettings

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
routeOverrideEnabled boolean Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a pa
editor object
spaceKey string
_links object
View JSON Schema on GitHub

JSON Schema

atlassian-spacesettings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SpaceSettings",
  "title": "SpaceSettings",
  "nullable": true,
  "required": [
    "_links",
    "routeOverrideEnabled"
  ],
  "type": "object",
  "properties": {
    "routeOverrideEnabled": {
      "type": "boolean",
      "description": "Defines whether an override for the space home should be used. This is\nused in conjunction with a space theme provided by an app. For\nexample, if this property is set to true, a theme can display a page\nother than the space homepage when users visit the root URL for a\nspace. This property allows apps to provide content-only theming\nwithout overriding the space home.",
      "example": true
    },
    "editor": {
      "required": [
        "page",
        "blogpost",
        "default"
      ],
      "type": "object",
      "properties": {
        "page": {
          "type": "string"
        },
        "blogpost": {
          "type": "string"
        },
        "default": {
          "type": "string"
        }
      },
      "example": "example_value"
    },
    "spaceKey": {
      "type": "string",
      "example": "example_value"
    },
    "_links": {
      "$ref": "#/components/schemas/GenericLinks"
    }
  }
}