Amazon API Gateway · Schema

Model

GatewayHTTP APIREST APIServerlessWebSocket

Properties

Name Type Description
id string The identifier of the model.
name string The name of the model.
description string The description of the model.
schema string The schema for the model. For application/json models, this should be JSON schema draft 4 model.
contentType string The content type for the model.
View JSON Schema on GitHub

JSON Schema

amazon-api-gateway-model-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Model",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The identifier of the model."
    },
    "name": {
      "type": "string",
      "description": "The name of the model."
    },
    "description": {
      "type": "string",
      "description": "The description of the model."
    },
    "schema": {
      "type": "string",
      "description": "The schema for the model. For application/json models, this should be JSON schema draft 4 model."
    },
    "contentType": {
      "type": "string",
      "description": "The content type for the model."
    }
  }
}