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

Clarification about removal of stage called Stage in AWS::Serverless::Api  #142

@GiltosMx

Description

@GiltosMx

I noticed my SAM templates were creating a stage called Stage automatically when using the SAM CLI for deploying my API.

I went through the open issues in the serverless-application-model repository, and found #1202.

Quoting keetonian's reply:

We definitely can make this more clear in the documentation. I'll add a label to this issue to update our documentation.

I decided to update the documentation to make it perfectly clear that there is indeed a stage called Stage created automatically unless the OpenApi property is set to any valid value.

I appreciate the current Note in the AWS docs:

Note: Setting this property to any valid value will also remove the stage Stage that SAM creates

However, when I first read through the SAM documentation it wasn't clear to me what the note was referring to - or that it would create an additional stage besides the one specified in the StageName property).

I'm proposing adding a more detailed note, which hopefully removes ambiguity regarding this auto-generated stage Stage.

I will create a Pull Request with my proposal and link it as a comment in this issue. Thanks a lot!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions