TestInvokeMethodRequest

Make a request to simulate the invocation of a Method.

APIs.ioEngineeringPlatform

Properties

Name Type Description
pathWithQueryString object
body object
headers object
multiValueHeaders object
clientCertificateId object
stageVariables object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-testinvokemethodrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TestInvokeMethodRequest",
  "title": "TestInvokeMethodRequest",
  "type": "object",
  "properties": {
    "pathWithQueryString": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters."
        }
      ]
    },
    "body": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The simulated request body of an incoming invocation request."
        }
      ]
    },
    "headers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "A key-value map of headers to simulate an incoming invocation request."
        }
      ]
    },
    "multiValueHeaders": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToList"
        },
        {
          "description": "The headers as a map from string to list of values to simulate an incoming invocation request."
        }
      ]
    },
    "clientCertificateId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint."
        }
      ]
    },
    "stageVariables": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "A key-value map of stage variables to simulate an invocation on a deployed Stage."
        }
      ]
    }
  },
  "description": "Make a request to simulate the invocation of a Method."
}