WSO2 · Schema

API Info object with basic API details.

APIInfo schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
id	string
name	string
displayName	string	Display name of the API. This is the name that will be displayed in the Publisher and DevPortal. If not provided, the name will be used as the display name.
context	string
version	string
provider	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/service-catalog-api-api-info-schema.json",
  "title": "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"
    }
  }
}