From d78ed92a155aa6499f41338cf27757cf55ceb621 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Toscano?= Date: Tue, 25 Jan 2022 15:53:59 -0600 Subject: [PATCH] Clarify how OpenApi property removes stage 'Stage' Adding context that this is required to ensure backwards compatibility --- doc_source/sam-resource-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc_source/sam-resource-api.md b/doc_source/sam-resource-api.md index 67f541d..4cdafcd 100644 --- a/doc_source/sam-resource-api.md +++ b/doc_source/sam-resource-api.md @@ -157,7 +157,7 @@ A name for the API Gateway RestApi resource `OpenApiVersion` 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\.