Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 2.1 KB

cdk-rest-api-with-spec.methodoptionswithspec.requestparameterschemas.md

File metadata and controls

45 lines (31 loc) · 2.1 KB
Raw

Home > cdk-rest-api-with-spec > MethodOptionsWithSpec > requestParameterSchemas

MethodOptionsWithSpec.requestParameterSchemas property

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Request parameters which maps parameter objects for the OpenAPI definition instead of boolean values.

Signature:

requestParameterSchemas?: {
        [key: string]: BaseParameterObject;
    };

Remarks

Corresponds to paths[path][method].parameters in the OpenAPI definition.

Possible keys are the same as those of requestParameters; i.e., in one of the following forms,

- method.request.path.<parameter-name>
- method.request.querystring.<parameter-name>
- method.request.header.<parameter-name>

A key represents the following properties of the parameter object of the OpenAPI definition,

- name = <parameter-name>
- in
  "path" for "method.request.path.*",
  "query" for "method.request.querystirng.*",
  "header" for "method.request.header.*".

Values of required properties are copied to corresponding boolean values of requestParameters.

If both requestParameters and requestParameterSchemas are specified, requestParameterSchemas precedes.

Please refer to OpenApi3-TS for more details about BaseParameterObject.