better docstring for jersey2 client (OpenAPITools#6104)

michaelpro1 · May 7, 2020 · 3156f5d · 3156f5d
1 parent 6613402
commit 3156f5d
Show file tree

Hide file tree

Showing 17 changed files with 195 additions and 12 deletions.
diff --git a/...tor/src/main/resources/Java/libraries/jersey2-experimental/AbstractOpenApiSchema.mustache b/...tor/src/main/resources/Java/libraries/jersey2-experimental/AbstractOpenApiSchema.mustache
@@ -7,23 +7,48 @@ import java.lang.reflect.Type;
 import java.util.Map;
 import javax.ws.rs.core.GenericType;
 
+/**
+ * Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
+ */
 {{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}
 public abstract class AbstractOpenApiSchema {
 
+    // store the actual instance of the schema/object
     private Object instance;
 
-    public final String schemaType;
+    // schema type (e.g. oneOf, anyOf)
+    private final String schemaType;
 
     public AbstractOpenApiSchema(String schemaType) {
         this.schemaType = schemaType;
     }
 
+    /***
+     * Get the list of schemas allowed to be stored in this object
+     *
+     * @return an instance of the actual schema/object
+     */
     public abstract Map<String, GenericType> getSchemas();
 
+    /***
+     * Get the actual instance
+     *
+     * @return an instance of the actual schema/object
+     */
     public Object getActualInstance() {return instance;}
 
+    /***
+     * Set the actual instance
+     *
+     * @param instance the actual instance of the schema/object
+     */
     public void setActualInstance(Object instance) {this.instance = instance;}
 
+    /***
+     * Get the schema type (e.g. anyOf, oneOf)
+     *
+     * @return the schema type
+     */
     public String getSchemaType() {
         return schemaType;
     }

diff --git a/...api-generator/src/main/resources/Java/libraries/jersey2-experimental/ApiResponse.mustache b/...api-generator/src/main/resources/Java/libraries/jersey2-experimental/ApiResponse.mustache
@@ -44,14 +44,29 @@ public class ApiResponse<T> {
         this.data = data;
     }
 
+    /**
+     * Get the status code
+     *
+     * @return status code
+     */
     public int getStatusCode() {
         return statusCode;
     }
 
+    /**
+     * Get the headers
+     *
+     * @return map of headers
+     */
     public Map<String, List<String>> getHeaders() {
         return headers;
     }
 
+    /**
+     * Get the data
+     *
+     * @return data
+     */
     public T getData() {
         return data;
     }

diff --git a/...es/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/JSON.mustache b/...es/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/JSON.mustache
@@ -63,5 +63,10 @@ public class JSON implements ContextResolver<ObjectMapper> {
     return mapper;
   }
 
+  /**
+   * Get the object mapper
+   *
+   * @return object mapper
+   */
   public ObjectMapper getMapper() { return mapper; }
 }
diff --git a/...les/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/api.mustache b/...les/openapi-generator/src/main/resources/Java/libraries/jersey2-experimental/api.mustache
@@ -16,8 +16,8 @@ import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-{{/fullJavaUtil}}
 
+{{/fullJavaUtil}}
 {{>generatedAnnotation}}
 {{#operations}}
 public class {{classname}} {
@@ -31,13 +31,24 @@ public class {{classname}} {
     this.apiClient = apiClient;
   }
 
+  /**
+   * Get the API cilent
+   *
+   * @return API client
+   */
   public ApiClient getApiClient() {
     return apiClient;
   }
 
+  /**
+   * Set the API cilent
+   *
+   * @param apiClient an instance of API client
+   */
   public void setApiClient(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
+
   {{#operation}}
   {{^vendorExtensions.x-group-parameters}}
   /**
@@ -170,7 +181,8 @@ public class {{classname}} {
       this.{{localVariablePrefix}}{{paramName}} = {{paramName}};
       {{/pathParams}}
     }
-    {{#allParams}}{{^isPathParam}}
+    {{#allParams}}
+    {{^isPathParam}}
 
     /**
      * Set {{paramName}}
@@ -181,7 +193,8 @@ public class {{classname}} {
       this.{{localVariablePrefix}}{{paramName}} = {{paramName}};
       return this;
     }
-    {{/isPathParam}}{{/allParams}}
+    {{/isPathParam}}
+    {{/allParams}}
 
     /**
      * Execute {{operationId}} request
@@ -216,9 +229,12 @@ public class {{classname}} {
          {{/responses}}
        </table>
      {{/responses.0}}
-     {{#isDeprecated}}* @deprecated{{/isDeprecated}}
+     {{#isDeprecated}}
+     * @deprecated{{/isDeprecated}}
      */
-    {{#isDeprecated}}@Deprecated{{/isDeprecated}}
+    {{#isDeprecated}}
+    @Deprecated
+    {{/isDeprecated}}
     public ApiResponse<{{#returnType}}{{{.}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> executeWithHttpInfo() throws ApiException {
       return {{operationId}}WithHttpInfo({{#allParams}}{{localVariablePrefix}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
     }
@@ -234,7 +250,9 @@ public class {{classname}} {
    {{#externalDocs}}* {{description}}
    * @see <a href="{{url}}">{{summary}} Documentation</a>{{/externalDocs}}
    */
-  {{#isDeprecated}}@Deprecated{{/isDeprecated}}
+  {{#isDeprecated}}
+  @Deprecated
+  {{/isDeprecated}}
   public API{{operationId}}Request {{operationId}}({{#pathParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/pathParams}}) throws ApiException {
     return new API{{operationId}}Request({{#pathParams}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/pathParams}});
   }

diff --git a/...pi-generator/src/main/resources/Java/libraries/jersey2-experimental/apiException.mustache b/...pi-generator/src/main/resources/Java/libraries/jersey2-experimental/apiException.mustache
@@ -9,6 +9,9 @@ import java.util.Map.Entry;
 import java.util.TreeMap;
 {{/caseInsensitiveResponseHeaders}}
 
+/**
+ * API Exception
+ */
 {{>generatedAnnotation}}
 public class ApiException extends{{#useRuntimeException}} RuntimeException {{/useRuntimeException}}{{^useRuntimeException}} Exception {{/useRuntimeException}}{
     private int code = 0;

diff --git a/...api-generator/src/main/resources/Java/libraries/jersey2-experimental/oneof_model.mustache b/...api-generator/src/main/resources/Java/libraries/jersey2-experimental/oneof_model.mustache
@@ -26,10 +26,6 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
         return {{classname}}.schemas;
     }
 
-    public String getSchemaType() {
-        return schemaType;
-    }
-
     @Override
     public void setActualInstance(Object instance) {
         {{#oneOf}}

diff --git a/...etstore/java/jersey2-experimental/src/main/java/org/openapitools/client/ApiException.java b/...etstore/java/jersey2-experimental/src/main/java/org/openapitools/client/ApiException.java
@@ -15,6 +15,7 @@
 import java.util.List;
 import java.util.Map;
 
+/** API Exception */
 public class ApiException extends Exception {
   private int code = 0;
   private Map<String, List<String>> responseHeaders = null;

diff --git a/...petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/ApiResponse.java b/...petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/ApiResponse.java
@@ -44,14 +44,29 @@ public ApiResponse(int statusCode, Map<String, List<String>> headers, T data) {
     this.data = data;
   }
 
+  /**
+   * Get the status code
+   *
+   * @return status code
+   */
   public int getStatusCode() {
     return statusCode;
   }
 
+  /**
+   * Get the headers
+   *
+   * @return map of headers
+   */
   public Map<String, List<String>> getHeaders() {
     return headers;
   }
 
+  /**
+   * Get the data
+   *
+   * @return data
+   */
   public T getData() {
     return data;
   }

diff --git a/...client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/JSON.java b/...client/petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/JSON.java
@@ -43,6 +43,11 @@ public ObjectMapper getContext(Class<?> type) {
     return mapper;
   }
 
+  /**
+   * Get the object mapper
+   *
+   * @return object mapper
+   */
   public ObjectMapper getMapper() {
     return mapper;
   }

diff --git a/...e/java/jersey2-experimental/src/main/java/org/openapitools/client/api/AnotherFakeApi.java b/...e/java/jersey2-experimental/src/main/java/org/openapitools/client/api/AnotherFakeApi.java
@@ -23,13 +23,24 @@ public AnotherFakeApi(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
 
+  /**
+   * Get the API cilent
+   *
+   * @return API client
+   */
   public ApiClient getApiClient() {
     return apiClient;
   }
 
+  /**
+   * Set the API cilent
+   *
+   * @param apiClient an instance of API client
+   */
   public void setApiClient(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
+
   /**
    * To test special tags To test special tags and operation ID starting with number
    *

diff --git a/...store/java/jersey2-experimental/src/main/java/org/openapitools/client/api/DefaultApi.java b/...store/java/jersey2-experimental/src/main/java/org/openapitools/client/api/DefaultApi.java
@@ -23,13 +23,24 @@ public DefaultApi(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
 
+  /**
+   * Get the API cilent
+   *
+   * @return API client
+   */
   public ApiClient getApiClient() {
     return apiClient;
   }
 
+  /**
+   * Set the API cilent
+   *
+   * @param apiClient an instance of API client
+   */
   public void setApiClient(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
+
   /**
    * @return InlineResponseDefault
    * @throws ApiException if fails to make API call

diff --git a/...petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/FakeApi.java b/...petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/FakeApi.java
@@ -32,13 +32,24 @@ public FakeApi(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
 
+  /**
+   * Get the API cilent
+   *
+   * @return API client
+   */
   public ApiClient getApiClient() {
     return apiClient;
   }
 
+  /**
+   * Set the API cilent
+   *
+   * @param apiClient an instance of API client
+   */
   public void setApiClient(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
+
   /**
    * Health check endpoint
    *

diff --git a/...rsey2-experimental/src/main/java/org/openapitools/client/api/FakeClassnameTags123Api.java b/...rsey2-experimental/src/main/java/org/openapitools/client/api/FakeClassnameTags123Api.java
@@ -23,13 +23,24 @@ public FakeClassnameTags123Api(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
 
+  /**
+   * Get the API cilent
+   *
+   * @return API client
+   */
   public ApiClient getApiClient() {
     return apiClient;
   }
 
+  /**
+   * Set the API cilent
+   *
+   * @param apiClient an instance of API client
+   */
   public void setApiClient(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
+
   /**
    * To test class name in snake case To test class name in snake case
    *

diff --git a/.../petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/PetApi.java b/.../petstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/PetApi.java
@@ -25,13 +25,24 @@ public PetApi(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
 
+  /**
+   * Get the API cilent
+   *
+   * @return API client
+   */
   public ApiClient getApiClient() {
     return apiClient;
   }
 
+  /**
+   * Set the API cilent
+   *
+   * @param apiClient an instance of API client
+   */
   public void setApiClient(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
+
   /**
    * Add a new pet to the store
    *

diff --git a/...etstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/StoreApi.java b/...etstore/java/jersey2-experimental/src/main/java/org/openapitools/client/api/StoreApi.java
@@ -23,13 +23,24 @@ public StoreApi(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
 
+  /**
+   * Get the API cilent
+   *
+   * @return API client
+   */
   public ApiClient getApiClient() {
     return apiClient;
   }
 
+  /**
+   * Set the API cilent
+   *
+   * @param apiClient an instance of API client
+   */
   public void setApiClient(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
+
   /**
    * Delete purchase order by ID For valid response try integer IDs with value &lt; 1000. Anything
    * above 1000 or nonintegers will generate API errors