-
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
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
[Java][*] Annotate deprecated operations and schemas #9478
[Java][*] Annotate deprecated operations and schemas #9478
Conversation
15fcec4
to
a68965c
Compare
AFAIK marking Operations as deprecated is working - marking model-fields as deprecated is not |
@cljk can you elaborate a bit? AFAICT it's working correctly with this commit... see ObjectWithDeprecatedFields in the schema and in all the newly generated samples, for example this one |
And to clarify, prior to this commit "marking Operations as deprecated" was only supported for a few Java clients (jersey2, resteasy, rest-assured, some retrofit) ... this commit brings along all the other Java clients |
Oh, I´m sorry. I completely missed out your commit / pull request. I thought this was just an open issue description. I checked out your pull request for I would by glad if this would be merged and released soon. |
I had an uneducated look in the circleci output and tried to figure out why it failed.
|
I'll rebase and see if it behaves better now, at the time I opened the PR it seems that most builds were failing the same way, perhaps the issue has been fixed on master? |
a68965c
to
0d55c7e
Compare
This time travis, also an error and also an error of the test setup - not code modifications?! Perhaps the maintainers can tell something about that 🤷🏼♂️
|
@wing328 |
Refs OpenAPITools#3358 Ensure `deprecated` operations are annotated/documented as such on the generated methods. Libraries updated: * [feign] * [google-api-client] * [microprofile] * [okhttp-gson] * [resttemplate] * [retrofit] * [retrofit/play*] * [webclient] * [vertx] Ensure `deprecated` schemas are annotated/documented as such on the generated classes/fields. Libraries updated: * [feign] * [google-api-client] * [jersey2] * [microprofile] * [native] * [okhttp-gson] * [rest-assured] * [resteasy] * [resttemplate] * [retrofit*] * [webclient] * [vertx] Also fix two minor bugs to get the java sample tests working: * Fix an invalid jackson-datatype-threetenbp version number in vertx/pom.mustache * Fix a bad return type in webclient/api_test.mustache when uniqueItems=true Since this commit updates petstore-with-fake-endpoints-models-for-testing.yaml, several other samples were updated, but it's just new files to reflect the deprecated schemas, so there should be no consequential differences. Relevant bits of the spec: * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#user-content-operationdeprecated * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#user-content-schemadeprecated
0d55c7e
to
fd99bf5
Compare
Sorry for the delay in reviewing as there are too many PRs to review. I tested it locally and the result is good. We may remove some newly added samples introduced in this PR while we're consolidating the test samples. |
Thanks @wing328! |
Refs #3358
Ensure
deprecated
operations are annotated/documented as such on thegenerated methods. Libraries updated:
Ensure
deprecated
schemas are annotated/documented as such on thegenerated classes/fields. Libraries updated:
Also fix two minor bugs to get the java sample tests working:
Since this commit updates petstore-with-fake-endpoints-models-for-testing.yaml,
several other samples were updated, but it's just new files to reflect the
deprecated schemas, so there should be no consequential differences. 🤞
Relevant bits of the spec:
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*
.For Windows users, please run the script in Git BASH.
master
,5.1.x
,6.0.x