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
otherTypeName	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-schema.json",
  "title": "Document",
  "description": "Document schema from WSO2 API Manager",
  "required": [
    "name",
    "sourceType",
    "type"
  ],
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "type": "string",
      "example": "CalculatorDoc"
    },
    "type": {
      "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",
        "MARKDOWN",
        "URL",
        "FILE"
      ]
    },
    "sourceUrl": {
      "type": "string",
      "example": ""
    },
    "otherTypeName": {
      "type": "string",
      "example": ""
    }
  }
}