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

Home > @codemonger-io/cdk-rest-api-with-spec > MethodOptionsWithSpec

MethodOptionsWithSpec interface

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.

aws_apigateway.MethodOptions augmented with the properties necessary to build the OpenAPI definition.

Signature:

export interface MethodOptionsWithSpec extends apigateway.MethodOptions 

Extends: apigateway.MethodOptions

Remarks

operationName corresponds to paths[path][method].operationId in the OpenAPI definition.

Properties

Property	Modifiers	Type	Description
authorizer?		IAuthorizerWithSpec	(BETA) (Optional) Authorizer augmented with the OpenAPI definition.
description?		string	(BETA) (Optional) Description of the method.
methodResponses?		MethodResponseWithSpec[]	(BETA) (Optional) Method responses augmented with properties necessary for the OpenAPI definition.
requestParameterSchemas?		{ [key: string]: BaseParameterObject; }	(BETA) (Optional) Request parameters which maps parameter objects for the OpenAPI definition instead of boolean values.
summary?		string	(BETA) (Optional) Summary of the method.