Skip to content
This repository was archived by the owner on Jun 28, 2023. It is now read-only.

Clarify how OpenApi property removes stage 'Stage' #143

Closed
wants to merge 1 commit into from
Closed

Clarify how OpenApi property removes stage 'Stage' #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc_source/sam-resource-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ A name for the API Gateway RestApi resource

`OpenApiVersion` <a name="sam-api-openapiversion"></a>
Version of OpenApi to use\. This can either be `2.0` for the Swagger specification, or one of the OpenApi 3\.0 versions, like `3.0.1`\. For more information about OpenAPI, see the [OpenAPI Specification](https://swagger.io/specification/)\.
**Note**: Setting this property to any valid value will also remove the stage `Stage` that SAM creates\.
**Note**: For reasons of backwards compatibility, SAM creates a stage called `Stage` by default. Setting this property to any valid value will prevent the creation of the auto-generated stage `Stage`\.
*Type*: String
*Required*: No
*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\.
Expand Down