Add deprecated annotations on shorthand functions for deprecated operations #384
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
czechboy0
approved these changes
Nov 17, 2023
|
I just met this one today :-) |
Contributor
|
@groue we published a release today with the fix |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Motivation
If an operation is marked as deprecated in the OpenAPI document then the generated protocol requirement is annotated as deprecated. However, the shorthand overload for this function, in the protocol extension, was missing this annotation.
Modifications
Add deprecated annotation to the generated function in the protocol extension for deprecated API operations.
Result
If an operation is marked as deprecated in the OpenAPI document then both variants of the generated function (the protocol requirement and the protocol extension) are annotated as deprecated.
Test Plan
Updated the snippet test to include a path with one deprecated operation and one non-deprecated operation.
Related Issues