Repository navigation
fix(openapi3): warn when a server variable with enum values has no default #12302
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Yashvardhan Thanvi (Thanatos9404)
wants to merge
4
commits into
microsoft:main
Choose a base branch
from
Thanatos9404:fix/openapi3-server-variable-enum-default
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+152
−6
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
90346d8
fix(openapi3): use the first enum value as the server variable default
Thanatos9404 207198d
fix(openapi3): warn when a server variable default falls back to the …
Thanatos9404 d20dd31
fix(openapi3): warn about a missing server variable default instead o…
Thanatos9404 38690fc
Merge branch 'main' into fix/openapi3-server-variable-enum-default
Thanatos9404 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
.chronus/changes/fix-openapi3-server-variable-enum-default-2026-9-19-11-21-11.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| changeKind: fix | ||
| packages: | ||
| - "@typespec/openapi3" | ||
| --- | ||
|
|
||
| Report a new `missing-server-variable-default` warning when a server variable that has an `enum` has no default and the document is emitted for OpenAPI 3.1.0 or later, since those versions require the default to be one of the `enum` values. The emitted `default` stays an empty string. |
20 changes: 20 additions & 0 deletions
20
packages/openapi3/src/diagnostics/missing-server-variable-default.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| This diagnostic is issued when a variable in the `@server` decorator has a fixed set of values (an enum, a union of string literals or a string literal) but no default, and the document is emitted for OpenAPI 3.1.0 or later. | ||
| Those versions require the `default` of a server variable to be one of its `enum` values. The emitter does not pick one for you, so the variable keeps an empty `default` and the document is not valid. | ||
|
|
||
| To fix this issue, set a default on the server parameter. | ||
|
|
||
| ### Example | ||
|
|
||
| ```typespec | ||
| @server("https://{region}.example.com", "Regional endpoint", { | ||
| region: "westus" | "eastus", // No default | ||
| }) | ||
| ``` | ||
|
|
||
| Set a default: | ||
|
|
||
| ```typespec | ||
| @server("https://{region}.example.com", "Regional endpoint", { | ||
| region?: "westus" | "eastus" = "eastus", | ||
| }) | ||
| ``` | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the diagnostic, I don't like choosing a default for the user. If we were to do so, the first variant makes sense, but the possibility of changing an invalid spec into a valid but incorrect spec isn't appealing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, thanks. I dropped the default selection, so a variable without a default keeps
default: ""as before, andmissing-server-variable-defaultis now reported only when emitting OpenAPI 3.1.0 or later, where the default must be one of the enum values (d20dd31). That also removes the special case for the versions enum. Happy to turn the warning on for 3.0 as well if you would rather have it there.