diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/ApiClient.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/ApiClient.mustache index 2b2698548722..184dc13e05c0 100644 --- a/modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/ApiClient.mustache +++ b/modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/ApiClient.mustache @@ -46,6 +46,8 @@ public class ApiClient { /** * Use common specification for all operations + * @param supplier supplier + * @return configuration */ public Config reqSpecSupplier(Supplier supplier) { this.baseReqSpec = supplier; diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/api.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/api.mustache index 4e784645989f..8d90f195764a 100644 --- a/modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/api.mustache +++ b/modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/api.mustache @@ -51,8 +51,10 @@ public class {{classname}} { {{/operations}} /** - * Customise request specification - */ + * Customise request specification + * @param consumer consumer + * @return api + */ public {{classname}} reqSpec(Consumer consumer) { consumer.accept(reqSpec); return this; @@ -68,7 +70,7 @@ public class {{classname}} { * @see #{{#isPathParam}}{{paramName}}Path{{/isPathParam}}{{#isQueryParam}}{{paramName}}Query{{/isQueryParam}}{{#isFormParam}}{{^isFile}}{{paramName}}Form{{/isFile}}{{#isFile}}{{paramName}}MultiPart{{/isFile}}{{/isFormParam}}{{#isHeaderParam}}{{paramName}}Header{{/isHeaderParam}}{{#isBodyParam}}body{{/isBodyParam}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} {{/allParams}} {{#returnType}} - * return {{{returnType}}} + * return {{returnType}} {{/returnType}} {{#isDeprecated}} * @deprecated @@ -117,6 +119,9 @@ public class {{classname}} { /** * {{httpMethod}} {{path}} + * @param handler handler + * @param type + * @return type */ public T execute(Function handler) { return handler.apply(RestAssured.given().spec(reqSpec.build()).expect().spec(respSpec.build()).when().request({{httpMethod}}, REQ_URI)); @@ -125,7 +130,8 @@ public class {{classname}} { /** * {{httpMethod}} {{path}} - * @return {{{returnType}}} + * @param handler handler + * @return {{returnType}} */ public {{{returnType}}} executeAs(Function handler) { Type type = new TypeToken<{{{returnType}}}>(){}.getType(); @@ -135,7 +141,8 @@ public class {{classname}} { {{#bodyParams}} /** - * @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @return operation */ public {{operationIdCamelCase}}Oper body({{{dataType}}} {{paramName}}) { reqSpec.setBody({{paramName}}); @@ -145,7 +152,8 @@ public class {{classname}} { {{#headerParams}} /** - * @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @return operation */ public {{operationIdCamelCase}}Oper {{paramName}}Header(String {{paramName}}) { reqSpec.addHeader("{{baseName}}", {{paramName}}); @@ -155,7 +163,8 @@ public class {{classname}} { {{#pathParams}} /** - * @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @return operation */ public {{operationIdCamelCase}}Oper {{paramName}}Path(Object {{paramName}}) { reqSpec.addPathParam("{{baseName}}", {{paramName}}); @@ -165,7 +174,8 @@ public class {{classname}} { {{#queryParams}} /** - * @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @return operation */ public {{operationIdCamelCase}}Oper {{paramName}}Query(Object... {{paramName}}) { reqSpec.addQueryParam("{{baseName}}", {{paramName}}); @@ -176,7 +186,8 @@ public class {{classname}} { {{^isFile}} /** - * @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @return operation */ public {{operationIdCamelCase}}Oper {{paramName}}Form(Object... {{paramName}}) { reqSpec.addFormParam("{{baseName}}", {{paramName}}); @@ -188,9 +199,10 @@ public class {{classname}} { {{#isFile}} /** - * It will assume that the control name is file and the is + * It will assume that the control name is file and the <content-type> is <application/octet-stream> * @see #reqSpec for customise - * @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} + * @return operation */ public {{operationIdCamelCase}}Oper {{paramName}}MultiPart({{{dataType}}} {{paramName}}) { reqSpec.addMultiPart({{paramName}}); @@ -201,6 +213,8 @@ public class {{classname}} { /** * Customise request specification + * @param consumer consumer + * @return operation */ public {{operationIdCamelCase}}Oper reqSpec(Consumer consumer) { consumer.accept(reqSpec); @@ -209,6 +223,8 @@ public class {{classname}} { /** * Customise response specification + * @param consumer consumer + * @return operation */ public {{operationIdCamelCase}}Oper respSpec(Consumer consumer) { consumer.accept(respSpec);