Atlassian · Schema

ProjectFeature

Details of a project feature.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
feature string The key of the feature.
imageUri string URI for the image representing the feature.
localisedDescription string Localized display description for the feature.
localisedName string Localized display name for the feature.
prerequisites array List of keys of the features required to enable the feature.
projectId integer The ID of the project.
state string The state of the feature. When updating the state of a feature, only ENABLED and DISABLED are supported. Responses can contain all values
toggleLocked boolean Whether the state of the feature can be updated.
View JSON Schema on GitHub

JSON Schema

atlassian-projectfeature-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProjectFeature",
  "title": "ProjectFeature",
  "additionalProperties": false,
  "description": "Details of a project feature.",
  "properties": {
    "feature": {
      "description": "The key of the feature.",
      "type": "string"
    },
    "imageUri": {
      "description": "URI for the image representing the feature.",
      "type": "string"
    },
    "localisedDescription": {
      "description": "Localized display description for the feature.",
      "type": "string"
    },
    "localisedName": {
      "description": "Localized display name for the feature.",
      "type": "string"
    },
    "prerequisites": {
      "description": "List of keys of the features required to enable the feature.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "projectId": {
      "description": "The ID of the project.",
      "format": "int64",
      "type": "integer"
    },
    "state": {
      "description": "The state of the feature. When updating the state of a feature, only ENABLED and DISABLED are supported. Responses can contain all values",
      "enum": [
        "ENABLED",
        "DISABLED",
        "COMING_SOON"
      ],
      "type": "string"
    },
    "toggleLocked": {
      "description": "Whether the state of the feature can be updated.",
      "type": "boolean"
    }
  },
  "type": "object"
}