WSO2 · Schema

API Info object with basic minimal API details.

APIMetadata schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name Type Description
id string
name string
context string
version string
provider string If the provider value is not given, the user invoking the API will be used as the provider.
View JSON Schema on GitHub

JSON Schema

publisher-api-api-metadata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/publisher-api-api-metadata-schema.json",
  "title": "API Info object with basic minimal API details.",
  "description": "APIMetadata schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "type": "string",
      "example": "CalculatorAPI"
    },
    "context": {
      "type": "string",
      "example": "CalculatorAPI"
    },
    "version": {
      "type": "string",
      "example": "1.0.0"
    },
    "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"
    }
  }
}