-
Notifications
You must be signed in to change notification settings - Fork 99
Openapi: adding more info in x-state, adding x-state info to fields and params #4431
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
base: main
Are you sure you want to change the base?
Conversation
There is info about the differences between these extensions in https://docs.bump.sh/help/specification-support/doc-badges/. The benefit of using x-beta was that it affected what was deemed a "breaking change" in the automated changelog. However, given that we didn't have the same consideration for tech preview / experimental states, IMO it's not worth trying to have both the
Since this PR affects only a specification extension, in my opinion it should be something that's ignorable by any other tools or processes that consume these OpenAPI documents. That is to say, IMO it can be standard output. |
I did a quick skim of the output and the
And here's what I see in this PR's serverless-specific output:
IMO the output should match the |
63774cd
to
0c62637
Compare
@lcawl fixed the serverless output! |
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.
Output LGTM, thanks!
Closes #4386, Closes #4356.
Couple of doubts:
This would replace "x-beta" with "x-state" in the Beta case, and change the field type from a boolean to a string, is this okay?Does this also have to be configurable, or can it be the standard output?