WSO2 · JSON Structure

Service Catalog Api Api Info Structure

APIInfo schema from WSO2 API Manager

Type: object Properties: 6
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

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

Properties

id name displayName context version provider

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/service-catalog-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"
    },
    "context": {
      "type": "string",
      "example": "CalculatorAPI"
    },
    "version": {
      "type": "string",
      "example": "1.0.0"
    },
    "provider": {
      "type": "string",
      "example": "admin"
    }
  }
}