Interface Parameter

Parameter is used to define required path, query or header parameters for API Gateway. If "ALL" or "PARAMS_ONLY" validator is set then, api gateway will validate the parameter is included and non-blank for incoming requests.

interface Parameter {
    in: "header" | "query" | "path";
    name: string;
}

Properties

in name

Properties

in

in: "header" | "query" | "path"

in is where the parameter is expected to appear. API Gateway can validate parameters expected in the path, query or header.

name

name: string

Settings

Member Visibility

Theme

On This Page

inname

Generated using TypeDoc