WSO2 · Schema

Document Result

DocumentSearchResult schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPRESTIdentity FederationAPI Gateway

Properties

Name	Type	Description
docType	string
summary	string
sourceType	string
sourceUrl	string
otherTypeName	string
visibility	string
apiName	string	The name of the associated API
apiDisplayName	string	Human-friendly name shown in UI for associated API. Length limited to DB column size.
apiVersion	string	The version of the associated API
apiProvider	string
apiUUID	string
associatedType	string

View JSON Schema on GitHub

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-document-search-result-schema.json",
  "title": "Document Result",
  "description": "DocumentSearchResult schema from WSO2 API Manager",
  "allOf": [
    {
      "$ref": "#/components/schemas/SearchResult"
    },
    {
      "type": "object",
      "properties": {
        "docType": {
          "type": "string",
          "example": "HOWTO",
          "enum": [
            "HOWTO",
            "SAMPLES",
            "PUBLIC_FORUM",
            "SUPPORT_FORUM",
            "API_MESSAGE_FORMAT",
            "SWAGGER_DOC",
            "OTHER"
          ]
        },
        "summary": {
          "type": "string",
          "example": "Summary of Calculator Documentation"
        },
        "sourceType": {
          "type": "string",
          "example": "INLINE",
          "enum": [
            "INLINE",
            "URL",
            "FILE",
            "MARKDOWN"
          ]
        },
        "sourceUrl": {
          "type": "string",
          "example": ""
        },
        "otherTypeName": {
          "type": "string",
          "example": ""
        },
        "visibility": {
          "type": "string",
          "example": "API_LEVEL",
          "enum": [
            "OWNER_ONLY",
            "PRIVATE",
            "API_LEVEL"
          ]
        },
        "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"
        },
        "apiProvider": {
          "type": "string",
          "example": "admin"
        },
        "apiUUID": {
          "type": "string"
        },
        "associatedType": {
          "type": "string"
        }
      }
    }
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/devportal-api-document-search-result"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.