mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-12-08 19:46:10 +00:00
[Java][*] Annotate deprecated operations and schemas (#9478)
Refs #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
This commit is contained in:
@@ -306,7 +306,10 @@ public class PetApi {
|
||||
* @param tags Tags to filter by
|
||||
* @return Set<Pet>
|
||||
* @throws IOException if an error occurs while attempting to invoke the API
|
||||
* @deprecated
|
||||
|
||||
**/
|
||||
@Deprecated
|
||||
public Set<Pet> findPetsByTags(Set<String> tags) throws IOException {
|
||||
HttpResponse response = findPetsByTagsForHttpResponse(tags);
|
||||
TypeReference<Set<Pet>> typeRef = new TypeReference<Set<Pet>>() {};
|
||||
@@ -322,13 +325,17 @@ public class PetApi {
|
||||
* @param params Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.
|
||||
* @return Set<Pet>
|
||||
* @throws IOException if an error occurs while attempting to invoke the API
|
||||
* @deprecated
|
||||
|
||||
**/
|
||||
@Deprecated
|
||||
public Set<Pet> findPetsByTags(Set<String> tags, Map<String, Object> params) throws IOException {
|
||||
HttpResponse response = findPetsByTagsForHttpResponse(tags, params);
|
||||
TypeReference<Set<Pet>> typeRef = new TypeReference<Set<Pet>>() {};
|
||||
return apiClient.getObjectMapper().readValue(response.getContent(), typeRef);
|
||||
}
|
||||
|
||||
@Deprecated
|
||||
public HttpResponse findPetsByTagsForHttpResponse(Set<String> tags) throws IOException {
|
||||
// verify the required parameter 'tags' is set
|
||||
if (tags == null) {
|
||||
@@ -354,6 +361,7 @@ public class PetApi {
|
||||
return apiClient.getHttpRequestFactory().buildRequest(HttpMethods.GET, genericUrl, content).execute();
|
||||
}
|
||||
|
||||
@Deprecated
|
||||
public HttpResponse findPetsByTagsForHttpResponse(Set<String> tags, Map<String, Object> params) throws IOException {
|
||||
// verify the required parameter 'tags' is set
|
||||
if (tags == null) {
|
||||
|
||||
Reference in New Issue
Block a user