WSO2 · Schema

SharedScopeUsage

SharedScopeUsage schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name Type Description
id string UUID of the Scope. Valid only for shared scopes.
name string name of Scope
usedApiList array API list which have used the shared scope. [DEPRECATED] Use `usages` instead. Retained only for backward compatibility.
usages array List of entities which have used the shared scope
View JSON Schema on GitHub

JSON Schema

publisher-api-shared-scope-usage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/publisher-api-shared-scope-usage-schema.json",
  "title": "SharedScopeUsage",
  "description": "SharedScopeUsage schema from WSO2 API Manager",
  "required": [
    "id",
    "name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the Scope. Valid only for shared scopes.\n",
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "type": "string",
      "description": "name of Scope\n",
      "example": "apim:api_view"
    },
    "usedApiList": {
      "deprecated": true,
      "type": "array",
      "description": "API list which have used the shared scope. [DEPRECATED] Use `usages` instead. \nRetained only for backward compatibility.\n",
      "items": {
        "$ref": "#/components/schemas/SharedScopeUsedAPIInfo"
      }
    },
    "usages": {
      "type": "array",
      "description": "List of entities which have used the shared scope\n",
      "items": {
        "$ref": "#/components/schemas/SharedScopeUsageEntity"
      }
    }
  }
}