WSO2 · JSON Structure

Publisher Api Api Endpoint Structure

APIEndpoint schema from WSO2 API Manager

Type: object Properties: 5 Required: 1
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Endpoint is a JSON Structure definition published by WSO2, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name deploymentStage endpointConfig apiDefinition

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/publisher-api-api-endpoint-structure.json",
  "name": "Endpoint",
  "description": "APIEndpoint schema from WSO2 API Manager",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "57a380b7-d852-4f56-bb23-db172722e9d4"
    },
    "name": {
      "type": "string",
      "example": "Endpoint1"
    },
    "deploymentStage": {
      "type": "string",
      "example": "PRODUCTION or SANDBOX"
    },
    "endpointConfig": {
      "type": "object",
      "properties": {},
      "description": "Endpoint configuration of the API. This can be used to provide different types of endpoints including \nSimple REST Endpoints, Loadbalanced and Failover.\n"
    },
    "apiDefinition": {
      "type": "string",
      "description": "OpenAPI specification of the backend endpoint"
    }
  }
}