v3.2: Define a policy for deprecation markings. #4591
Merged
Conversation
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
We already deprecate `example` in the Schema Object, but do not define what deprecations means. We also effectively deprecate `allowEmptyValue` in the Parameter Object but did not explictly say so. We will likely make other deprecations in the future. This defines a very basic deprecaton policy (they are still supported, but we reserve the right to define a policy for removing them in the future) and marks `allowEmptyValue` with the same formatting used for `example`.
handrews
added
clarification
3 tasks
ralfhandl
approved these changes
May 16, 2025
miqui
approved these changes
May 19, 2025
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.
We already deprecate
examplein the Schema Object, but do not define what deprecations means. We also effectively deprecateallowEmptyValuein the Parameter Object but did not explicitly say so. We will likely make other deprecations in the future.This defines a very basic deprecaton policy (they are still supported, but we reserve the right to define a policy for removing them in the future) and marks
allowEmptyValuewith the same formatting used forexample.