APIs.io Engineering Platform · Schema
PutIntegrationResponseRequest
Represents a put integration response request.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| selectionPattern | object | |
| responseParameters | object | |
| responseTemplates | object | |
| contentHandling | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PutIntegrationResponseRequest",
"title": "PutIntegrationResponseRequest",
"type": "object",
"properties": {
"selectionPattern": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "Specifies the selection pattern of a put integration response."
}
]
},
"responseParameters": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfStringToString"
},
{
"description": "A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.{name}</code> or <code>integration.response.body.{JSON-expression}</code>, where <code>name</code> must be a valid and unique response header name and <code>JSON-expression</code> a valid JSON expression without the <code>$</code> prefix."
}
]
},
"responseTemplates": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfStringToString"
},
{
"description": "Specifies a put integration response's templates."
}
]
},
"contentHandling": {
"allOf": [
{
"$ref": "#/components/schemas/ContentHandlingStrategy"
},
{
"description": "<p>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</p>"
}
]
}
},
"description": "Represents a put integration response request."
}