latest--aws-apigateway-documentationpart

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-apigateway-documentationpart.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::ApiGateway::DocumentationPart. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway

Properties

Location object required
5 nested properties
Method string | Aws_CF_FunctionString

The HTTP verb of a method.

Name string | Aws_CF_FunctionString

The name of the targeted API entity.

Path string | Aws_CF_FunctionString

The URL path of the target.

StatusCode string | Aws_CF_FunctionString

The HTTP status code of a response.

Type string | Aws_CF_FunctionString

The type of API entity that the documentation content applies to.

Properties string | Aws_CF_FunctionString required

The documentation content map of the targeted API entity.

RestApiId string | Aws_CF_FunctionString required

Identifier of the targeted API entity

Definitions

Location object
Method string | Aws_CF_FunctionString

The HTTP verb of a method.

Name string | Aws_CF_FunctionString

The name of the targeted API entity.

Path string | Aws_CF_FunctionString

The URL path of the target.

StatusCode string | Aws_CF_FunctionString

The HTTP status code of a response.

Type string | Aws_CF_FunctionString

The type of API entity that the documentation content applies to.