WSO2 · JSON Structure

Devportal Api Search Result Structure

SearchResult schema from WSO2 API Manager

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

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

Properties

id name type transportType

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/devportal-api-search-result-structure.json",
  "name": "Search Result",
  "description": "SearchResult schema from WSO2 API Manager",
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "type": "string",
      "example": "TestAPI"
    },
    "type": {
      "type": "string",
      "example": "API",
      "enum": [
        "DOC",
        "API",
        "APIProduct",
        "DEFINITION",
        "MCP"
      ]
    },
    "transportType": {
      "type": "string",
      "description": "Accepted values are HTTP, WS, SOAPTOREST, GRAPHQL"
    }
  },
  "discriminator": {
    "propertyName": "name"
  }
}