WSO2 · Schema

API Result

APIProductSearchResult schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST
View JSON Schema on GitHub

JSON Schema

publisher-api-api-product-search-result-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-product-search-result-schema.json",
  "title": "API Result",
  "description": "APIProductSearchResult 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"
        },
        "version": {
          "type": "string",
          "description": "The version of the API Product",
          "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 APIPRODUCT is",
          "example": "PUBLISHED"
        },
        "thumbnailUri": {
          "type": "string",
          "example": "/apis/01234567-0123-0123-0123-012345678901/thumbnail"
        },
        "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]"
        },
        "egress": {
          "type": "boolean",
          "description": "Whether the API is Egress or not",
          "example": false
        },
        "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
        }
      }
    }
  ]
}