DocumentationPart

GatewayHTTP APIREST APIServerlessWebSocket

Properties

Name	Type	Description
id	string
location	object
properties	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DocumentationPart",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "location": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "API",
            "AUTHORIZER",
            "MODEL",
            "RESOURCE",
            "METHOD",
            "PATH_PARAMETER",
            "QUERY_PARAMETER",
            "REQUEST_HEADER",
            "REQUEST_BODY",
            "RESPONSE",
            "RESPONSE_HEADER",
            "RESPONSE_BODY"
          ]
        },
        "path": {
          "type": "string"
        },
        "method": {
          "type": "string"
        },
        "statusCode": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "properties": {
      "type": "string"
    }
  }
}