WSO2 · JSON Structure

Devportal Api Additional Subscription Info Structure

AdditionalSubscriptionInfo schema from WSO2 API Manager

Type: object Properties: 7
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Additional Information of subscriptions related to an API is a JSON Structure definition published by WSO2, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

subscriptionId applicationId applicationName apiId isSolaceAPI solaceOrganization solaceDeployedEnvironments

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/devportal-api-additional-subscription-info-structure.json",
  "name": "Additional Information of subscriptions related to an API",
  "description": "AdditionalSubscriptionInfo schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "subscriptionId": {
      "type": "string",
      "description": "The UUID of the subscription",
      "readOnly": true,
      "example": "faae5fcc-cbae-40c4-bf43-89931630d313"
    },
    "applicationId": {
      "type": "string",
      "description": "The UUID of the application",
      "example": "b3ade481-30b0-4b38-9a67-498a40873a6d"
    },
    "applicationName": {
      "type": "string",
      "description": "The name of the application",
      "example": "Sample Application"
    },
    "apiId": {
      "type": "string",
      "description": "The unique identifier of the API.",
      "example": "2962f3bb-8330-438e-baee-0ee1d6434ba4"
    },
    "isSolaceAPI": {
      "type": "boolean",
      "example": false
    },
    "solaceOrganization": {
      "type": "string",
      "example": "SolaceWso2"
    },
    "solaceDeployedEnvironments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "environmentName": {
            "type": "string"
          },
          "environmentDisplayName": {
            "type": "string"
          },
          "organizationName": {
            "type": "string"
          },
          "solaceURLs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "protocol": {
                  "type": "string",
                  "example": "Defalt"
                },
                "endpointURL": {
                  "type": "string",
                  "example": "Default"
                }
              }
            }
          },
          "SolaceTopicsObject": {
            "type": "object",
            "properties": {
              "defaultSyntax": {
                "$ref": "#/components/schemas/SolaceTopics"
              },
              "mqttSyntax": {
                "$ref": "#/components/schemas/SolaceTopics"
              }
            }
          }
        }
      }
    }
  }
}