raml.schemas.response-definition.schema.json Maven / Gradle / Ivy

Go to download
{
    "type": "object",
    "properties": {
        "status": {
            "description": "The HTTP status code to be returned",
            "type": "integer"
        },
        "statusMessage": {
            "description": "The HTTP status message to be returned",
            "type": "string"
        },
        "body": {
            "description": "The response body as a string. Only one of body, base64Body, jsonBody or bodyFileName may be specified.",
            "type": "string"
        },
        "headers": {
            "description": "Map of response headers to send",
            "type": "object"
        },
        "jsonBody": {
            "description": "The response body as a JSON object. Only one of body, base64Body, jsonBody or bodyFileName may be specified.",
            "type": "object"
        },
        "bodyFileName": {
            "description": "The path to the file containing the response body, relative to the configured file root. Only one of body, base64Body, jsonBody or bodyFileName may be specified.",
            "type": "string"
        },
        "base64Body": {
            "description": "The response body as a base64 encoded string (useful for binary content). Only one of body, base64Body, jsonBody or bodyFileName may be specified.",
            "type": "string"
        },
        "additionalProxyRequestHeaders": {
            "description": "Extra request headers to send when proxying to another host.",
            "type": "object"
        },
        "fixedDelayMilliseconds": {
            "description": "Number of milliseconds to delay be before sending the response.",
            "type": "integer"
        },
        "delayDistribution": {
            "description": "Random delay settings.",
            "$ref": "delay-distribution.schema.json"
        },
        "fault": {
            "type": "string",
            "description": "The fault to apply (instead of a full, valid response).",
            "enum": [
                "CONNECTION_RESET_BY_PEER",
                "EMPTY_RESPONSE",
                "MALFORMED_RESPONSE_CHUNK",
                "RANDOM_DATA_THEN_CLOSE"
            ]
        },
        "proxyBaseUrl": {
            "description": "The base URL of the target to proxy matching requests to.",
            "type": "string"
        },
        "transformers": {
            "description": "List of names of transformers to apply to this response.",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "transformerParameters": {
            "description": "Parameters to apply to response transformers.",
            "type": "object"
        },
        "fromConfiguredStub": {
            "description": "Read-only flag indicating false if this was the default, unmatched response. Not present otherwise.",
            "type": "boolean"
        }
    }
}