WSO2 · JSON Structure

Devportal Api Document Structure

Document schema from WSO2 API Manager

Type: object Properties: 7 Required: 3
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Document is a JSON Structure definition published by WSO2, describing 7 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

documentId name type summary sourceType sourceUrl otherTypeName

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-document-structure.json",
  "name": "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": ""
    }
  }
}