docs: Remove incorrect default value for shouldStartNameWithService #11711
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The plan was to make the default shouldStartNameWithService to be true in v3, but that decision was reverted in serverless#9160 (comment) and the default value in v3 is still actually false.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The plan was to make the default
shouldStartNameWithServiceto be true in v3, but that decision was reverted in#9160 (comment) and the default value in v3 is still actually false.
This caused my team issues today after we removed
shouldStartNameWithService: truefrom ourserverless.ymlthinking that as its the default it isn't needed to be explicitly defined (we're using v3), but when we deployed the change it created a new API gateway resource which was totally unexpected and caused us some headaches. I believe this is because contrary to what the docs say, the defaultshouldStartNameWithServicein v3 is still actually false.