-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(openapi): fix sort criteria parameter #12090
fix(openapi): fix sort criteria parameter #12090
Conversation
@@ -570,19 +570,15 @@ private static void addExtraParameters(final Components components) { | |||
"SortBy" + MODEL_VERSION, | |||
new Parameter() | |||
.in(NAME_QUERY) | |||
.name("sort") | |||
.name("sortCriteria") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
need a note in the release notes section for this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
breaking change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the API controller still supports "sort", however client sdks using the spec will break the programmatic apis.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It technically doesn't remove the deprecated parameter so if you were previously sending in a single string here it would not break with these changes. It only affects the documentation and OpenAPI spec. Will add a note nonetheless.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pending release note
Checklist