WSO2 · Schema
API Definition Search Result
APIDefinitionSearchResult 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/devportal-api-api-definition-search-result-schema.json",
"title": "API Definition Search Result",
"description": "APIDefinitionSearchResult schema from WSO2 API Manager",
"allOf": [
{
"$ref": "#/components/schemas/SearchResult"
},
{
"properties": {
"apiName": {
"type": "string",
"description": "The name of the associated API",
"example": "TestAPI"
},
"apiDisplayName": {
"description": "Human-friendly name shown in UI for associated API. Length limited to DB column size.",
"type": "string",
"example": "Pizza Shack API"
},
"apiVersion": {
"type": "string",
"description": "The version of the associated API",
"example": "1.0.0"
},
"apiContext": {
"type": "string",
"description": "The context of the associated API",
"example": "/test"
},
"apiUUID": {
"type": "string",
"description": "The UUID of the associated API"
},
"apiProvider": {
"type": "string",
"description": "The provider name of the associated API",
"example": "publisher"
},
"apiType": {
"type": "string",
"description": "The type of the associated API",
"example": "REST"
},
"associatedType": {
"type": "string",
"description": "API or APIProduct",
"example": "API"
}
}
}
]
}