WSO2 · JSON Structure

Devportal Api Api Info Structure

APIInfo schema from WSO2 API Manager

Type: object Properties: 23

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

API Info object with basic API details. is a JSON Structure definition published by WSO2, describing 23 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name displayName description context version type createdTime provider lifeCycleStatus thumbnailUri avgRating throttlingPolicies advertiseInfo businessInformation isSubscriptionAvailable monetizationLabel gatewayType gatewayVendor additionalProperties monetizedInfo egress subtype

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/devportal-api-api-info-structure.json",
  "name": "API Info object with basic API details.",
  "description": "APIInfo schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "type": "string",
      "example": "CalculatorAPI"
    },
    "displayName": {
      "type": "string",
      "example": "Calculator API",
      "description": "Display name of the API.\nThis is the name that will be displayed in the Publisher and DevPortal.\nIf not provided, the name will be used as the display name.\n"
    },
    "description": {
      "type": "string",
      "example": "A calculator API that supports basic operations"
    },
    "context": {
      "type": "string",
      "example": "CalculatorAPI"
    },
    "version": {
      "type": "string",
      "example": "1.0.0"
    },
    "type": {
      "type": "string",
      "example": "WS"
    },
    "createdTime": {
      "type": "string",
      "example": 1614020559444
    },
    "provider": {
      "type": "string",
      "description": "If the provider value is not given, the user invoking the API will be used as the provider.\n",
      "example": "admin"
    },
    "lifeCycleStatus": {
      "type": "string",
      "example": "PUBLISHED"
    },
    "thumbnailUri": {
      "type": "string",
      "example": "/apis/01234567-0123-0123-0123-012345678901/thumbnail"
    },
    "avgRating": {
      "type": "string",
      "description": "Average rating of the API",
      "example": "4.5"
    },
    "throttlingPolicies": {
      "type": "array",
      "description": "List of throttling policies of the API",
      "example": [
        "Unlimited",
        "Bronze"
      ],
      "items": {
        "type": "string"
      }
    },
    "advertiseInfo": {
      "$ref": "#/components/schemas/AdvertiseInfo"
    },
    "businessInformation": {
      "$ref": "#/components/schemas/APIBusinessInformation"
    },
    "isSubscriptionAvailable": {
      "type": "boolean",
      "example": false
    },
    "monetizationLabel": {
      "type": "string",
      "example": "Free"
    },
    "gatewayType": {
      "type": "string",
      "example": "solace"
    },
    "gatewayVendor": {
      "type": "string",
      "example": "WSO2"
    },
    "additionalProperties": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "display": {
            "type": "boolean"
          }
        }
      },
      "description": "Custom(user defined) properties of API\n",
      "example": {}
    },
    "monetizedInfo": {
      "type": "boolean",
      "example": true
    },
    "egress": {
      "type": "boolean",
      "description": "Whether the API is Egress or not",
      "default": false,
      "example": true
    },
    "subtype": {
      "type": "string",
      "description": "Subtype of the API.",
      "default": "DEFAULT",
      "example": "AIAPI",
      "readOnly": true
    }
  }
}