WSO2 · Schema

Document

Document schema from WSO2 API Manager

API ManagementGatewaysOpen-SourceAPI LifecycleGraphQLSOAPREST

Properties

Name Type Description
documentId string
name string
type string
summary string
sourceType string
sourceUrl string
fileName string
inlineContent string
otherTypeName string
visibility string
createdTime string
createdBy string
lastUpdatedTime string
lastUpdatedBy string
View JSON Schema on GitHub

JSON Schema

publisher-api-document-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-document-schema.json",
  "title": "Document",
  "description": "Document schema from WSO2 API Manager",
  "required": [
    "name",
    "sourceType",
    "type",
    "visibility"
  ],
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "readOnly": true,
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "maxLength": 255,
      "minLength": 1,
      "type": "string",
      "example": "PizzaShackDoc"
    },
    "type": {
      "type": "string",
      "example": "HOWTO",
      "enum": [
        "HOWTO",
        "SAMPLES",
        "PUBLIC_FORUM",
        "SUPPORT_FORUM",
        "API_MESSAGE_FORMAT",
        "SWAGGER_DOC",
        "OTHER"
      ]
    },
    "summary": {
      "maxLength": 32766,
      "minLength": 1,
      "type": "string",
      "example": "Summary of PizzaShackAPI Documentation"
    },
    "sourceType": {
      "type": "string",
      "example": "INLINE",
      "enum": [
        "INLINE",
        "MARKDOWN",
        "URL",
        "FILE"
      ]
    },
    "sourceUrl": {
      "type": "string",
      "readOnly": true,
      "example": ""
    },
    "fileName": {
      "type": "string",
      "readOnly": true,
      "example": ""
    },
    "inlineContent": {
      "type": "string",
      "example": "This is doc content. This can have many lines."
    },
    "otherTypeName": {
      "type": "string",
      "readOnly": true,
      "example": ""
    },
    "visibility": {
      "type": "string",
      "example": "API_LEVEL",
      "enum": [
        "OWNER_ONLY",
        "PRIVATE",
        "API_LEVEL"
      ]
    },
    "createdTime": {
      "type": "string",
      "readOnly": true
    },
    "createdBy": {
      "type": "string",
      "example": "admin"
    },
    "lastUpdatedTime": {
      "type": "string",
      "readOnly": true
    },
    "lastUpdatedBy": {
      "type": "string",
      "readOnly": true,
      "example": "admin"
    }
  }
}

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/publisher-api-document"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

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