Add @deprecated tag: mark deprecated attributes of the models in the OpenAPI files #1414
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
jillingk
previously approved these changes
Oct 3, 2024
Contributor
Author
|
Thanks @jillingk. Please don't merge, I am pushing another change (deprecated operations) |
gcatanese
force-pushed
the
mark-deprecated-model-attributes
branch
from
4dc0724 to
e0b0209
Compare
Kwok-he-Chu
approved these changes
Oct 15, 2024
gcatanese
force-pushed
the
mark-deprecated-model-attributes
branch
from
e0b0209 to
5d4afa0
Compare
gcatanese
force-pushed
the
mark-deprecated-model-attributes
branch
from
5d4afa0 to
317d064
Compare
|
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.
Description
The OpenAPI specs deprecate endpoints and models, but the code generation of the NodeJS library doesn't deprecate the corresponding code.
Proposed improvement
Add the
@deprecatedtag to the corresponding code, include the extensionsx-deprecatedInVersionandx-deprecatedMessagetoo.