fix(java-jersey2): Fixing javadocs warnings (#3040)

* edit fix(java-jersey2): Fixing javadocs warnings

* fix(java-jersey): Updating pet project
This commit is contained in:
Sai Giridhar P 2019-06-03 13:07:55 +05:30 committed by William Cheng
parent ded0bd6801
commit 25dce23d81
17 changed files with 65 additions and 2 deletions

View File

@ -808,6 +808,8 @@ public class ApiClient {
* Update query and header parameters based on authentication settings.
*
* @param authNames The authentications to apply
* @param queryParams List of query parameters
* @param headerParams Map of header parameters
*/
protected void updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String, String> headerParams) {
for (String authName : authNames) {

View File

@ -75,9 +75,7 @@ public class {{classname}} {
{{#allParams}}
* @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
{{/allParams}}
{{#returnType}}
* @return ApiResponse&lt;{{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}Void{{/returnType}}&gt;
{{/returnType}}
* @throws ApiException if fails to make API call
{{#isDeprecated}}
* @deprecated

View File

@ -784,6 +784,8 @@ public class ApiClient {
* Update query and header parameters based on authentication settings.
*
* @param authNames The authentications to apply
* @param queryParams List of query parameters
* @param headerParams Map of header parameters
*/
protected void updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String, String> headerParams) {
for (String authName : authNames) {

View File

@ -58,6 +58,7 @@ public class FakeApi {
* creates an XmlItem
* this route creates an XmlItem
* @param xmlItem XmlItem Body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createXmlItemWithHttpInfo(XmlItem xmlItem) throws ApiException {
@ -297,6 +298,7 @@ public class FakeApi {
*
* For this test, the body for this request much reference a schema named &#x60;File&#x60;.
* @param body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testBodyWithFileSchemaWithHttpInfo(FileSchemaTestClass body) throws ApiException {
@ -350,6 +352,7 @@ public class FakeApi {
*
* @param query (required)
* @param body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testBodyWithQueryParamsWithHttpInfo(String query, User body) throws ApiException {
@ -485,6 +488,7 @@ public class FakeApi {
* @param dateTime None (optional)
* @param password None (optional)
* @param paramCallback None (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testEndpointParametersWithHttpInfo(BigDecimal number, Double _double, String patternWithoutDelimiter, byte[] _byte, Integer integer, Integer int32, Long int64, Float _float, String string, File binary, LocalDate date, OffsetDateTime dateTime, String password, String paramCallback) throws ApiException {
@ -593,6 +597,7 @@ if (paramCallback != null)
* @param enumQueryDouble Query parameter enum test (double) (optional)
* @param enumFormStringArray Form parameter enum test (string array) (optional, default to $)
* @param enumFormString Form parameter enum test (string) (optional, default to -efg)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testEnumParametersWithHttpInfo(List<String> enumHeaderStringArray, String enumHeaderString, List<String> enumQueryStringArray, String enumQueryString, Integer enumQueryInteger, Double enumQueryDouble, List<String> enumFormStringArray, String enumFormString) throws ApiException {
@ -661,6 +666,7 @@ if (enumFormString != null)
* @param stringGroup String in group parameters (optional)
* @param booleanGroup Boolean in group parameters (optional)
* @param int64Group Integer in group parameters (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testGroupParametersWithHttpInfo(Integer requiredStringGroup, Boolean requiredBooleanGroup, Long requiredInt64Group, Integer stringGroup, Boolean booleanGroup, Long int64Group) throws ApiException {
@ -730,6 +736,7 @@ if (booleanGroup != null)
* test inline additionalProperties
*
* @param param request body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testInlineAdditionalPropertiesWithHttpInfo(Map<String, String> param) throws ApiException {
@ -783,6 +790,7 @@ if (booleanGroup != null)
*
* @param param field1 (required)
* @param param2 field2 (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testJsonFormDataWithHttpInfo(String param, String param2) throws ApiException {

View File

@ -52,6 +52,7 @@ public class PetApi {
* Add a new pet to the store
*
* @param body Pet object that needs to be added to the store (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> addPetWithHttpInfo(Pet body) throws ApiException {
@ -105,6 +106,7 @@ public class PetApi {
*
* @param petId Pet id to delete (required)
* @param apiKey (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> deletePetWithHttpInfo(Long petId, String apiKey) throws ApiException {
@ -322,6 +324,7 @@ public class PetApi {
* Update an existing pet
*
* @param body Pet object that needs to be added to the store (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> updatePetWithHttpInfo(Pet body) throws ApiException {
@ -377,6 +380,7 @@ public class PetApi {
* @param petId ID of pet that needs to be updated (required)
* @param name Updated name of the pet (optional)
* @param status Updated status of the pet (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> updatePetWithFormWithHttpInfo(Long petId, String name, String status) throws ApiException {

View File

@ -50,6 +50,7 @@ public class StoreApi {
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* @param orderId ID of the order that needs to be deleted (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> deleteOrderWithHttpInfo(String orderId) throws ApiException {

View File

@ -50,6 +50,7 @@ public class UserApi {
* Create user
* This can only be done by the logged in user.
* @param body Created user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createUserWithHttpInfo(User body) throws ApiException {
@ -101,6 +102,7 @@ public class UserApi {
* Creates list of users with given input array
*
* @param body List of user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createUsersWithArrayInputWithHttpInfo(List<User> body) throws ApiException {
@ -152,6 +154,7 @@ public class UserApi {
* Creates list of users with given input array
*
* @param body List of user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createUsersWithListInputWithHttpInfo(List<User> body) throws ApiException {
@ -203,6 +206,7 @@ public class UserApi {
* Delete user
* This can only be done by the logged in user.
* @param username The name that needs to be deleted (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> deleteUserWithHttpInfo(String username) throws ApiException {
@ -367,6 +371,7 @@ public class UserApi {
/**
* Logs out current logged in user session
*
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> logoutUserWithHttpInfo() throws ApiException {
@ -415,6 +420,7 @@ public class UserApi {
* This can only be done by the logged in user.
* @param username name that need to be deleted (required)
* @param body Updated user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> updateUserWithHttpInfo(String username, User body) throws ApiException {

View File

@ -787,6 +787,8 @@ public class ApiClient {
* Update query and header parameters based on authentication settings.
*
* @param authNames The authentications to apply
* @param queryParams List of query parameters
* @param headerParams Map of header parameters
*/
protected void updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String, String> headerParams) {
for (String authName : authNames) {

View File

@ -58,6 +58,7 @@ public class FakeApi {
* creates an XmlItem
* this route creates an XmlItem
* @param xmlItem XmlItem Body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createXmlItemWithHttpInfo(XmlItem xmlItem) throws ApiException {
@ -297,6 +298,7 @@ public class FakeApi {
*
* For this test, the body for this request much reference a schema named &#x60;File&#x60;.
* @param body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testBodyWithFileSchemaWithHttpInfo(FileSchemaTestClass body) throws ApiException {
@ -350,6 +352,7 @@ public class FakeApi {
*
* @param query (required)
* @param body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testBodyWithQueryParamsWithHttpInfo(String query, User body) throws ApiException {
@ -485,6 +488,7 @@ public class FakeApi {
* @param dateTime None (optional)
* @param password None (optional)
* @param paramCallback None (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testEndpointParametersWithHttpInfo(BigDecimal number, Double _double, String patternWithoutDelimiter, byte[] _byte, Integer integer, Integer int32, Long int64, Float _float, String string, File binary, LocalDate date, OffsetDateTime dateTime, String password, String paramCallback) throws ApiException {
@ -593,6 +597,7 @@ if (paramCallback != null)
* @param enumQueryDouble Query parameter enum test (double) (optional)
* @param enumFormStringArray Form parameter enum test (string array) (optional, default to $)
* @param enumFormString Form parameter enum test (string) (optional, default to -efg)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testEnumParametersWithHttpInfo(List<String> enumHeaderStringArray, String enumHeaderString, List<String> enumQueryStringArray, String enumQueryString, Integer enumQueryInteger, Double enumQueryDouble, List<String> enumFormStringArray, String enumFormString) throws ApiException {
@ -661,6 +666,7 @@ if (enumFormString != null)
* @param stringGroup String in group parameters (optional)
* @param booleanGroup Boolean in group parameters (optional)
* @param int64Group Integer in group parameters (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testGroupParametersWithHttpInfo(Integer requiredStringGroup, Boolean requiredBooleanGroup, Long requiredInt64Group, Integer stringGroup, Boolean booleanGroup, Long int64Group) throws ApiException {
@ -730,6 +736,7 @@ if (booleanGroup != null)
* test inline additionalProperties
*
* @param param request body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testInlineAdditionalPropertiesWithHttpInfo(Map<String, String> param) throws ApiException {
@ -783,6 +790,7 @@ if (booleanGroup != null)
*
* @param param field1 (required)
* @param param2 field2 (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testJsonFormDataWithHttpInfo(String param, String param2) throws ApiException {

View File

@ -52,6 +52,7 @@ public class PetApi {
* Add a new pet to the store
*
* @param body Pet object that needs to be added to the store (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> addPetWithHttpInfo(Pet body) throws ApiException {
@ -105,6 +106,7 @@ public class PetApi {
*
* @param petId Pet id to delete (required)
* @param apiKey (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> deletePetWithHttpInfo(Long petId, String apiKey) throws ApiException {
@ -322,6 +324,7 @@ public class PetApi {
* Update an existing pet
*
* @param body Pet object that needs to be added to the store (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> updatePetWithHttpInfo(Pet body) throws ApiException {
@ -377,6 +380,7 @@ public class PetApi {
* @param petId ID of pet that needs to be updated (required)
* @param name Updated name of the pet (optional)
* @param status Updated status of the pet (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> updatePetWithFormWithHttpInfo(Long petId, String name, String status) throws ApiException {

View File

@ -50,6 +50,7 @@ public class StoreApi {
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* @param orderId ID of the order that needs to be deleted (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> deleteOrderWithHttpInfo(String orderId) throws ApiException {

View File

@ -50,6 +50,7 @@ public class UserApi {
* Create user
* This can only be done by the logged in user.
* @param body Created user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createUserWithHttpInfo(User body) throws ApiException {
@ -101,6 +102,7 @@ public class UserApi {
* Creates list of users with given input array
*
* @param body List of user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createUsersWithArrayInputWithHttpInfo(List<User> body) throws ApiException {
@ -152,6 +154,7 @@ public class UserApi {
* Creates list of users with given input array
*
* @param body List of user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createUsersWithListInputWithHttpInfo(List<User> body) throws ApiException {
@ -203,6 +206,7 @@ public class UserApi {
* Delete user
* This can only be done by the logged in user.
* @param username The name that needs to be deleted (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> deleteUserWithHttpInfo(String username) throws ApiException {
@ -367,6 +371,7 @@ public class UserApi {
/**
* Logs out current logged in user session
*
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> logoutUserWithHttpInfo() throws ApiException {
@ -415,6 +420,7 @@ public class UserApi {
* This can only be done by the logged in user.
* @param username name that need to be deleted (required)
* @param body Updated user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> updateUserWithHttpInfo(String username, User body) throws ApiException {

View File

@ -787,6 +787,8 @@ public class ApiClient {
* Update query and header parameters based on authentication settings.
*
* @param authNames The authentications to apply
* @param queryParams List of query parameters
* @param headerParams Map of header parameters
*/
protected void updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String, String> headerParams) {
for (String authName : authNames) {

View File

@ -58,6 +58,7 @@ public class FakeApi {
* creates an XmlItem
* this route creates an XmlItem
* @param xmlItem XmlItem Body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createXmlItemWithHttpInfo(XmlItem xmlItem) throws ApiException {
@ -297,6 +298,7 @@ public class FakeApi {
*
* For this test, the body for this request much reference a schema named &#x60;File&#x60;.
* @param body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testBodyWithFileSchemaWithHttpInfo(FileSchemaTestClass body) throws ApiException {
@ -350,6 +352,7 @@ public class FakeApi {
*
* @param query (required)
* @param body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testBodyWithQueryParamsWithHttpInfo(String query, User body) throws ApiException {
@ -485,6 +488,7 @@ public class FakeApi {
* @param dateTime None (optional)
* @param password None (optional)
* @param paramCallback None (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testEndpointParametersWithHttpInfo(BigDecimal number, Double _double, String patternWithoutDelimiter, byte[] _byte, Integer integer, Integer int32, Long int64, Float _float, String string, File binary, LocalDate date, OffsetDateTime dateTime, String password, String paramCallback) throws ApiException {
@ -593,6 +597,7 @@ if (paramCallback != null)
* @param enumQueryDouble Query parameter enum test (double) (optional)
* @param enumFormStringArray Form parameter enum test (string array) (optional, default to $)
* @param enumFormString Form parameter enum test (string) (optional, default to -efg)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testEnumParametersWithHttpInfo(List<String> enumHeaderStringArray, String enumHeaderString, List<String> enumQueryStringArray, String enumQueryString, Integer enumQueryInteger, Double enumQueryDouble, List<String> enumFormStringArray, String enumFormString) throws ApiException {
@ -661,6 +666,7 @@ if (enumFormString != null)
* @param stringGroup String in group parameters (optional)
* @param booleanGroup Boolean in group parameters (optional)
* @param int64Group Integer in group parameters (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testGroupParametersWithHttpInfo(Integer requiredStringGroup, Boolean requiredBooleanGroup, Long requiredInt64Group, Integer stringGroup, Boolean booleanGroup, Long int64Group) throws ApiException {
@ -730,6 +736,7 @@ if (booleanGroup != null)
* test inline additionalProperties
*
* @param param request body (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testInlineAdditionalPropertiesWithHttpInfo(Map<String, String> param) throws ApiException {
@ -783,6 +790,7 @@ if (booleanGroup != null)
*
* @param param field1 (required)
* @param param2 field2 (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> testJsonFormDataWithHttpInfo(String param, String param2) throws ApiException {

View File

@ -52,6 +52,7 @@ public class PetApi {
* Add a new pet to the store
*
* @param body Pet object that needs to be added to the store (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> addPetWithHttpInfo(Pet body) throws ApiException {
@ -105,6 +106,7 @@ public class PetApi {
*
* @param petId Pet id to delete (required)
* @param apiKey (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> deletePetWithHttpInfo(Long petId, String apiKey) throws ApiException {
@ -322,6 +324,7 @@ public class PetApi {
* Update an existing pet
*
* @param body Pet object that needs to be added to the store (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> updatePetWithHttpInfo(Pet body) throws ApiException {
@ -377,6 +380,7 @@ public class PetApi {
* @param petId ID of pet that needs to be updated (required)
* @param name Updated name of the pet (optional)
* @param status Updated status of the pet (optional)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> updatePetWithFormWithHttpInfo(Long petId, String name, String status) throws ApiException {

View File

@ -50,6 +50,7 @@ public class StoreApi {
* Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
* @param orderId ID of the order that needs to be deleted (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> deleteOrderWithHttpInfo(String orderId) throws ApiException {

View File

@ -50,6 +50,7 @@ public class UserApi {
* Create user
* This can only be done by the logged in user.
* @param body Created user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createUserWithHttpInfo(User body) throws ApiException {
@ -101,6 +102,7 @@ public class UserApi {
* Creates list of users with given input array
*
* @param body List of user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createUsersWithArrayInputWithHttpInfo(List<User> body) throws ApiException {
@ -152,6 +154,7 @@ public class UserApi {
* Creates list of users with given input array
*
* @param body List of user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> createUsersWithListInputWithHttpInfo(List<User> body) throws ApiException {
@ -203,6 +206,7 @@ public class UserApi {
* Delete user
* This can only be done by the logged in user.
* @param username The name that needs to be deleted (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> deleteUserWithHttpInfo(String username) throws ApiException {
@ -367,6 +371,7 @@ public class UserApi {
/**
* Logs out current logged in user session
*
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> logoutUserWithHttpInfo() throws ApiException {
@ -415,6 +420,7 @@ public class UserApi {
* This can only be done by the logged in user.
* @param username name that need to be deleted (required)
* @param body Updated user object (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<Void> updateUserWithHttpInfo(String username, User body) throws ApiException {