WSO2 · Schema

API info object with basic API details

APIInfo schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
name	string	The name of the API.
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.
version	string	The version of the API
provider	string	The provider of the API

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/admin-api-api-info-schema.json",
  "title": "API info object with basic API details",
  "description": "APIInfo schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the API.",
      "example": "PizzaShackAPI"
    },
    "displayName": {
      "type": "string",
      "example": "PizzaShack 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"
    },
    "version": {
      "type": "string",
      "description": "The version of the API",
      "example": "1.0.0"
    },
    "provider": {
      "type": "string",
      "description": "The provider of the API",
      "example": "admin"
    }
  }
}