WSO2 · Schema
API Result
APISearchResult schema from WSO2 API Manager
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST
JSON Schema
{
"$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-search-result-schema.json",
"title": "API Result",
"description": "APISearchResult schema from WSO2 API Manager",
"allOf": [
{
"$ref": "#/components/schemas/SearchResult"
},
{
"type": "object",
"properties": {
"displayName": {
"description": "Human-friendly name shown in UI. Length limited to DB column size.",
"type": "string",
"example": "Pizza Shack API"
},
"description": {
"type": "string",
"description": "A brief description about the API",
"example": "A calculator API that supports basic operations"
},
"context": {
"type": "string",
"description": "A string that represents the context of the user's request",
"example": "CalculatorAPI"
},
"contextTemplate": {
"type": "string",
"description": "The templated context of the API",
"example": "CalculatorAPI/{version}"
},
"version": {
"type": "string",
"description": "The version of the API",
"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"
},
"status": {
"type": "string",
"description": "This describes in which status of the lifecycle the API is",
"example": "CREATED"
},
"thumbnailUri": {
"type": "string",
"example": "/apis/01234567-0123-0123-0123-012345678901/thumbnail"
},
"advertiseOnly": {
"type": "boolean",
"example": true
},
"gatewayVendor": {
"title": "Field to identify gateway vendor",
"type": "string",
"description": "Vendor of the gateway where the API is deployed.",
"example": "wso2"
},
"gatewayType": {
"title": "Field to identify gateway type.",
"type": "string",
"description": "The type of the gateway.",
"example": "wso2/synapse"
},
"hasThumbnail": {
"type": "boolean",
"example": true
},
"monetizedInfo": {
"type": "boolean",
"example": true
},
"businessOwner": {
"type": "string",
"example": "Business Owner"
},
"businessOwnerEmail": {
"type": "string",
"example": "[email protected]"
},
"TechnicalOwner": {
"type": "string",
"example": "Technical Owner"
},
"TechnicalOwnerEmail": {
"type": "string",
"example": "[email protected]"
},
"createdTime": {
"type": "string",
"description": "Created time as unix timestamp in milliseconds.",
"example": 1756199448644
},
"updatedTime": {
"type": "string",
"description": "Update time as unix timestamp in milliseconds.",
"example": 1756199448644
}
}
}
]
}