diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java index 32691e641365..786ab27631af 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java @@ -63,6 +63,7 @@ import java.util.*; import java.util.regex.Matcher; import java.util.stream.Collectors; +import java.util.stream.Stream; import static org.apache.commons.lang3.StringUtils.isNotEmpty; import static org.openapitools.codegen.CodegenConstants.*; @@ -1126,87 +1127,110 @@ public void preprocessOpenAPI(OpenAPI openAPI) { @Override public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List allModels) { - final OperationMap operations = objs.getOperations(); - if (operations != null) { - final List ops = operations.getOperation(); - for (final CodegenOperation operation : ops) { - final List responses = operation.responses; - if (responses != null) { - for (final CodegenResponse resp : responses) { - if ("0".equals(resp.code)) { - resp.code = "200"; - } - doDataTypeAssignment(resp.dataType, new DataTypeAssigner() { - @Override - public void setReturnType(final String returnType) { - resp.dataType = returnType; - } - - @Override - public void setReturnContainer(final String returnContainer) { - resp.containerType = returnContainer; - } - - @Override - public void setIsVoid(boolean isVoid) { - resp.isVoid = isVoid; - } - }); - } - } - - doDataTypeAssignment(operation.returnType, new DataTypeAssigner() { + removeImport(objs, "java.util.List"); - @Override - public void setReturnType(final String returnType) { - operation.returnType = returnType; - } + final OperationMap operations = objs.getOperations(); + if (operations == null) { + return objs; + } - @Override - public void setReturnContainer(final String returnContainer) { - operation.returnContainer = returnContainer; - } + final List ops = operations.getOperation(); + for (final CodegenOperation operation : ops) { + clearEmptyDescriptions(operation); + postProcessResponses(operation.responses); - @Override - public void setIsVoid(boolean isVoid) { - operation.isVoid = isVoid; - } - }); + doDataTypeAssignment(operation.returnType, new DataTypeAssigner() { - prepareVersioningParameters(ops); - handleImplicitHeaders(operation); - normalizeVendorExtensionWithStringList(operation.vendorExtensions, VendorExtension.X_OPERATION_EXTRA_ANNOTATION.getName()); - normalizeOperationParameterVendorExtensions(operation, VendorExtension.X_FIELD_EXTRA_ANNOTATION.getName()); + @Override + public void setReturnType(final String returnType) { + operation.returnType = returnType; + } - if (useSpringSecurityPreAuthorize) { - addSpringSecurityPreAuthorize(operation); + @Override + public void setReturnContainer(final String returnContainer) { + operation.returnContainer = returnContainer; } - if (isLibrary(SPRING_HTTP_INTERFACE) || isLibrary(SPRING_BOOT)) { - if (operation.isArray && "string".equalsIgnoreCase(operation.returnBaseType)) { - operation.vendorExtensions.put(VendorExtension.X_REACTIVE_RETURN_EXCEPT_LIST_OF_STRING.getName(), true); - } + @Override + public void setIsVoid(boolean isVoid) { + operation.isVoid = isVoid; } + }); + + prepareVersioningParameters(ops); + handleImplicitHeaders(operation); + normalizeVendorExtensionWithStringList(operation.vendorExtensions, VendorExtension.X_OPERATION_EXTRA_ANNOTATION.getName()); + normalizeOperationParameterVendorExtensions(operation, VendorExtension.X_FIELD_EXTRA_ANNOTATION.getName()); + + if (useSpringSecurityPreAuthorize) { + addSpringSecurityPreAuthorize(operation); } - // The tag for the controller is the first tag of the first operation - final CodegenOperation firstOperation = ops.get(0); - final Tag firstTag = firstOperation.tags.get(0); - final String firstTagName = firstTag.getName(); - // But use a sensible tag name if there is none - objs.put("tagName", escapeText("default".equals(firstTagName) ? firstOperation.baseName : firstTagName)); - objs.put("tagDescription", escapeText(firstTag.getDescription())); - - // Add clientRegistrationId for spring-http-interface with OAuth - if (SPRING_HTTP_INTERFACE.equals(library) && clientRegistrationId != null && !clientRegistrationId.isEmpty()) { - operations.put("clientRegistrationId", clientRegistrationId); + + if ((isLibrary(SPRING_HTTP_INTERFACE) || isLibrary(SPRING_BOOT)) + && operation.isArray && "string".equalsIgnoreCase(operation.returnBaseType)) { + operation.vendorExtensions.put(VendorExtension.X_REACTIVE_RETURN_EXCEPT_LIST_OF_STRING.getName(), true); } } + // The tag for the controller is the first tag of the first operation + final CodegenOperation firstOperation = ops.get(0); + final Tag firstTag = firstOperation.tags.get(0); + final String firstTagName = firstTag.getName(); + // But use a sensible tag name if there is none + objs.put("tagName", escapeText("default".equals(firstTagName) ? firstOperation.baseName : firstTagName)); + objs.put("tagDescription", escapeText(firstTag.getDescription())); - removeImport(objs, "java.util.List"); + // Add clientRegistrationId for spring-http-interface with OAuth + if (SPRING_HTTP_INTERFACE.equals(library) && clientRegistrationId != null && !clientRegistrationId.isEmpty()) { + operations.put("clientRegistrationId", clientRegistrationId); + } return objs; } + /** + * Treats empty descriptions as absent, so templates omit annotation attributes like {@code description = ""}. + */ + private static void clearEmptyDescriptions(CodegenOperation operation) { + if (StringUtils.isEmpty(operation.notes)) { + operation.notes = null; + } + Stream.of(operation.allParams, operation.bodyParams, operation.pathParams, operation.queryParams, + operation.headerParams, operation.implicitHeadersParams, operation.formParams, operation.cookieParams, + operation.requiredParams, operation.optionalParams, operation.requiredAndNotNullableParams, + operation.notNullableParams) + .filter(Objects::nonNull) + .flatMap(List::stream) + .filter(param -> StringUtils.isEmpty(param.description)) + .forEach(param -> param.description = null); + } + + private void postProcessResponses(List responses) { + if (responses == null) { + return; + } + for (final CodegenResponse resp : responses) { + if ("0".equals(resp.code)) { + resp.code = "200"; + } + doDataTypeAssignment(resp.dataType, new DataTypeAssigner() { + @Override + public void setReturnType(final String returnType) { + resp.dataType = returnType; + } + + @Override + public void setReturnContainer(final String returnContainer) { + resp.containerType = returnContainer; + } + + @Override + public void setIsVoid(boolean isVoid) { + resp.isVoid = isVoid; + } + }); + } + } + /** * Adds a Spring Security expression that preserves the OpenAPI security requirement semantics: * entries in a {@code security} array are OR alternatives, while schemes and scopes in one diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/formParams.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/formParams.mustache index ca41fa6a80a9..b8292cc68c12 100644 --- a/modules/openapi-generator/src/main/resources/JavaSpring/formParams.mustache +++ b/modules/openapi-generator/src/main/resources/JavaSpring/formParams.mustache @@ -1 +1 @@ -{{#isFormParam}}{{^isFile}}{{>paramDoc}}{{#useBeanValidation}} {{>beanValidationBodyParams}}{{^isContainer}}{{#isModel}}@Valid {{/isModel}}{{^isModel}}{{^useOptional}}@Valid {{/useOptional}}{{#useOptional}}{{#required}}@Valid {{/required}}{{/useOptional}}{{/isModel}}{{/isContainer}}{{/useBeanValidation}}{{^useBeanValidation}} {{/useBeanValidation}}{{#isModel}}@RequestPart{{/isModel}}{{^isModel}}{{#isArray}}@RequestPart{{/isArray}}{{^isArray}}{{#reactive}}@RequestPart{{/reactive}}{{^reactive}}@RequestParam{{/reactive}}{{/isArray}}{{/isModel}}(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}){{>dateTimeParam}} {{^required}}{{#useOptional}}Optional<{{/useOptional}}{{/required}}{{{dataType}}}{{^required}}{{#useOptional}}>{{/useOptional}}{{/required}} {{paramName}}{{/isFile}}{{#isFile}}{{>paramDoc}} {{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}@RequestPart(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}) {{#reactive}}{{#isArray}}Flux<{{/isArray}}Part{{#isArray}}>{{/isArray}}{{/reactive}}{{^reactive}}{{#isArray}}List<{{/isArray}}MultipartFile{{#isArray}}>{{/isArray}}{{/reactive}} {{paramName}}{{/isFile}}{{/isFormParam}} \ No newline at end of file +{{#isFormParam}}{{^isFile}}{{>paramDoc}}{{#useBeanValidation}} {{>beanValidationBodyParams}}{{^isContainer}}{{#isModel}}@Valid {{/isModel}}{{^isModel}}{{^useOptional}}@Valid {{/useOptional}}{{#useOptional}}{{#required}}@Valid {{/required}}{{/useOptional}}{{/isModel}}{{/isContainer}}{{/useBeanValidation}}{{^useBeanValidation}} {{/useBeanValidation}}{{#isModel}}@RequestPart{{/isModel}}{{^isModel}}{{#isArray}}@RequestPart{{/isArray}}{{^isArray}}{{#reactive}}@RequestPart{{/reactive}}{{^reactive}}@RequestParam{{/reactive}}{{/isArray}}{{/isModel}}(value = "{{baseName}}"{{^required}}, required = false{{/required}}){{>dateTimeParam}} {{^required}}{{#useOptional}}Optional<{{/useOptional}}{{/required}}{{{dataType}}}{{^required}}{{#useOptional}}>{{/useOptional}}{{/required}} {{paramName}}{{/isFile}}{{#isFile}}{{>paramDoc}} {{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}@RequestPart(value = "{{baseName}}"{{^required}}, required = false{{/required}}) {{#reactive}}{{#isArray}}Flux<{{/isArray}}Part{{#isArray}}>{{/isArray}}{{/reactive}}{{^reactive}}{{#isArray}}List<{{/isArray}}MultipartFile{{#isArray}}>{{/isArray}}{{/reactive}} {{paramName}}{{/isFile}}{{/isFormParam}} \ No newline at end of file diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/headerParams.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/headerParams.mustache index 80b1d0a82341..baf6d547f7e8 100644 --- a/modules/openapi-generator/src/main/resources/JavaSpring/headerParams.mustache +++ b/modules/openapi-generator/src/main/resources/JavaSpring/headerParams.mustache @@ -1 +1 @@ -{{#isHeaderParam}}{{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{>paramDoc}} @RequestHeader(value = "{{baseName}}", required = {{#required}}true{{/required}}{{^required}}false{{/required}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{>dateTimeParam}} {{>nullableAnnotation}}{{>optionalDataType}} {{paramName}}{{/isHeaderParam}} \ No newline at end of file +{{#isHeaderParam}}{{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{>paramDoc}} @RequestHeader(value = "{{baseName}}"{{^required}}, required = false{{/required}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{>dateTimeParam}} {{>nullableAnnotation}}{{>optionalDataType}} {{paramName}}{{/isHeaderParam}} \ No newline at end of file diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/paramDoc.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/paramDoc.mustache index c546f9c4e904..5e1e63f8b9f2 100644 --- a/modules/openapi-generator/src/main/resources/JavaSpring/paramDoc.mustache +++ b/modules/openapi-generator/src/main/resources/JavaSpring/paramDoc.mustache @@ -1 +1 @@ -{{#swagger2AnnotationLibrary}}@Parameter(name = "{{{baseName}}}"{{#isDeprecated}}, deprecated = true{{/isDeprecated}}, description = "{{{description}}}"{{#required}}, required = true{{/required}}{{#isPathParam}}, in = ParameterIn.PATH{{/isPathParam}}{{#isQueryParam}}, in = ParameterIn.QUERY{{/isQueryParam}}{{#isCookieParam}}, in = ParameterIn.COOKIE{{/isCookieParam}}{{#isHeaderParam}}, in = ParameterIn.HEADER{{/isHeaderParam}}){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}@ApiParam(value = "{{{description}}}"{{#required}}, required = true{{/required}}{{#allowableValues}}, {{> allowableValues }}{{/allowableValues}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/swagger1AnnotationLibrary}} \ No newline at end of file +{{#swagger2AnnotationLibrary}}@Parameter(name = "{{{baseName}}}"{{#isDeprecated}}, deprecated = true{{/isDeprecated}}{{#description}}, description = "{{{.}}}"{{/description}}{{#required}}, required = true{{/required}}{{#isPathParam}}, in = ParameterIn.PATH{{/isPathParam}}{{#isQueryParam}}, in = ParameterIn.QUERY{{/isQueryParam}}{{#isCookieParam}}, in = ParameterIn.COOKIE{{/isCookieParam}}{{#isHeaderParam}}, in = ParameterIn.HEADER{{/isHeaderParam}}){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}@ApiParam(value = "{{{description}}}"{{#required}}, required = true{{/required}}{{#allowableValues}}, {{> allowableValues }}{{/allowableValues}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/swagger1AnnotationLibrary}} \ No newline at end of file diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/queryParams.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/queryParams.mustache index 24382e72ac11..26ef93559911 100644 --- a/modules/openapi-generator/src/main/resources/JavaSpring/queryParams.mustache +++ b/modules/openapi-generator/src/main/resources/JavaSpring/queryParams.mustache @@ -1 +1 @@ -{{#isQueryParam}}{{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{>paramDoc}}{{#useBeanValidation}}{{^isContainer}}{{#isModel}} @Valid{{/isModel}}{{^isModel}}{{^useOptional}} @Valid{{/useOptional}}{{#useOptional}}{{#required}} @Valid{{/required}}{{/useOptional}}{{/isModel}}{{/isContainer}}{{/useBeanValidation}}{{^isModel}} @RequestParam(value = {{#isMap}}""{{/isMap}}{{^isMap}}"{{baseName}}"{{/isMap}}{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/isModel}}{{>dateTimeParam}}{{#isDeprecated}} @Deprecated{{/isDeprecated}} {{>nullableAnnotation}}{{>optionalDataType}} {{paramName}}{{/isQueryParam}} \ No newline at end of file +{{#isQueryParam}}{{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{>paramDoc}}{{#useBeanValidation}}{{^isContainer}}{{#isModel}} @Valid{{/isModel}}{{^isModel}}{{^useOptional}} @Valid{{/useOptional}}{{#useOptional}}{{#required}} @Valid{{/required}}{{/useOptional}}{{/isModel}}{{/isContainer}}{{/useBeanValidation}}{{^isModel}} @RequestParam(value = {{#isMap}}""{{/isMap}}{{^isMap}}"{{baseName}}"{{/isMap}}{{^required}}, required = false{{/required}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/isModel}}{{>dateTimeParam}}{{#isDeprecated}} @Deprecated{{/isDeprecated}} {{>nullableAnnotation}}{{>optionalDataType}} {{paramName}}{{/isQueryParam}} \ No newline at end of file diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java index 1185da2824c7..4f41c60cb9b8 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java @@ -806,12 +806,12 @@ public void testMultipartBoot() throws IOException { .assertParameter("status").hasType("MultipartMixedStatus") .assertParameterAnnotations() .containsWithName("Valid") - .containsWithNameAndAttributes("Parameter", ImmutableMap.of("name", "\"status\"", "description", "\"\"", "required", "true")) - .containsWithNameAndAttributes("RequestParam", ImmutableMap.of("value", "\"status\"", "required", "true")) + .containsWithNameAndAttributes("Parameter", ImmutableMap.of("name", "\"status\"", "required", "true")) + .containsWithNameAndAttributes("RequestParam", ImmutableMap.of("value", "\"status\"")) .toParameter().toMethod() .assertParameter("file").hasType("MultipartFile") .assertParameterAnnotations() - .containsWithNameAndAttributes("RequestPart", ImmutableMap.of("value", "\"file\"", "required", "true")) + .containsWithNameAndAttributes("RequestPart", ImmutableMap.of("value", "\"file\"")) .toParameter().toMethod() .assertParameter("marker").hasType("MultipartMixedRequestMarker") .assertParameterAnnotations() @@ -1026,12 +1026,12 @@ public void testReactiveMultipartBoot() throws IOException { .assertParameter("status").hasType("MultipartMixedStatus") .assertParameterAnnotations() .containsWithName("Valid") - .containsWithNameAndAttributes("Parameter", ImmutableMap.of("name", "\"status\"", "description", "\"\"")) - .containsWithNameAndAttributes("RequestPart", ImmutableMap.of("value", "\"status\"", "required", "true")) + .containsWithNameAndAttributes("Parameter", ImmutableMap.of("name", "\"status\"")) + .containsWithNameAndAttributes("RequestPart", ImmutableMap.of("value", "\"status\"")) .toParameter().toMethod() .assertParameter("file").hasType("Part") .assertParameterAnnotations() - .containsWithNameAndAttributes("RequestPart", ImmutableMap.of("value", "\"file\"", "required", "true")) + .containsWithNameAndAttributes("RequestPart", ImmutableMap.of("value", "\"file\"")) .toParameter().toMethod() .assertParameter("marker").hasType("MultipartMixedRequestMarker") .assertParameterAnnotations() @@ -1130,11 +1130,29 @@ public void beanValidationOnContainerParameter_issue23614() throws IOException { // A list query parameter loses the container-level @Valid, while a single-object request body // still cascades via the parameter-level @Valid (non-containers are unaffected). JavaFileAssert.assertThat(files.get("PetApi.java")) - .fileContains("@RequestParam(value = \"status\", required = true) List status") + .fileContains("@RequestParam(value = \"status\") List status") .fileContains("@Valid @RequestBody Pet pet") // The scalar "status" form parameter of updatePetWithForm still keeps its (harmless) @Valid, // so the negative assertion must target the container form specifically. - .fileDoesNotContain("@Valid @RequestParam(value = \"status\", required = true) List"); + .fileDoesNotContain("@Valid @RequestParam(value = \"status\") List"); + } + + @Test + public void shouldOmitAnnotationAttributesWithDefaultValues() throws IOException { + Map files = generateFromContract( + "src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing.yaml", SPRING_BOOT); + + JavaFileAssert.assertThat(files.get("PetApi.java")) + .fileContains("@Parameter(name = \"api_key\", in = ParameterIn.HEADER) @RequestHeader(value = \"api_key\", required = false)") + .fileDoesNotContain("description = \"\""); + + JavaFileAssert.assertThat(files.get("FakeApi.java")) + .fileContains( + "@RequestHeader(value = \"required_boolean_group\") Boolean requiredBooleanGroup", + "@RequestParam(value = \"required_string_group\") Integer requiredStringGroup", + "@RequestHeader(value = \"enum_header_string\", required = false, defaultValue = \"-efg\")", + "@RequestPart(value = \"requiredFile\") MultipartFile requiredFile") + .fileDoesNotContain("description = \"\""); } @Test @@ -6390,7 +6408,7 @@ public void givenMultipartForm_whenGenerateUsingOptional_thenParameterAreCreated assertFileContains(Paths.get(outputPath + "/src/main/java/org/openapitools/api/PetApi.java"), // an Optional-wrapped scalar carries no cascade target, so no @Valid (avoids HV000271 on Optional) "@RequestParam(value = \"additionalMetadata\", required = false) Optional additionalMetadata", - "@Valid @RequestParam(value = \"length\", required = true) Integer length"); + "@Valid @RequestParam(value = \"length\") Integer length"); } @Test diff --git a/samples/client/others/go/oneof-not-enum/docs/EnumNullUnion.md b/samples/client/others/go/oneof-not-enum/docs/EnumNullUnion.md index 3dcae4fc7ccd..34b0d3134b3d 100644 --- a/samples/client/others/go/oneof-not-enum/docs/EnumNullUnion.md +++ b/samples/client/others/go/oneof-not-enum/docs/EnumNullUnion.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Kind** | Pointer to **string** | | [optional] +**Kind** | Pointer to **NullableString** | | [optional] ## Methods @@ -50,6 +50,16 @@ SetKind sets Kind field to given value. HasKind returns a boolean if a field has been set. +### SetKindNil + +`func (o *EnumNullUnion) SetKindNil(b bool)` + + SetKindNil sets the value for Kind to be an explicit nil + +### UnsetKind +`func (o *EnumNullUnion) UnsetKind()` + +UnsetKind ensures that no value is present for Kind, not even an explicit nil [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/api/DefaultApi.java b/samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/api/DefaultApi.java index 8c1998ebd3b1..e88e2111aabc 100644 --- a/samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/api/DefaultApi.java +++ b/samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/api/DefaultApi.java @@ -60,8 +60,8 @@ public interface DefaultApi { ) ResponseEntity get( @Parameter(name = "date", description = "A date path parameter", required = true, in = ParameterIn.PATH) @PathVariable("date") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date, - @NotNull @Parameter(name = "dateTime", description = "A date-time query parameter", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "dateTime", required = true, defaultValue = "1973-12-19T03:39:57-08:00") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime, - @NotNull @Parameter(name = "X-Order-Date", description = "A date header parameter", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "X-Order-Date", required = true, defaultValue = "1974-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate xOrderDate, + @NotNull @Parameter(name = "dateTime", description = "A date-time query parameter", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "dateTime", defaultValue = "1973-12-19T03:39:57-08:00") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime, + @NotNull @Parameter(name = "X-Order-Date", description = "A date header parameter", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "X-Order-Date", defaultValue = "1974-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate xOrderDate, @Parameter(name = "loginDate", description = "A date cookie parameter", in = ParameterIn.COOKIE) @CookieValue(name = "loginDate", required = false, defaultValue = "1975-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate loginDate ); diff --git a/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/PetApi.java index 51887bf0c3cc..07e171cd5b42 100644 --- a/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/PetApi.java @@ -40,7 +40,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return Invalid input (status code 405) @@ -48,7 +47,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -70,7 +68,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -79,7 +76,6 @@ ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -94,7 +90,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ); @@ -129,7 +125,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ); @@ -167,7 +163,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ); @@ -211,7 +207,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return Invalid ID supplied (status code 400) @@ -221,7 +216,6 @@ ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid ID supplied"), @@ -245,7 +239,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -255,7 +248,6 @@ ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -279,7 +271,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -289,7 +280,6 @@ ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/StoreApi.java index 0ff000a1ac60..7fab63c10fb6 100644 --- a/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/StoreApi.java @@ -132,7 +132,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -141,7 +140,6 @@ ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/UserApi.java index 5635c271c044..72673fd6af21 100644 --- a/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/UserApi.java @@ -69,7 +69,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -77,7 +76,6 @@ ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -99,7 +97,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -107,7 +104,6 @@ ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -160,7 +156,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -170,7 +165,6 @@ ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -194,7 +188,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -204,7 +197,6 @@ ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -220,22 +212,20 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", deprecated = true, description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) @Deprecated String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", deprecated = true, description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") @Deprecated String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/PetApi.java index 042748d4e043..662c30e99de7 100644 --- a/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/PetApi.java @@ -40,7 +40,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -49,7 +48,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -76,7 +74,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -85,7 +82,6 @@ ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -100,7 +96,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ); @@ -135,7 +131,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ); @@ -173,7 +169,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ); @@ -217,7 +213,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -230,7 +225,6 @@ ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -260,7 +254,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -270,7 +263,6 @@ ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -294,7 +286,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -304,7 +295,6 @@ ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/StoreApi.java index 0ff000a1ac60..7fab63c10fb6 100644 --- a/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/StoreApi.java @@ -132,7 +132,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -141,7 +140,6 @@ ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/UserApi.java index 0f80f6b4a53a..70176ab0e1f2 100644 --- a/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/UserApi.java @@ -69,7 +69,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -77,7 +76,6 @@ ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -99,7 +97,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -107,7 +104,6 @@ ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -160,7 +156,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -170,7 +165,6 @@ ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -194,7 +188,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -204,7 +197,6 @@ ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -220,22 +212,20 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/client/petstore/spring-cloud-tags/src/main/java/org/openapitools/api/PetController.java b/samples/client/petstore/spring-cloud-tags/src/main/java/org/openapitools/api/PetController.java index 60c8d92ab30b..1b3832ba1874 100644 --- a/samples/client/petstore/spring-cloud-tags/src/main/java/org/openapitools/api/PetController.java +++ b/samples/client/petstore/spring-cloud-tags/src/main/java/org/openapitools/api/PetController.java @@ -92,7 +92,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ); @@ -127,7 +127,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status, + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status, @ParameterObject final Pageable pageable ); @@ -166,7 +166,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags, + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags, @ParameterObject final Pageable pageable ); diff --git a/samples/client/petstore/spring-cloud-tags/src/main/java/org/openapitools/api/UserController.java b/samples/client/petstore/spring-cloud-tags/src/main/java/org/openapitools/api/UserController.java index d9091d8add3a..473f9399b8e7 100644 --- a/samples/client/petstore/spring-cloud-tags/src/main/java/org/openapitools/api/UserController.java +++ b/samples/client/petstore/spring-cloud-tags/src/main/java/org/openapitools/api/UserController.java @@ -197,8 +197,8 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ); diff --git a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java index 042748d4e043..662c30e99de7 100644 --- a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java @@ -40,7 +40,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -49,7 +48,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -76,7 +74,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -85,7 +82,6 @@ ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -100,7 +96,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ); @@ -135,7 +131,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ); @@ -173,7 +169,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ); @@ -217,7 +213,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -230,7 +225,6 @@ ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -260,7 +254,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -270,7 +263,6 @@ ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -294,7 +286,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -304,7 +295,6 @@ ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java index 0ff000a1ac60..7fab63c10fb6 100644 --- a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java @@ -132,7 +132,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -141,7 +140,6 @@ ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java index 0f80f6b4a53a..70176ab0e1f2 100644 --- a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java @@ -69,7 +69,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -77,7 +76,6 @@ ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -99,7 +97,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -107,7 +104,6 @@ ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -160,7 +156,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -170,7 +165,6 @@ ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -194,7 +188,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -204,7 +197,6 @@ ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -220,22 +212,20 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/FakeApi.java b/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/FakeApi.java index 6e73da75a378..0926988a43ee 100644 --- a/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/FakeApi.java @@ -183,7 +183,7 @@ ResponseEntity testBodyWithFileSchema( contentType = "application/json" ) ResponseEntity testBodyWithQueryParams( - @NotNull @Valid @RequestParam(value = "query", required = true) String query, + @NotNull @Valid @RequestParam(value = "query") String query, @Valid @RequestBody UserDto userDto ); @@ -236,10 +236,10 @@ ResponseEntity testClientModel( contentType = "application/x-www-form-urlencoded" ) ResponseEntity testEndpointParameters( - @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Valid @RequestParam(value = "byte") byte[] _byte, @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -306,9 +306,9 @@ ResponseEntity testEnumParameters( accept = { "application/json" } ) ResponseEntity testGroupParameters( - @NotNull @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -318,7 +318,6 @@ ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -337,7 +336,6 @@ ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -350,15 +348,14 @@ ResponseEntity testInlineAdditionalProperties( contentType = "application/x-www-form-urlencoded" ) ResponseEntity testJsonFormData( - @Valid @RequestParam(value = "param", required = true) String param, - @Valid @RequestParam(value = "param2", required = true) String param2 + @Valid @RequestParam(value = "param") String param, + @Valid @RequestParam(value = "param2") String param2 ); String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullableDto request body (required) * @return successful operation (status code 200) @@ -391,10 +388,10 @@ ResponseEntity testNullable( accept = { "application/json" } ) ResponseEntity testQueryParameterCollectionFormat( - @NotNull @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @RequestParam(value = "http", required = true) List http, - @NotNull @RequestParam(value = "url", required = true) List url, - @NotNull @RequestParam(value = "context", required = true) List context + @NotNull @RequestParam(value = "pipe") List pipe, + @NotNull @RequestParam(value = "http") List http, + @NotNull @RequestParam(value = "url") List url, + @NotNull @RequestParam(value = "context") List context ); @@ -418,7 +415,6 @@ ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -433,7 +429,7 @@ ResponseEntity testWithResultExample( ) ResponseEntity uploadFileWithRequiredFile( @PathVariable("petId") Long petId, - @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ); diff --git a/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/PetApi.java index 1ab1ec266b59..ea5dd273b09c 100644 --- a/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/PetApi.java @@ -30,7 +30,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -50,7 +49,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -83,7 +81,7 @@ ResponseEntity deletePet( accept = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @RequestParam(value = "status", required = true) List status + @NotNull @RequestParam(value = "status") List status ); @@ -104,7 +102,7 @@ ResponseEntity> findPetsByStatus( accept = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @RequestParam(value = "tags", required = true) Set tags + @NotNull @RequestParam(value = "tags") Set tags ); @@ -131,7 +129,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -153,7 +150,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -176,7 +172,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/StoreApi.java index faa0cc3ec4bd..684ae0e21d06 100644 --- a/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/StoreApi.java @@ -84,7 +84,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param orderDto order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/UserApi.java index 37c4f0165ce1..f98dd7c0be55 100644 --- a/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-http-interface-bean-validation/src/main/java/org/openapitools/api/UserApi.java @@ -47,7 +47,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -66,7 +65,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -104,7 +102,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -124,7 +121,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -137,15 +133,14 @@ ResponseEntity getUserByName( accept = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Valid @RequestParam(value = "username") String username, + @NotNull @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java b/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java index 3cef548dcc27..83dacc0c6769 100644 --- a/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java @@ -188,7 +188,7 @@ void testBodyWithFileSchema( contentType = "application/json" ) void testBodyWithQueryParams( - @RequestParam(value = "query", required = true) String query, + @RequestParam(value = "query") String query, @RequestBody UserDto userDto ); @@ -243,10 +243,10 @@ ClientDto testClientModel( contentType = "application/x-www-form-urlencoded" ) void testEndpointParameters( - @RequestParam(value = "number", required = true) BigDecimal number, - @RequestParam(value = "double", required = true) Double _double, - @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @RequestParam(value = "byte", required = true) byte[] _byte, + @RequestParam(value = "number") BigDecimal number, + @RequestParam(value = "double") Double _double, + @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @RequestParam(value = "byte") byte[] _byte, @RequestParam(value = "integer", required = false) Integer integer, @RequestParam(value = "int32", required = false) Integer int32, @RequestParam(value = "int64", required = false) Long int64, @@ -315,9 +315,9 @@ void testEnumParameters( accept = { "application/json" } ) void testGroupParameters( - @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @RequestParam(value = "required_int64_group") Long requiredInt64Group, @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -327,7 +327,6 @@ void testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -347,7 +346,6 @@ void testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -361,15 +359,14 @@ void testInlineAdditionalProperties( contentType = "application/x-www-form-urlencoded" ) void testJsonFormData( - @RequestParam(value = "param", required = true) String param, - @RequestParam(value = "param2", required = true) String param2 + @RequestParam(value = "param") String param, + @RequestParam(value = "param2") String param2 ); String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullableDto request body (required) * @return successful operation (status code 200) @@ -404,10 +401,10 @@ void testNullable( accept = { "application/json" } ) void testQueryParameterCollectionFormat( - @RequestParam(value = "pipe", required = true) List pipe, - @RequestParam(value = "http", required = true) List http, - @RequestParam(value = "url", required = true) List url, - @RequestParam(value = "context", required = true) List context + @RequestParam(value = "pipe") List pipe, + @RequestParam(value = "http") List http, + @RequestParam(value = "url") List url, + @RequestParam(value = "context") List context ); @@ -432,7 +429,6 @@ Integer testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -448,7 +444,7 @@ Integer testWithResultExample( ) ApiResponseDto uploadFileWithRequiredFile( @PathVariable("petId") Long petId, - @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @RequestPart(value = "requiredFile") MultipartFile requiredFile, @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ); diff --git a/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java index b9280d023616..b3b8b514c257 100644 --- a/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java @@ -27,7 +27,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -48,7 +47,6 @@ void addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -83,7 +81,7 @@ void deletePet( accept = { "application/json", "application/xml" } ) List findPetsByStatus( - @RequestParam(value = "status", required = true) List status + @RequestParam(value = "status") List status ); @@ -105,7 +103,7 @@ List findPetsByStatus( accept = { "application/json", "application/xml" } ) Set findPetsByTags( - @RequestParam(value = "tags", required = true) Set tags + @RequestParam(value = "tags") Set tags ); @@ -133,7 +131,6 @@ PetDto getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -156,7 +153,6 @@ void updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -180,7 +176,6 @@ void updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java index 16e394476f63..3bd0cf28bb0e 100644 --- a/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java @@ -84,7 +84,6 @@ OrderDto getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param orderDto order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java index e14c3fa8669c..3eefef40c24b 100644 --- a/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java @@ -45,7 +45,6 @@ void createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -65,7 +64,6 @@ void createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -105,7 +103,6 @@ void deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -126,7 +123,6 @@ UserDto getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -140,15 +136,14 @@ UserDto getUserByName( accept = { "application/json", "application/xml" } ) String loginUser( - @RequestParam(value = "username", required = true) String username, - @RequestParam(value = "password", required = true) String password + @RequestParam(value = "username") String username, + @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/client/petstore/spring-http-interface-oauth/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-http-interface-oauth/src/main/java/org/openapitools/api/PetApi.java index 5e9906c0ce5c..f19bf4949d0f 100644 --- a/samples/client/petstore/spring-http-interface-oauth/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-http-interface-oauth/src/main/java/org/openapitools/api/PetApi.java @@ -26,7 +26,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/FakeApi.java b/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/FakeApi.java index c96ecd17b026..182da6580c67 100644 --- a/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/FakeApi.java @@ -187,7 +187,7 @@ Mono> testBodyWithFileSchema( contentType = "application/json" ) Mono> testBodyWithQueryParams( - @NotNull @Valid @RequestParam(value = "query", required = true) String query, + @NotNull @Valid @RequestParam(value = "query") String query, @Valid @RequestBody Mono user ); @@ -240,10 +240,10 @@ Mono> testClientModel( contentType = "application/x-www-form-urlencoded" ) Mono> testEndpointParameters( - @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestPart(value = "number", required = true) BigDecimal number, - @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestPart(value = "double", required = true) Double _double, - @Pattern(regexp = "^[A-Z].*") @Valid @RequestPart(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Valid @RequestPart(value = "byte", required = true) byte[] _byte, + @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestPart(value = "number") BigDecimal number, + @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestPart(value = "double") Double _double, + @Pattern(regexp = "^[A-Z].*") @Valid @RequestPart(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Valid @RequestPart(value = "byte") byte[] _byte, @Min(value = 10) @Max(value = 100) @Valid @RequestPart(value = "integer", required = false) Integer integer, @Min(value = 20) @Max(value = 200) @Valid @RequestPart(value = "int32", required = false) Integer int32, @Valid @RequestPart(value = "int64", required = false) Long int64, @@ -310,9 +310,9 @@ Mono> testEnumParameters( accept = { "application/json" } ) Mono> testGroupParameters( - @NotNull @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -322,7 +322,6 @@ Mono> testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -341,7 +340,6 @@ Mono> testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -354,15 +352,14 @@ Mono> testInlineAdditionalProperties( contentType = "application/x-www-form-urlencoded" ) Mono> testJsonFormData( - @Valid @RequestPart(value = "param", required = true) String param, - @Valid @RequestPart(value = "param2", required = true) String param2 + @Valid @RequestPart(value = "param") String param, + @Valid @RequestPart(value = "param2") String param2 ); String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -395,10 +392,10 @@ Mono> testNullable( accept = { "application/json" } ) Mono> testQueryParameterCollectionFormat( - @NotNull @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @RequestParam(value = "http", required = true) List http, - @NotNull @RequestParam(value = "url", required = true) List url, - @NotNull @RequestParam(value = "context", required = true) List context + @NotNull @RequestParam(value = "pipe") List pipe, + @NotNull @RequestParam(value = "http") List http, + @NotNull @RequestParam(value = "url") List url, + @NotNull @RequestParam(value = "context") List context ); @@ -422,7 +419,6 @@ Mono> testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -437,7 +433,7 @@ Mono> testWithResultExample( ) Mono> uploadFileWithRequiredFile( @PathVariable("petId") Long petId, - @RequestPart(value = "requiredFile", required = true) Part requiredFile, + @RequestPart(value = "requiredFile") Part requiredFile, @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata ); diff --git a/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/PetApi.java index 05be1b2127b9..4f602fedeceb 100644 --- a/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/PetApi.java @@ -34,7 +34,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -54,7 +53,6 @@ Mono> addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -87,7 +85,7 @@ Mono> deletePet( accept = { "application/json", "application/xml" } ) Mono>> findPetsByStatus( - @NotNull @RequestParam(value = "status", required = true) List status + @NotNull @RequestParam(value = "status") List status ); @@ -108,7 +106,7 @@ Mono>> findPetsByStatus( accept = { "application/json", "application/xml" } ) Mono>> findPetsByTags( - @NotNull @RequestParam(value = "tags", required = true) Set tags + @NotNull @RequestParam(value = "tags") Set tags ); @@ -135,7 +133,6 @@ Mono> getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -157,7 +154,6 @@ Mono> updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -180,7 +176,6 @@ Mono> updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/StoreApi.java index 81632328b596..12ab536757d5 100644 --- a/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/StoreApi.java @@ -88,7 +88,6 @@ Mono> getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/UserApi.java index bc509682647c..efadc64dfc8b 100644 --- a/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-http-interface-reactive-bean-validation/src/main/java/org/openapitools/api/UserApi.java @@ -51,7 +51,6 @@ Mono> createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -70,7 +69,6 @@ Mono> createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -108,7 +106,6 @@ Mono> deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -128,7 +125,6 @@ Mono> getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -141,15 +137,14 @@ Mono> getUserByName( accept = { "application/json", "application/xml" } ) Mono> loginUser( - @NotNull @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Valid @RequestParam(value = "username") String username, + @NotNull @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java b/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java index b467f726e9d9..97532ba32aea 100644 --- a/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java @@ -172,7 +172,7 @@ Mono testBodyWithFileSchema( contentType = "application/json" ) Mono testBodyWithQueryParams( - @RequestParam(value = "query", required = true) String query, + @RequestParam(value = "query") String query, @RequestBody Mono user ); @@ -227,10 +227,10 @@ Mono testClientModel( contentType = "application/x-www-form-urlencoded" ) Mono testEndpointParameters( - @RequestPart(value = "number", required = true) BigDecimal number, - @RequestPart(value = "double", required = true) Double _double, - @RequestPart(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @RequestPart(value = "byte", required = true) byte[] _byte, + @RequestPart(value = "number") BigDecimal number, + @RequestPart(value = "double") Double _double, + @RequestPart(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @RequestPart(value = "byte") byte[] _byte, @RequestPart(value = "integer", required = false) Integer integer, @RequestPart(value = "int32", required = false) Integer int32, @RequestPart(value = "int64", required = false) Long int64, @@ -299,9 +299,9 @@ Mono testEnumParameters( accept = { "application/json" } ) Mono testGroupParameters( - @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @RequestParam(value = "required_int64_group") Long requiredInt64Group, @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -311,7 +311,6 @@ Mono testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -331,7 +330,6 @@ Mono testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -345,15 +343,14 @@ Mono testInlineAdditionalProperties( contentType = "application/x-www-form-urlencoded" ) Mono testJsonFormData( - @RequestPart(value = "param", required = true) String param, - @RequestPart(value = "param2", required = true) String param2 + @RequestPart(value = "param") String param, + @RequestPart(value = "param2") String param2 ); String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -388,10 +385,10 @@ Mono testNullable( accept = { "application/json" } ) Mono testQueryParameterCollectionFormat( - @RequestParam(value = "pipe", required = true) List pipe, - @RequestParam(value = "http", required = true) List http, - @RequestParam(value = "url", required = true) List url, - @RequestParam(value = "context", required = true) List context + @RequestParam(value = "pipe") List pipe, + @RequestParam(value = "http") List http, + @RequestParam(value = "url") List url, + @RequestParam(value = "context") List context ); diff --git a/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java index 75fec8644b46..cabff7222079 100644 --- a/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java @@ -32,7 +32,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -53,7 +52,6 @@ Mono addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -88,7 +86,7 @@ Mono deletePet( accept = { "application/json", "application/xml" } ) Flux findPetsByStatus( - @RequestParam(value = "status", required = true) List status + @RequestParam(value = "status") List status ); @@ -110,7 +108,7 @@ Flux findPetsByStatus( accept = { "application/json", "application/xml" } ) Flux findPetsByTags( - @RequestParam(value = "tags", required = true) Set tags + @RequestParam(value = "tags") Set tags ); @@ -156,7 +154,6 @@ Mono responseObjectDifferentNames( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -179,7 +176,6 @@ Mono updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -203,7 +199,6 @@ Mono updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -227,7 +222,6 @@ Mono uploadFile( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -243,7 +237,7 @@ Mono uploadFile( ) Mono uploadFileWithRequiredFile( @PathVariable("petId") Long petId, - @RequestPart(value = "requiredFile", required = true) Part requiredFile, + @RequestPart(value = "requiredFile") Part requiredFile, @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata ); diff --git a/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java index 895947109cd9..b146aa44c3f9 100644 --- a/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java @@ -88,7 +88,6 @@ Mono getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java index cae5e26735c3..b44318857387 100644 --- a/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java @@ -49,7 +49,6 @@ Mono createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -69,7 +68,6 @@ Mono createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -109,7 +107,6 @@ Mono deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -130,7 +127,6 @@ Mono getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -144,15 +140,14 @@ Mono getUserByName( accept = { "application/json", "application/xml" } ) Mono loginUser( - @RequestParam(value = "username", required = true) String username, - @RequestParam(value = "password", required = true) String password + @RequestParam(value = "username") String username, + @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/FakeApi.java b/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/FakeApi.java index 3c7c45ec49cc..47ce18a2e020 100644 --- a/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/FakeApi.java @@ -165,7 +165,7 @@ Mono> testBodyWithFileSchema( contentType = "application/json" ) Mono> testBodyWithQueryParams( - @RequestParam(value = "query", required = true) String query, + @RequestParam(value = "query") String query, @RequestBody Mono user ); @@ -218,10 +218,10 @@ Mono> testClientModel( contentType = "application/x-www-form-urlencoded" ) Mono> testEndpointParameters( - @RequestPart(value = "number", required = true) BigDecimal number, - @RequestPart(value = "double", required = true) Double _double, - @RequestPart(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @RequestPart(value = "byte", required = true) byte[] _byte, + @RequestPart(value = "number") BigDecimal number, + @RequestPart(value = "double") Double _double, + @RequestPart(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @RequestPart(value = "byte") byte[] _byte, @RequestPart(value = "integer", required = false) Integer integer, @RequestPart(value = "int32", required = false) Integer int32, @RequestPart(value = "int64", required = false) Long int64, @@ -288,9 +288,9 @@ Mono> testEnumParameters( accept = { "application/json" } ) Mono> testGroupParameters( - @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @RequestParam(value = "required_int64_group") Long requiredInt64Group, @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -300,7 +300,6 @@ Mono> testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -319,7 +318,6 @@ Mono> testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -332,15 +330,14 @@ Mono> testInlineAdditionalProperties( contentType = "application/x-www-form-urlencoded" ) Mono> testJsonFormData( - @RequestPart(value = "param", required = true) String param, - @RequestPart(value = "param2", required = true) String param2 + @RequestPart(value = "param") String param, + @RequestPart(value = "param2") String param2 ); String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -373,10 +370,10 @@ Mono> testNullable( accept = { "application/json" } ) Mono> testQueryParameterCollectionFormat( - @RequestParam(value = "pipe", required = true) List pipe, - @RequestParam(value = "http", required = true) List http, - @RequestParam(value = "url", required = true) List url, - @RequestParam(value = "context", required = true) List context + @RequestParam(value = "pipe") List pipe, + @RequestParam(value = "http") List http, + @RequestParam(value = "url") List url, + @RequestParam(value = "context") List context ); diff --git a/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/PetApi.java index 103fd5621774..47e8ada44071 100644 --- a/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/PetApi.java @@ -32,7 +32,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -52,7 +51,6 @@ Mono> addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -85,7 +83,7 @@ Mono> deletePet( accept = { "application/json", "application/xml" } ) Mono>> findPetsByStatus( - @RequestParam(value = "status", required = true) List status + @RequestParam(value = "status") List status ); @@ -106,7 +104,7 @@ Mono>> findPetsByStatus( accept = { "application/json", "application/xml" } ) Mono>> findPetsByTags( - @RequestParam(value = "tags", required = true) Set tags + @RequestParam(value = "tags") Set tags ); @@ -150,7 +148,6 @@ Mono> responseObjectDiffer String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -172,7 +169,6 @@ Mono> updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -195,7 +191,6 @@ Mono> updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -218,7 +213,6 @@ Mono> uploadFile( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -233,7 +227,7 @@ Mono> uploadFile( ) Mono> uploadFileWithRequiredFile( @PathVariable("petId") Long petId, - @RequestPart(value = "requiredFile", required = true) Part requiredFile, + @RequestPart(value = "requiredFile") Part requiredFile, @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata ); diff --git a/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/StoreApi.java index 6589e8bcd8e9..2b9e0d5ddf0e 100644 --- a/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/StoreApi.java @@ -85,7 +85,6 @@ Mono> getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/UserApi.java index b36bdcc377d0..46fd93a3f566 100644 --- a/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/api/UserApi.java @@ -48,7 +48,6 @@ Mono> createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -67,7 +66,6 @@ Mono> createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -105,7 +103,6 @@ Mono> deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -125,7 +122,6 @@ Mono> getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -138,15 +134,14 @@ Mono> getUserByName( accept = { "application/json", "application/xml" } ) Mono> loginUser( - @RequestParam(value = "username", required = true) String username, - @RequestParam(value = "password", required = true) String password + @RequestParam(value = "username") String username, + @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/FakeApi.java b/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/FakeApi.java index 6e73da75a378..0926988a43ee 100644 --- a/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/FakeApi.java @@ -183,7 +183,7 @@ ResponseEntity testBodyWithFileSchema( contentType = "application/json" ) ResponseEntity testBodyWithQueryParams( - @NotNull @Valid @RequestParam(value = "query", required = true) String query, + @NotNull @Valid @RequestParam(value = "query") String query, @Valid @RequestBody UserDto userDto ); @@ -236,10 +236,10 @@ ResponseEntity testClientModel( contentType = "application/x-www-form-urlencoded" ) ResponseEntity testEndpointParameters( - @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Valid @RequestParam(value = "byte") byte[] _byte, @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -306,9 +306,9 @@ ResponseEntity testEnumParameters( accept = { "application/json" } ) ResponseEntity testGroupParameters( - @NotNull @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -318,7 +318,6 @@ ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -337,7 +336,6 @@ ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -350,15 +348,14 @@ ResponseEntity testInlineAdditionalProperties( contentType = "application/x-www-form-urlencoded" ) ResponseEntity testJsonFormData( - @Valid @RequestParam(value = "param", required = true) String param, - @Valid @RequestParam(value = "param2", required = true) String param2 + @Valid @RequestParam(value = "param") String param, + @Valid @RequestParam(value = "param2") String param2 ); String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullableDto request body (required) * @return successful operation (status code 200) @@ -391,10 +388,10 @@ ResponseEntity testNullable( accept = { "application/json" } ) ResponseEntity testQueryParameterCollectionFormat( - @NotNull @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @RequestParam(value = "http", required = true) List http, - @NotNull @RequestParam(value = "url", required = true) List url, - @NotNull @RequestParam(value = "context", required = true) List context + @NotNull @RequestParam(value = "pipe") List pipe, + @NotNull @RequestParam(value = "http") List http, + @NotNull @RequestParam(value = "url") List url, + @NotNull @RequestParam(value = "context") List context ); @@ -418,7 +415,6 @@ ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -433,7 +429,7 @@ ResponseEntity testWithResultExample( ) ResponseEntity uploadFileWithRequiredFile( @PathVariable("petId") Long petId, - @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ); diff --git a/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/PetApi.java index 1ab1ec266b59..ea5dd273b09c 100644 --- a/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/PetApi.java @@ -30,7 +30,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -50,7 +49,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -83,7 +81,7 @@ ResponseEntity deletePet( accept = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @RequestParam(value = "status", required = true) List status + @NotNull @RequestParam(value = "status") List status ); @@ -104,7 +102,7 @@ ResponseEntity> findPetsByStatus( accept = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @RequestParam(value = "tags", required = true) Set tags + @NotNull @RequestParam(value = "tags") Set tags ); @@ -131,7 +129,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -153,7 +150,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -176,7 +172,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/StoreApi.java index faa0cc3ec4bd..684ae0e21d06 100644 --- a/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/StoreApi.java @@ -84,7 +84,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param orderDto order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/UserApi.java index 37c4f0165ce1..f98dd7c0be55 100644 --- a/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-http-interface-springboot-4/src/main/java/org/openapitools/api/UserApi.java @@ -47,7 +47,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -66,7 +65,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -104,7 +102,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -124,7 +121,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -137,15 +133,14 @@ ResponseEntity getUserByName( accept = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Valid @RequestParam(value = "username") String username, + @NotNull @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/FakeApi.java b/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/FakeApi.java index 316ff91cb2a3..85c67b416638 100644 --- a/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/FakeApi.java @@ -164,7 +164,7 @@ ResponseEntity testBodyWithFileSchema( contentType = "application/json" ) ResponseEntity testBodyWithQueryParams( - @NotNull @Valid @RequestParam(value = "query", required = true) String query, + @NotNull @Valid @RequestParam(value = "query") String query, @Valid @RequestBody User user ); @@ -217,10 +217,10 @@ ResponseEntity testClientModel( contentType = "application/x-www-form-urlencoded" ) ResponseEntity testEndpointParameters( - @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Valid @RequestParam(value = "byte") byte[] _byte, @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -287,9 +287,9 @@ ResponseEntity testEnumParameters( accept = { "application/json" } ) ResponseEntity testGroupParameters( - @NotNull @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -299,7 +299,6 @@ ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -318,7 +317,6 @@ ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -331,15 +329,14 @@ ResponseEntity testInlineAdditionalProperties( contentType = "application/x-www-form-urlencoded" ) ResponseEntity testJsonFormData( - @Valid @RequestParam(value = "param", required = true) String param, - @Valid @RequestParam(value = "param2", required = true) String param2 + @Valid @RequestParam(value = "param") String param, + @Valid @RequestParam(value = "param2") String param2 ); String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -372,10 +369,10 @@ ResponseEntity testNullable( accept = { "application/json" } ) ResponseEntity testQueryParameterCollectionFormat( - @NotNull @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @RequestParam(value = "http", required = true) List http, - @NotNull @RequestParam(value = "url", required = true) List url, - @NotNull @RequestParam(value = "context", required = true) List context + @NotNull @RequestParam(value = "pipe") List pipe, + @NotNull @RequestParam(value = "http") List http, + @NotNull @RequestParam(value = "url") List url, + @NotNull @RequestParam(value = "context") List context ); diff --git a/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/PetApi.java index ab40a0bbf89d..e224aebc45af 100644 --- a/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/PetApi.java @@ -31,7 +31,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -51,7 +50,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -84,7 +82,7 @@ ResponseEntity deletePet( accept = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @RequestParam(value = "status", required = true) List status + @NotNull @RequestParam(value = "status") List status ); @@ -105,7 +103,7 @@ ResponseEntity> findPetsByStatus( accept = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @RequestParam(value = "tags", required = true) Set tags + @NotNull @RequestParam(value = "tags") Set tags ); @@ -149,7 +147,6 @@ ResponseEntity responseObjectDifferentNam String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -171,7 +168,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -194,7 +190,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -217,7 +212,6 @@ ResponseEntity uploadFile( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -232,7 +226,7 @@ ResponseEntity uploadFile( ) ResponseEntity uploadFileWithRequiredFile( @PathVariable("petId") Long petId, - @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ); diff --git a/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/StoreApi.java index be4342743427..5ef55b267fa0 100644 --- a/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/StoreApi.java @@ -84,7 +84,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/UserApi.java index 6697db376e14..574bd0466538 100644 --- a/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-http-interface-useHttpServiceProxyFactoryInterfacesConfigurator/src/main/java/org/openapitools/api/UserApi.java @@ -47,7 +47,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -66,7 +65,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -104,7 +102,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -124,7 +121,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -137,15 +133,14 @@ ResponseEntity getUserByName( accept = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Valid @RequestParam(value = "username") String username, + @NotNull @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/FakeApi.java b/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/FakeApi.java index 836a70922310..ac39fb686337 100644 --- a/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/FakeApi.java @@ -161,7 +161,7 @@ ResponseEntity testBodyWithFileSchema( contentType = "application/json" ) ResponseEntity testBodyWithQueryParams( - @RequestParam(value = "query", required = true) String query, + @RequestParam(value = "query") String query, @RequestBody UserDto userDto ); @@ -214,10 +214,10 @@ ResponseEntity testClientModel( contentType = "application/x-www-form-urlencoded" ) ResponseEntity testEndpointParameters( - @RequestParam(value = "number", required = true) BigDecimal number, - @RequestParam(value = "double", required = true) Double _double, - @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @RequestParam(value = "byte", required = true) byte[] _byte, + @RequestParam(value = "number") BigDecimal number, + @RequestParam(value = "double") Double _double, + @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @RequestParam(value = "byte") byte[] _byte, @RequestParam(value = "integer", required = false) Integer integer, @RequestParam(value = "int32", required = false) Integer int32, @RequestParam(value = "int64", required = false) Long int64, @@ -284,9 +284,9 @@ ResponseEntity testEnumParameters( accept = { "application/json" } ) ResponseEntity testGroupParameters( - @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @RequestParam(value = "required_int64_group") Long requiredInt64Group, @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -296,7 +296,6 @@ ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -315,7 +314,6 @@ ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -328,15 +326,14 @@ ResponseEntity testInlineAdditionalProperties( contentType = "application/x-www-form-urlencoded" ) ResponseEntity testJsonFormData( - @RequestParam(value = "param", required = true) String param, - @RequestParam(value = "param2", required = true) String param2 + @RequestParam(value = "param") String param, + @RequestParam(value = "param2") String param2 ); String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullableDto request body (required) * @return successful operation (status code 200) @@ -369,10 +366,10 @@ ResponseEntity testNullable( accept = { "application/json" } ) ResponseEntity testQueryParameterCollectionFormat( - @RequestParam(value = "pipe", required = true) List pipe, - @RequestParam(value = "http", required = true) List http, - @RequestParam(value = "url", required = true) List url, - @RequestParam(value = "context", required = true) List context + @RequestParam(value = "pipe") List pipe, + @RequestParam(value = "http") List http, + @RequestParam(value = "url") List url, + @RequestParam(value = "context") List context ); diff --git a/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/PetApi.java index 6161dc1c61af..cff0a12cbb8f 100644 --- a/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/PetApi.java @@ -28,7 +28,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -48,7 +47,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -81,7 +79,7 @@ ResponseEntity deletePet( accept = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @RequestParam(value = "status", required = true) List status + @RequestParam(value = "status") List status ); @@ -102,7 +100,7 @@ ResponseEntity> findPetsByStatus( accept = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @RequestParam(value = "tags", required = true) Set tags + @RequestParam(value = "tags") Set tags ); @@ -146,7 +144,6 @@ ResponseEntity responseObjectDifferent String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -168,7 +165,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -191,7 +187,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -214,7 +209,6 @@ ResponseEntity uploadFile( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -229,7 +223,7 @@ ResponseEntity uploadFile( ) ResponseEntity uploadFileWithRequiredFile( @PathVariable("petId") Long petId, - @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @RequestPart(value = "requiredFile") MultipartFile requiredFile, @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ); diff --git a/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/StoreApi.java index 7f036396ba67..95fa84b1b15a 100644 --- a/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/StoreApi.java @@ -81,7 +81,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param orderDto order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/UserApi.java index 2eb819ee0206..cd8a75734ee0 100644 --- a/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/api/UserApi.java @@ -44,7 +44,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -63,7 +62,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -101,7 +99,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -121,7 +118,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -134,15 +130,14 @@ ResponseEntity getUserByName( accept = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @RequestParam(value = "username", required = true) String username, - @RequestParam(value = "password", required = true) String password + @RequestParam(value = "username") String username, + @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/PetApi.java index fa34b5363180..cd1ffc7b9499 100644 --- a/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/PetApi.java @@ -27,7 +27,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -47,7 +46,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -78,7 +76,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @RequestParam(value = "status") @Deprecated List status ); @@ -99,7 +97,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @RequestParam(value = "tags", required = true) List tags + @NotNull @RequestParam(value = "tags") List tags ); @@ -126,7 +124,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -150,7 +147,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -172,7 +168,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/StoreApi.java index 107bfbf06337..f3d6e07cba48 100644 --- a/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/StoreApi.java @@ -81,7 +81,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/UserApi.java index ce4fbccf28b6..da861fbd5cfa 100644 --- a/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-3-with-optional/src/main/java/org/openapitools/api/UserApi.java @@ -44,7 +44,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -62,7 +61,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -98,7 +96,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -118,7 +115,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -131,15 +127,14 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Valid @RequestParam(value = "username") String username, + @NotNull @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/PetApi.java index 042748d4e043..662c30e99de7 100644 --- a/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/PetApi.java @@ -40,7 +40,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -49,7 +48,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -76,7 +74,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -85,7 +82,6 @@ ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -100,7 +96,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ); @@ -135,7 +131,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ); @@ -173,7 +169,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ); @@ -217,7 +213,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -230,7 +225,6 @@ ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -260,7 +254,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -270,7 +263,6 @@ ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -294,7 +286,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -304,7 +295,6 @@ ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/StoreApi.java index 0ff000a1ac60..7fab63c10fb6 100644 --- a/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/StoreApi.java @@ -132,7 +132,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -141,7 +140,6 @@ ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/UserApi.java index 0f80f6b4a53a..70176ab0e1f2 100644 --- a/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/UserApi.java @@ -69,7 +69,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -77,7 +76,6 @@ ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -99,7 +97,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -107,7 +104,6 @@ ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -160,7 +156,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -170,7 +165,6 @@ ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -194,7 +188,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -204,7 +197,6 @@ ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -220,22 +212,20 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/PetApi.java index fa34b5363180..cd1ffc7b9499 100644 --- a/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/PetApi.java @@ -27,7 +27,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -47,7 +46,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -78,7 +76,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @RequestParam(value = "status") @Deprecated List status ); @@ -99,7 +97,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @RequestParam(value = "tags", required = true) List tags + @NotNull @RequestParam(value = "tags") List tags ); @@ -126,7 +124,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -150,7 +147,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -172,7 +168,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/StoreApi.java index 107bfbf06337..f3d6e07cba48 100644 --- a/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/StoreApi.java @@ -81,7 +81,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/UserApi.java index ce4fbccf28b6..da861fbd5cfa 100644 --- a/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-4-with-optional/src/main/java/org/openapitools/api/UserApi.java @@ -44,7 +44,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -62,7 +61,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -98,7 +96,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -118,7 +115,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -131,15 +127,14 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Valid @RequestParam(value = "username") String username, + @NotNull @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/PetApi.java index 6b256be68acf..34d023380403 100644 --- a/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/PetApi.java @@ -41,7 +41,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -50,7 +49,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -77,7 +75,6 @@ CompletableFuture> addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -86,7 +83,6 @@ CompletableFuture> addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -101,7 +97,7 @@ CompletableFuture> addPet( ) CompletableFuture> deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ); @@ -136,7 +132,7 @@ CompletableFuture> deletePet( produces = { "application/json", "application/xml" } ) CompletableFuture>> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ); @@ -174,7 +170,7 @@ CompletableFuture>> findPetsByStatus( produces = { "application/json", "application/xml" } ) CompletableFuture>> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ); @@ -218,7 +214,6 @@ CompletableFuture> getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -231,7 +226,6 @@ CompletableFuture> getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -261,7 +255,6 @@ CompletableFuture> updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -271,7 +264,6 @@ CompletableFuture> updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -295,7 +287,6 @@ CompletableFuture> updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -305,7 +296,6 @@ CompletableFuture> updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/StoreApi.java index 8cdd7c8340d0..317d1d7e3a14 100644 --- a/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/StoreApi.java @@ -133,7 +133,6 @@ CompletableFuture> getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -142,7 +141,6 @@ CompletableFuture> getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/UserApi.java index 4d86973eaa61..8ceadf519968 100644 --- a/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/UserApi.java @@ -70,7 +70,6 @@ CompletableFuture> createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -78,7 +77,6 @@ CompletableFuture> createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -100,7 +98,6 @@ CompletableFuture> createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -108,7 +105,6 @@ CompletableFuture> createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -161,7 +157,6 @@ CompletableFuture> deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -171,7 +166,6 @@ CompletableFuture> deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -195,7 +189,6 @@ CompletableFuture> getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -205,7 +198,6 @@ CompletableFuture> getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -221,22 +213,20 @@ CompletableFuture> getUserByName( produces = { "application/json", "application/xml" } ) CompletableFuture> loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/api/DefaultApi.java b/samples/openapi3/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/api/DefaultApi.java index 8c1998ebd3b1..e88e2111aabc 100644 --- a/samples/openapi3/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/api/DefaultApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/api/DefaultApi.java @@ -60,8 +60,8 @@ public interface DefaultApi { ) ResponseEntity get( @Parameter(name = "date", description = "A date path parameter", required = true, in = ParameterIn.PATH) @PathVariable("date") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date, - @NotNull @Parameter(name = "dateTime", description = "A date-time query parameter", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "dateTime", required = true, defaultValue = "1973-12-19T03:39:57-08:00") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime, - @NotNull @Parameter(name = "X-Order-Date", description = "A date header parameter", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "X-Order-Date", required = true, defaultValue = "1974-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate xOrderDate, + @NotNull @Parameter(name = "dateTime", description = "A date-time query parameter", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "dateTime", defaultValue = "1973-12-19T03:39:57-08:00") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime, + @NotNull @Parameter(name = "X-Order-Date", description = "A date header parameter", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "X-Order-Date", defaultValue = "1974-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate xOrderDate, @Parameter(name = "loginDate", description = "A date cookie parameter", in = ParameterIn.COOKIE) @CookieValue(name = "loginDate", required = false, defaultValue = "1975-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate loginDate ); diff --git a/samples/openapi3/client/petstore/spring-cloud-http-basic/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-cloud-http-basic/src/main/java/org/openapitools/api/PetApi.java index a78b50ecb5da..a901bb8fc2ad 100644 --- a/samples/openapi3/client/petstore/spring-cloud-http-basic/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-http-basic/src/main/java/org/openapitools/api/PetApi.java @@ -38,7 +38,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -47,7 +46,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/FakeApi.java b/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/FakeApi.java index da305c464065..a9bffcb91153 100644 --- a/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/FakeApi.java @@ -211,7 +211,7 @@ ResponseEntity fakeOuterStringSerialize( consumes = "application/json" ) ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ); @@ -236,8 +236,8 @@ ResponseEntity testBodyWithFileSchema( consumes = "application/json" ) ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ); @@ -312,10 +312,10 @@ ResponseEntity testClientModel( consumes = "application/x-www-form-urlencoded" ) ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -399,9 +399,9 @@ ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -411,7 +411,6 @@ ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -419,7 +418,6 @@ ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -438,7 +436,6 @@ ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -447,7 +444,6 @@ ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -459,15 +455,14 @@ ResponseEntity testInlineAdditionalProperties( consumes = "application/x-www-form-urlencoded" ) ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ); String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -475,7 +470,6 @@ ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -515,10 +509,10 @@ ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ); diff --git a/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/PetApi.java index aa796c85cde8..3039d80eeef9 100644 --- a/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/PetApi.java @@ -42,7 +42,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -51,7 +50,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -74,7 +72,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -84,7 +81,6 @@ ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -100,7 +96,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ); @@ -135,7 +131,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ); @@ -173,7 +169,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ); @@ -243,7 +239,6 @@ ResponseEntity responseObjectDifferentNam String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -254,7 +249,6 @@ ResponseEntity responseObjectDifferentNam @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -279,7 +273,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -289,7 +282,6 @@ ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -313,7 +305,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -323,7 +314,6 @@ ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -350,7 +340,6 @@ ResponseEntity uploadFile( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -360,7 +349,6 @@ ResponseEntity uploadFile( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -379,7 +367,7 @@ ResponseEntity uploadFile( ) ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ); diff --git a/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/StoreApi.java index 99d5abd32a85..1cc0ff71f19b 100644 --- a/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/StoreApi.java @@ -132,7 +132,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -141,7 +140,6 @@ ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/UserApi.java index 9f597430d019..cc476752af19 100644 --- a/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/UserApi.java @@ -66,7 +66,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -74,7 +73,6 @@ ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -93,7 +91,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -101,7 +98,6 @@ ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -148,7 +144,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -158,7 +153,6 @@ ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -182,7 +176,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -192,7 +185,6 @@ ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -208,22 +200,20 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/PetApi.java index cee0cb92ac5a..970712860492 100644 --- a/samples/openapi3/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/PetApi.java @@ -95,7 +95,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ); @@ -132,7 +132,7 @@ ResponseEntity deletePet( @org.springframework.validation.annotation.Validated @org.springframework.security.access.prepost.PreAuthorize("hasRole('ADMIN')") ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status, + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status, @ParameterObject final Pageable pageable ); @@ -172,7 +172,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags, + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags, @Parameter(name = "size", description = "A test HeaderParam for issue #8315 - must NOT be removed when x-spring-paginated:true is used.", in = ParameterIn.HEADER) @RequestHeader(value = "size", required = false) @Nullable String size, @PageableDefault(page = 0, size = 20) @SortDefault.SortDefaults({@SortDefault(sort = {"id"}, direction = Sort.Direction.ASC)}) @ParameterObject final Pageable pageable ); diff --git a/samples/openapi3/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/UserApi.java index 5db9dc331df5..8bd6da25c98b 100644 --- a/samples/openapi3/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/UserApi.java @@ -197,8 +197,8 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ); diff --git a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java index 042748d4e043..662c30e99de7 100644 --- a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java @@ -40,7 +40,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -49,7 +48,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -76,7 +74,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -85,7 +82,6 @@ ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -100,7 +96,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ); @@ -135,7 +131,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ); @@ -173,7 +169,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ); @@ -217,7 +213,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -230,7 +225,6 @@ ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -260,7 +254,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -270,7 +263,6 @@ ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -294,7 +286,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -304,7 +295,6 @@ ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java index 0ff000a1ac60..7fab63c10fb6 100644 --- a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java @@ -132,7 +132,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -141,7 +140,6 @@ ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java index 0f80f6b4a53a..70176ab0e1f2 100644 --- a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java @@ -69,7 +69,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -77,7 +76,6 @@ ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -99,7 +97,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -107,7 +104,6 @@ ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -160,7 +156,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -170,7 +165,6 @@ ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -194,7 +188,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -204,7 +197,6 @@ ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -220,22 +212,20 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ); String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/PetApi.java index e7092e632ffa..4f41431be54a 100644 --- a/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/PetApi.java @@ -40,7 +40,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -49,7 +48,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -76,7 +74,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -85,7 +82,6 @@ ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -100,7 +96,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) throws Exception; @@ -135,7 +131,7 @@ ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) throws Exception; @@ -173,7 +169,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) throws Exception; @@ -217,7 +213,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -230,7 +225,6 @@ ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -260,7 +254,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -270,7 +263,6 @@ ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -294,7 +286,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -304,7 +295,6 @@ ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/StoreApi.java index e706451b695e..67cfb2c1408f 100644 --- a/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/StoreApi.java @@ -132,7 +132,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -141,7 +140,6 @@ ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/UserApi.java index 6bdbf9ebae39..70b1aba4f117 100644 --- a/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/UserApi.java @@ -69,7 +69,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -77,7 +76,6 @@ ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -99,7 +97,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -107,7 +104,6 @@ ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -160,7 +156,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -170,7 +165,6 @@ ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -194,7 +188,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -204,7 +197,6 @@ ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -220,22 +212,20 @@ ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) throws Exception; String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/PetApi.java index 09ff78a3e315..931f17ec89f5 100644 --- a/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/PetApi.java @@ -47,7 +47,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -56,7 +55,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -100,7 +98,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -109,7 +106,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -124,7 +120,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -162,7 +158,7 @@ default ResponseEntity deletePet( produces = { "application/json", "application/xml" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -217,7 +213,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/json", "application/xml" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -295,7 +291,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -308,7 +303,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -355,7 +349,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -365,7 +358,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -392,7 +384,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -402,7 +393,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/StoreApi.java index 6ad955b8a608..43ec575f5440 100644 --- a/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/UserApi.java index d2bf96db574b..5eab69a9d71b 100644 --- a/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/UserApi.java @@ -79,7 +79,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -87,7 +86,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -112,7 +110,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -120,7 +117,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -179,7 +175,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -189,7 +184,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -230,7 +224,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -240,7 +233,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -256,8 +248,8 @@ default ResponseEntity getUserByName( produces = { "application/json", "application/xml" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -267,14 +259,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/server/petstore/spring-boot-oneof-interface/src/main/java/org/openapitools/api/BarApi.java b/samples/openapi3/server/petstore/spring-boot-oneof-interface/src/main/java/org/openapitools/api/BarApi.java index a12589e326f7..a83f07b6c88f 100644 --- a/samples/openapi3/server/petstore/spring-boot-oneof-interface/src/main/java/org/openapitools/api/BarApi.java +++ b/samples/openapi3/server/petstore/spring-boot-oneof-interface/src/main/java/org/openapitools/api/BarApi.java @@ -67,7 +67,7 @@ default Optional getRequest() { consumes = { "application/json" } ) default ResponseEntity createBar( - @Parameter(name = "BarCreate", description = "", required = true) @Valid @RequestBody BarCreate barCreate + @Parameter(name = "BarCreate", required = true) @Valid @RequestBody BarCreate barCreate ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/AnimalsApi.java b/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/AnimalsApi.java index 91bd3ae57729..8f0c5f06bd6b 100644 --- a/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/AnimalsApi.java +++ b/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/AnimalsApi.java @@ -65,7 +65,7 @@ default Optional getRequest() { consumes = { "application/json" } ) default ResponseEntity createAnimal( - @Parameter(name = "Animal", description = "", required = true) @Valid @RequestBody Animal animal + @Parameter(name = "Animal", required = true) @Valid @RequestBody Animal animal ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/BeveragesApi.java b/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/BeveragesApi.java index faa5d51e30e1..9562616fc7c2 100644 --- a/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/BeveragesApi.java +++ b/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/BeveragesApi.java @@ -65,7 +65,7 @@ default Optional getRequest() { consumes = { "application/json" } ) default ResponseEntity createBeverage( - @Parameter(name = "Beverage", description = "", required = true) @Valid @RequestBody Beverage beverage + @Parameter(name = "Beverage", required = true) @Valid @RequestBody Beverage beverage ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/FruitsApi.java b/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/FruitsApi.java index ca8755adadc2..2a235fea9392 100644 --- a/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/FruitsApi.java +++ b/samples/openapi3/server/petstore/spring-boot-oneof-jackson-default-impl/src/main/java/org/openapitools/api/FruitsApi.java @@ -65,7 +65,7 @@ default Optional getRequest() { consumes = { "application/json" } ) default ResponseEntity createFruit( - @Parameter(name = "Fruit", description = "", required = true) @Valid @RequestBody Fruit fruit + @Parameter(name = "Fruit", required = true) @Valid @RequestBody Fruit fruit ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/spring-boot-oneof-sealed/src/main/java/org/openapitools/api/BarApi.java b/samples/openapi3/server/petstore/spring-boot-oneof-sealed/src/main/java/org/openapitools/api/BarApi.java index a12589e326f7..a83f07b6c88f 100644 --- a/samples/openapi3/server/petstore/spring-boot-oneof-sealed/src/main/java/org/openapitools/api/BarApi.java +++ b/samples/openapi3/server/petstore/spring-boot-oneof-sealed/src/main/java/org/openapitools/api/BarApi.java @@ -67,7 +67,7 @@ default Optional getRequest() { consumes = { "application/json" } ) default ResponseEntity createBar( - @Parameter(name = "BarCreate", description = "", required = true) @Valid @RequestBody BarCreate barCreate + @Parameter(name = "BarCreate", required = true) @Valid @RequestBody BarCreate barCreate ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/spring-boot-oneof/src/main/java/org/openapitools/api/BarApi.java b/samples/openapi3/server/petstore/spring-boot-oneof/src/main/java/org/openapitools/api/BarApi.java index a12589e326f7..a83f07b6c88f 100644 --- a/samples/openapi3/server/petstore/spring-boot-oneof/src/main/java/org/openapitools/api/BarApi.java +++ b/samples/openapi3/server/petstore/spring-boot-oneof/src/main/java/org/openapitools/api/BarApi.java @@ -67,7 +67,7 @@ default Optional getRequest() { consumes = { "application/json" } ) default ResponseEntity createBar( - @Parameter(name = "BarCreate", description = "", required = true) @Valid @RequestBody BarCreate barCreate + @Parameter(name = "BarCreate", required = true) @Valid @RequestBody BarCreate barCreate ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java index 3c5d676d38a5..d65ae6c1c1f2 100644 --- a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java @@ -47,7 +47,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -56,7 +55,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -100,7 +98,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -109,7 +106,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -124,7 +120,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -162,7 +158,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -217,7 +213,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -295,7 +291,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -308,7 +303,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -355,7 +349,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -365,7 +358,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -392,7 +384,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -402,7 +393,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/StoreApi.java index 8425ab0970d4..c4068b12a627 100644 --- a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java index 2a40a157eba2..21b896b4e39e 100644 --- a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java @@ -79,7 +79,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -87,7 +86,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -112,7 +110,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -120,7 +117,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -179,7 +175,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -189,7 +184,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -230,7 +224,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -240,7 +233,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -256,8 +248,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -267,14 +259,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/PetApi.java index a1e00b3b6d71..684725ebf140 100644 --- a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/PetApi.java @@ -44,7 +44,6 @@ default PetApiDelegate getDelegate() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -53,7 +52,6 @@ default PetApiDelegate getDelegate() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -83,7 +81,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -92,7 +89,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -107,7 +103,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey, + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return getDelegate().deletePet(petId, apiKey, servletRequest); @@ -145,7 +141,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status, + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return getDelegate().findPetsByStatus(status, servletRequest); @@ -186,7 +182,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags, + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return getDelegate().findPetsByTags(tags, servletRequest); @@ -236,7 +232,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -249,7 +244,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -282,7 +276,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -292,7 +285,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -319,7 +311,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -329,7 +320,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/PetApiDelegate.java b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/PetApiDelegate.java index 99ef4e827454..8d3fb989f6a2 100644 --- a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/PetApiDelegate.java +++ b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/PetApiDelegate.java @@ -30,7 +30,6 @@ default Optional getRequest() { /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -59,7 +58,6 @@ default ResponseEntity addPet(Pet pet, /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -165,7 +163,6 @@ default ResponseEntity getPetById(Long petId, /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -198,7 +195,6 @@ default ResponseEntity updatePet(Pet pet, /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -216,7 +212,6 @@ default ResponseEntity updatePetWithForm(Long petId, /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/StoreApi.java index e48b36f7ff7c..dc63af463d6b 100644 --- a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/StoreApi.java @@ -144,7 +144,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -153,7 +152,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/StoreApiDelegate.java b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/StoreApiDelegate.java index 2787db7be905..224e7c2d96b7 100644 --- a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/StoreApiDelegate.java +++ b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/StoreApiDelegate.java @@ -86,7 +86,6 @@ default ResponseEntity getOrderById(Long orderId, /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/UserApi.java index 6b23ab759286..c0e4c2a560fb 100644 --- a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -109,7 +107,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -117,7 +114,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -176,7 +172,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -186,7 +181,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -213,7 +207,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -223,7 +216,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -239,8 +231,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password, + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return getDelegate().loginUser(username, password, servletRequest); @@ -250,14 +242,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/UserApiDelegate.java b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/UserApiDelegate.java index 730f01e89ce7..55c55996aefa 100644 --- a/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/UserApiDelegate.java +++ b/samples/openapi3/server/petstore/springboot-3-include-http-request-context/src/main/java/org/openapitools/api/UserApiDelegate.java @@ -43,7 +43,6 @@ default ResponseEntity createUser(User user, /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default ResponseEntity createUsersWithArrayInput(List<@Valid User> user, /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -86,7 +84,6 @@ default ResponseEntity deleteUser(String username, /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -116,7 +113,6 @@ default ResponseEntity getUserByName(String username, /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -133,7 +129,6 @@ default ResponseEntity loginUser(String username, /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) * @see UserApi#logoutUser diff --git a/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/PetApi.java index 3c5d676d38a5..d65ae6c1c1f2 100644 --- a/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/PetApi.java @@ -47,7 +47,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -56,7 +55,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -100,7 +98,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -109,7 +106,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -124,7 +120,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -162,7 +158,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -217,7 +213,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -295,7 +291,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -308,7 +303,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -355,7 +349,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -365,7 +358,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -392,7 +384,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -402,7 +393,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/StoreApi.java index 8425ab0970d4..c4068b12a627 100644 --- a/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/UserApi.java index 2a40a157eba2..21b896b4e39e 100644 --- a/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/UserApi.java @@ -79,7 +79,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -87,7 +86,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -112,7 +110,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -120,7 +117,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -179,7 +175,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -189,7 +184,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -230,7 +224,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -240,7 +233,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -256,8 +248,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -267,14 +259,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/FileApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/FileApi.java index 61fe29a84470..e6dc5cb89cac 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/FileApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/FileApi.java @@ -64,7 +64,7 @@ default Optional getRequest() { produces = { "application/json" } ) default ResponseEntity fileIdGet( - @Parameter(name = "id", description = "", required = true, in = ParameterIn.PATH) @PathVariable("id") String id + @Parameter(name = "id", required = true, in = ParameterIn.PATH) @PathVariable("id") String id ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/FooApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/FooApi.java index c3e5cafe60a6..580fabcc28ee 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/FooApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/FooApi.java @@ -70,10 +70,10 @@ default Optional getRequest() { produces = { "application/json" } ) default ResponseEntity fooDtParamGet( - @Parameter(name = "dtParam", description = "", in = ParameterIn.PATH) @PathVariable("dtParam") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtParam, - @Parameter(name = "dtQuery", description = "", in = ParameterIn.QUERY) @Valid @RequestParam(value = "dtQuery", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtQuery, - @Parameter(name = "dtCookie", description = "", in = ParameterIn.COOKIE) @CookieValue(name = "dtCookie", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtCookie, - @Parameter(name = "color", description = "", in = ParameterIn.QUERY) @Valid @RequestParam(value = "color", required = false, defaultValue = "red") String color + @Parameter(name = "dtParam", in = ParameterIn.PATH) @PathVariable("dtParam") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtParam, + @Parameter(name = "dtQuery", in = ParameterIn.QUERY) @Valid @RequestParam(value = "dtQuery", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtQuery, + @Parameter(name = "dtCookie", in = ParameterIn.COOKIE) @CookieValue(name = "dtCookie", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtCookie, + @Parameter(name = "color", in = ParameterIn.QUERY) @Valid @RequestParam(value = "color", required = false, defaultValue = "red") String color ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/UploadApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/UploadApi.java index acdc9ebdbf00..693c20dddd14 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/UploadApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/UploadApi.java @@ -62,7 +62,7 @@ default Optional getRequest() { consumes = { "multipart/form-data" } ) default ResponseEntity uploadPost( - @Parameter(name = "file", description = "") @RequestPart(value = "file", required = false) MultipartFile file + @Parameter(name = "file") @RequestPart(value = "file", required = false) MultipartFile file ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/UploadFilesApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/UploadFilesApi.java index ee6ac46ca176..a3d26ce91166 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/UploadFilesApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify-openapiNullable/src/main/java/org/openapitools/api/UploadFilesApi.java @@ -62,7 +62,7 @@ default Optional getRequest() { consumes = { "multipart/form-data" } ) default ResponseEntity uploadFilesPost( - @Parameter(name = "file", description = "") @RequestPart(value = "file", required = false) List file + @Parameter(name = "file") @RequestPart(value = "file", required = false) List file ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/FileApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/FileApi.java index 61fe29a84470..e6dc5cb89cac 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/FileApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/FileApi.java @@ -64,7 +64,7 @@ default Optional getRequest() { produces = { "application/json" } ) default ResponseEntity fileIdGet( - @Parameter(name = "id", description = "", required = true, in = ParameterIn.PATH) @PathVariable("id") String id + @Parameter(name = "id", required = true, in = ParameterIn.PATH) @PathVariable("id") String id ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/FooApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/FooApi.java index 23f497326fcd..25d6d8872692 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/FooApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/FooApi.java @@ -70,10 +70,10 @@ default Optional getRequest() { produces = { "application/json" } ) default ResponseEntity fooDtParamGet( - @Parameter(name = "dtParam", description = "", in = ParameterIn.PATH) @PathVariable("dtParam") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) Optional dtParam, - @Parameter(name = "dtQuery", description = "", in = ParameterIn.QUERY) @RequestParam(value = "dtQuery", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) Optional dtQuery, - @Parameter(name = "dtCookie", description = "", in = ParameterIn.COOKIE) @CookieValue(name = "dtCookie", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) Optional dtCookie, - @Parameter(name = "color", description = "", in = ParameterIn.QUERY) @RequestParam(value = "color", required = false, defaultValue = "red") Optional color + @Parameter(name = "dtParam", in = ParameterIn.PATH) @PathVariable("dtParam") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) Optional dtParam, + @Parameter(name = "dtQuery", in = ParameterIn.QUERY) @RequestParam(value = "dtQuery", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) Optional dtQuery, + @Parameter(name = "dtCookie", in = ParameterIn.COOKIE) @CookieValue(name = "dtCookie", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) Optional dtCookie, + @Parameter(name = "color", in = ParameterIn.QUERY) @RequestParam(value = "color", required = false, defaultValue = "red") Optional color ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/UploadApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/UploadApi.java index acdc9ebdbf00..693c20dddd14 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/UploadApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/UploadApi.java @@ -62,7 +62,7 @@ default Optional getRequest() { consumes = { "multipart/form-data" } ) default ResponseEntity uploadPost( - @Parameter(name = "file", description = "") @RequestPart(value = "file", required = false) MultipartFile file + @Parameter(name = "file") @RequestPart(value = "file", required = false) MultipartFile file ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/UploadFilesApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/UploadFilesApi.java index ee6ac46ca176..a3d26ce91166 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/UploadFilesApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify-useOptional/src/main/java/org/openapitools/api/UploadFilesApi.java @@ -62,7 +62,7 @@ default Optional getRequest() { consumes = { "multipart/form-data" } ) default ResponseEntity uploadFilesPost( - @Parameter(name = "file", description = "") @RequestPart(value = "file", required = false) List file + @Parameter(name = "file") @RequestPart(value = "file", required = false) List file ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/FileApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/FileApi.java index 61fe29a84470..e6dc5cb89cac 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/FileApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/FileApi.java @@ -64,7 +64,7 @@ default Optional getRequest() { produces = { "application/json" } ) default ResponseEntity fileIdGet( - @Parameter(name = "id", description = "", required = true, in = ParameterIn.PATH) @PathVariable("id") String id + @Parameter(name = "id", required = true, in = ParameterIn.PATH) @PathVariable("id") String id ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/FooApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/FooApi.java index c3e5cafe60a6..580fabcc28ee 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/FooApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/FooApi.java @@ -70,10 +70,10 @@ default Optional getRequest() { produces = { "application/json" } ) default ResponseEntity fooDtParamGet( - @Parameter(name = "dtParam", description = "", in = ParameterIn.PATH) @PathVariable("dtParam") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtParam, - @Parameter(name = "dtQuery", description = "", in = ParameterIn.QUERY) @Valid @RequestParam(value = "dtQuery", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtQuery, - @Parameter(name = "dtCookie", description = "", in = ParameterIn.COOKIE) @CookieValue(name = "dtCookie", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtCookie, - @Parameter(name = "color", description = "", in = ParameterIn.QUERY) @Valid @RequestParam(value = "color", required = false, defaultValue = "red") String color + @Parameter(name = "dtParam", in = ParameterIn.PATH) @PathVariable("dtParam") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtParam, + @Parameter(name = "dtQuery", in = ParameterIn.QUERY) @Valid @RequestParam(value = "dtQuery", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtQuery, + @Parameter(name = "dtCookie", in = ParameterIn.COOKIE) @CookieValue(name = "dtCookie", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) java.time.@Nullable Instant dtCookie, + @Parameter(name = "color", in = ParameterIn.QUERY) @Valid @RequestParam(value = "color", required = false, defaultValue = "red") String color ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/UploadApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/UploadApi.java index acdc9ebdbf00..693c20dddd14 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/UploadApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/UploadApi.java @@ -62,7 +62,7 @@ default Optional getRequest() { consumes = { "multipart/form-data" } ) default ResponseEntity uploadPost( - @Parameter(name = "file", description = "") @RequestPart(value = "file", required = false) MultipartFile file + @Parameter(name = "file") @RequestPart(value = "file", required = false) MultipartFile file ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); diff --git a/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/UploadFilesApi.java b/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/UploadFilesApi.java index ee6ac46ca176..a3d26ce91166 100644 --- a/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/UploadFilesApi.java +++ b/samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/UploadFilesApi.java @@ -62,7 +62,7 @@ default Optional getRequest() { consumes = { "multipart/form-data" } ) default ResponseEntity uploadFilesPost( - @Parameter(name = "file", description = "") @RequestPart(value = "file", required = false) List file + @Parameter(name = "file") @RequestPart(value = "file", required = false) List file ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); diff --git a/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/PetApi.java index 3c5d676d38a5..d65ae6c1c1f2 100644 --- a/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/PetApi.java @@ -47,7 +47,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -56,7 +55,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -100,7 +98,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -109,7 +106,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -124,7 +120,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -162,7 +158,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -217,7 +213,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -295,7 +291,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -308,7 +303,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -355,7 +349,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -365,7 +358,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -392,7 +384,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -402,7 +393,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/StoreApi.java index 8425ab0970d4..c4068b12a627 100644 --- a/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/UserApi.java index 2a40a157eba2..21b896b4e39e 100644 --- a/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/springboot-4/src/main/java/org/openapitools/api/UserApi.java @@ -79,7 +79,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -87,7 +86,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -112,7 +110,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -120,7 +117,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -179,7 +175,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -189,7 +184,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -230,7 +224,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -240,7 +233,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -256,8 +248,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -267,14 +259,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java index 700e045b496e..0b40b7c588a8 100644 --- a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java @@ -254,7 +254,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return getDelegate().testBodyWithFileSchema(fileSchemaTestClass); } @@ -281,8 +281,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return getDelegate().testBodyWithQueryParams(query, user); } @@ -361,10 +361,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -452,9 +452,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -466,7 +466,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -474,7 +473,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -495,7 +493,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -504,7 +501,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -516,8 +512,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return getDelegate().testJsonFormData(param, param2); } @@ -526,7 +522,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -534,7 +529,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -576,10 +570,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return getDelegate().testQueryParameterCollectionFormat(pipe, http, url, context); } @@ -617,7 +611,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -627,7 +620,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -646,7 +638,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { return getDelegate().uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata); diff --git a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApiDelegate.java b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApiDelegate.java index 5b6cdd7f828f..cef41060cb6f 100644 --- a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApiDelegate.java +++ b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApiDelegate.java @@ -275,7 +275,6 @@ default ResponseEntity testGroupParameters(Integer requiredStringGroup, /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -288,7 +287,6 @@ default ResponseEntity testInlineAdditionalProperties(Map /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -303,7 +301,6 @@ default ResponseEntity testJsonFormData(String param, /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -356,7 +353,6 @@ default ResponseEntity testWithResultExample() { /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) diff --git a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApi.java index b3b7d3fc88e7..a3bae4930633 100644 --- a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApi.java @@ -44,7 +44,6 @@ default PetApiDelegate getDelegate() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -53,7 +52,6 @@ default PetApiDelegate getDelegate() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -78,7 +76,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -88,7 +85,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -104,7 +100,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return getDelegate().deletePet(petId, apiKey); } @@ -141,7 +137,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { return getDelegate().findPetsByStatus(status); } @@ -181,7 +177,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { return getDelegate().findPetsByTags(tags); } @@ -229,7 +225,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -240,7 +235,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -267,7 +261,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -277,7 +270,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -303,7 +295,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -313,7 +304,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApiDelegate.java b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApiDelegate.java index 423d0415dba4..dd1749004add 100644 --- a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApiDelegate.java +++ b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApiDelegate.java @@ -30,7 +30,6 @@ default Optional getRequest() { /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -44,7 +43,6 @@ default ResponseEntity addPet(Pet pet) { /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -147,7 +145,6 @@ default ResponseEntity getPetById(Long petId) { /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -163,7 +160,6 @@ default ResponseEntity updatePet(Pet pet) { /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -180,7 +176,6 @@ default ResponseEntity updatePetWithForm(Long petId, /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApi.java index e942c0ba6398..7c1720354682 100644 --- a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApi.java @@ -141,7 +141,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -150,7 +149,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApiDelegate.java b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApiDelegate.java index 7e90b451b58e..7047b8d5ae7e 100644 --- a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApiDelegate.java +++ b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApiDelegate.java @@ -83,7 +83,6 @@ default ResponseEntity getOrderById(Long orderId) { /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApi.java index 6d9cf96487e0..c0754fbe4c00 100644 --- a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApi.java @@ -71,7 +71,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -79,7 +78,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -100,7 +98,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -108,7 +105,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -159,7 +155,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -169,7 +164,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -195,7 +189,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -205,7 +198,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -221,8 +213,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return getDelegate().loginUser(username, password); } @@ -231,14 +223,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApiDelegate.java b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApiDelegate.java index b393ee7e9ade..9404cd728f78 100644 --- a/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApiDelegate.java +++ b/samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApiDelegate.java @@ -41,7 +41,6 @@ default ResponseEntity createUser(User user) { /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -54,7 +53,6 @@ default ResponseEntity createUsersWithArrayInput(List<@Valid User> user) { /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -81,7 +79,6 @@ default ResponseEntity deleteUser(String username) { /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -110,7 +107,6 @@ default ResponseEntity getUserByName(String username) { /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -126,7 +122,6 @@ default ResponseEntity loginUser(String username, /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) * @see UserApi#logoutUser diff --git a/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java b/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java index 3bd55f263449..6e8d7ca3923b 100644 --- a/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java @@ -282,7 +282,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -310,8 +310,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -401,10 +401,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -496,8 +496,8 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group ) { @@ -509,7 +509,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -517,7 +516,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -539,7 +537,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -548,7 +545,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -560,8 +556,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -571,7 +567,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -579,7 +574,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -622,10 +616,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -674,7 +668,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -684,7 +677,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -703,7 +695,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/PetApi.java index 93fedb03eaf9..cb8f88f7f148 100644 --- a/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -83,7 +81,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @return successful operation (status code 200) @@ -92,7 +89,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -103,7 +99,7 @@ default ResponseEntity addPet( } ) @Parameters({ - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) + @Parameter(name = "api_key", in = ParameterIn.HEADER) }) @RequestMapping( method = RequestMethod.DELETE, @@ -148,7 +144,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -203,7 +199,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -281,7 +277,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -292,7 +287,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -320,7 +314,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -330,7 +323,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -357,7 +349,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -367,7 +358,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/StoreApi.java index 0813a3064040..de1c903c312d 100644 --- a/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/UserApi.java index 660dc5874bba..c91b30bdfee5 100644 --- a/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -167,7 +163,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -177,7 +172,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -218,7 +212,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -228,7 +221,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -244,8 +236,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -255,14 +247,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java index b98fa191e0a2..37b54db103ca 100644 --- a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java @@ -34,7 +34,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -71,7 +70,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -105,7 +103,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -143,7 +141,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @RequestParam(value = "tags", required = true) List tags + @NotNull @RequestParam(value = "tags") List tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -204,7 +202,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -245,7 +242,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -270,7 +266,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/StoreApi.java index eca12efebb7b..8597576f2c25 100644 --- a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/StoreApi.java @@ -111,7 +111,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/UserApi.java index 497f10559a9e..cbfcbeaa435e 100644 --- a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/UserApi.java @@ -54,7 +54,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -75,7 +74,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -117,7 +115,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -154,7 +151,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -167,8 +163,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Valid @RequestParam(value = "username") String username, + @NotNull @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -178,7 +174,6 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java index b9aa61f0f2ef..b2a8cec2728f 100644 --- a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -101,7 +99,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -110,7 +107,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -125,7 +121,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -163,7 +159,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -218,7 +214,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -296,7 +292,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -309,7 +304,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -356,7 +350,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -366,7 +359,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -393,7 +385,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -403,7 +394,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java index a9027934286d..346992fc22ff 100644 --- a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java @@ -163,7 +163,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -172,7 +171,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java index 86857321436f..6671c792b623 100644 --- a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java @@ -80,7 +80,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -88,7 +87,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -113,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -121,7 +118,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -180,7 +176,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -190,7 +185,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -231,7 +225,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -241,7 +234,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -257,8 +249,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -268,14 +260,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/FakeApi.java index 59eeed7a8269..2ae1e88f8ee6 100644 --- a/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/FakeApi.java @@ -239,7 +239,7 @@ ResponseEntity responseObjectDifferentNam consumes = { "application/json" } ) ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) throws Exception; @@ -264,8 +264,8 @@ ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) throws Exception; @@ -340,10 +340,10 @@ ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -427,9 +427,9 @@ ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -439,7 +439,6 @@ ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -447,7 +446,6 @@ ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -466,7 +464,6 @@ ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -475,7 +472,6 @@ ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -487,15 +483,14 @@ ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) throws Exception; String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -503,7 +498,6 @@ ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -543,10 +537,10 @@ ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) throws Exception; @@ -580,7 +574,6 @@ ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -590,7 +583,6 @@ ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -609,7 +601,7 @@ ResponseEntity testWithResultExample( ) ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) throws Exception; diff --git a/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/PetApi.java index 6a70db2b3296..ecf79f9d77a6 100644 --- a/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/PetApi.java @@ -41,7 +41,6 @@ public interface PetApi { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -50,7 +49,6 @@ public interface PetApi { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -73,7 +71,6 @@ ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -83,7 +80,6 @@ ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -99,7 +95,7 @@ ResponseEntity addPet( ) ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) throws Exception; @@ -134,7 +130,7 @@ ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) throws Exception; @@ -172,7 +168,7 @@ ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) throws Exception; @@ -216,7 +212,6 @@ ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -227,7 +222,6 @@ ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -252,7 +246,6 @@ ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -262,7 +255,6 @@ ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -286,7 +278,6 @@ ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -296,7 +287,6 @@ ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/StoreApi.java index fef0d5f25373..859f9dce31a8 100644 --- a/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/StoreApi.java @@ -132,7 +132,6 @@ ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -141,7 +140,6 @@ ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/UserApi.java index ff7416c1d945..b39c382e463f 100644 --- a/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/spring-boot-defaultInterface-unhandledExcp/src/main/java/org/openapitools/api/UserApi.java @@ -66,7 +66,6 @@ ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -74,7 +73,6 @@ ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -93,7 +91,6 @@ ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -101,7 +98,6 @@ ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -148,7 +144,6 @@ ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -158,7 +153,6 @@ ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -182,7 +176,6 @@ ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -192,7 +185,6 @@ ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -208,22 +200,20 @@ ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) throws Exception; String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/spring-boot-nullable-set/src/main/java/org/openapitools/api/NullableApi.java b/samples/server/petstore/spring-boot-nullable-set/src/main/java/org/openapitools/api/NullableApi.java index f12ebbe092d9..3af5db66e8c6 100644 --- a/samples/server/petstore/spring-boot-nullable-set/src/main/java/org/openapitools/api/NullableApi.java +++ b/samples/server/petstore/spring-boot-nullable-set/src/main/java/org/openapitools/api/NullableApi.java @@ -66,7 +66,7 @@ default Optional getRequest() { consumes = "application/json" ) default ResponseEntity nullableTest( - @Parameter(name = "ObjectWithUniqueItems", description = "") @Valid @RequestBody(required = false) @Nullable ObjectWithUniqueItems objectWithUniqueItems + @Parameter(name = "ObjectWithUniqueItems") @Valid @RequestBody(required = false) @Nullable ObjectWithUniqueItems objectWithUniqueItems ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); diff --git a/samples/server/petstore/springboot-api-response-examples/src/main/java/org/openapitools/api/DogsApi.java b/samples/server/petstore/springboot-api-response-examples/src/main/java/org/openapitools/api/DogsApi.java index e1abbfa7d6a1..89bf827f2f7c 100644 --- a/samples/server/petstore/springboot-api-response-examples/src/main/java/org/openapitools/api/DogsApi.java +++ b/samples/server/petstore/springboot-api-response-examples/src/main/java/org/openapitools/api/DogsApi.java @@ -81,7 +81,7 @@ default DogsApiDelegate getDelegate() { consumes = { "application/json" } ) default ResponseEntity createDog( - @Parameter(name = "Dog", description = "") @Valid @RequestBody(required = false) @Nullable Dog dog + @Parameter(name = "Dog") @Valid @RequestBody(required = false) @Nullable Dog dog ) { return getDelegate().createDog(dog); } diff --git a/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeApi.java index 5f74932d8aaf..a9cc5cd7e310 100644 --- a/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeApi.java @@ -282,7 +282,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -310,8 +310,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -401,10 +401,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -494,9 +494,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -509,7 +509,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -517,7 +516,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -539,7 +537,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -548,7 +545,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -560,8 +556,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -571,7 +567,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -579,7 +574,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -622,10 +616,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -674,7 +668,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -684,7 +677,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -703,7 +695,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/PetApi.java index e653463d6d4d..24968a196a06 100644 --- a/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -83,7 +81,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -93,7 +90,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -109,7 +105,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -147,7 +143,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -202,7 +198,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -280,7 +276,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -291,7 +286,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -319,7 +313,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -329,7 +322,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -356,7 +348,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -366,7 +357,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/StoreApi.java index 0813a3064040..de1c903c312d 100644 --- a/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/UserApi.java index 660dc5874bba..c91b30bdfee5 100644 --- a/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -167,7 +163,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -177,7 +172,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -218,7 +212,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -228,7 +221,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -244,8 +236,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -255,14 +247,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java index 5f74932d8aaf..a9cc5cd7e310 100644 --- a/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java @@ -282,7 +282,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -310,8 +310,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -401,10 +401,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -494,9 +494,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -509,7 +509,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -517,7 +516,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -539,7 +537,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -548,7 +545,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -560,8 +556,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -571,7 +567,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -579,7 +574,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -622,10 +616,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -674,7 +668,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -684,7 +677,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -703,7 +695,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/PetApi.java index e653463d6d4d..24968a196a06 100644 --- a/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -83,7 +81,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -93,7 +90,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -109,7 +105,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -147,7 +143,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -202,7 +198,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -280,7 +276,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -291,7 +286,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -319,7 +313,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -329,7 +322,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -356,7 +348,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -366,7 +357,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/StoreApi.java index 0813a3064040..de1c903c312d 100644 --- a/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/UserApi.java index 660dc5874bba..c91b30bdfee5 100644 --- a/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -167,7 +163,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -177,7 +172,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -218,7 +212,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -228,7 +221,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -244,8 +236,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -255,14 +247,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/FakeApi.java index f7a6a0fdc8a3..ca40d43c325c 100644 --- a/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/FakeApi.java @@ -282,7 +282,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -310,8 +310,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -401,10 +401,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -494,9 +494,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -509,7 +509,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -517,7 +516,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -539,7 +537,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -548,7 +545,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -560,8 +556,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -571,7 +567,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -579,7 +574,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -622,10 +616,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -674,7 +668,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -684,7 +677,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -703,7 +695,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/PetApi.java index a513ced9150a..d76609c8a103 100644 --- a/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -83,7 +81,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -93,7 +90,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -109,7 +105,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -147,7 +143,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -202,7 +198,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -280,7 +276,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -291,7 +286,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -319,7 +313,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -329,7 +322,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -356,7 +348,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -366,7 +357,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/StoreApi.java index 22ad10d8e5b4..6a2e36eabe5f 100644 --- a/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/UserApi.java index 7b607a84aaa9..ab7b2475ab2f 100644 --- a/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-builtin-validation/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -167,7 +163,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -177,7 +172,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -218,7 +212,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -228,7 +221,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -244,8 +236,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -255,14 +247,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApi.java index 700e045b496e..0b40b7c588a8 100644 --- a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApi.java @@ -254,7 +254,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return getDelegate().testBodyWithFileSchema(fileSchemaTestClass); } @@ -281,8 +281,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return getDelegate().testBodyWithQueryParams(query, user); } @@ -361,10 +361,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -452,9 +452,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -466,7 +466,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -474,7 +473,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -495,7 +493,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -504,7 +501,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -516,8 +512,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return getDelegate().testJsonFormData(param, param2); } @@ -526,7 +522,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -534,7 +529,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -576,10 +570,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return getDelegate().testQueryParameterCollectionFormat(pipe, http, url, context); } @@ -617,7 +611,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -627,7 +620,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -646,7 +638,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { return getDelegate().uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata); diff --git a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApiDelegate.java b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApiDelegate.java index 5b6cdd7f828f..cef41060cb6f 100644 --- a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApiDelegate.java +++ b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApiDelegate.java @@ -275,7 +275,6 @@ default ResponseEntity testGroupParameters(Integer requiredStringGroup, /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -288,7 +287,6 @@ default ResponseEntity testInlineAdditionalProperties(Map /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -303,7 +301,6 @@ default ResponseEntity testJsonFormData(String param, /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -356,7 +353,6 @@ default ResponseEntity testWithResultExample() { /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) diff --git a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApi.java index b3b7d3fc88e7..a3bae4930633 100644 --- a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApi.java @@ -44,7 +44,6 @@ default PetApiDelegate getDelegate() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -53,7 +52,6 @@ default PetApiDelegate getDelegate() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -78,7 +76,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -88,7 +85,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -104,7 +100,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return getDelegate().deletePet(petId, apiKey); } @@ -141,7 +137,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { return getDelegate().findPetsByStatus(status); } @@ -181,7 +177,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { return getDelegate().findPetsByTags(tags); } @@ -229,7 +225,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -240,7 +235,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -267,7 +261,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -277,7 +270,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -303,7 +295,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -313,7 +304,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApiDelegate.java b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApiDelegate.java index 423d0415dba4..dd1749004add 100644 --- a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApiDelegate.java +++ b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApiDelegate.java @@ -30,7 +30,6 @@ default Optional getRequest() { /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -44,7 +43,6 @@ default ResponseEntity addPet(Pet pet) { /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -147,7 +145,6 @@ default ResponseEntity getPetById(Long petId) { /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -163,7 +160,6 @@ default ResponseEntity updatePet(Pet pet) { /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -180,7 +176,6 @@ default ResponseEntity updatePetWithForm(Long petId, /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApi.java index e942c0ba6398..7c1720354682 100644 --- a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApi.java @@ -141,7 +141,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -150,7 +149,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApiDelegate.java b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApiDelegate.java index 7e90b451b58e..7047b8d5ae7e 100644 --- a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApiDelegate.java +++ b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApiDelegate.java @@ -83,7 +83,6 @@ default ResponseEntity getOrderById(Long orderId) { /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApi.java index 6d9cf96487e0..c0754fbe4c00 100644 --- a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApi.java @@ -71,7 +71,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -79,7 +78,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -100,7 +98,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -108,7 +105,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -159,7 +155,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -169,7 +164,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -195,7 +189,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -205,7 +198,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -221,8 +213,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return getDelegate().loginUser(username, password); } @@ -231,14 +223,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApiDelegate.java b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApiDelegate.java index b393ee7e9ade..9404cd728f78 100644 --- a/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApiDelegate.java +++ b/samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApiDelegate.java @@ -41,7 +41,6 @@ default ResponseEntity createUser(User user) { /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -54,7 +53,6 @@ default ResponseEntity createUsersWithArrayInput(List<@Valid User> user) { /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -81,7 +79,6 @@ default ResponseEntity deleteUser(String username) { /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -110,7 +107,6 @@ default ResponseEntity getUserByName(String username) { /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -126,7 +122,6 @@ default ResponseEntity loginUser(String username, /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) * @see UserApi#logoutUser diff --git a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/PetApi.java index 213e1e8ca03a..9edb0604a025 100644 --- a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/PetApi.java @@ -43,7 +43,6 @@ default PetApiDelegate getDelegate() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -52,7 +51,6 @@ default PetApiDelegate getDelegate() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -82,7 +80,6 @@ default Pet addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -91,7 +88,6 @@ default Pet addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -107,7 +103,7 @@ default Pet addPet( @ResponseStatus(HttpStatus.BAD_REQUEST) default void deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { getDelegate().deletePet(petId, apiKey); } @@ -145,7 +141,7 @@ default void deletePet( ) @ResponseStatus(HttpStatus.OK) default List findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { return getDelegate().findPetsByStatus(status); } @@ -186,7 +182,7 @@ default List findPetsByStatus( ) @ResponseStatus(HttpStatus.OK) default List findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) { return getDelegate().findPetsByTags(tags); } @@ -235,7 +231,6 @@ default Pet getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -248,7 +243,6 @@ default Pet getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -281,7 +275,6 @@ default Pet updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -291,7 +284,6 @@ default Pet updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -318,7 +310,6 @@ default void updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -328,7 +319,6 @@ default void updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/PetApiDelegate.java b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/PetApiDelegate.java index ae977f8f1bb5..d150bf982886 100644 --- a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/PetApiDelegate.java +++ b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/PetApiDelegate.java @@ -28,7 +28,6 @@ default Optional getRequest() { /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -56,7 +55,6 @@ default Pet addPet(Pet pet) { /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -158,7 +156,6 @@ default Pet getPetById(Long petId) { /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -190,7 +187,6 @@ default Pet updatePet(Pet pet) { /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -207,7 +203,6 @@ default void updatePetWithForm(Long petId, /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/StoreApi.java index 0b5fedec1da6..1a3f54019544 100644 --- a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/StoreApi.java @@ -144,7 +144,6 @@ default Order getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -153,7 +152,6 @@ default Order getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/StoreApiDelegate.java b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/StoreApiDelegate.java index 3b63b91bd905..8fbd7b37e09b 100644 --- a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/StoreApiDelegate.java +++ b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/StoreApiDelegate.java @@ -82,7 +82,6 @@ default Order getOrderById(Long orderId) { /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/UserApi.java index 9f19243f8f7e..a5f353264427 100644 --- a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/UserApi.java @@ -75,7 +75,6 @@ default void createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -83,7 +82,6 @@ default void createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -108,7 +106,6 @@ default void createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -116,7 +113,6 @@ default void createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -175,7 +171,6 @@ default void deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -185,7 +180,6 @@ default void deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -212,7 +206,6 @@ default User getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -222,7 +215,6 @@ default User getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -239,8 +231,8 @@ default User getUserByName( ) @ResponseStatus(HttpStatus.OK) default String loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return getDelegate().loginUser(username, password); } @@ -249,14 +241,12 @@ default String loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/UserApiDelegate.java b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/UserApiDelegate.java index 7e0cfba9ff32..7defec351066 100644 --- a/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/UserApiDelegate.java +++ b/samples/server/petstore/springboot-delegate-no-response-entity/src/main/java/org/openapitools/api/UserApiDelegate.java @@ -40,7 +40,6 @@ default void createUser(User user) { /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -53,7 +52,6 @@ default void createUsersWithArrayInput(List<@Valid User> user) { /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -80,7 +78,6 @@ default void deleteUser(String username) { /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -109,7 +106,6 @@ default User getUserByName(String username) { /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -125,7 +121,6 @@ default String loginUser(String username, /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) * @see UserApi#logoutUser diff --git a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java index 700e045b496e..0b40b7c588a8 100644 --- a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java @@ -254,7 +254,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return getDelegate().testBodyWithFileSchema(fileSchemaTestClass); } @@ -281,8 +281,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return getDelegate().testBodyWithQueryParams(query, user); } @@ -361,10 +361,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -452,9 +452,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -466,7 +466,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -474,7 +473,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -495,7 +493,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -504,7 +501,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -516,8 +512,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return getDelegate().testJsonFormData(param, param2); } @@ -526,7 +522,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -534,7 +529,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -576,10 +570,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return getDelegate().testQueryParameterCollectionFormat(pipe, http, url, context); } @@ -617,7 +611,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -627,7 +620,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -646,7 +638,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { return getDelegate().uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata); diff --git a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApiDelegate.java b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApiDelegate.java index 5b6cdd7f828f..cef41060cb6f 100644 --- a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApiDelegate.java +++ b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApiDelegate.java @@ -275,7 +275,6 @@ default ResponseEntity testGroupParameters(Integer requiredStringGroup, /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -288,7 +287,6 @@ default ResponseEntity testInlineAdditionalProperties(Map /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -303,7 +301,6 @@ default ResponseEntity testJsonFormData(String param, /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -356,7 +353,6 @@ default ResponseEntity testWithResultExample() { /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) diff --git a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApi.java index b3b7d3fc88e7..a3bae4930633 100644 --- a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApi.java @@ -44,7 +44,6 @@ default PetApiDelegate getDelegate() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -53,7 +52,6 @@ default PetApiDelegate getDelegate() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -78,7 +76,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -88,7 +85,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -104,7 +100,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return getDelegate().deletePet(petId, apiKey); } @@ -141,7 +137,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { return getDelegate().findPetsByStatus(status); } @@ -181,7 +177,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { return getDelegate().findPetsByTags(tags); } @@ -229,7 +225,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -240,7 +235,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -267,7 +261,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -277,7 +270,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -303,7 +295,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -313,7 +304,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApiDelegate.java b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApiDelegate.java index 423d0415dba4..dd1749004add 100644 --- a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApiDelegate.java +++ b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApiDelegate.java @@ -30,7 +30,6 @@ default Optional getRequest() { /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -44,7 +43,6 @@ default ResponseEntity addPet(Pet pet) { /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -147,7 +145,6 @@ default ResponseEntity getPetById(Long petId) { /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -163,7 +160,6 @@ default ResponseEntity updatePet(Pet pet) { /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -180,7 +176,6 @@ default ResponseEntity updatePetWithForm(Long petId, /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApi.java index e942c0ba6398..7c1720354682 100644 --- a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApi.java @@ -141,7 +141,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -150,7 +149,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApiDelegate.java b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApiDelegate.java index 7e90b451b58e..7047b8d5ae7e 100644 --- a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApiDelegate.java +++ b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApiDelegate.java @@ -83,7 +83,6 @@ default ResponseEntity getOrderById(Long orderId) { /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApi.java index 6d9cf96487e0..c0754fbe4c00 100644 --- a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApi.java @@ -71,7 +71,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -79,7 +78,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -100,7 +98,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -108,7 +105,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -159,7 +155,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -169,7 +164,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -195,7 +189,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -205,7 +198,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -221,8 +213,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return getDelegate().loginUser(username, password); } @@ -231,14 +223,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApiDelegate.java b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApiDelegate.java index b393ee7e9ade..9404cd728f78 100644 --- a/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApiDelegate.java +++ b/samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApiDelegate.java @@ -41,7 +41,6 @@ default ResponseEntity createUser(User user) { /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -54,7 +53,6 @@ default ResponseEntity createUsersWithArrayInput(List<@Valid User> user) { /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -81,7 +79,6 @@ default ResponseEntity deleteUser(String username) { /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -110,7 +107,6 @@ default ResponseEntity getUserByName(String username) { /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -126,7 +122,6 @@ default ResponseEntity loginUser(String username, /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) * @see UserApi#logoutUser diff --git a/samples/server/petstore/springboot-file-delegate-optional/src/main/java/org/openapitools/api/DummyApi.java b/samples/server/petstore/springboot-file-delegate-optional/src/main/java/org/openapitools/api/DummyApi.java index c42bc74caa29..6fcdfe357647 100644 --- a/samples/server/petstore/springboot-file-delegate-optional/src/main/java/org/openapitools/api/DummyApi.java +++ b/samples/server/petstore/springboot-file-delegate-optional/src/main/java/org/openapitools/api/DummyApi.java @@ -42,14 +42,12 @@ default DummyApiDelegate getDelegate() { String PATH_UPLOAD_FILE = "/dummy"; /** * POST /dummy - * * * @param body (optional) * @return successful operation (status code 200) */ @Operation( operationId = "uploadFile", - description = "", responses = { @ApiResponse(responseCode = "200", description = "successful operation") } @@ -60,7 +58,7 @@ default DummyApiDelegate getDelegate() { consumes = { "application/octet-stream" } ) default ResponseEntity uploadFile( - @Parameter(name = "body", description = "") @Valid @RequestBody(required = false) Optional body + @Parameter(name = "body") @Valid @RequestBody(required = false) Optional body ) { return getDelegate().uploadFile(body); } diff --git a/samples/server/petstore/springboot-file-delegate-optional/src/main/java/org/openapitools/api/DummyApiDelegate.java b/samples/server/petstore/springboot-file-delegate-optional/src/main/java/org/openapitools/api/DummyApiDelegate.java index 30e0e671abe0..cc6cec3f82e9 100644 --- a/samples/server/petstore/springboot-file-delegate-optional/src/main/java/org/openapitools/api/DummyApiDelegate.java +++ b/samples/server/petstore/springboot-file-delegate-optional/src/main/java/org/openapitools/api/DummyApiDelegate.java @@ -27,7 +27,6 @@ default Optional getRequest() { /** * POST /dummy - * * * @param body (optional) * @return successful operation (status code 200) diff --git a/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/PetApi.java index 81b9baed7004..3a395cdc9b9f 100644 --- a/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/PetApi.java @@ -34,7 +34,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -71,7 +70,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @return Invalid pet value (status code 400) @@ -103,7 +101,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -141,7 +139,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @RequestParam(value = "tags", required = true) List tags + @NotNull @RequestParam(value = "tags") List tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -202,7 +200,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -243,7 +240,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -268,7 +264,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/StoreApi.java index f24ccfc33eb1..2c0593016bf3 100644 --- a/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/StoreApi.java @@ -111,7 +111,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/UserApi.java index 95ad07a6924f..31cd3ea95206 100644 --- a/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/UserApi.java @@ -54,7 +54,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -75,7 +74,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -117,7 +115,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -154,7 +151,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -167,8 +163,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Valid @RequestParam(value = "username") String username, + @NotNull @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -178,7 +174,6 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ diff --git a/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java index e9853c88108b..aa389ba3bf2e 100644 --- a/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java @@ -282,7 +282,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -310,8 +310,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -401,10 +401,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -496,8 +496,8 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group ) { @@ -509,7 +509,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -517,7 +516,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -539,7 +537,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -548,7 +545,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -560,8 +556,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -571,7 +567,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -579,7 +574,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -622,10 +616,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -674,7 +668,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -684,7 +677,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -703,7 +695,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/PetApi.java index 66c043195dbb..9973e5fa54e6 100644 --- a/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -83,7 +81,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @return successful operation (status code 200) @@ -92,7 +89,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -103,7 +99,7 @@ default ResponseEntity addPet( } ) @Parameters({ - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) + @Parameter(name = "api_key", in = ParameterIn.HEADER) }) @RequestMapping( method = RequestMethod.DELETE, @@ -148,7 +144,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -203,7 +199,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -281,7 +277,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -292,7 +287,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -320,7 +314,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -330,7 +323,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -357,7 +349,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -367,7 +358,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/StoreApi.java index db15a801607e..e20b9a1426f6 100644 --- a/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/UserApi.java index b5064fcc1277..09720cc81b4d 100644 --- a/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -167,7 +163,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -177,7 +172,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -218,7 +212,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -228,7 +221,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -244,8 +236,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -255,14 +247,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/FakeApi.java index 3252e7aef472..fcd2f6d277ee 100644 --- a/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/FakeApi.java @@ -289,7 +289,7 @@ default ResponseEntity responseObjectD consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClassDto", description = "", required = true) @Valid @RequestBody FileSchemaTestClassDto fileSchemaTestClassDto, + @Parameter(name = "FileSchemaTestClassDto", required = true) @Valid @RequestBody FileSchemaTestClassDto fileSchemaTestClassDto, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -318,8 +318,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "UserDto", description = "", required = true) @Valid @RequestBody UserDto userDto, + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "UserDto", required = true) @Valid @RequestBody UserDto userDto, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -411,10 +411,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -506,9 +506,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group, @@ -522,7 +522,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -530,7 +529,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -553,7 +551,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -562,7 +559,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -574,8 +570,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2, + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -586,7 +582,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullableDto request body (required) * @return successful operation (status code 200) @@ -594,7 +589,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -638,10 +632,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context, + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -691,7 +685,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -701,7 +694,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -720,7 +712,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { diff --git a/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/PetApi.java index 115ffd3b1acd..f9dac94c72ee 100644 --- a/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/PetApi.java @@ -49,7 +49,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -58,7 +57,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -85,7 +83,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -95,7 +92,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -111,7 +107,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey, + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -150,7 +146,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status, + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { getRequest().ifPresent(request -> { @@ -206,7 +202,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags, + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { getRequest().ifPresent(request -> { @@ -286,7 +282,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -297,7 +292,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -326,7 +320,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -336,7 +329,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -364,7 +356,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -374,7 +365,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/StoreApi.java index 25d0ec7d461e..0f2b5f9896f0 100644 --- a/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/StoreApi.java @@ -165,7 +165,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param orderDto order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -174,7 +173,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/UserApi.java index f4b13731be2f..f94e5a19af6e 100644 --- a/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-include-http-request-context/src/main/java/org/openapitools/api/UserApi.java @@ -78,7 +78,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -86,7 +85,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -109,7 +107,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -117,7 +114,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -172,7 +168,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -182,7 +177,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -224,7 +218,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -234,7 +227,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -250,8 +242,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password, + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password, @Parameter(hidden = true) final HttpServletRequest servletRequest ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -262,14 +254,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/PetApi.java index 3c5d676d38a5..d65ae6c1c1f2 100644 --- a/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/PetApi.java @@ -47,7 +47,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -56,7 +55,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -100,7 +98,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -109,7 +106,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -124,7 +120,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -162,7 +158,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -217,7 +213,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -295,7 +291,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -308,7 +303,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -355,7 +349,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -365,7 +358,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -392,7 +384,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -402,7 +393,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/StoreApi.java index 8425ab0970d4..c4068b12a627 100644 --- a/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/UserApi.java index 2a40a157eba2..21b896b4e39e 100644 --- a/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-lombok-data/src/main/java/org/openapitools/api/UserApi.java @@ -79,7 +79,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -87,7 +86,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -112,7 +110,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -120,7 +117,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -179,7 +175,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -189,7 +184,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -230,7 +224,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -240,7 +233,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -256,8 +248,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -267,14 +259,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/PetApi.java index 3c5d676d38a5..d65ae6c1c1f2 100644 --- a/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/PetApi.java @@ -47,7 +47,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -56,7 +55,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -100,7 +98,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -109,7 +106,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -124,7 +120,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -162,7 +158,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -217,7 +213,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -295,7 +291,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -308,7 +303,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -355,7 +349,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -365,7 +358,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -392,7 +384,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -402,7 +393,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/StoreApi.java index 8425ab0970d4..c4068b12a627 100644 --- a/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/UserApi.java index 2a40a157eba2..21b896b4e39e 100644 --- a/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-lombok-tostring/src/main/java/org/openapitools/api/UserApi.java @@ -79,7 +79,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -87,7 +86,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -112,7 +110,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -120,7 +117,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -179,7 +175,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -189,7 +184,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -230,7 +224,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -240,7 +233,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -256,8 +248,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -267,14 +259,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/PetApi.java index 240c23eaa6fd..edc6d8038095 100644 --- a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/PetApi.java @@ -43,7 +43,6 @@ default PetApiDelegate getDelegate() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -52,7 +51,6 @@ default PetApiDelegate getDelegate() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -91,7 +89,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -100,7 +97,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "400", description = "Invalid pet value") @@ -115,7 +111,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return getDelegate().deletePet(petId, apiKey); } @@ -158,7 +154,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { return getDelegate().findPetsByStatus(status); } @@ -198,7 +194,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags ) { return getDelegate().findPetsByTags(tags); } @@ -246,7 +242,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -259,7 +254,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -291,7 +285,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -301,7 +294,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -327,7 +319,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -337,7 +328,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/PetApiDelegate.java b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/PetApiDelegate.java index 9ee4cb85f6a8..8ca1878aa958 100644 --- a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/PetApiDelegate.java +++ b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/PetApiDelegate.java @@ -29,7 +29,6 @@ default Optional getRequest() { /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default ResponseEntity addPet(Pet pet) { /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -159,7 +157,6 @@ default ResponseEntity getPetById(Long petId) { /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -191,7 +188,6 @@ default ResponseEntity updatePet(Pet pet) { /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -208,7 +204,6 @@ default ResponseEntity updatePetWithForm(Long petId, /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/StoreApi.java index 8e37bfe64c8b..8be61f80c28a 100644 --- a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/StoreApi.java @@ -141,7 +141,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -150,7 +149,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/StoreApiDelegate.java b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/StoreApiDelegate.java index 7dcf713d2bd0..3cf8a2da2e18 100644 --- a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/StoreApiDelegate.java +++ b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/StoreApiDelegate.java @@ -83,7 +83,6 @@ default ResponseEntity getOrderById(Long orderId) { /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/UserApi.java index abe51b61ea09..bb6f5aa539e5 100644 --- a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/UserApi.java @@ -74,7 +74,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -82,7 +81,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -171,7 +167,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -181,7 +176,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -207,7 +201,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -217,7 +210,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -233,8 +225,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return getDelegate().loginUser(username, password); } @@ -243,14 +235,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/UserApiDelegate.java b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/UserApiDelegate.java index b393ee7e9ade..9404cd728f78 100644 --- a/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/UserApiDelegate.java +++ b/samples/server/petstore/springboot-petstore-with-api-response-examples/src/main/java/org/openapitools/api/UserApiDelegate.java @@ -41,7 +41,6 @@ default ResponseEntity createUser(User user) { /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -54,7 +53,6 @@ default ResponseEntity createUsersWithArrayInput(List<@Valid User> user) { /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -81,7 +79,6 @@ default ResponseEntity deleteUser(String username) { /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -110,7 +107,6 @@ default ResponseEntity getUserByName(String username) { /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -126,7 +122,6 @@ default ResponseEntity loginUser(String username, /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) * @see UserApi#logoutUser diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java index 49b4c7a1f45d..89660dbe8736 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java @@ -264,7 +264,7 @@ default Mono responseObjectDifferentNames ) @ResponseStatus(HttpStatus.OK) default Mono testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody Mono fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody Mono fileSchemaTestClass ) { return getDelegate().testBodyWithFileSchema(fileSchemaTestClass); } @@ -292,8 +292,8 @@ default Mono testBodyWithFileSchema( ) @ResponseStatus(HttpStatus.OK) default Mono testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody Mono user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody Mono user ) { return getDelegate().testBodyWithQueryParams(query, user); } @@ -374,10 +374,10 @@ default Mono testClientModel( ) @ResponseStatus(HttpStatus.BAD_REQUEST) default Mono testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestPart(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestPart(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestPart(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestPart(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestPart(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestPart(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestPart(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestPart(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestPart(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestPart(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestPart(value = "int64", required = false) Long int64, @@ -467,9 +467,9 @@ default Mono testEnumParameters( ) @ResponseStatus(HttpStatus.BAD_REQUEST) default Mono testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -481,7 +481,6 @@ default Mono testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -489,7 +488,6 @@ default Mono testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -511,7 +509,6 @@ default Mono testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -520,7 +517,6 @@ default Mono testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -533,8 +529,8 @@ default Mono testInlineAdditionalProperties( ) @ResponseStatus(HttpStatus.OK) default Mono testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestPart(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestPart(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestPart(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestPart(value = "param2") String param2 ) { return getDelegate().testJsonFormData(param, param2); } @@ -543,7 +539,6 @@ default Mono testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -551,7 +546,6 @@ default Mono testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -595,10 +589,10 @@ default Mono testNullable( ) @ResponseStatus(HttpStatus.OK) default Mono testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return getDelegate().testQueryParameterCollectionFormat(pipe, http, url, context); } @@ -637,7 +631,6 @@ default Mono testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -647,7 +640,6 @@ default Mono testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -667,7 +659,7 @@ default Mono testWithResultExample( @ResponseStatus(HttpStatus.OK) default Mono uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) Part requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") Part requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata ) { return getDelegate().uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata); diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApiDelegate.java index 6e86c59c7b1f..55c3e057359b 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApiDelegate.java @@ -286,7 +286,6 @@ default Mono testGroupParameters(Integer requiredStringGroup, /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -302,7 +301,6 @@ default Mono testInlineAdditionalProperties(Mono> requ /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -320,7 +318,6 @@ default Mono testJsonFormData(String param, /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -373,7 +370,6 @@ default Mono testWithResultExample() { /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java index db31a4242ba5..3260513af5ef 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApi.java @@ -47,7 +47,6 @@ default PetApiDelegate getDelegate() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -56,7 +55,6 @@ default PetApiDelegate getDelegate() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -82,7 +80,6 @@ default Mono addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -92,7 +89,6 @@ default Mono addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -109,7 +105,7 @@ default Mono addPet( @ResponseStatus(HttpStatus.OK) default Mono deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return getDelegate().deletePet(petId, apiKey); } @@ -147,7 +143,7 @@ default Mono deletePet( ) @ResponseStatus(HttpStatus.OK) default Flux findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { return getDelegate().findPetsByStatus(status); } @@ -188,7 +184,7 @@ default Flux findPetsByStatus( ) @ResponseStatus(HttpStatus.OK) default Flux findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { return getDelegate().findPetsByTags(tags); } @@ -237,7 +233,6 @@ default Mono getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -248,7 +243,6 @@ default Mono getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -276,7 +270,6 @@ default Mono updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -286,7 +279,6 @@ default Mono updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -313,7 +305,6 @@ default Mono updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -323,7 +314,6 @@ default Mono updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApiDelegate.java index 17894cd18b47..c41c49c0741a 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApiDelegate.java @@ -32,7 +32,6 @@ default Optional getRequest() { /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -49,7 +48,6 @@ default Mono addPet(Mono pet) { /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -122,7 +120,6 @@ default Mono getPetById(Long petId) { /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -141,7 +138,6 @@ default Mono updatePet(Mono pet) { /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -161,7 +157,6 @@ default Mono updatePetWithForm(Long petId, /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java index 639ff2a22074..0923735548dc 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApi.java @@ -147,7 +147,6 @@ default Mono getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -156,7 +155,6 @@ default Mono getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApiDelegate.java index 23aaf3b2ffef..e690cb3a3731 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApiDelegate.java @@ -80,7 +80,6 @@ default Mono getOrderById(Long orderId) { /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java index 9c344dd1c9f9..4f74d8c61ed4 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApi.java @@ -75,7 +75,6 @@ default Mono createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -83,7 +82,6 @@ default Mono createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -105,7 +103,6 @@ default Mono createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -113,7 +110,6 @@ default Mono createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -166,7 +162,6 @@ default Mono deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -176,7 +171,6 @@ default Mono deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -203,7 +197,6 @@ default Mono getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -213,7 +206,6 @@ default Mono getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -230,8 +222,8 @@ default Mono getUserByName( ) @ResponseStatus(HttpStatus.OK) default Mono loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return getDelegate().loginUser(username, password); } @@ -240,14 +232,12 @@ default Mono loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApiDelegate.java index 910e285345da..a8b0f07e6843 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApiDelegate.java @@ -46,7 +46,6 @@ default Mono createUser(Mono user) { /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -62,7 +61,6 @@ default Mono createUsersWithArrayInput(Flux user) { /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -95,7 +93,6 @@ default Mono deleteUser(String username) { /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -113,7 +110,6 @@ default Mono getUserByName(String username) { /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -132,7 +128,6 @@ default Mono loginUser(String username, /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) * @see UserApi#logoutUser diff --git a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApi.java index fab0f1c75273..b6d155814a06 100644 --- a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApi.java @@ -264,7 +264,7 @@ default Mono> responseObje consumes = { "application/json" } ) default Mono> testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody Mono fileSchemaTestClass, + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody Mono fileSchemaTestClass, @Parameter(hidden = true) final ServerWebExchange exchange ) { return getDelegate().testBodyWithFileSchema(fileSchemaTestClass, exchange); @@ -292,8 +292,8 @@ default Mono> testBodyWithFileSchema( consumes = { "application/json" } ) default Mono> testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody Mono user, + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody Mono user, @Parameter(hidden = true) final ServerWebExchange exchange ) { return getDelegate().testBodyWithQueryParams(query, user, exchange); @@ -374,10 +374,10 @@ default Mono> testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default Mono> testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestPart(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestPart(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestPart(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestPart(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestPart(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestPart(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestPart(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestPart(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestPart(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestPart(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestPart(value = "int64", required = false) Long int64, @@ -467,9 +467,9 @@ default Mono> testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default Mono> testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group, @@ -482,7 +482,6 @@ default Mono> testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -490,7 +489,6 @@ default Mono> testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -512,7 +510,6 @@ default Mono> testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -521,7 +518,6 @@ default Mono> testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -533,8 +529,8 @@ default Mono> testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default Mono> testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestPart(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestPart(value = "param2", required = true) String param2, + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestPart(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestPart(value = "param2") String param2, @Parameter(hidden = true) final ServerWebExchange exchange ) { return getDelegate().testJsonFormData(param, param2, exchange); @@ -544,7 +540,6 @@ default Mono> testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -552,7 +547,6 @@ default Mono> testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -595,10 +589,10 @@ default Mono> testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default Mono> testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context, + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context, @Parameter(hidden = true) final ServerWebExchange exchange ) { return getDelegate().testQueryParameterCollectionFormat(pipe, http, url, context, exchange); @@ -637,7 +631,6 @@ default Mono> testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -647,7 +640,6 @@ default Mono> testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -666,7 +658,7 @@ default Mono> testWithResultExample( ) default Mono> uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) Part requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") Part requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata, @Parameter(hidden = true) final ServerWebExchange exchange ) { diff --git a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApiDelegate.java b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApiDelegate.java index 030b302bfc28..38d829754a23 100644 --- a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApiDelegate.java +++ b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApiDelegate.java @@ -345,7 +345,6 @@ default Mono> testGroupParameters(Integer requiredStringGro /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -364,7 +363,6 @@ default Mono> testInlineAdditionalProperties(Mono> testJsonFormData(String param, /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -453,7 +450,6 @@ default Mono> testWithResultExample(ServerWebExchange ex /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) diff --git a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApi.java index b3ab6be11be1..ec37557f5dda 100644 --- a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default PetApiDelegate getDelegate() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default PetApiDelegate getDelegate() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -83,7 +81,6 @@ default Mono> addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -93,7 +90,6 @@ default Mono> addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -109,7 +105,7 @@ default Mono> addPet( ) default Mono> deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey, + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey, @Parameter(hidden = true) final ServerWebExchange exchange ) { return getDelegate().deletePet(petId, apiKey, exchange); @@ -147,7 +143,7 @@ default Mono> deletePet( produces = { "application/xml", "application/json" } ) default Mono>> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status, + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status, @Parameter(hidden = true) final ServerWebExchange exchange ) { return getDelegate().findPetsByStatus(status, exchange); @@ -188,7 +184,7 @@ default Mono>> findPetsByStatus( produces = { "application/xml", "application/json" } ) default Mono>> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags, + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags, @Parameter(hidden = true) final ServerWebExchange exchange ) { return getDelegate().findPetsByTags(tags, exchange); @@ -238,7 +234,6 @@ default Mono> getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -249,7 +244,6 @@ default Mono> getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -277,7 +271,6 @@ default Mono> updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -287,7 +280,6 @@ default Mono> updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -314,7 +306,6 @@ default Mono> updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -324,7 +315,6 @@ default Mono> updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApiDelegate.java b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApiDelegate.java index a2da18ba11bb..ca4ab0368840 100644 --- a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApiDelegate.java +++ b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApiDelegate.java @@ -34,7 +34,6 @@ default Optional getRequest() { /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -54,7 +53,6 @@ default Mono> addPet(Mono pet, /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -178,7 +176,6 @@ default Mono> getPetById(Long petId, /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -200,7 +197,6 @@ default Mono> updatePet(Mono pet, /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -223,7 +219,6 @@ default Mono> updatePetWithForm(Long petId, /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/StoreApi.java index 2c52ce3dddf3..ec2d1d1a0817 100644 --- a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/StoreApi.java @@ -147,7 +147,6 @@ default Mono> getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -156,7 +155,6 @@ default Mono> getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/StoreApiDelegate.java b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/StoreApiDelegate.java index 625431966e02..4790b0051b6f 100644 --- a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/StoreApiDelegate.java +++ b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/StoreApiDelegate.java @@ -103,7 +103,6 @@ default Mono> getOrderById(Long orderId, /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/UserApi.java index ae5518115cf6..82a9111f9e7d 100644 --- a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default Mono> createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default Mono> createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default Mono> createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default Mono> createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -167,7 +163,6 @@ default Mono> deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -177,7 +172,6 @@ default Mono> deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -204,7 +198,6 @@ default Mono> getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -214,7 +207,6 @@ default Mono> getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -230,8 +222,8 @@ default Mono> getUserByName( produces = { "application/xml", "application/json" } ) default Mono> loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password, + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password, @Parameter(hidden = true) final ServerWebExchange exchange ) { return getDelegate().loginUser(username, password, exchange); @@ -241,14 +233,12 @@ default Mono> loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/UserApiDelegate.java b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/UserApiDelegate.java index 3039069f6617..a64dd6c83534 100644 --- a/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/UserApiDelegate.java +++ b/samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/UserApiDelegate.java @@ -51,7 +51,6 @@ default Mono> createUser(Mono user, /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -70,7 +69,6 @@ default Mono> createUsersWithArrayInput(Flux user, /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -109,7 +107,6 @@ default Mono> deleteUser(String username, /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -143,7 +140,6 @@ default Mono> getUserByName(String username, /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -165,7 +161,6 @@ default Mono> loginUser(String username, /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) * @see UserApi#logoutUser diff --git a/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/FakeApi.java index ec48cd909bef..83896e9a62a7 100644 --- a/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/FakeApi.java @@ -220,7 +220,7 @@ default ResponseEntity fakeOuterStringSerialize( consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "body", description = "", required = true) @Valid @RequestBody FileSchemaTestClass body + @Parameter(name = "body", required = true) @Valid @RequestBody FileSchemaTestClass body ) { return getDelegate().testBodyWithFileSchema(body); } @@ -247,8 +247,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "body", description = "", required = true) @Valid @RequestBody User body + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "body", required = true) @Valid @RequestBody User body ) { return getDelegate().testBodyWithQueryParams(query, body); } @@ -327,10 +327,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -418,9 +418,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -478,8 +478,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return getDelegate().testJsonFormData(param, param2); } @@ -510,11 +510,11 @@ default ResponseEntity testJsonFormData( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "ioutil", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil", required = true) List ioutil, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "ioutil", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil") List ioutil, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return getDelegate().testQueryParameterCollectionFormat(pipe, ioutil, http, url, context); } @@ -550,7 +550,7 @@ default ResponseEntity testQueryParameterCollectionFormat( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { return getDelegate().uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata); diff --git a/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/PetApi.java index 46e79b7483b4..401d18a2b9a0 100644 --- a/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/PetApi.java @@ -104,7 +104,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return getDelegate().deletePet(petId, apiKey); } @@ -141,7 +141,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status, + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status, @ParameterObject final Pageable pageable ) { return getDelegate().findPetsByStatus(status, pageable); @@ -183,7 +183,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags, + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags, @Parameter(name = "size", description = "A test HeaderParam for issue #8315 - must NOT be removed when x-spring-paginated:true is used.", in = ParameterIn.HEADER) @RequestHeader(value = "size", required = false) @Nullable String size, @PageableDefault(page = 0, size = 20) @SortDefault.SortDefaults({@SortDefault(sort = {"id"}, direction = Sort.Direction.ASC)}) @ParameterObject final Pageable pageable ) { diff --git a/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/UserApi.java index 49c93446d313..34839683ab8c 100644 --- a/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/UserApi.java @@ -210,8 +210,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return getDelegate().loginUser(username, password); } diff --git a/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/VersioningApi.java b/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/VersioningApi.java index e64dc2f510ac..5b3ba9e5296f 100644 --- a/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/VersioningApi.java +++ b/samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/VersioningApi.java @@ -63,8 +63,8 @@ default VersioningApiDelegate getDelegate() { headers = { "VersionWithDefaultValue=V1", "VersionNoDefaultValue" } ) default ResponseEntity versioningHeaders( - @NotNull @Parameter(name = "VersionWithDefaultValue", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionWithDefaultValue", required = true, defaultValue = "V1") String versionWithDefaultValue, - @NotNull @Parameter(name = "VersionNoDefaultValue", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionNoDefaultValue", required = true) String versionNoDefaultValue, + @NotNull @Parameter(name = "VersionWithDefaultValue", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionWithDefaultValue", defaultValue = "V1") String versionWithDefaultValue, + @NotNull @Parameter(name = "VersionNoDefaultValue", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionNoDefaultValue") String versionNoDefaultValue, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { return getDelegate().versioningHeaders(versionWithDefaultValue, versionNoDefaultValue, petId); @@ -99,10 +99,10 @@ default ResponseEntity versioningHeaders( params = { "VersionWithDefaultValueQuery=V1", "VersionNoDefaultValueQuery" } ) default ResponseEntity versioningMix( - @NotNull @Parameter(name = "VersionWithDefaultValueQuery", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValueQuery", required = true, defaultValue = "V1") String versionWithDefaultValueQuery, - @NotNull @Parameter(name = "VersionNoDefaultValueQuery", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValueQuery", required = true) String versionNoDefaultValueQuery, - @NotNull @Parameter(name = "VersionWithDefaultValueHeader", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionWithDefaultValueHeader", required = true, defaultValue = "V1") String versionWithDefaultValueHeader, - @NotNull @Parameter(name = "VersionNoDefaultValueHeader", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionNoDefaultValueHeader", required = true) String versionNoDefaultValueHeader, + @NotNull @Parameter(name = "VersionWithDefaultValueQuery", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValueQuery", defaultValue = "V1") String versionWithDefaultValueQuery, + @NotNull @Parameter(name = "VersionNoDefaultValueQuery", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValueQuery") String versionNoDefaultValueQuery, + @NotNull @Parameter(name = "VersionWithDefaultValueHeader", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionWithDefaultValueHeader", defaultValue = "V1") String versionWithDefaultValueHeader, + @NotNull @Parameter(name = "VersionNoDefaultValueHeader", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionNoDefaultValueHeader") String versionNoDefaultValueHeader, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { return getDelegate().versioningMix(versionWithDefaultValueQuery, versionNoDefaultValueQuery, versionWithDefaultValueHeader, versionNoDefaultValueHeader, petId); @@ -134,8 +134,8 @@ default ResponseEntity versioningMix( params = { "VersionWithDefaultValue=V1", "VersionNoDefaultValue" } ) default ResponseEntity versioningQueryParams( - @NotNull @Parameter(name = "VersionWithDefaultValue", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValue", required = true, defaultValue = "V1") String versionWithDefaultValue, - @NotNull @Parameter(name = "VersionNoDefaultValue", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValue", required = true) String versionNoDefaultValue, + @NotNull @Parameter(name = "VersionWithDefaultValue", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValue", defaultValue = "V1") String versionWithDefaultValue, + @NotNull @Parameter(name = "VersionNoDefaultValue", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValue") String versionNoDefaultValue, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { return getDelegate().versioningQueryParams(versionWithDefaultValue, versionNoDefaultValue, petId); diff --git a/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/FakeApi.java index ec48cd909bef..83896e9a62a7 100644 --- a/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/FakeApi.java @@ -220,7 +220,7 @@ default ResponseEntity fakeOuterStringSerialize( consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "body", description = "", required = true) @Valid @RequestBody FileSchemaTestClass body + @Parameter(name = "body", required = true) @Valid @RequestBody FileSchemaTestClass body ) { return getDelegate().testBodyWithFileSchema(body); } @@ -247,8 +247,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "body", description = "", required = true) @Valid @RequestBody User body + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "body", required = true) @Valid @RequestBody User body ) { return getDelegate().testBodyWithQueryParams(query, body); } @@ -327,10 +327,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -418,9 +418,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -478,8 +478,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return getDelegate().testJsonFormData(param, param2); } @@ -510,11 +510,11 @@ default ResponseEntity testJsonFormData( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "ioutil", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil", required = true) List ioutil, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "ioutil", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil") List ioutil, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return getDelegate().testQueryParameterCollectionFormat(pipe, ioutil, http, url, context); } @@ -550,7 +550,7 @@ default ResponseEntity testQueryParameterCollectionFormat( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { return getDelegate().uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata); diff --git a/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/PetApi.java index 46e79b7483b4..401d18a2b9a0 100644 --- a/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/PetApi.java @@ -104,7 +104,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return getDelegate().deletePet(petId, apiKey); } @@ -141,7 +141,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status, + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status, @ParameterObject final Pageable pageable ) { return getDelegate().findPetsByStatus(status, pageable); @@ -183,7 +183,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags, + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags, @Parameter(name = "size", description = "A test HeaderParam for issue #8315 - must NOT be removed when x-spring-paginated:true is used.", in = ParameterIn.HEADER) @RequestHeader(value = "size", required = false) @Nullable String size, @PageableDefault(page = 0, size = 20) @SortDefault.SortDefaults({@SortDefault(sort = {"id"}, direction = Sort.Direction.ASC)}) @ParameterObject final Pageable pageable ) { diff --git a/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/UserApi.java index 49c93446d313..34839683ab8c 100644 --- a/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/UserApi.java @@ -210,8 +210,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return getDelegate().loginUser(username, password); } diff --git a/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/VersioningApi.java b/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/VersioningApi.java index 8037276f6650..4f1e84b3eb5c 100644 --- a/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/VersioningApi.java +++ b/samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/api/VersioningApi.java @@ -55,8 +55,8 @@ default VersioningApiDelegate getDelegate() { } ) @Parameters({ - @Parameter(name = "VersionWithDefaultValue", description = "", required = true, in = ParameterIn.HEADER), - @Parameter(name = "VersionNoDefaultValue", description = "", required = true, in = ParameterIn.HEADER) + @Parameter(name = "VersionWithDefaultValue", required = true, in = ParameterIn.HEADER), + @Parameter(name = "VersionNoDefaultValue", required = true, in = ParameterIn.HEADER) }) @RequestMapping( method = RequestMethod.POST, @@ -90,8 +90,8 @@ default ResponseEntity versioningHeaders( } ) @Parameters({ - @Parameter(name = "VersionWithDefaultValueHeader", description = "", required = true, in = ParameterIn.HEADER), - @Parameter(name = "VersionNoDefaultValueHeader", description = "", required = true, in = ParameterIn.HEADER) + @Parameter(name = "VersionWithDefaultValueHeader", required = true, in = ParameterIn.HEADER), + @Parameter(name = "VersionNoDefaultValueHeader", required = true, in = ParameterIn.HEADER) }) @RequestMapping( method = RequestMethod.POST, @@ -101,8 +101,8 @@ default ResponseEntity versioningHeaders( params = { "VersionWithDefaultValueQuery=V1", "VersionNoDefaultValueQuery" } ) default ResponseEntity versioningMix( - @NotNull @Parameter(name = "VersionWithDefaultValueQuery", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValueQuery", required = true, defaultValue = "V1") String versionWithDefaultValueQuery, - @NotNull @Parameter(name = "VersionNoDefaultValueQuery", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValueQuery", required = true) String versionNoDefaultValueQuery, + @NotNull @Parameter(name = "VersionWithDefaultValueQuery", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValueQuery", defaultValue = "V1") String versionWithDefaultValueQuery, + @NotNull @Parameter(name = "VersionNoDefaultValueQuery", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValueQuery") String versionNoDefaultValueQuery, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { return getDelegate().versioningMix(versionWithDefaultValueQuery, versionNoDefaultValueQuery, petId); @@ -134,8 +134,8 @@ default ResponseEntity versioningMix( params = { "VersionWithDefaultValue=V1", "VersionNoDefaultValue" } ) default ResponseEntity versioningQueryParams( - @NotNull @Parameter(name = "VersionWithDefaultValue", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValue", required = true, defaultValue = "V1") String versionWithDefaultValue, - @NotNull @Parameter(name = "VersionNoDefaultValue", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValue", required = true) String versionNoDefaultValue, + @NotNull @Parameter(name = "VersionWithDefaultValue", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValue", defaultValue = "V1") String versionWithDefaultValue, + @NotNull @Parameter(name = "VersionNoDefaultValue", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValue") String versionNoDefaultValue, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { return getDelegate().versioningQueryParams(versionWithDefaultValue, versionNoDefaultValue, petId); diff --git a/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/FakeApi.java index 454545ee1b41..b89e516d97de 100644 --- a/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/FakeApi.java @@ -238,7 +238,7 @@ default ResponseEntity fakeOuterStringSerialize( consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "body", description = "", required = true) @Valid @RequestBody FileSchemaTestClass body + @Parameter(name = "body", required = true) @Valid @RequestBody FileSchemaTestClass body ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -266,8 +266,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "body", description = "", required = true) @Valid @RequestBody User body + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "body", required = true) @Valid @RequestBody User body ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -357,10 +357,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -450,9 +450,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -512,8 +512,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -545,11 +545,11 @@ default ResponseEntity testJsonFormData( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "ioutil", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil", required = true) List ioutil, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "ioutil", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil") List ioutil, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -586,7 +586,7 @@ default ResponseEntity testQueryParameterCollectionFormat( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/PetApi.java index 46fc9e9bbec9..5c1ef52848b9 100644 --- a/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/PetApi.java @@ -109,7 +109,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -147,7 +147,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status, + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status, @ParameterObject final Pageable pageable ) { getRequest().ifPresent(request -> { @@ -204,7 +204,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags, + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags, @Parameter(name = "size", description = "A test HeaderParam for issue #8315 - must NOT be removed when x-spring-paginated:true is used.", in = ParameterIn.HEADER) @RequestHeader(value = "size", required = false) @Nullable String size, @PageableDefault(page = 0, size = 20) @SortDefault.SortDefaults({@SortDefault(sort = {"id"}, direction = Sort.Direction.ASC)}) @ParameterObject final Pageable pageable ) { diff --git a/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/UserApi.java index 24ddd90dc8b5..f585ff9ff195 100644 --- a/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/UserApi.java @@ -233,8 +233,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); diff --git a/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/VersioningApi.java b/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/VersioningApi.java index 452dd4b4a78b..b5f69948cebb 100644 --- a/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/VersioningApi.java +++ b/samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/api/VersioningApi.java @@ -67,8 +67,8 @@ default Optional getRequest() { headers = { "VersionWithDefaultValue=V1", "VersionNoDefaultValue" } ) default ResponseEntity versioningHeaders( - @NotNull @Parameter(name = "VersionWithDefaultValue", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionWithDefaultValue", required = true, defaultValue = "V1") String versionWithDefaultValue, - @NotNull @Parameter(name = "VersionNoDefaultValue", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionNoDefaultValue", required = true) String versionNoDefaultValue, + @NotNull @Parameter(name = "VersionWithDefaultValue", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionWithDefaultValue", defaultValue = "V1") String versionWithDefaultValue, + @NotNull @Parameter(name = "VersionNoDefaultValue", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionNoDefaultValue") String versionNoDefaultValue, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { getRequest().ifPresent(request -> { @@ -113,10 +113,10 @@ default ResponseEntity versioningHeaders( params = { "VersionWithDefaultValueQuery=V1", "VersionNoDefaultValueQuery" } ) default ResponseEntity versioningMix( - @NotNull @Parameter(name = "VersionWithDefaultValueQuery", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValueQuery", required = true, defaultValue = "V1") String versionWithDefaultValueQuery, - @NotNull @Parameter(name = "VersionNoDefaultValueQuery", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValueQuery", required = true) String versionNoDefaultValueQuery, - @NotNull @Parameter(name = "VersionWithDefaultValueHeader", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionWithDefaultValueHeader", required = true, defaultValue = "V1") String versionWithDefaultValueHeader, - @NotNull @Parameter(name = "VersionNoDefaultValueHeader", description = "", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionNoDefaultValueHeader", required = true) String versionNoDefaultValueHeader, + @NotNull @Parameter(name = "VersionWithDefaultValueQuery", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValueQuery", defaultValue = "V1") String versionWithDefaultValueQuery, + @NotNull @Parameter(name = "VersionNoDefaultValueQuery", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValueQuery") String versionNoDefaultValueQuery, + @NotNull @Parameter(name = "VersionWithDefaultValueHeader", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionWithDefaultValueHeader", defaultValue = "V1") String versionWithDefaultValueHeader, + @NotNull @Parameter(name = "VersionNoDefaultValueHeader", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "VersionNoDefaultValueHeader") String versionNoDefaultValueHeader, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { getRequest().ifPresent(request -> { @@ -158,8 +158,8 @@ default ResponseEntity versioningMix( params = { "VersionWithDefaultValue=V1", "VersionNoDefaultValue" } ) default ResponseEntity versioningQueryParams( - @NotNull @Parameter(name = "VersionWithDefaultValue", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValue", required = true, defaultValue = "V1") String versionWithDefaultValue, - @NotNull @Parameter(name = "VersionNoDefaultValue", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValue", required = true) String versionNoDefaultValue, + @NotNull @Parameter(name = "VersionWithDefaultValue", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValue", defaultValue = "V1") String versionWithDefaultValue, + @NotNull @Parameter(name = "VersionNoDefaultValue", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValue") String versionNoDefaultValue, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java index 454545ee1b41..b89e516d97de 100644 --- a/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java @@ -238,7 +238,7 @@ default ResponseEntity fakeOuterStringSerialize( consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "body", description = "", required = true) @Valid @RequestBody FileSchemaTestClass body + @Parameter(name = "body", required = true) @Valid @RequestBody FileSchemaTestClass body ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -266,8 +266,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "body", description = "", required = true) @Valid @RequestBody User body + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "body", required = true) @Valid @RequestBody User body ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -357,10 +357,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -450,9 +450,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -512,8 +512,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -545,11 +545,11 @@ default ResponseEntity testJsonFormData( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "ioutil", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil", required = true) List ioutil, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "ioutil", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil") List ioutil, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -586,7 +586,7 @@ default ResponseEntity testQueryParameterCollectionFormat( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/PetApi.java index 46fc9e9bbec9..5c1ef52848b9 100644 --- a/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/PetApi.java @@ -109,7 +109,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -147,7 +147,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status, + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status, @ParameterObject final Pageable pageable ) { getRequest().ifPresent(request -> { @@ -204,7 +204,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) List tags, + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") List tags, @Parameter(name = "size", description = "A test HeaderParam for issue #8315 - must NOT be removed when x-spring-paginated:true is used.", in = ParameterIn.HEADER) @RequestHeader(value = "size", required = false) @Nullable String size, @PageableDefault(page = 0, size = 20) @SortDefault.SortDefaults({@SortDefault(sort = {"id"}, direction = Sort.Direction.ASC)}) @ParameterObject final Pageable pageable ) { diff --git a/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/UserApi.java index 24ddd90dc8b5..f585ff9ff195 100644 --- a/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/UserApi.java @@ -233,8 +233,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); diff --git a/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/VersioningApi.java b/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/VersioningApi.java index ec657691627c..a415c68bf02b 100644 --- a/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/VersioningApi.java +++ b/samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/api/VersioningApi.java @@ -59,8 +59,8 @@ default Optional getRequest() { } ) @Parameters({ - @Parameter(name = "VersionWithDefaultValue", description = "", required = true, in = ParameterIn.HEADER), - @Parameter(name = "VersionNoDefaultValue", description = "", required = true, in = ParameterIn.HEADER) + @Parameter(name = "VersionWithDefaultValue", required = true, in = ParameterIn.HEADER), + @Parameter(name = "VersionNoDefaultValue", required = true, in = ParameterIn.HEADER) }) @RequestMapping( method = RequestMethod.POST, @@ -104,8 +104,8 @@ default ResponseEntity versioningHeaders( } ) @Parameters({ - @Parameter(name = "VersionWithDefaultValueHeader", description = "", required = true, in = ParameterIn.HEADER), - @Parameter(name = "VersionNoDefaultValueHeader", description = "", required = true, in = ParameterIn.HEADER) + @Parameter(name = "VersionWithDefaultValueHeader", required = true, in = ParameterIn.HEADER), + @Parameter(name = "VersionNoDefaultValueHeader", required = true, in = ParameterIn.HEADER) }) @RequestMapping( method = RequestMethod.POST, @@ -115,8 +115,8 @@ default ResponseEntity versioningHeaders( params = { "VersionWithDefaultValueQuery=V1", "VersionNoDefaultValueQuery" } ) default ResponseEntity versioningMix( - @NotNull @Parameter(name = "VersionWithDefaultValueQuery", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValueQuery", required = true, defaultValue = "V1") String versionWithDefaultValueQuery, - @NotNull @Parameter(name = "VersionNoDefaultValueQuery", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValueQuery", required = true) String versionNoDefaultValueQuery, + @NotNull @Parameter(name = "VersionWithDefaultValueQuery", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValueQuery", defaultValue = "V1") String versionWithDefaultValueQuery, + @NotNull @Parameter(name = "VersionNoDefaultValueQuery", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValueQuery") String versionNoDefaultValueQuery, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { getRequest().ifPresent(request -> { @@ -158,8 +158,8 @@ default ResponseEntity versioningMix( params = { "VersionWithDefaultValue=V1", "VersionNoDefaultValue" } ) default ResponseEntity versioningQueryParams( - @NotNull @Parameter(name = "VersionWithDefaultValue", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValue", required = true, defaultValue = "V1") String versionWithDefaultValue, - @NotNull @Parameter(name = "VersionNoDefaultValue", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValue", required = true) String versionNoDefaultValue, + @NotNull @Parameter(name = "VersionWithDefaultValue", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionWithDefaultValue", defaultValue = "V1") String versionWithDefaultValue, + @NotNull @Parameter(name = "VersionNoDefaultValue", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "VersionNoDefaultValue") String versionNoDefaultValue, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-spring-provide-args/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-spring-provide-args/src/main/java/org/openapitools/api/UserApi.java index 25f6b8c01dde..61fc85ae3c23 100644 --- a/samples/server/petstore/springboot-spring-provide-args/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-spring-provide-args/src/main/java/org/openapitools/api/UserApi.java @@ -73,8 +73,8 @@ default Optional getRequest() { produces = { "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password, + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password, @Parameter(hidden = true) @Value("${server.port}") String someValue, @Parameter(hidden = true) @RequestHeader(value = "x-project-id", required = false) String someHeaderValue, @Parameter(hidden = true) @RequestHeader final HttpHeaders headers, diff --git a/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/FakeApi.java index 281d87c7a317..47fe00881e2e 100644 --- a/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/FakeApi.java @@ -282,7 +282,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -310,8 +310,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -401,10 +401,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @RequestParam(value = "integer", required = false) Optional integer, @Parameter(name = "int32", description = "None") @RequestParam(value = "int32", required = false) Optional int32, @Parameter(name = "int64", description = "None") @RequestParam(value = "int64", required = false) Optional int64, @@ -494,9 +494,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @RequestParam(value = "string_group", required = false) Optional stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) Optional booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @RequestParam(value = "int64_group", required = false) Optional int64Group @@ -509,7 +509,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -517,7 +516,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -539,7 +537,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -548,7 +545,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -560,8 +556,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -571,7 +567,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -579,7 +574,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -622,10 +616,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -674,7 +668,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -684,7 +677,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -703,7 +695,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @RequestParam(value = "additionalMetadata", required = false) Optional additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/PetApi.java index e1db1fdc66b3..8d23239d65fc 100644 --- a/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -83,7 +81,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -93,7 +90,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -109,7 +105,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) Optional apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) Optional apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -147,7 +143,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -202,7 +198,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -280,7 +276,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -291,7 +286,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -319,7 +313,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -329,7 +322,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -356,7 +348,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -366,7 +357,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/StoreApi.java index 0813a3064040..de1c903c312d 100644 --- a/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/UserApi.java index 660dc5874bba..c91b30bdfee5 100644 --- a/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -167,7 +163,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -177,7 +172,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -218,7 +212,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -228,7 +221,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -244,8 +236,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -255,14 +247,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/FakeApi.java b/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/FakeApi.java index 96482045f99a..0890bd6f186a 100644 --- a/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/FakeApi.java +++ b/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/FakeApi.java @@ -292,7 +292,7 @@ default ResponseEntity responseObjectDiff consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClass", description = "", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass + @Parameter(name = "FileSchemaTestClass", required = true) @Valid @RequestBody FileSchemaTestClass fileSchemaTestClass ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -321,8 +321,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "User", description = "", required = true) @Valid @RequestBody User user + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "User", required = true) @Valid @RequestBody User user ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -414,10 +414,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -509,9 +509,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -524,7 +524,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -533,7 +532,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -555,7 +553,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -565,7 +562,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -577,8 +573,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -588,7 +584,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullable request body (required) * @return successful operation (status code 200) @@ -597,7 +592,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -641,10 +635,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -694,7 +688,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -705,7 +698,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -724,7 +716,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/PetApi.java b/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/PetApi.java index f6539bc15881..1b74bd12c445 100644 --- a/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/PetApi.java +++ b/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/PetApi.java @@ -51,7 +51,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -61,7 +60,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -87,7 +85,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -98,7 +95,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -114,7 +110,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -153,7 +149,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -209,7 +205,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -288,7 +284,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -300,7 +295,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -328,7 +322,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -339,7 +332,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -366,7 +358,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -377,7 +368,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/StoreApi.java b/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/StoreApi.java index e59e31d371a7..6dc7d27782ef 100644 --- a/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/StoreApi.java +++ b/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/StoreApi.java @@ -168,7 +168,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -178,7 +177,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/UserApi.java b/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/UserApi.java index 86eb3587fb74..74e7d52e3c2b 100644 --- a/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/UserApi.java +++ b/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/UserApi.java @@ -80,7 +80,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -89,7 +88,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -111,7 +109,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -120,7 +117,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -174,7 +170,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -185,7 +180,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -226,7 +220,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -237,7 +230,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -253,8 +245,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -264,7 +256,6 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @@ -272,7 +263,6 @@ default ResponseEntity loginUser( @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/FakeApi.java index 78ff6c36ed97..d989f345a054 100644 --- a/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/FakeApi.java @@ -352,7 +352,6 @@ default ResponseEntity fakePropertyEnumIntegerSe String PATH_TEST_ADDITIONAL_PROPERTIES_REFERENCE = "/fake/additionalProperties-reference"; /** * POST /fake/additionalProperties-reference : test referenced additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -360,7 +359,6 @@ default ResponseEntity fakePropertyEnumIntegerSe @Operation( operationId = "testAdditionalPropertiesReference", summary = "test referenced additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -430,7 +428,7 @@ default ResponseEntity testBodyWithBinary( consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClassDto", description = "", required = true) @NotNull @Valid @RequestBody FileSchemaTestClassDto fileSchemaTestClassDto + @Parameter(name = "FileSchemaTestClassDto", required = true) @NotNull @Valid @RequestBody FileSchemaTestClassDto fileSchemaTestClassDto ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -458,8 +456,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "UserDto", description = "", required = true) @NotNull @Valid @RequestBody UserDto userDto + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "UserDto", required = true) @NotNull @Valid @RequestBody UserDto userDto ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -549,10 +547,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @NotNull @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @NotNull @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @NotNull @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @NotNull @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @NotNull @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @NotNull @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @NotNull @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @NotNull @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -608,7 +606,7 @@ default ResponseEntity testEnumParameters( @Parameter(name = "enum_query_string", description = "Query parameter enum test (string)", in = ParameterIn.QUERY) @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue = "-efg") String enumQueryString, @Parameter(name = "enum_query_integer", description = "Query parameter enum test (double)", in = ParameterIn.QUERY) @Valid @RequestParam(value = "enum_query_integer", required = false) @Nullable Integer enumQueryInteger, @Parameter(name = "enum_query_double", description = "Query parameter enum test (double)", in = ParameterIn.QUERY) @Valid @RequestParam(value = "enum_query_double", required = false) @Nullable Double enumQueryDouble, - @Parameter(name = "enum_query_model_array", description = "", in = ParameterIn.QUERY) @RequestParam(value = "enum_query_model_array", required = false) @Nullable List enumQueryModelArray, + @Parameter(name = "enum_query_model_array", in = ParameterIn.QUERY) @RequestParam(value = "enum_query_model_array", required = false) @Nullable List enumQueryModelArray, @Parameter(name = "enum_form_string_array", description = "Form parameter enum test (string array)") @RequestPart(value = "enum_form_string_array", required = false) List enumFormStringArray, @Parameter(name = "enum_form_string", description = "Form parameter enum test (string)") @Valid @RequestParam(value = "enum_form_string", required = false) String enumFormString ) { @@ -647,9 +645,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -662,7 +660,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -670,7 +667,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -692,7 +688,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_INLINE_FREEFORM_ADDITIONAL_PROPERTIES = "/fake/inline-freeform-additionalProperties"; /** * POST /fake/inline-freeform-additionalProperties : test inline free-form additionalProperties - * * * @param testInlineFreeformAdditionalPropertiesRequestDto request body (required) * @return successful operation (status code 200) @@ -700,7 +695,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testInlineFreeformAdditionalProperties", summary = "test inline free-form additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -722,7 +716,6 @@ default ResponseEntity testInlineFreeformAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -731,7 +724,6 @@ default ResponseEntity testInlineFreeformAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -743,8 +735,8 @@ default ResponseEntity testInlineFreeformAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @NotNull @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @NotNull @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @NotNull @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @NotNull @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -754,7 +746,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullableDto request body (required) * @return successful operation (status code 200) @@ -762,7 +753,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -808,13 +798,13 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "ioutil", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil", required = true) List ioutil, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context, - @NotNull @Parameter(name = "allowEmpty", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "allowEmpty", required = true) String allowEmpty, - @Parameter(name = "language", description = "", in = ParameterIn.QUERY) @RequestParam(value = "", required = false) @Nullable Map language + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "ioutil", required = true, in = ParameterIn.QUERY) @RequestParam(value = "ioutil") List ioutil, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context, + @NotNull @Parameter(name = "allowEmpty", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "allowEmpty") String allowEmpty, + @Parameter(name = "language", in = ParameterIn.QUERY) @RequestParam(value = "", required = false) @Nullable Map language ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -824,7 +814,6 @@ default ResponseEntity testQueryParameterCollectionFormat( String PATH_TEST_STRING_MAP_REFERENCE = "/fake/stringMap-reference"; /** * POST /fake/stringMap-reference : test referenced string map - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -832,7 +821,6 @@ default ResponseEntity testQueryParameterCollectionFormat( @Operation( operationId = "testStringMapReference", summary = "test referenced string map", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -854,7 +842,6 @@ default ResponseEntity testStringMapReference( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -864,7 +851,6 @@ default ResponseEntity testStringMapReference( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -883,7 +869,7 @@ default ResponseEntity testStringMapReference( ) default ResponseEntity uploadFileWithRequiredFile( @NotNull @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/PetApi.java index 94430c14e917..93dd90efff8f 100644 --- a/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param petDto Pet object that needs to be added to the store (required) * @return Successful operation (status code 200) @@ -57,7 +56,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "Successful operation"), @@ -83,7 +81,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -93,7 +90,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "Successful operation"), @@ -109,7 +105,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @NotNull @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -147,7 +143,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) @Deprecated List status + @NotNull @Parameter(name = "status", deprecated = true, description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") @Deprecated List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -202,7 +198,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -280,7 +276,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param petDto Pet object that needs to be added to the store (required) * @return Successful operation (status code 200) @@ -291,7 +286,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "Successful operation"), @@ -319,7 +313,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -330,7 +323,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "Successful operation"), @@ -358,7 +350,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -368,7 +359,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/StoreApi.java index 621fff1557c7..753cb0e9ece6 100644 --- a/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param orderDto order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/UserApi.java index 4e7c04e0f3fe..09ae310cbb9c 100644 --- a/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot-x-implements-skip/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -167,7 +163,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -177,7 +172,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -218,7 +212,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -228,7 +221,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -244,8 +236,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -255,14 +247,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") diff --git a/samples/server/petstore/springboot/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot/src/main/java/org/openapitools/api/FakeApi.java index 847703b53f8f..525bbbebda4f 100644 --- a/samples/server/petstore/springboot/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot/src/main/java/org/openapitools/api/FakeApi.java @@ -282,7 +282,7 @@ default ResponseEntity responseObjectD consumes = { "application/json" } ) default ResponseEntity testBodyWithFileSchema( - @Parameter(name = "FileSchemaTestClassDto", description = "", required = true) @Valid @RequestBody FileSchemaTestClassDto fileSchemaTestClassDto + @Parameter(name = "FileSchemaTestClassDto", required = true) @Valid @RequestBody FileSchemaTestClassDto fileSchemaTestClassDto ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -310,8 +310,8 @@ default ResponseEntity testBodyWithFileSchema( consumes = { "application/json" } ) default ResponseEntity testBodyWithQueryParams( - @NotNull @Parameter(name = "query", description = "", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query", required = true) String query, - @Parameter(name = "UserDto", description = "", required = true) @Valid @RequestBody UserDto userDto + @NotNull @Parameter(name = "query", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "query") String query, + @Parameter(name = "UserDto", required = true) @Valid @RequestBody UserDto userDto ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -401,10 +401,10 @@ default ResponseEntity testClientModel( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testEndpointParameters( - @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number, - @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double", required = true) Double _double, - @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter, - @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte, + @Parameter(name = "number", description = "None", required = true) @DecimalMin(value = "32.1") @DecimalMax(value = "543.2") @Valid @RequestParam(value = "number") BigDecimal number, + @Parameter(name = "double", description = "None", required = true) @DecimalMin(value = "67.8") @DecimalMax(value = "123.4") @Valid @RequestParam(value = "double") Double _double, + @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter") String patternWithoutDelimiter, + @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte") byte[] _byte, @Parameter(name = "integer", description = "None") @Min(value = 10) @Max(value = 100) @Valid @RequestParam(value = "integer", required = false) Integer integer, @Parameter(name = "int32", description = "None") @Min(value = 20) @Max(value = 200) @Valid @RequestParam(value = "int32", required = false) Integer int32, @Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64, @@ -494,9 +494,9 @@ default ResponseEntity testEnumParameters( value = FakeApi.PATH_TEST_GROUP_PARAMETERS ) default ResponseEntity testGroupParameters( - @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup, - @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup, - @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group, + @NotNull @Parameter(name = "required_string_group", description = "Required String in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_string_group") Integer requiredStringGroup, + @NotNull @Parameter(name = "required_boolean_group", description = "Required Boolean in group parameters", required = true, in = ParameterIn.HEADER) @RequestHeader(value = "required_boolean_group") Boolean requiredBooleanGroup, + @NotNull @Parameter(name = "required_int64_group", description = "Required Integer in group parameters", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "required_int64_group") Long requiredInt64Group, @Parameter(name = "string_group", description = "String in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "string_group", required = false) @Nullable Integer stringGroup, @Parameter(name = "boolean_group", description = "Boolean in group parameters", in = ParameterIn.HEADER) @RequestHeader(value = "boolean_group", required = false) @Nullable Boolean booleanGroup, @Parameter(name = "int64_group", description = "Integer in group parameters", in = ParameterIn.QUERY) @Valid @RequestParam(value = "int64_group", required = false) @Nullable Long int64Group @@ -509,7 +509,6 @@ default ResponseEntity testGroupParameters( String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties"; /** * POST /fake/inline-additionalProperties : test inline additionalProperties - * * * @param requestBody request body (required) * @return successful operation (status code 200) @@ -517,7 +516,6 @@ default ResponseEntity testGroupParameters( @Operation( operationId = "testInlineAdditionalProperties", summary = "test inline additionalProperties", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -539,7 +537,6 @@ default ResponseEntity testInlineAdditionalProperties( String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData"; /** * GET /fake/jsonFormData : test json serialization of form data - * * * @param param field1 (required) * @param param2 field2 (required) @@ -548,7 +545,6 @@ default ResponseEntity testInlineAdditionalProperties( @Operation( operationId = "testJsonFormData", summary = "test json serialization of form data", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -560,8 +556,8 @@ default ResponseEntity testInlineAdditionalProperties( consumes = { "application/x-www-form-urlencoded" } ) default ResponseEntity testJsonFormData( - @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param, - @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2 + @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param") String param, + @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2") String param2 ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -571,7 +567,6 @@ default ResponseEntity testJsonFormData( String PATH_TEST_NULLABLE = "/fake/nullable"; /** * POST /fake/nullable : test nullable parent property - * * * @param childWithNullableDto request body (required) * @return successful operation (status code 200) @@ -579,7 +574,6 @@ default ResponseEntity testJsonFormData( @Operation( operationId = "testNullable", summary = "test nullable parent property", - description = "", tags = { "fake" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation") @@ -622,10 +616,10 @@ default ResponseEntity testNullable( value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT ) default ResponseEntity testQueryParameterCollectionFormat( - @NotNull @Parameter(name = "pipe", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe", required = true) List pipe, - @NotNull @Parameter(name = "http", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http", required = true) List http, - @NotNull @Parameter(name = "url", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url", required = true) List url, - @NotNull @Parameter(name = "context", description = "", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context", required = true) List context + @NotNull @Parameter(name = "pipe", required = true, in = ParameterIn.QUERY) @RequestParam(value = "pipe") List pipe, + @NotNull @Parameter(name = "http", required = true, in = ParameterIn.QUERY) @RequestParam(value = "http") List http, + @NotNull @Parameter(name = "url", required = true, in = ParameterIn.QUERY) @RequestParam(value = "url") List url, + @NotNull @Parameter(name = "context", required = true, in = ParameterIn.QUERY) @RequestParam(value = "context") List context ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -674,7 +668,6 @@ default ResponseEntity testWithResultExample( String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile"; /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) - * * * @param petId ID of pet to update (required) * @param requiredFile file to upload (required) @@ -684,7 +677,6 @@ default ResponseEntity testWithResultExample( @Operation( operationId = "uploadFileWithRequiredFile", summary = "uploads an image (required)", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -703,7 +695,7 @@ default ResponseEntity testWithResultExample( ) default ResponseEntity uploadFileWithRequiredFile( @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile, + @Parameter(name = "requiredFile", description = "file to upload", required = true) @RequestPart(value = "requiredFile") MultipartFile requiredFile, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata ) { getRequest().ifPresent(request -> { diff --git a/samples/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java b/samples/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java index 746196e20b79..00534b859af1 100644 --- a/samples/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java @@ -48,7 +48,6 @@ default Optional getRequest() { String PATH_ADD_PET = "/pet"; /** * POST /pet : Add a new pet to the store - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -57,7 +56,6 @@ default Optional getRequest() { @Operation( operationId = "addPet", summary = "Add a new pet to the store", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -83,7 +81,6 @@ default ResponseEntity addPet( String PATH_DELETE_PET = "/pet/{petId}"; /** * DELETE /pet/{petId} : Deletes a pet - * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -93,7 +90,6 @@ default ResponseEntity addPet( @Operation( operationId = "deletePet", summary = "Deletes a pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -109,7 +105,7 @@ default ResponseEntity addPet( ) default ResponseEntity deletePet( @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, - @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey + @Parameter(name = "api_key", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -147,7 +143,7 @@ default ResponseEntity deletePet( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByStatus( - @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status", required = true) List status + @NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @RequestParam(value = "status") List status ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -202,7 +198,7 @@ default ResponseEntity> findPetsByStatus( produces = { "application/xml", "application/json" } ) default ResponseEntity> findPetsByTags( - @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags", required = true) Set tags + @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @RequestParam(value = "tags") Set tags ) { getRequest().ifPresent(request -> { for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) { @@ -280,7 +276,6 @@ default ResponseEntity getPetById( String PATH_UPDATE_PET = "/pet"; /** * PUT /pet : Update an existing pet - * * * @param petDto Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -291,7 +286,6 @@ default ResponseEntity getPetById( @Operation( operationId = "updatePet", summary = "Update an existing pet", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation"), @@ -319,7 +313,6 @@ default ResponseEntity updatePet( String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}"; /** * POST /pet/{petId} : Updates a pet in the store with form data - * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -329,7 +322,6 @@ default ResponseEntity updatePet( @Operation( operationId = "updatePetWithForm", summary = "Updates a pet in the store with form data", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "405", description = "Invalid input") @@ -356,7 +348,6 @@ default ResponseEntity updatePetWithForm( String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage"; /** * POST /pet/{petId}/uploadImage : uploads an image - * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -366,7 +357,6 @@ default ResponseEntity updatePetWithForm( @Operation( operationId = "uploadFile", summary = "uploads an image", - description = "", tags = { "pet" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java b/samples/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java index ad0a5f2f352c..bb9e413ad006 100644 --- a/samples/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java @@ -162,7 +162,6 @@ default ResponseEntity getOrderById( String PATH_PLACE_ORDER = "/store/order"; /** * POST /store/order : Place an order for a pet - * * * @param orderDto order placed for purchasing the pet (required) * @return successful operation (status code 200) @@ -171,7 +170,6 @@ default ResponseEntity getOrderById( @Operation( operationId = "placeOrder", summary = "Place an order for a pet", - description = "", tags = { "store" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { diff --git a/samples/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java b/samples/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java index 8d0e0293be75..c4ed4875d520 100644 --- a/samples/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java @@ -76,7 +76,6 @@ default ResponseEntity createUser( String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray"; /** * POST /user/createWithArray : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -84,7 +83,6 @@ default ResponseEntity createUser( @Operation( operationId = "createUsersWithArrayInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -106,7 +104,6 @@ default ResponseEntity createUsersWithArrayInput( String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList"; /** * POST /user/createWithList : Creates list of users with given input array - * * * @param userDto List of user object (required) * @return successful operation (status code 200) @@ -114,7 +111,6 @@ default ResponseEntity createUsersWithArrayInput( @Operation( operationId = "createUsersWithListInput", summary = "Creates list of users with given input array", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation") @@ -167,7 +163,6 @@ default ResponseEntity deleteUser( String PATH_GET_USER_BY_NAME = "/user/{username}"; /** * GET /user/{username} : Get user by user name - * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -177,7 +172,6 @@ default ResponseEntity deleteUser( @Operation( operationId = "getUserByName", summary = "Get user by user name", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -218,7 +212,6 @@ default ResponseEntity getUserByName( String PATH_LOGIN_USER = "/user/login"; /** * GET /user/login : Logs user into the system - * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -228,7 +221,6 @@ default ResponseEntity getUserByName( @Operation( operationId = "loginUser", summary = "Logs user into the system", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = { @@ -244,8 +236,8 @@ default ResponseEntity getUserByName( produces = { "application/xml", "application/json" } ) default ResponseEntity loginUser( - @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username, - @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) String password + @NotNull @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username") String username, + @NotNull @Parameter(name = "password", description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password") String password ) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -255,14 +247,12 @@ default ResponseEntity loginUser( String PATH_LOGOUT_USER = "/user/logout"; /** * GET /user/logout : Logs out current logged in user session - * * * @return successful operation (status code 200) */ @Operation( operationId = "logoutUser", summary = "Logs out current logged in user session", - description = "", tags = { "user" }, responses = { @ApiResponse(responseCode = "default", description = "successful operation")