Amazon API Gateway · Schema

Resource

GatewayHTTP APIREST APIServerlessWebSocket

Properties

Name Type Description
id string The resource's identifier.
parentId string The parent resource's identifier.
pathPart string The last path segment for this resource.
path string The full path for this resource.
resourceMethods object Map of methods for this resource keyed by HTTP method type.
View JSON Schema on GitHub

JSON Schema

amazon-api-gateway-resource-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Resource",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The resource's identifier."
    },
    "parentId": {
      "type": "string",
      "description": "The parent resource's identifier."
    },
    "pathPart": {
      "type": "string",
      "description": "The last path segment for this resource."
    },
    "path": {
      "type": "string",
      "description": "The full path for this resource."
    },
    "resourceMethods": {
      "type": "object",
      "description": "Map of methods for this resource keyed by HTTP method type."
    }
  }
}