Get project features

v1.0.0

Returns the list of features for a project.

Input

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

Output

{
  "type": "object",
  "description": "The list of features on a project.",
  "properties": {
    "features": {
      "type": "array",
      "description": "The project features.",
      "items": {
        "type": "object",
        "description": "Details of a project feature.",
        "properties": {
          "feature": {
            "type": "string",
            "description": "The key of the feature."
          },
          "imageUri": {
            "type": "string",
            "description": "URI for the image representing the feature."
          },
          "localisedDescription": {
            "type": "string",
            "description": "Localized display description for the feature."
          },
          "localisedName": {
            "type": "string",
            "description": "Localized display name for the feature."
          },
          "prerequisites": {
            "type": "array",
            "description": "List of keys of the features required to enable the feature.",
            "items": {
              "type": "string"
            }
          },
          "projectId": {
            "type": "integer",
            "format": "int64",
            "description": "The ID of the project."
          },
          "state": {
            "type": "string",
            "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"
            ]
          },
          "toggleLocked": {
            "type": "boolean",
            "description": "Whether the state of the feature can be updated."
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}