WSO2 · JSON Structure

Publisher Api Shared Scope Used Api Info Structure

SharedScopeUsedAPIInfo schema from WSO2 API Manager

Type: object Properties: 6 Required: 3
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

API object using shared scope is a JSON Structure definition published by WSO2, describing 6 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name context version provider revisionID usedResourceList

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/publisher-api-shared-scope-used-api-info-structure.json",
  "name": "API object using shared scope",
  "description": "SharedScopeUsedAPIInfo schema from WSO2 API Manager",
  "required": [
    "context",
    "name",
    "version"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "CalculatorAPI"
    },
    "context": {
      "type": "string",
      "example": "CalculatorAPI"
    },
    "version": {
      "type": "string",
      "example": "1.0.0"
    },
    "provider": {
      "type": "string",
      "description": "If the provider value is not given user invoking the api will be used as the provider.\n",
      "example": "admin"
    },
    "revisionID": {
      "type": "string",
      "example": "Revision 1"
    },
    "usedResourceList": {
      "type": "array",
      "description": "Resource list which have used the shared scope within this API\n",
      "items": {
        "$ref": "#/components/schemas/SharedScopeUsedAPIResourceInfo"
      }
    }
  }
}