PutMethodResponseRequest

Request to add a MethodResponse to an existing Method resource.

APIs.ioEngineeringPlatform

Properties

Name Type Description
responseParameters object
responseModels object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-putmethodresponserequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutMethodResponseRequest",
  "title": "PutMethodResponseRequest",
  "type": "object",
  "properties": {
    "responseParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToBoolean"
        },
        {
          "description": "A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in <code>integration.response.header.{name}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.{JSON-expression}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)"
        }
      ]
    },
    "responseModels": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value."
        }
      ]
    }
  },
  "description": "Request to add a MethodResponse to an existing Method resource."
}