Path Item $ref change warning (3.1.1) #3860
Merged
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
Previously we deprecated the special $ref behavior entirely, but doing so violates the compatibility guidelines that we have re-established for ourselves within 3.x. This wording allows changes in 3.2, but emphasizes convergence rather than discouraging the usage.
handrews
added
re-use: ref/id resolution
Co-authored-by: Ralf Handl <[email protected]>
ralfhandl
previously approved these changes
May 28, 2024
lornajane
previously approved these changes
Jun 6, 2024
ralfhandl
approved these changes
Jun 6, 2024
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.
Fixes:
Previously we deprecated the special $ref behavior entirely, but doing so violates the compatibility guidelines that we have re-established for ourselves within 3.x. This wording allows changes in 3.2, but emphasizes convergence rather than discouraging the usage.
NOTE: I'm not sure what we should do for this in 3.2, but options include treating
summaryanddescriptionlike in the Reference Object but retaining the special behavior for the other entries, and/or allowing the same overwriting for some or all other Path Item entries (although I am reluctant to open that can of worms withparameters). We could also just formalize the behavior that is currently undefined in some way (e.g. make it a clear error - undefined behavior can be changed to anything without breaking compatibility, but defined behavior cannot be removed).