hide deprecated properties in examples #4758
Merged
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.
Hide deprecated properties in schema examples
Motivation and Context
Showing deprecated properties in examples gives false impression that they are still current and should be used. This PR hides deprecated properties from examples shown in the UI, so new users are less likely to use deprecated properties by copy/pasting examples, or by using the examples as a form of ad-hoc documentation.
How Has This Been Tested?
Deprecated a property, verified that it does not appear in the example section of a POST request body.
Screenshots (if appropriate):
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests