Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
better docstring for jersey2 client
  • Loading branch information
wing328 committed Apr 29, 2020
commit 853ff5c57ebd7ed0b8b516b825845a4e7cdaa712
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,10 @@ public class JSON implements ContextResolver<ObjectMapper> {
return mapper;
}

/**
* Get the object mapper
*
* @return object mapper
*/
public ObjectMapper getMapper() { return mapper; }
}
Original file line number Diff line number Diff line change
Expand Up @@ -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}} {
Expand All @@ -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}}
/**
Expand Down Expand Up @@ -170,7 +181,8 @@ public class {{classname}} {
this.{{localVariablePrefix}}{{paramName}} = {{paramName}};
{{/pathParams}}
}
{{#allParams}}{{^isPathParam}}
{{#allParams}}
{{^isPathParam}}

/**
* Set {{paramName}}
Expand All @@ -181,7 +193,8 @@ public class {{classname}} {
this.{{localVariablePrefix}}{{paramName}} = {{paramName}};
return this;
}
{{/isPathParam}}{{/allParams}}
{{/isPathParam}}
{{/allParams}}

/**
* Execute {{operationId}} request
Expand Down Expand Up @@ -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}});
}
Expand All @@ -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}});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ public ObjectMapper getContext(Class<?> type) {
return mapper;
}

/**
* Get the object mapper
*
* @return object mapper
*/
public ObjectMapper getMapper() {
return mapper;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading