GatewayResponse

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

APIs.ioEngineeringPlatform

Properties

Name Type Description
responseType object
statusCode object
responseParameters object
responseTemplates object
defaultResponse object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-gatewayresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GatewayResponse",
  "title": "GatewayResponse",
  "type": "object",
  "properties": {
    "responseType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GatewayResponseType"
        },
        {
          "description": "The response type of the associated GatewayResponse."
        }
      ]
    },
    "statusCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StatusCode"
        },
        {
          "description": "The HTTP status code for this GatewayResponse."
        }
      ]
    },
    "responseParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs."
        }
      ]
    },
    "responseTemplates": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs."
        }
      ]
    },
    "defaultResponse": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A Boolean flag to indicate whether this GatewayResponse is the default gateway response (<code>true</code>) or not (<code>false</code>). A default gateway response is one generated by API Gateway without any customization by an API developer. "
        }
      ]
    }
  },
  "description": "A gateway response of a given response type and status code, with optional response parameters and mapping templates."
}