From a10fbe835b77da52e948d57658b546edfe884851 Mon Sep 17 00:00:00 2001 From: mzinchenko Date: Wed, 18 Oct 2017 12:53:00 +0300 Subject: [PATCH 1/5] Issue #4680 correct values for enum with escaped double quotes --- .../src/main/resources/JavaSpring/pathParams.mustache | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache b/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache index f2b5c5b2ea8..2e0341f43cf 100644 --- a/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache +++ b/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache @@ -1 +1,4 @@ -{{#isPathParam}}{{#useBeanValidation}}{{>beanValidationPathParams}}{{/useBeanValidation}}@ApiParam(value = "{{{description}}}"{{#required}},required=true{{/required}}{{#allowableValues}}, allowableValues = "{{#values}}{{{.}}}{{^-last}}, {{/-last}}{{#-last}}{{/-last}}{{/values}}"{{/allowableValues}}{{#defaultValue}}, defaultValue="{{{defaultValue}}}"{{/defaultValue}}) @PathVariable("{{baseName}}") {{>optionalDataType}} {{paramName}}{{/isPathParam}} \ No newline at end of file +{{#isPathParam}}{{#useBeanValidation}}{{>beanValidationPathParams}}{{/useBeanValidation}}@ApiParam(value = "{{{description}}}"{{#required}},required=true{{/required}}{{#allowableValues}}, +allowableValues = "{{#enumVars}}{{#lambdaEscapeDoubleQuote}}{{{value}}}{{/lambdaEscapeDoubleQuote}}{{^-last}}, {{/-last}}{{#-last}}{{/-last}}{{/enumVars}}"{{/allowableValues}} {{#defaultValue}}, +defaultValue="{{{defaultValue}}}"{{/defaultValue}}) +@PathVariable("{{paramName}}") {{{dataType}}} {{paramName}}{{/isPathParam}} \ No newline at end of file From 80b1f7625ed9a03456a98a566313e8a1ed32305c Mon Sep 17 00:00:00 2001 From: mzinchenko Date: Mon, 13 Nov 2017 13:22:08 +0300 Subject: [PATCH 2/5] Issue #4680 regenerate samples --- bin/windows/java-petstore-okhttp-gson.bat | 2 +- bin/windows/java-petstore.bat | 2 +- .../java-play-framework-petstore-server.bat | 2 +- .../java-vertx-async-petstore-server.bat | 2 +- bin/windows/java-vertx-rx-petstore-server.bat | 2 +- .../spring-mvc-petstore-j8-async-server.bat | 2 +- bin/windows/spring-mvc-petstore-server.bat | 2 +- bin/windows/springboot-petstore-server.bat | 2 +- .../resources/JavaSpring/pathParams.mustache | 5 +--- .../java-vertx/async/.swagger-codegen/VERSION | 2 +- .../io/swagger/server/api/model/Order.java | 2 +- .../java/io/swagger/server/api/model/Pet.java | 4 +-- .../async/src/main/resources/swagger.json | 3 +- .../java-vertx/rx/.swagger-codegen/VERSION | 2 +- .../io/swagger/server/api/model/Order.java | 2 +- .../java/io/swagger/server/api/model/Pet.java | 4 +-- .../rx/src/main/resources/swagger.json | 3 +- .../src/main/java/io/swagger/api/PetApi.java | 29 ++++++++++++++----- .../main/java/io/swagger/api/StoreApi.java | 13 +++++---- .../src/main/java/io/swagger/api/UserApi.java | 23 ++++++++++----- .../SwaggerDocumentationConfig.java | 2 +- .../main/java/io/swagger/model/Category.java | 3 +- .../io/swagger/model/ModelApiResponse.java | 3 +- .../src/main/java/io/swagger/model/Order.java | 3 +- .../src/main/java/io/swagger/model/Pet.java | 3 +- .../src/main/java/io/swagger/model/Tag.java | 3 +- .../src/main/java/io/swagger/model/User.java | 3 +- .../src/main/java/io/swagger/api/PetApi.java | 29 ++++++++++++++----- .../java/io/swagger/api/PetApiController.java | 29 ++++++++++++++----- .../main/java/io/swagger/api/StoreApi.java | 13 +++++---- .../io/swagger/api/StoreApiController.java | 9 ++++-- .../src/main/java/io/swagger/api/UserApi.java | 23 ++++++++++----- .../io/swagger/api/UserApiController.java | 23 ++++++++++----- .../SwaggerDocumentationConfig.java | 2 +- .../main/java/io/swagger/model/Category.java | 3 +- .../io/swagger/model/ModelApiResponse.java | 3 +- .../src/main/java/io/swagger/model/Order.java | 3 +- .../src/main/java/io/swagger/model/Pet.java | 3 +- .../src/main/java/io/swagger/model/Tag.java | 3 +- .../src/main/java/io/swagger/model/User.java | 3 +- .../src/main/java/io/swagger/api/PetApi.java | 29 ++++++++++++++----- .../java/io/swagger/api/PetApiController.java | 29 ++++++++++++++----- .../main/java/io/swagger/api/StoreApi.java | 13 +++++---- .../io/swagger/api/StoreApiController.java | 9 ++++-- .../src/main/java/io/swagger/api/UserApi.java | 23 ++++++++++----- .../io/swagger/api/UserApiController.java | 23 ++++++++++----- .../SwaggerDocumentationConfig.java | 2 +- .../main/java/io/swagger/model/Category.java | 3 +- .../io/swagger/model/ModelApiResponse.java | 3 +- .../src/main/java/io/swagger/model/Order.java | 3 +- .../src/main/java/io/swagger/model/Pet.java | 3 +- .../src/main/java/io/swagger/model/Tag.java | 3 +- .../src/main/java/io/swagger/model/User.java | 3 +- .../src/main/resources/application.properties | 2 +- 54 files changed, 282 insertions(+), 140 deletions(-) diff --git a/bin/windows/java-petstore-okhttp-gson.bat b/bin/windows/java-petstore-okhttp-gson.bat index 58b3edef39e..5341168eee1 100755 --- a/bin/windows/java-petstore-okhttp-gson.bat +++ b/bin/windows/java-petstore-okhttp-gson.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java -o samples\client\petstore\java --library=okhttp-gson -DdateLibrary=joda,hideGenerationTimestamp=true +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java -o samples\client\petstore\java --library=okhttp-gson -DdateLibrary=joda -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/java-petstore.bat b/bin/windows/java-petstore.bat index e68f7219914..1bef8a0c699 100755 --- a/bin/windows/java-petstore.bat +++ b/bin/windows/java-petstore.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java -o samples\client\petstore\java -DdateLibrary=joda,hideGenerationTimestamp=true +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java -o samples\client\petstore\java -DdateLibrary=joda -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/java-play-framework-petstore-server.bat b/bin/windows/java-play-framework-petstore-server.bat index 058e54e5e79..f0011360a52 100644 --- a/bin/windows/java-play-framework-petstore-server.bat +++ b/bin/windows/java-play-framework-petstore-server.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java-play-framework -o samples\server\petstore\java-play-framework +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java-play-framework -o samples\server\petstore\java-play-framework -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/java-vertx-async-petstore-server.bat b/bin/windows/java-vertx-async-petstore-server.bat index 105eaa23687..8195b0664a4 100644 --- a/bin/windows/java-vertx-async-petstore-server.bat +++ b/bin/windows/java-vertx-async-petstore-server.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java-vertx -o samples\server\petstore\java-vertx\async -DvertxSwaggerRouterVersion=1.2.0 +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java-vertx -o samples\server\petstore\java-vertx\async -DvertxSwaggerRouterVersion=1.2.0 -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/java-vertx-rx-petstore-server.bat b/bin/windows/java-vertx-rx-petstore-server.bat index fc7b2397547..ee45c09eeae 100644 --- a/bin/windows/java-vertx-rx-petstore-server.bat +++ b/bin/windows/java-vertx-rx-petstore-server.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java-vertx -o samples\server\petstore\java-vertx\rx -DvertxSwaggerRouterVersion=1.2.0,rxInterface=true +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java-vertx -o samples\server\petstore\java-vertx\rx -DvertxSwaggerRouterVersion=1.2.0 -DrxInterface=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/spring-mvc-petstore-j8-async-server.bat b/bin/windows/spring-mvc-petstore-j8-async-server.bat index b9c9745e8d9..13526e78e92 100644 --- a/bin/windows/spring-mvc-petstore-j8-async-server.bat +++ b/bin/windows/spring-mvc-petstore-j8-async-server.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l spring --library=spring-mvc -o samples\server\petstore\spring-mvc-j8-async -c bin\spring-mvc-petstore-j8-async.json +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l spring --library=spring-mvc -o samples\server\petstore\spring-mvc-j8-async -c bin\spring-mvc-petstore-j8-async.json -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/spring-mvc-petstore-server.bat b/bin/windows/spring-mvc-petstore-server.bat index 18975dead96..c6aa4933b5d 100644 --- a/bin/windows/spring-mvc-petstore-server.bat +++ b/bin/windows/spring-mvc-petstore-server.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l spring --library=spring-mvc -o samples\server\petstore\spring-mvc +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l spring --library=spring-mvc -o samples\server\petstore\spring-mvc -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/springboot-petstore-server.bat b/bin/windows/springboot-petstore-server.bat index 4a9ca037c3b..530bc5b5d86 100644 --- a/bin/windows/springboot-petstore-server.bat +++ b/bin/windows/springboot-petstore-server.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l spring -o samples\server\petstore\springboot +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l spring -o samples\server\petstore\springboot -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache b/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache index 2e0341f43cf..27f5773b4e0 100644 --- a/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache +++ b/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache @@ -1,4 +1 @@ -{{#isPathParam}}{{#useBeanValidation}}{{>beanValidationPathParams}}{{/useBeanValidation}}@ApiParam(value = "{{{description}}}"{{#required}},required=true{{/required}}{{#allowableValues}}, -allowableValues = "{{#enumVars}}{{#lambdaEscapeDoubleQuote}}{{{value}}}{{/lambdaEscapeDoubleQuote}}{{^-last}}, {{/-last}}{{#-last}}{{/-last}}{{/enumVars}}"{{/allowableValues}} {{#defaultValue}}, -defaultValue="{{{defaultValue}}}"{{/defaultValue}}) -@PathVariable("{{paramName}}") {{{dataType}}} {{paramName}}{{/isPathParam}} \ No newline at end of file +{{#isPathParam}}{{#useBeanValidation}}{{>beanValidationPathParams}}{{/useBeanValidation}}@ApiParam(value = "{{{description}}}"{{#required}},required=true{{/required}}{{#allowableValues}}, allowableValues = "{{#enumVars}}{{#lambdaEscapeDoubleQuote}}{{{value}}}{{/lambdaEscapeDoubleQuote}}{{^-last}}, {{/-last}}{{#-last}}{{/-last}}{{/enumVars}}"{{/allowableValues}}{{#defaultValue}}, defaultValue="{{{defaultValue}}}"{{/defaultValue}}) @PathVariable("{{baseName}}") {{>optionalDataType}} {{paramName}}{{/isPathParam}} diff --git a/samples/server/petstore/java-vertx/async/.swagger-codegen/VERSION b/samples/server/petstore/java-vertx/async/.swagger-codegen/VERSION index 7fea99011a6..f9f7450d135 100644 --- a/samples/server/petstore/java-vertx/async/.swagger-codegen/VERSION +++ b/samples/server/petstore/java-vertx/async/.swagger-codegen/VERSION @@ -1 +1 @@ -2.2.3-SNAPSHOT \ No newline at end of file +2.3.0-SNAPSHOT \ No newline at end of file diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java index 9e7d41ff04c..0eaaa46f352 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java @@ -99,7 +99,7 @@ public void setStatus(StatusEnum status) { @JsonProperty("complete") - public Boolean getComplete() { + public Boolean isComplete() { return complete; } public void setComplete(Boolean complete) { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java index 8b3181be26e..e975a8dc2b2 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java @@ -18,8 +18,8 @@ public class Pet { private Long id = null; private Category category = null; private String name = null; - private List photoUrls = new ArrayList(); - private List tags = new ArrayList(); + private List photoUrls = new ArrayList<>(); + private List tags = new ArrayList<>(); public enum StatusEnum { diff --git a/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json b/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json index 25192459c61..cc8c2b7d468 100644 --- a/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json +++ b/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json @@ -9,7 +9,7 @@ "email" : "apiteam@swagger.io" }, "license" : { - "name" : "Apache 2.0", + "name" : "Apache-2.0", "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, @@ -173,6 +173,7 @@ "security" : [ { "petstore_auth" : [ "write:pets", "read:pets" ] } ], + "deprecated" : true, "x-contentType" : "application/json", "x-accepts" : "application/json" } diff --git a/samples/server/petstore/java-vertx/rx/.swagger-codegen/VERSION b/samples/server/petstore/java-vertx/rx/.swagger-codegen/VERSION index 7fea99011a6..f9f7450d135 100644 --- a/samples/server/petstore/java-vertx/rx/.swagger-codegen/VERSION +++ b/samples/server/petstore/java-vertx/rx/.swagger-codegen/VERSION @@ -1 +1 @@ -2.2.3-SNAPSHOT \ No newline at end of file +2.3.0-SNAPSHOT \ No newline at end of file diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java index 9e7d41ff04c..0eaaa46f352 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java @@ -99,7 +99,7 @@ public void setStatus(StatusEnum status) { @JsonProperty("complete") - public Boolean getComplete() { + public Boolean isComplete() { return complete; } public void setComplete(Boolean complete) { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java index 8b3181be26e..e975a8dc2b2 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java @@ -18,8 +18,8 @@ public class Pet { private Long id = null; private Category category = null; private String name = null; - private List photoUrls = new ArrayList(); - private List tags = new ArrayList(); + private List photoUrls = new ArrayList<>(); + private List tags = new ArrayList<>(); public enum StatusEnum { diff --git a/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json b/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json index 25192459c61..cc8c2b7d468 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json +++ b/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json @@ -9,7 +9,7 @@ "email" : "apiteam@swagger.io" }, "license" : { - "name" : "Apache 2.0", + "name" : "Apache-2.0", "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, @@ -173,6 +173,7 @@ "security" : [ { "petstore_auth" : [ "write:pets", "read:pets" ] } ], + "deprecated" : true, "x-contentType" : "application/json", "x-accepts" : "application/json" } diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/PetApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/PetApi.java index 4681a226115..b4bbba3a391 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/PetApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/PetApi.java @@ -61,7 +61,8 @@ default Optional getAcceptHeader() { produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.POST) - default CompletableFuture> addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + default CompletableFuture> addPet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default PetApi interface so no example is generated"); @@ -81,7 +82,9 @@ default CompletableFuture> addPet(@ApiParam(value = "Pet ob @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - default CompletableFuture> deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { + default CompletableFuture> deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default PetApi interface so no example is generated"); @@ -102,7 +105,8 @@ default CompletableFuture> deletePet(@ApiParam(value = "Pet @RequestMapping(value = "/pet/findByStatus", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture>> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status) { + default CompletableFuture>> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status +) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -139,7 +143,8 @@ default CompletableFuture>> findPetsByStatus(@NotNull @ @RequestMapping(value = "/pet/findByTags", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags) { + default CompletableFuture>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags +) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -174,7 +179,8 @@ default CompletableFuture>> findPetsByTags(@NotNull @Ap @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture> getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId) { + default CompletableFuture> getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId +) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -213,7 +219,8 @@ default CompletableFuture> getPetById(@ApiParam(value = "ID produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.PUT) - default CompletableFuture> updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + default CompletableFuture> updatePet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default PetApi interface so no example is generated"); @@ -234,7 +241,10 @@ default CompletableFuture> updatePet(@ApiParam(value = "Pet produces = { "application/xml", "application/json" }, consumes = { "application/x-www-form-urlencoded" }, method = RequestMethod.POST) - default CompletableFuture> updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { + default CompletableFuture> updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, +@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default PetApi interface so no example is generated"); @@ -255,7 +265,10 @@ default CompletableFuture> updatePetWithForm(@ApiParam(valu produces = { "application/json" }, consumes = { "multipart/form-data" }, method = RequestMethod.POST) - default CompletableFuture> uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { + default CompletableFuture> uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, +@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java index e77f2de7f70..e007e50daae 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java @@ -52,10 +52,11 @@ default Optional getAcceptHeader() { @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{order_id}", + @RequestMapping(value = "/store/order/{orderId}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - default CompletableFuture> deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId) { + default CompletableFuture> deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId +) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default StoreApi interface so no example is generated"); @@ -94,10 +95,11 @@ default CompletableFuture>> getInventory() { @ApiResponse(code = 200, message = "successful operation", response = Order.class), @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{order_id}", + @RequestMapping(value = "/store/order/{orderId}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture> getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId) { + default CompletableFuture> getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId +) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -129,7 +131,8 @@ default CompletableFuture> getOrderById(@Min(1) @Max(5) @A @RequestMapping(value = "/store/order", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - default CompletableFuture> placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { + default CompletableFuture> placeOrder( +@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/UserApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/UserApi.java index 4e755a2a73d..d697caf9c64 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/UserApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/UserApi.java @@ -54,7 +54,8 @@ default Optional getAcceptHeader() { @RequestMapping(value = "/user", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - default CompletableFuture> createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { + default CompletableFuture> createUser( +@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); @@ -69,7 +70,8 @@ default CompletableFuture> createUser(@ApiParam(value = "Cr @RequestMapping(value = "/user/createWithArray", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - default CompletableFuture> createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + default CompletableFuture> createUsersWithArrayInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); @@ -84,7 +86,8 @@ default CompletableFuture> createUsersWithArrayInput(@ApiPa @RequestMapping(value = "/user/createWithList", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - default CompletableFuture> createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + default CompletableFuture> createUsersWithListInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); @@ -100,7 +103,8 @@ default CompletableFuture> createUsersWithListInput(@ApiPar @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - default CompletableFuture> deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username) { + default CompletableFuture> deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username +) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); @@ -117,7 +121,8 @@ default CompletableFuture> deleteUser(@ApiParam(value = "Th @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture> getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username) { + default CompletableFuture> getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username +) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -149,7 +154,9 @@ default CompletableFuture> getUserByName(@ApiParam(value = @RequestMapping(value = "/user/login", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture> loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password) { + default CompletableFuture> loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username +,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password +) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -196,7 +203,9 @@ default CompletableFuture> logoutUser() { @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.PUT) - default CompletableFuture> updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { + default CompletableFuture> updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username +, +@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java index 301e80043ba..6ec5d0d2614 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java @@ -17,7 +17,7 @@ public class SwaggerDocumentationConfig { ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Swagger Petstore") - .description("This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\") + .description("This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.") .license("Apache-2.0") .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html") .termsOfServiceUrl("") diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Category.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Category.java index 1e0ea848c21..ec5cb00ee16 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Category.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Category.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * Category + * A category for a pet */ +@ApiModel(description = "A category for a pet") @Validated public class Category { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/ModelApiResponse.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/ModelApiResponse.java index ab88a41e0eb..050d15d9b01 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/ModelApiResponse.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/ModelApiResponse.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * ModelApiResponse + * Describes the result of uploading an image resource */ +@ApiModel(description = "Describes the result of uploading an image resource") @Validated public class ModelApiResponse { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Order.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Order.java index 1d8ee746517..2862ac1af36 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Order.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Order.java @@ -12,8 +12,9 @@ import javax.validation.constraints.*; /** - * Order + * An order for a pets from the pet store */ +@ApiModel(description = "An order for a pets from the pet store") @Validated public class Order { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Pet.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Pet.java index 406db97bb61..f4d084d8ddc 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Pet.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Pet.java @@ -15,8 +15,9 @@ import javax.validation.constraints.*; /** - * Pet + * A pet for sale in the pet store */ +@ApiModel(description = "A pet for sale in the pet store") @Validated public class Pet { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Tag.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Tag.java index e993412e9cf..0370fd0e4c6 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Tag.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Tag.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * Tag + * A tag for a pet */ +@ApiModel(description = "A tag for a pet") @Validated public class Tag { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/User.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/User.java index 0cbec699d47..ded14da7cc0 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/User.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/User.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * User + * A User who is purchasing from the pet store */ +@ApiModel(description = "A User who is purchasing from the pet store") @Validated public class User { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApi.java index d4604e9380e..44a3c43b446 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApi.java @@ -39,7 +39,8 @@ public interface PetApi { produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.POST) - ResponseEntity addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); + ResponseEntity addPet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); @ApiOperation(value = "Deletes a pet", nickname = "deletePet", notes = "", authorizations = { @@ -53,7 +54,9 @@ public interface PetApi { @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey); + ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey); @ApiOperation(value = "Finds Pets by status", nickname = "findPetsByStatus", notes = "Multiple status values can be provided with comma separated strings", response = Pet.class, responseContainer = "List", authorizations = { @@ -68,7 +71,8 @@ public interface PetApi { @RequestMapping(value = "/pet/findByStatus", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status); + ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status +); @ApiOperation(value = "Finds Pets by tags", nickname = "findPetsByTags", notes = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", response = Pet.class, responseContainer = "List", authorizations = { @@ -83,7 +87,8 @@ public interface PetApi { @RequestMapping(value = "/pet/findByTags", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags); + ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags +); @ApiOperation(value = "Find pet by ID", nickname = "getPetById", notes = "Returns a single pet", response = Pet.class, authorizations = { @@ -96,7 +101,8 @@ public interface PetApi { @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId); + ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId +); @ApiOperation(value = "Update an existing pet", nickname = "updatePet", notes = "", authorizations = { @@ -113,7 +119,8 @@ public interface PetApi { produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.PUT) - ResponseEntity updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); + ResponseEntity updatePet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); @ApiOperation(value = "Updates a pet in the store with form data", nickname = "updatePetWithForm", notes = "", authorizations = { @@ -128,7 +135,10 @@ public interface PetApi { produces = { "application/xml", "application/json" }, consumes = { "application/x-www-form-urlencoded" }, method = RequestMethod.POST) - ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status); + ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, +@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status); @ApiOperation(value = "uploads an image", nickname = "uploadFile", notes = "", response = ModelApiResponse.class, authorizations = { @@ -143,6 +153,9 @@ public interface PetApi { produces = { "application/json" }, consumes = { "multipart/form-data" }, method = RequestMethod.POST) - ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file); + ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, +@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApiController.java index a3890cf787d..b8f0525659d 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApiController.java @@ -38,17 +38,21 @@ public PetApiController(ObjectMapper objectMapper, HttpServletRequest request) { this.request = request; } - public ResponseEntity addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + public ResponseEntity addPet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { + public ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status) { + public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -71,7 +75,8 @@ public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "St return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags) { + public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -94,7 +99,8 @@ public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId) { + public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -117,17 +123,24 @@ public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",re return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + public ResponseEntity updatePet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { + public ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, +@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { + public ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, +@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java index f23d712511f..85b78743bfa 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java @@ -30,10 +30,11 @@ public interface StoreApi { @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{order_id}", + @RequestMapping(value = "/store/order/{orderId}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId); + ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId +); @ApiOperation(value = "Returns pet inventories by status", nickname = "getInventory", notes = "Returns a map of status codes to quantities", response = Integer.class, responseContainer = "Map", authorizations = { @@ -52,10 +53,11 @@ public interface StoreApi { @ApiResponse(code = 200, message = "successful operation", response = Order.class), @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{order_id}", + @RequestMapping(value = "/store/order/{orderId}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId); + ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId +); @ApiOperation(value = "Place an order for a pet", nickname = "placeOrder", notes = "", response = Order.class, tags={ "store", }) @@ -65,6 +67,7 @@ public interface StoreApi { @RequestMapping(value = "/store/order", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body); + ResponseEntity placeOrder( +@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java index 6e463e1307f..655bb35bd08 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java @@ -37,7 +37,8 @@ public StoreApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId) { + public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId +) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } @@ -56,7 +57,8 @@ public ResponseEntity> getInventory() { return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId) { + public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -79,7 +81,8 @@ public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { + public ResponseEntity placeOrder( +@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApi.java index 3dbcf7293cd..8bb388b1d24 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApi.java @@ -32,7 +32,8 @@ public interface UserApi { @RequestMapping(value = "/user", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body); + ResponseEntity createUser( +@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body); @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithArrayInput", notes = "", tags={ "user", }) @@ -41,7 +42,8 @@ public interface UserApi { @RequestMapping(value = "/user/createWithArray", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); + ResponseEntity createUsersWithArrayInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithListInput", notes = "", tags={ "user", }) @@ -50,7 +52,8 @@ public interface UserApi { @RequestMapping(value = "/user/createWithList", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); + ResponseEntity createUsersWithListInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); @ApiOperation(value = "Delete user", nickname = "deleteUser", notes = "This can only be done by the logged in user.", tags={ "user", }) @@ -60,7 +63,8 @@ public interface UserApi { @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username); + ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username +); @ApiOperation(value = "Get user by user name", nickname = "getUserByName", notes = "", response = User.class, tags={ "user", }) @@ -71,7 +75,8 @@ public interface UserApi { @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username); + ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username +); @ApiOperation(value = "Logs user into the system", nickname = "loginUser", notes = "", response = String.class, tags={ "user", }) @@ -81,7 +86,9 @@ public interface UserApi { @RequestMapping(value = "/user/login", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password); + ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username +,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password +); @ApiOperation(value = "Logs out current logged in user session", nickname = "logoutUser", notes = "", tags={ "user", }) @@ -100,6 +107,8 @@ public interface UserApi { @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.PUT) - ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body); + ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username +, +@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApiController.java index e96dfe648b4..404b1174b58 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApiController.java @@ -37,27 +37,32 @@ public UserApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { + public ResponseEntity createUser( +@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + public ResponseEntity createUsersWithArrayInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + public ResponseEntity createUsersWithListInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username) { + public ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username +) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username) { + public ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -80,7 +85,9 @@ public ResponseEntity getUserByName(@ApiParam(value = "The name that needs return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password) { + public ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username +,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -108,7 +115,9 @@ public ResponseEntity logoutUser() { return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { + public ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username +, +@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java index 01bdae11a8e..26d4fc0e1f9 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java @@ -17,7 +17,7 @@ public class SwaggerDocumentationConfig { ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Swagger Petstore") - .description("This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\") + .description("This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.") .license("Apache-2.0") .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html") .termsOfServiceUrl("") diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Category.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Category.java index 1e0ea848c21..ec5cb00ee16 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Category.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Category.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * Category + * A category for a pet */ +@ApiModel(description = "A category for a pet") @Validated public class Category { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/ModelApiResponse.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/ModelApiResponse.java index ab88a41e0eb..050d15d9b01 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/ModelApiResponse.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/ModelApiResponse.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * ModelApiResponse + * Describes the result of uploading an image resource */ +@ApiModel(description = "Describes the result of uploading an image resource") @Validated public class ModelApiResponse { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Order.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Order.java index 8b87b88b024..51394f276d1 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Order.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Order.java @@ -12,8 +12,9 @@ import javax.validation.constraints.*; /** - * Order + * An order for a pets from the pet store */ +@ApiModel(description = "An order for a pets from the pet store") @Validated public class Order { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Pet.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Pet.java index 2f4545d717a..c25439608c9 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Pet.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Pet.java @@ -15,8 +15,9 @@ import javax.validation.constraints.*; /** - * Pet + * A pet for sale in the pet store */ +@ApiModel(description = "A pet for sale in the pet store") @Validated public class Pet { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Tag.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Tag.java index e993412e9cf..0370fd0e4c6 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Tag.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Tag.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * Tag + * A tag for a pet */ +@ApiModel(description = "A tag for a pet") @Validated public class Tag { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/User.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/User.java index 0cbec699d47..ded14da7cc0 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/User.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/User.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * User + * A User who is purchasing from the pet store */ +@ApiModel(description = "A User who is purchasing from the pet store") @Validated public class User { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApi.java index d4604e9380e..44a3c43b446 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApi.java @@ -39,7 +39,8 @@ public interface PetApi { produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.POST) - ResponseEntity addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); + ResponseEntity addPet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); @ApiOperation(value = "Deletes a pet", nickname = "deletePet", notes = "", authorizations = { @@ -53,7 +54,9 @@ public interface PetApi { @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey); + ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey); @ApiOperation(value = "Finds Pets by status", nickname = "findPetsByStatus", notes = "Multiple status values can be provided with comma separated strings", response = Pet.class, responseContainer = "List", authorizations = { @@ -68,7 +71,8 @@ public interface PetApi { @RequestMapping(value = "/pet/findByStatus", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status); + ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status +); @ApiOperation(value = "Finds Pets by tags", nickname = "findPetsByTags", notes = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", response = Pet.class, responseContainer = "List", authorizations = { @@ -83,7 +87,8 @@ public interface PetApi { @RequestMapping(value = "/pet/findByTags", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags); + ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags +); @ApiOperation(value = "Find pet by ID", nickname = "getPetById", notes = "Returns a single pet", response = Pet.class, authorizations = { @@ -96,7 +101,8 @@ public interface PetApi { @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId); + ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId +); @ApiOperation(value = "Update an existing pet", nickname = "updatePet", notes = "", authorizations = { @@ -113,7 +119,8 @@ public interface PetApi { produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.PUT) - ResponseEntity updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); + ResponseEntity updatePet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); @ApiOperation(value = "Updates a pet in the store with form data", nickname = "updatePetWithForm", notes = "", authorizations = { @@ -128,7 +135,10 @@ public interface PetApi { produces = { "application/xml", "application/json" }, consumes = { "application/x-www-form-urlencoded" }, method = RequestMethod.POST) - ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status); + ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, +@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status); @ApiOperation(value = "uploads an image", nickname = "uploadFile", notes = "", response = ModelApiResponse.class, authorizations = { @@ -143,6 +153,9 @@ public interface PetApi { produces = { "application/json" }, consumes = { "multipart/form-data" }, method = RequestMethod.POST) - ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file); + ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, +@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApiController.java index a3890cf787d..b8f0525659d 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApiController.java @@ -38,17 +38,21 @@ public PetApiController(ObjectMapper objectMapper, HttpServletRequest request) { this.request = request; } - public ResponseEntity addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + public ResponseEntity addPet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { + public ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status) { + public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -71,7 +75,8 @@ public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "St return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags) { + public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -94,7 +99,8 @@ public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId) { + public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -117,17 +123,24 @@ public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",re return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + public ResponseEntity updatePet( +@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { + public ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, +@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { + public ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId +, +@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, +@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java index f23d712511f..85b78743bfa 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java @@ -30,10 +30,11 @@ public interface StoreApi { @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{order_id}", + @RequestMapping(value = "/store/order/{orderId}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId); + ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId +); @ApiOperation(value = "Returns pet inventories by status", nickname = "getInventory", notes = "Returns a map of status codes to quantities", response = Integer.class, responseContainer = "Map", authorizations = { @@ -52,10 +53,11 @@ public interface StoreApi { @ApiResponse(code = 200, message = "successful operation", response = Order.class), @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{order_id}", + @RequestMapping(value = "/store/order/{orderId}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId); + ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId +); @ApiOperation(value = "Place an order for a pet", nickname = "placeOrder", notes = "", response = Order.class, tags={ "store", }) @@ -65,6 +67,7 @@ public interface StoreApi { @RequestMapping(value = "/store/order", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body); + ResponseEntity placeOrder( +@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java index 6e463e1307f..655bb35bd08 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java @@ -37,7 +37,8 @@ public StoreApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId) { + public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId +) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } @@ -56,7 +57,8 @@ public ResponseEntity> getInventory() { return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId) { + public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -79,7 +81,8 @@ public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { + public ResponseEntity placeOrder( +@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApi.java index 3dbcf7293cd..8bb388b1d24 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApi.java @@ -32,7 +32,8 @@ public interface UserApi { @RequestMapping(value = "/user", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body); + ResponseEntity createUser( +@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body); @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithArrayInput", notes = "", tags={ "user", }) @@ -41,7 +42,8 @@ public interface UserApi { @RequestMapping(value = "/user/createWithArray", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); + ResponseEntity createUsersWithArrayInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithListInput", notes = "", tags={ "user", }) @@ -50,7 +52,8 @@ public interface UserApi { @RequestMapping(value = "/user/createWithList", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); + ResponseEntity createUsersWithListInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); @ApiOperation(value = "Delete user", nickname = "deleteUser", notes = "This can only be done by the logged in user.", tags={ "user", }) @@ -60,7 +63,8 @@ public interface UserApi { @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username); + ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username +); @ApiOperation(value = "Get user by user name", nickname = "getUserByName", notes = "", response = User.class, tags={ "user", }) @@ -71,7 +75,8 @@ public interface UserApi { @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username); + ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username +); @ApiOperation(value = "Logs user into the system", nickname = "loginUser", notes = "", response = String.class, tags={ "user", }) @@ -81,7 +86,9 @@ public interface UserApi { @RequestMapping(value = "/user/login", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password); + ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username +,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password +); @ApiOperation(value = "Logs out current logged in user session", nickname = "logoutUser", notes = "", tags={ "user", }) @@ -100,6 +107,8 @@ public interface UserApi { @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.PUT) - ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body); + ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username +, +@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApiController.java index e96dfe648b4..404b1174b58 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApiController.java @@ -37,27 +37,32 @@ public UserApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { + public ResponseEntity createUser( +@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + public ResponseEntity createUsersWithArrayInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + public ResponseEntity createUsersWithListInput( +@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username) { + public ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username +) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username) { + public ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -80,7 +85,9 @@ public ResponseEntity getUserByName(@ApiParam(value = "The name that needs return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password) { + public ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username +,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password +) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -108,7 +115,9 @@ public ResponseEntity logoutUser() { return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { + public ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username +, +@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java b/samples/server/petstore/springboot/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java index 01bdae11a8e..26d4fc0e1f9 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java @@ -17,7 +17,7 @@ public class SwaggerDocumentationConfig { ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Swagger Petstore") - .description("This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\") + .description("This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.") .license("Apache-2.0") .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html") .termsOfServiceUrl("") diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Category.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Category.java index 1e0ea848c21..ec5cb00ee16 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Category.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Category.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * Category + * A category for a pet */ +@ApiModel(description = "A category for a pet") @Validated public class Category { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/ModelApiResponse.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/ModelApiResponse.java index ab88a41e0eb..050d15d9b01 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/ModelApiResponse.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/ModelApiResponse.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * ModelApiResponse + * Describes the result of uploading an image resource */ +@ApiModel(description = "Describes the result of uploading an image resource") @Validated public class ModelApiResponse { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Order.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Order.java index 8b87b88b024..51394f276d1 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Order.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Order.java @@ -12,8 +12,9 @@ import javax.validation.constraints.*; /** - * Order + * An order for a pets from the pet store */ +@ApiModel(description = "An order for a pets from the pet store") @Validated public class Order { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Pet.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Pet.java index 2f4545d717a..c25439608c9 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Pet.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Pet.java @@ -15,8 +15,9 @@ import javax.validation.constraints.*; /** - * Pet + * A pet for sale in the pet store */ +@ApiModel(description = "A pet for sale in the pet store") @Validated public class Pet { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Tag.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Tag.java index e993412e9cf..0370fd0e4c6 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Tag.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Tag.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * Tag + * A tag for a pet */ +@ApiModel(description = "A tag for a pet") @Validated public class Tag { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/User.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/User.java index 0cbec699d47..ded14da7cc0 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/User.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/User.java @@ -10,8 +10,9 @@ import javax.validation.constraints.*; /** - * User + * A User who is purchasing from the pet store */ +@ApiModel(description = "A User who is purchasing from the pet store") @Validated public class User { diff --git a/samples/server/petstore/springboot/src/main/resources/application.properties b/samples/server/petstore/springboot/src/main/resources/application.properties index a72d110dea9..a2ef8627027 100644 --- a/samples/server/petstore/springboot/src/main/resources/application.properties +++ b/samples/server/petstore/springboot/src/main/resources/application.properties @@ -1,5 +1,5 @@ springfox.documentation.swagger.v2.path=/api-docs server.contextPath=/v2 -server.port=80 +server.port=8080 spring.jackson.date-format=io.swagger.RFC3339DateFormat spring.jackson.serialization.WRITE_DATES_AS_TIMESTAMPS=false \ No newline at end of file From 86a353188b6cef534486e4f0f6e696f326d6b532 Mon Sep 17 00:00:00 2001 From: mzinchenko Date: Mon, 20 Nov 2017 16:14:04 +0300 Subject: [PATCH 3/5] Issue #4680 remove new lines --- .../resources/JavaSpring/pathParams.mustache | 2 +- .../java-play-framework/app/Module.java | 3 + .../app/apimodels/Category.java | 2 +- .../app/apimodels/ModelApiResponse.java | 2 +- .../app/apimodels/Order.java | 2 +- .../app/apimodels/Pet.java | 2 +- .../app/apimodels/Tag.java | 2 +- .../app/apimodels/User.java | 2 +- .../petstore/java-play-framework/conf/routes | 17 + .../java-play-framework/public/swagger.json | 1232 ++++++++++++++--- .../swagger/server/api/MainApiVerticle.java | 29 +- .../io/swagger/server/api/model/Category.java | 3 - .../server/api/model/ModelApiResponse.java | 3 - .../io/swagger/server/api/model/Order.java | 3 - .../java/io/swagger/server/api/model/Pet.java | 3 - .../java/io/swagger/server/api/model/Tag.java | 3 - .../io/swagger/server/api/model/User.java | 3 - .../server/api/verticle/StoreApiVerticle.java | 4 +- .../async/src/main/resources/swagger.json | 948 ++++++++++++- .../swagger/server/api/MainApiVerticle.java | 29 +- .../io/swagger/server/api/model/Category.java | 3 - .../server/api/model/ModelApiResponse.java | 3 - .../io/swagger/server/api/model/Order.java | 3 - .../java/io/swagger/server/api/model/Pet.java | 3 - .../java/io/swagger/server/api/model/Tag.java | 3 - .../io/swagger/server/api/model/User.java | 3 - .../server/api/verticle/StoreApiVerticle.java | 4 +- .../rx/src/main/resources/swagger.json | 948 ++++++++++++- .../java/io/swagger/api/AnotherFakeApi.java | 3 +- .../src/main/java/io/swagger/api/FakeApi.java | 48 +- .../io/swagger/api/FakeClassnameTestApi.java | 3 +- .../main/java/io/swagger/api/StoreApi.java | 8 +- .../SwaggerDocumentationConfig.java | 2 +- .../main/java/io/swagger/model/Category.java | 3 +- .../io/swagger/model/ModelApiResponse.java | 3 +- .../src/main/java/io/swagger/model/Order.java | 3 +- .../src/main/java/io/swagger/model/Pet.java | 3 +- .../src/main/java/io/swagger/model/Tag.java | 3 +- .../src/main/java/io/swagger/model/User.java | 3 +- samples/server/petstore/spring-mvc/pom.xml | 4 +- .../java/io/swagger/api/AnotherFakeApi.java | 3 +- .../swagger/api/AnotherFakeApiController.java | 3 +- .../src/main/java/io/swagger/api/FakeApi.java | 48 +- .../io/swagger/api/FakeApiController.java | 48 +- .../io/swagger/api/FakeClassnameTestApi.java | 3 +- .../api/FakeClassnameTestApiController.java | 3 +- .../main/java/io/swagger/api/StoreApi.java | 8 +- .../io/swagger/api/StoreApiController.java | 4 +- .../SwaggerDocumentationConfig.java | 2 +- .../main/java/io/swagger/model/Category.java | 3 +- .../io/swagger/model/ModelApiResponse.java | 3 +- .../src/main/java/io/swagger/model/Order.java | 3 +- .../src/main/java/io/swagger/model/Pet.java | 3 +- .../src/main/java/io/swagger/model/Tag.java | 3 +- .../src/main/java/io/swagger/model/User.java | 3 +- .../java/io/swagger/api/AnotherFakeApi.java | 3 +- .../swagger/api/AnotherFakeApiController.java | 3 +- .../src/main/java/io/swagger/api/FakeApi.java | 48 +- .../io/swagger/api/FakeApiController.java | 48 +- .../io/swagger/api/FakeClassnameTestApi.java | 3 +- .../api/FakeClassnameTestApiController.java | 3 +- .../main/java/io/swagger/api/StoreApi.java | 8 +- .../io/swagger/api/StoreApiController.java | 4 +- .../SwaggerDocumentationConfig.java | 2 +- .../main/java/io/swagger/model/Category.java | 3 +- .../io/swagger/model/ModelApiResponse.java | 3 +- .../src/main/java/io/swagger/model/Order.java | 3 +- .../src/main/java/io/swagger/model/Pet.java | 3 +- .../src/main/java/io/swagger/model/Tag.java | 3 +- .../src/main/java/io/swagger/model/User.java | 3 +- .../src/main/resources/application.properties | 2 +- 71 files changed, 3276 insertions(+), 356 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache b/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache index 27f5773b4e0..e433fa121a8 100644 --- a/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache +++ b/modules/swagger-codegen/src/main/resources/JavaSpring/pathParams.mustache @@ -1 +1 @@ -{{#isPathParam}}{{#useBeanValidation}}{{>beanValidationPathParams}}{{/useBeanValidation}}@ApiParam(value = "{{{description}}}"{{#required}},required=true{{/required}}{{#allowableValues}}, allowableValues = "{{#enumVars}}{{#lambdaEscapeDoubleQuote}}{{{value}}}{{/lambdaEscapeDoubleQuote}}{{^-last}}, {{/-last}}{{#-last}}{{/-last}}{{/enumVars}}"{{/allowableValues}}{{#defaultValue}}, defaultValue="{{{defaultValue}}}"{{/defaultValue}}) @PathVariable("{{baseName}}") {{>optionalDataType}} {{paramName}}{{/isPathParam}} +{{#isPathParam}}{{#useBeanValidation}}{{>beanValidationPathParams}}{{/useBeanValidation}}@ApiParam(value = "{{{description}}}"{{#required}},required=true{{/required}}{{#allowableValues}}, allowableValues = "{{#enumVars}}{{#lambdaEscapeDoubleQuote}}{{{value}}}{{/lambdaEscapeDoubleQuote}}{{^-last}}, {{/-last}}{{#-last}}{{/-last}}{{/enumVars}}"{{/allowableValues}}{{#defaultValue}}, defaultValue="{{{defaultValue}}}"{{/defaultValue}}) @PathVariable("{{baseName}}") {{>optionalDataType}} {{paramName}}{{/isPathParam}} \ No newline at end of file diff --git a/samples/server/petstore/java-play-framework/app/Module.java b/samples/server/petstore/java-play-framework/app/Module.java index f1b062c2934..eea2541f91c 100644 --- a/samples/server/petstore/java-play-framework/app/Module.java +++ b/samples/server/petstore/java-play-framework/app/Module.java @@ -6,6 +6,9 @@ public class Module extends AbstractModule { @Override protected void configure() { + bind(AnotherFakeApiControllerImpInterface.class).to(AnotherFakeApiControllerImp.class); + bind(FakeApiControllerImpInterface.class).to(FakeApiControllerImp.class); + bind(FakeClassnameTags123ApiControllerImpInterface.class).to(FakeClassnameTags123ApiControllerImp.class); bind(PetApiControllerImpInterface.class).to(PetApiControllerImp.class); bind(StoreApiControllerImpInterface.class).to(StoreApiControllerImp.class); bind(UserApiControllerImpInterface.class).to(UserApiControllerImp.class); diff --git a/samples/server/petstore/java-play-framework/app/apimodels/Category.java b/samples/server/petstore/java-play-framework/app/apimodels/Category.java index 9f0206575f5..c2a4222a8aa 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/Category.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/Category.java @@ -6,7 +6,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * A category for a pet + * Category */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/ModelApiResponse.java b/samples/server/petstore/java-play-framework/app/apimodels/ModelApiResponse.java index 07493e84825..a5505482e08 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/ModelApiResponse.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/ModelApiResponse.java @@ -6,7 +6,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * Describes the result of uploading an image resource + * ModelApiResponse */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/Order.java b/samples/server/petstore/java-play-framework/app/apimodels/Order.java index cdc21f722c9..50990892750 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/Order.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/Order.java @@ -7,7 +7,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * An order for a pets from the pet store + * Order */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/Pet.java b/samples/server/petstore/java-play-framework/app/apimodels/Pet.java index 5e5ff376294..aaa139c566d 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/Pet.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/Pet.java @@ -10,7 +10,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * A pet for sale in the pet store + * Pet */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/Tag.java b/samples/server/petstore/java-play-framework/app/apimodels/Tag.java index 15a8774252a..5426c883569 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/Tag.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/Tag.java @@ -6,7 +6,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * A tag for a pet + * Tag */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/User.java b/samples/server/petstore/java-play-framework/app/apimodels/User.java index 689de768893..0308cc92681 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/User.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/User.java @@ -6,7 +6,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * A User who is purchasing from the pet store + * User */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/conf/routes b/samples/server/petstore/java-play-framework/conf/routes index 775497a59fc..6a342645b5d 100644 --- a/samples/server/petstore/java-play-framework/conf/routes +++ b/samples/server/petstore/java-play-framework/conf/routes @@ -5,6 +5,23 @@ GET /api controllers.ApiDocController.api +#Functions for AnotherFake API +PATCH /v2/another-fake/dummy controllers.AnotherFakeApiController.testSpecialTags() + +#Functions for Fake API +POST /v2/fake/outer/boolean controllers.FakeApiController.fakeOuterBooleanSerialize() +POST /v2/fake/outer/composite controllers.FakeApiController.fakeOuterCompositeSerialize() +POST /v2/fake/outer/number controllers.FakeApiController.fakeOuterNumberSerialize() +POST /v2/fake/outer/string controllers.FakeApiController.fakeOuterStringSerialize() +PATCH /v2/fake controllers.FakeApiController.testClientModel() +POST /v2/fake controllers.FakeApiController.testEndpointParameters() +GET /v2/fake controllers.FakeApiController.testEnumParameters() +POST /v2/fake/inline-additionalProperties controllers.FakeApiController.testInlineAdditionalProperties() +GET /v2/fake/jsonFormData controllers.FakeApiController.testJsonFormData() + +#Functions for FakeClassnameTags123 API +PATCH /v2/fake_classname_test controllers.FakeClassnameTags123ApiController.testClassname() + #Functions for Pet API POST /v2/pet controllers.PetApiController.addPet() DELETE /v2/pet/:petId controllers.PetApiController.deletePet(petId: Long) diff --git a/samples/server/petstore/java-play-framework/public/swagger.json b/samples/server/petstore/java-play-framework/public/swagger.json index 7b8017053a1..8943dddcaa2 100644 --- a/samples/server/petstore/java-play-framework/public/swagger.json +++ b/samples/server/petstore/java-play-framework/public/swagger.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "description" : "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "description" : "This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\", "version" : "1.0.0", "title" : "Swagger Petstore", "termsOfService" : "http://swagger.io/terms/", @@ -13,7 +13,7 @@ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, - "host" : "petstore.swagger.io", + "host" : "petstore.swagger.io:80", "basePath" : "/v2", "tags" : [ { "name" : "pet", @@ -383,7 +383,7 @@ "x-accepts" : "application/json" } }, - "/store/order/{orderId}" : { + "/store/order/{order_id}" : { "get" : { "tags" : [ "store" ], "summary" : "Find purchase order by ID", @@ -391,7 +391,7 @@ "operationId" : "getOrderById", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "orderId", + "name" : "order_id", "in" : "path", "description" : "ID of pet that needs to be fetched", "required" : true, @@ -424,7 +424,7 @@ "operationId" : "deleteOrder", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "orderId", + "name" : "order_id", "in" : "path", "description" : "ID of the order that needs to be deleted", "required" : true, @@ -674,6 +674,478 @@ "x-contentType" : "application/json", "x-accepts" : "application/json" } + }, + "/fake_classname_test" : { + "patch" : { + "tags" : [ "fake_classname_tags 123#$%^" ], + "summary" : "To test class name in snake case", + "operationId" : "testClassname", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "client model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Client" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Client" + } + } + }, + "security" : [ { + "api_key_query" : [ ] + } ], + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake" : { + "get" : { + "tags" : [ "fake" ], + "summary" : "To test enum parameters", + "description" : "To test enum parameters", + "operationId" : "testEnumParameters", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "enum_form_string_array", + "in" : "formData", + "description" : "Form parameter enum test (string array)", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "default" : "$", + "enum" : [ ">", "$" ] + } + }, { + "name" : "enum_form_string", + "in" : "formData", + "description" : "Form parameter enum test (string)", + "required" : false, + "type" : "string", + "default" : "-efg", + "enum" : [ "_abc", "-efg", "(xyz)" ] + }, { + "name" : "enum_header_string_array", + "in" : "header", + "description" : "Header parameter enum test (string array)", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "default" : "$", + "enum" : [ ">", "$" ] + } + }, { + "name" : "enum_header_string", + "in" : "header", + "description" : "Header parameter enum test (string)", + "required" : false, + "type" : "string", + "default" : "-efg", + "enum" : [ "_abc", "-efg", "(xyz)" ] + }, { + "name" : "enum_query_string_array", + "in" : "query", + "description" : "Query parameter enum test (string array)", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "default" : "$", + "enum" : [ ">", "$" ] + } + }, { + "name" : "enum_query_string", + "in" : "query", + "description" : "Query parameter enum test (string)", + "required" : false, + "type" : "string", + "default" : "-efg", + "enum" : [ "_abc", "-efg", "(xyz)" ] + }, { + "name" : "enum_query_integer", + "in" : "query", + "description" : "Query parameter enum test (double)", + "required" : false, + "type" : "integer", + "format" : "int32", + "enum" : [ 1, -2 ] + }, { + "name" : "enum_query_double", + "in" : "formData", + "description" : "Query parameter enum test (double)", + "required" : false, + "type" : "number", + "format" : "double", + "enum" : [ 1.1, -1.2 ] + } ], + "responses" : { + "400" : { + "description" : "Invalid request" + }, + "404" : { + "description" : "Not found" + } + }, + "x-contentType" : "*/*", + "x-accepts" : "*/*" + }, + "post" : { + "tags" : [ "fake" ], + "summary" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", + "description" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", + "operationId" : "testEndpointParameters", + "consumes" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], + "produces" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], + "parameters" : [ { + "name" : "integer", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "integer", + "maximum" : 100, + "minimum" : 10 + }, { + "name" : "int32", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "integer", + "maximum" : 200, + "minimum" : 20, + "format" : "int32" + }, { + "name" : "int64", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "integer", + "format" : "int64" + }, { + "name" : "number", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "number", + "maximum" : 543.2, + "minimum" : 32.1 + }, { + "name" : "float", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "number", + "maximum" : 987.6, + "format" : "float" + }, { + "name" : "double", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "number", + "maximum" : 123.4, + "minimum" : 67.8, + "format" : "double" + }, { + "name" : "string", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "pattern" : "/[a-z]/i" + }, { + "name" : "pattern_without_delimiter", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "string", + "pattern" : "^[A-Z].*" + }, { + "name" : "byte", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "string", + "format" : "byte" + }, { + "name" : "binary", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "format" : "binary" + }, { + "name" : "date", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "format" : "date" + }, { + "name" : "dateTime", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "format" : "date-time" + }, { + "name" : "password", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "maxLength" : 64, + "minLength" : 10, + "format" : "password" + }, { + "name" : "callback", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string" + } ], + "responses" : { + "400" : { + "description" : "Invalid username supplied" + }, + "404" : { + "description" : "User not found" + } + }, + "security" : [ { + "http_basic_test" : [ ] + } ], + "x-contentType" : "application/xml; charset=utf-8", + "x-accepts" : "application/xml; charset=utf-8,application/json; charset=utf-8" + }, + "patch" : { + "tags" : [ "fake" ], + "summary" : "To test \"client\" model", + "description" : "To test \"client\" model", + "operationId" : "testClientModel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "client model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Client" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Client" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/number" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of outer number types", + "operationId" : "fakeOuterNumberSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input number as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterNumber" + } + } ], + "responses" : { + "200" : { + "description" : "Output number", + "schema" : { + "$ref" : "#/definitions/OuterNumber" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json", + "missingReturnInfoIfNeeded" : "1.0" + } + }, + "/fake/outer/string" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of outer string types", + "operationId" : "fakeOuterStringSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input string as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterString" + } + } ], + "responses" : { + "200" : { + "description" : "Output string", + "schema" : { + "$ref" : "#/definitions/OuterString" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/boolean" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of outer boolean types", + "operationId" : "fakeOuterBooleanSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input boolean as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterBoolean" + } + } ], + "responses" : { + "200" : { + "description" : "Output boolean", + "schema" : { + "$ref" : "#/definitions/OuterBoolean" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json", + "missingReturnInfoIfNeeded" : "true" + } + }, + "/fake/outer/composite" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of object with outer number type", + "operationId" : "fakeOuterCompositeSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input composite as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterComposite" + } + } ], + "responses" : { + "200" : { + "description" : "Output composite", + "schema" : { + "$ref" : "#/definitions/OuterComposite" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/jsonFormData" : { + "get" : { + "tags" : [ "fake" ], + "summary" : "test json serialization of form data", + "description" : "", + "operationId" : "testJsonFormData", + "consumes" : [ "application/json" ], + "parameters" : [ { + "name" : "param", + "in" : "formData", + "description" : "field1", + "required" : true, + "type" : "string" + }, { + "name" : "param2", + "in" : "formData", + "description" : "field2", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation" + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/inline-additionalProperties" : { + "post" : { + "tags" : [ "fake" ], + "summary" : "test inline additionalProperties", + "description" : "", + "operationId" : "testInlineAdditionalProperties", + "consumes" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "param", + "description" : "request body", + "required" : true, + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation" + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/another-fake/dummy" : { + "patch" : { + "tags" : [ "$another-fake?" ], + "summary" : "To test special tags", + "description" : "To test special tags", + "operationId" : "test_special_tags", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "client model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Client" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Client" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } } }, "securityDefinitions" : { @@ -686,230 +1158,678 @@ "read:pets" : "read your pets" } }, - "api_key" : { - "type" : "apiKey", - "name" : "api_key", - "in" : "header" - } - }, - "definitions" : { - "Order" : { + "api_key" : { + "type" : "apiKey", + "name" : "api_key", + "in" : "header" + }, + "api_key_query" : { + "type" : "apiKey", + "name" : "api_key_query", + "in" : "query" + }, + "http_basic_test" : { + "type" : "basic" + } + }, + "definitions" : { + "Order" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "petId" : { + "type" : "integer", + "format" : "int64" + }, + "quantity" : { + "type" : "integer", + "format" : "int32" + }, + "shipDate" : { + "type" : "string", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "Order Status", + "enum" : [ "placed", "approved", "delivered" ] + }, + "complete" : { + "type" : "boolean", + "default" : false + } + }, + "example" : { + "petId" : 6, + "quantity" : 1, + "id" : 0, + "shipDate" : "2000-01-23T04:56:07.000+00:00", + "complete" : false, + "status" : "placed" + }, + "xml" : { + "name" : "Order" + } + }, + "Category" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + } + }, + "example" : { + "name" : "name", + "id" : 6 + }, + "xml" : { + "name" : "Category" + } + }, + "User" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "x-is-unique" : true + }, + "username" : { + "type" : "string" + }, + "firstName" : { + "type" : "string" + }, + "lastName" : { + "type" : "string" + }, + "email" : { + "type" : "string" + }, + "password" : { + "type" : "string" + }, + "phone" : { + "type" : "string" + }, + "userStatus" : { + "type" : "integer", + "format" : "int32", + "description" : "User Status" + } + }, + "example" : { + "firstName" : "firstName", + "lastName" : "lastName", + "password" : "password", + "userStatus" : 6, + "phone" : "phone", + "id" : 0, + "email" : "email", + "username" : "username" + }, + "xml" : { + "name" : "User" + } + }, + "Tag" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + } + }, + "example" : { + "name" : "name", + "id" : 1 + }, + "xml" : { + "name" : "Tag" + } + }, + "Pet" : { + "type" : "object", + "required" : [ "name", "photoUrls" ], + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "x-is-unique" : true + }, + "category" : { + "$ref" : "#/definitions/Category" + }, + "name" : { + "type" : "string", + "example" : "doggie" + }, + "photoUrls" : { + "type" : "array", + "xml" : { + "name" : "photoUrl", + "wrapped" : true + }, + "items" : { + "type" : "string" + } + }, + "tags" : { + "type" : "array", + "xml" : { + "name" : "tag", + "wrapped" : true + }, + "items" : { + "$ref" : "#/definitions/Tag" + } + }, + "status" : { + "type" : "string", + "description" : "pet status in the store", + "enum" : [ "available", "pending", "sold" ] + } + }, + "example" : { + "photoUrls" : [ "photoUrls", "photoUrls" ], + "name" : "doggie", + "id" : 0, + "category" : { + "name" : "name", + "id" : 6 + }, + "tags" : [ { + "name" : "name", + "id" : 1 + }, { + "name" : "name", + "id" : 1 + } ], + "status" : "available" + }, + "xml" : { + "name" : "Pet" + } + }, + "ApiResponse" : { + "type" : "object", + "properties" : { + "code" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string" + }, + "message" : { + "type" : "string" + } + }, + "example" : { + "code" : 0, + "type" : "type", + "message" : "message" + } + }, + "$special[model.name]" : { + "properties" : { + "$special[property.name]" : { + "type" : "integer", + "format" : "int64" + } + }, + "xml" : { + "name" : "$special[model.name]" + } + }, + "Return" : { + "properties" : { + "return" : { + "type" : "integer", + "format" : "int32" + } + }, + "description" : "Model for testing reserved words", + "xml" : { + "name" : "Return" + } + }, + "Name" : { + "required" : [ "name" ], + "properties" : { + "name" : { + "type" : "integer", + "format" : "int32" + }, + "snake_case" : { + "type" : "integer", + "format" : "int32", + "readOnly" : true + }, + "property" : { + "type" : "string" + }, + "123Number" : { + "type" : "integer", + "readOnly" : true + } + }, + "description" : "Model for testing model name same as property name", + "xml" : { + "name" : "Name" + } + }, + "200_response" : { + "properties" : { + "name" : { + "type" : "integer", + "format" : "int32" + }, + "class" : { + "type" : "string" + } + }, + "description" : "Model for testing model name starting with number", + "xml" : { + "name" : "Name" + } + }, + "ClassModel" : { + "properties" : { + "_class" : { + "type" : "string" + } + }, + "description" : "Model for testing model with \"_class\" property" + }, + "Dog" : { + "allOf" : [ { + "$ref" : "#/definitions/Animal" + }, { + "type" : "object", + "properties" : { + "breed" : { + "type" : "string" + } + } + } ] + }, + "Cat" : { + "allOf" : [ { + "$ref" : "#/definitions/Animal" + }, { + "type" : "object", + "properties" : { + "declawed" : { + "type" : "boolean" + } + } + } ] + }, + "Animal" : { + "type" : "object", + "required" : [ "className" ], + "discriminator" : "className", + "properties" : { + "className" : { + "type" : "string" + }, + "color" : { + "type" : "string", + "default" : "red" + } + } + }, + "AnimalFarm" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Animal" + } + }, + "format_test" : { "type" : "object", + "required" : [ "byte", "date", "number", "password" ], "properties" : { - "id" : { + "integer" : { "type" : "integer", - "format" : "int64" + "minimum" : 10, + "maximum" : 100 }, - "petId" : { + "int32" : { "type" : "integer", - "format" : "int64" + "format" : "int32", + "minimum" : 20, + "maximum" : 200 }, - "quantity" : { + "int64" : { "type" : "integer", - "format" : "int32" + "format" : "int64" }, - "shipDate" : { + "number" : { + "type" : "number", + "minimum" : 32.1, + "maximum" : 543.2 + }, + "float" : { + "type" : "number", + "format" : "float", + "minimum" : 54.3, + "maximum" : 987.6 + }, + "double" : { + "type" : "number", + "format" : "double", + "minimum" : 67.8, + "maximum" : 123.4 + }, + "string" : { + "type" : "string", + "pattern" : "/[a-z]/i" + }, + "byte" : { + "type" : "string", + "format" : "byte", + "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" + }, + "binary" : { + "type" : "string", + "format" : "binary" + }, + "date" : { + "type" : "string", + "format" : "date" + }, + "dateTime" : { "type" : "string", "format" : "date-time" }, - "status" : { + "uuid" : { "type" : "string", - "description" : "Order Status", - "enum" : [ "placed", "approved", "delivered" ] + "format" : "uuid" }, - "complete" : { - "type" : "boolean", - "default" : false + "password" : { + "type" : "string", + "format" : "password", + "minLength" : 10, + "maxLength" : 64 } - }, - "title" : "Pet Order", - "description" : "An order for a pets from the pet store", - "example" : { - "petId" : 6, - "quantity" : 1, - "id" : 0, - "shipDate" : "2000-01-23T04:56:07.000+00:00", - "complete" : false, - "status" : "placed" - }, - "xml" : { - "name" : "Order" } }, - "Category" : { + "EnumClass" : { + "type" : "string", + "enum" : [ "_abc", "-efg", "(xyz)" ], + "default" : "-efg" + }, + "Enum_Test" : { "type" : "object", "properties" : { - "id" : { + "enum_string" : { + "type" : "string", + "enum" : [ "UPPER", "lower", "" ] + }, + "enum_integer" : { "type" : "integer", - "format" : "int64" + "format" : "int32", + "enum" : [ 1, -1 ] }, - "name" : { + "enum_number" : { + "type" : "number", + "format" : "double", + "enum" : [ 1.1, -1.2 ] + }, + "outerEnum" : { + "$ref" : "#/definitions/OuterEnum" + } + } + }, + "AdditionalPropertiesClass" : { + "type" : "object", + "properties" : { + "map_property" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "map_of_map_property" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + } + } + }, + "MixedPropertiesAndAdditionalPropertiesClass" : { + "type" : "object", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "uuid" + }, + "dateTime" : { + "type" : "string", + "format" : "date-time" + }, + "map" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/definitions/Animal" + } + } + } + }, + "List" : { + "type" : "object", + "properties" : { + "123-list" : { + "type" : "string" + } + } + }, + "Client" : { + "type" : "object", + "properties" : { + "client" : { "type" : "string" } }, - "title" : "Pet catehgry", - "description" : "A category for a pet", "example" : { - "name" : "name", - "id" : 6 - }, - "xml" : { - "name" : "Category" + "client" : "client" } }, - "User" : { + "ReadOnlyFirst" : { "type" : "object", "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" + "bar" : { + "type" : "string", + "readOnly" : true }, - "username" : { + "baz" : { "type" : "string" + } + } + }, + "hasOnlyReadOnly" : { + "type" : "object", + "properties" : { + "bar" : { + "type" : "string", + "readOnly" : true }, - "firstName" : { + "foo" : { + "type" : "string", + "readOnly" : true + } + } + }, + "Capitalization" : { + "type" : "object", + "properties" : { + "smallCamel" : { "type" : "string" }, - "lastName" : { + "CapitalCamel" : { "type" : "string" }, - "email" : { + "small_Snake" : { "type" : "string" }, - "password" : { + "Capital_Snake" : { "type" : "string" }, - "phone" : { + "SCA_ETH_Flow_Points" : { "type" : "string" }, - "userStatus" : { - "type" : "integer", - "format" : "int32", - "description" : "User Status" + "ATT_NAME" : { + "type" : "string", + "description" : "Name of the pet\n" } - }, - "title" : "a User", - "description" : "A User who is purchasing from the pet store", - "example" : { - "firstName" : "firstName", - "lastName" : "lastName", - "password" : "password", - "userStatus" : 6, - "phone" : "phone", - "id" : 0, - "email" : "email", - "username" : "username" - }, - "xml" : { - "name" : "User" } }, - "Tag" : { + "MapTest" : { "type" : "object", "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" + "map_map_of_string" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } }, - "name" : { - "type" : "string" + "map_of_enum_string" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "enum" : [ "UPPER", "lower" ] + } } - }, - "title" : "Pet Tag", - "description" : "A tag for a pet", - "example" : { - "name" : "name", - "id" : 1 - }, - "xml" : { - "name" : "Tag" } }, - "Pet" : { + "ArrayTest" : { "type" : "object", - "required" : [ "name", "photoUrls" ], "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "category" : { - "$ref" : "#/definitions/Category" - }, - "name" : { - "type" : "string", - "example" : "doggie" - }, - "photoUrls" : { + "array_of_string" : { "type" : "array", - "xml" : { - "name" : "photoUrl", - "wrapped" : true - }, "items" : { "type" : "string" } }, - "tags" : { + "array_array_of_integer" : { "type" : "array", - "xml" : { - "name" : "tag", - "wrapped" : true - }, "items" : { - "$ref" : "#/definitions/Tag" + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int64" + } } }, - "status" : { - "type" : "string", - "description" : "pet status in the store", - "enum" : [ "available", "pending", "sold" ] + "array_array_of_model" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ReadOnlyFirst" + } + } } - }, - "title" : "a Pet", - "description" : "A pet for sale in the pet store", - "example" : { - "photoUrls" : [ "photoUrls", "photoUrls" ], - "name" : "doggie", - "id" : 0, - "category" : { - "name" : "name", - "id" : 6 + } + }, + "NumberOnly" : { + "type" : "object", + "properties" : { + "JustNumber" : { + "type" : "number" + } + } + }, + "ArrayOfNumberOnly" : { + "type" : "object", + "properties" : { + "ArrayNumber" : { + "type" : "array", + "items" : { + "type" : "number" + } + } + } + }, + "ArrayOfArrayOfNumberOnly" : { + "type" : "object", + "properties" : { + "ArrayArrayNumber" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "type" : "number" + } + } + } + } + }, + "EnumArrays" : { + "type" : "object", + "properties" : { + "just_symbol" : { + "type" : "string", + "enum" : [ ">=", "$" ] }, - "tags" : [ { - "name" : "name", - "id" : 1 - }, { - "name" : "name", - "id" : 1 - } ], - "status" : "available" - }, - "xml" : { - "name" : "Pet" + "array_enum" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "fish", "crab" ] + } + } } }, - "ApiResponse" : { + "OuterEnum" : { + "type" : "string", + "enum" : [ "placed", "approved", "delivered" ] + }, + "OuterComposite" : { "type" : "object", "properties" : { - "code" : { - "type" : "integer", - "format" : "int32" + "my_number" : { + "$ref" : "#/definitions/OuterNumber" }, - "type" : { - "type" : "string" + "my_string" : { + "$ref" : "#/definitions/OuterString" }, - "message" : { - "type" : "string" + "my_boolean" : { + "$ref" : "#/definitions/OuterBoolean" } }, - "title" : "An uploaded response", - "description" : "Describes the result of uploading an image resource", "example" : { - "code" : 0, - "type" : "type", - "message" : "message" + "my_string" : { }, + "my_number" : { }, + "my_boolean" : { } } + }, + "OuterNumber" : { + "type" : "number" + }, + "OuterString" : { + "type" : "string" + }, + "OuterBoolean" : { + "type" : "boolean" } }, "externalDocs" : { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/MainApiVerticle.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/MainApiVerticle.java index 8fb3ae2f3cf..5939adbb1a9 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/MainApiVerticle.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/MainApiVerticle.java @@ -34,7 +34,7 @@ public void start(Future startFuture) throws Exception { vertx.createHttpServer() .requestHandler(swaggerRouter::accept) - .listen(8080); + .listen(80); startFuture.complete(); } else { startFuture.fail(readFile.cause()); @@ -44,6 +44,33 @@ public void start(Future startFuture) throws Exception { public void deployVerticles(Future startFuture) { + vertx.deployVerticle("io.swagger.server.api.verticle.AnotherFakeApiVerticle", res -> { + if (res.succeeded()) { + LOGGER.info("AnotherFakeApiVerticle : Deployed"); + } else { + startFuture.fail(res.cause()); + LOGGER.error("AnotherFakeApiVerticle : Deployement failed"); + } + }); + + vertx.deployVerticle("io.swagger.server.api.verticle.FakeApiVerticle", res -> { + if (res.succeeded()) { + LOGGER.info("FakeApiVerticle : Deployed"); + } else { + startFuture.fail(res.cause()); + LOGGER.error("FakeApiVerticle : Deployement failed"); + } + }); + + vertx.deployVerticle("io.swagger.server.api.verticle.FakeClassnameTags123ApiVerticle", res -> { + if (res.succeeded()) { + LOGGER.info("FakeClassnameTags123ApiVerticle : Deployed"); + } else { + startFuture.fail(res.cause()); + LOGGER.error("FakeClassnameTags123ApiVerticle : Deployement failed"); + } + }); + vertx.deployVerticle("io.swagger.server.api.verticle.PetApiVerticle", res -> { if (res.succeeded()) { LOGGER.info("PetApiVerticle : Deployed"); diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Category.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Category.java index 10659635427..fd984611ff5 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Category.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Category.java @@ -4,9 +4,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -/** - * A category for a pet - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Category { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/ModelApiResponse.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/ModelApiResponse.java index ef5261c7edb..747d3aafa88 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/ModelApiResponse.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/ModelApiResponse.java @@ -4,9 +4,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -/** - * Describes the result of uploading an image resource - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class ModelApiResponse { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java index 0eaaa46f352..c31f74d27bb 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java @@ -6,9 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue; import java.time.OffsetDateTime; -/** - * An order for a pets from the pet store - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Order { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java index e975a8dc2b2..1062b2295d6 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java @@ -9,9 +9,6 @@ import java.util.ArrayList; import java.util.List; -/** - * A pet for sale in the pet store - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Pet { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Tag.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Tag.java index f00a458e3d7..ce22ddfc29a 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Tag.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Tag.java @@ -4,9 +4,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -/** - * A tag for a pet - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Tag { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/User.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/User.java index 6e7331cd236..1d000fde501 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/User.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/User.java @@ -4,9 +4,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -/** - * A User who is purchasing from the pet store - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class User { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java index 9299a08e013..5261eedbf70 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java @@ -31,7 +31,7 @@ public void start() throws Exception { //Consumer for deleteOrder vertx.eventBus(). consumer(DELETEORDER_SERVICE_ID).handler(message -> { try { - String orderId = message.body().getString("orderId"); + String orderId = message.body().getString("order_id"); service.deleteOrder(orderId, result -> { if (result.succeeded()) message.reply(null); @@ -66,7 +66,7 @@ public void start() throws Exception { //Consumer for getOrderById vertx.eventBus(). consumer(GETORDERBYID_SERVICE_ID).handler(message -> { try { - Long orderId = Json.mapper.readValue(message.body().getString("orderId"), Long.class); + Long orderId = Json.mapper.readValue(message.body().getString("order_id"), Long.class); service.getOrderById(orderId, result -> { if (result.succeeded()) message.reply(new JsonObject(Json.encode(result.result())).encodePrettily()); diff --git a/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json b/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json index cc8c2b7d468..c977405fb28 100644 --- a/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json +++ b/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "description" : "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "description" : "This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\", "version" : "1.0.0", "title" : "Swagger Petstore", "termsOfService" : "http://swagger.io/terms/", @@ -13,7 +13,7 @@ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, - "host" : "petstore.swagger.io", + "host" : "petstore.swagger.io:80", "basePath" : "/v2", "tags" : [ { "name" : "pet", @@ -383,7 +383,7 @@ "x-accepts" : "application/json" } }, - "/store/order/{orderId}" : { + "/store/order/{order_id}" : { "get" : { "tags" : [ "store" ], "summary" : "Find purchase order by ID", @@ -391,7 +391,7 @@ "operationId" : "getOrderById", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "orderId", + "name" : "order_id", "in" : "path", "description" : "ID of pet that needs to be fetched", "required" : true, @@ -424,7 +424,7 @@ "operationId" : "deleteOrder", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "orderId", + "name" : "order_id", "in" : "path", "description" : "ID of the order that needs to be deleted", "required" : true, @@ -674,6 +674,476 @@ "x-contentType" : "application/json", "x-accepts" : "application/json" } + }, + "/fake_classname_test" : { + "patch" : { + "tags" : [ "fake_classname_tags 123#$%^" ], + "summary" : "To test class name in snake case", + "operationId" : "testClassname", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "client model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Client" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Client" + } + } + }, + "security" : [ { + "api_key_query" : [ ] + } ], + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake" : { + "get" : { + "tags" : [ "fake" ], + "summary" : "To test enum parameters", + "description" : "To test enum parameters", + "operationId" : "testEnumParameters", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "enum_form_string_array", + "in" : "formData", + "description" : "Form parameter enum test (string array)", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "default" : "$", + "enum" : [ ">", "$" ] + } + }, { + "name" : "enum_form_string", + "in" : "formData", + "description" : "Form parameter enum test (string)", + "required" : false, + "type" : "string", + "default" : "-efg", + "enum" : [ "_abc", "-efg", "(xyz)" ] + }, { + "name" : "enum_header_string_array", + "in" : "header", + "description" : "Header parameter enum test (string array)", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "default" : "$", + "enum" : [ ">", "$" ] + } + }, { + "name" : "enum_header_string", + "in" : "header", + "description" : "Header parameter enum test (string)", + "required" : false, + "type" : "string", + "default" : "-efg", + "enum" : [ "_abc", "-efg", "(xyz)" ] + }, { + "name" : "enum_query_string_array", + "in" : "query", + "description" : "Query parameter enum test (string array)", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "default" : "$", + "enum" : [ ">", "$" ] + } + }, { + "name" : "enum_query_string", + "in" : "query", + "description" : "Query parameter enum test (string)", + "required" : false, + "type" : "string", + "default" : "-efg", + "enum" : [ "_abc", "-efg", "(xyz)" ] + }, { + "name" : "enum_query_integer", + "in" : "query", + "description" : "Query parameter enum test (double)", + "required" : false, + "type" : "integer", + "format" : "int32", + "enum" : [ 1, -2 ] + }, { + "name" : "enum_query_double", + "in" : "formData", + "description" : "Query parameter enum test (double)", + "required" : false, + "type" : "number", + "format" : "double", + "enum" : [ 1.1, -1.2 ] + } ], + "responses" : { + "400" : { + "description" : "Invalid request" + }, + "404" : { + "description" : "Not found" + } + }, + "x-contentType" : "*/*", + "x-accepts" : "*/*" + }, + "post" : { + "tags" : [ "fake" ], + "summary" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", + "description" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", + "operationId" : "testEndpointParameters", + "consumes" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], + "produces" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], + "parameters" : [ { + "name" : "integer", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "integer", + "maximum" : 100, + "minimum" : 10 + }, { + "name" : "int32", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "integer", + "maximum" : 200, + "minimum" : 20, + "format" : "int32" + }, { + "name" : "int64", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "integer", + "format" : "int64" + }, { + "name" : "number", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "number", + "maximum" : 543.2, + "minimum" : 32.1 + }, { + "name" : "float", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "number", + "maximum" : 987.6, + "format" : "float" + }, { + "name" : "double", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "number", + "maximum" : 123.4, + "minimum" : 67.8, + "format" : "double" + }, { + "name" : "string", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "pattern" : "/[a-z]/i" + }, { + "name" : "pattern_without_delimiter", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "string", + "pattern" : "^[A-Z].*" + }, { + "name" : "byte", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "string", + "format" : "byte" + }, { + "name" : "binary", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "format" : "binary" + }, { + "name" : "date", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "format" : "date" + }, { + "name" : "dateTime", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "format" : "date-time" + }, { + "name" : "password", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "maxLength" : 64, + "minLength" : 10, + "format" : "password" + }, { + "name" : "callback", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string" + } ], + "responses" : { + "400" : { + "description" : "Invalid username supplied" + }, + "404" : { + "description" : "User not found" + } + }, + "security" : [ { + "http_basic_test" : [ ] + } ], + "x-contentType" : "application/xml; charset=utf-8", + "x-accepts" : "application/xml; charset=utf-8,application/json; charset=utf-8" + }, + "patch" : { + "tags" : [ "fake" ], + "summary" : "To test \"client\" model", + "description" : "To test \"client\" model", + "operationId" : "testClientModel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "client model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Client" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Client" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/number" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of outer number types", + "operationId" : "fakeOuterNumberSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input number as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterNumber" + } + } ], + "responses" : { + "200" : { + "description" : "Output number", + "schema" : { + "$ref" : "#/definitions/OuterNumber" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/string" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of outer string types", + "operationId" : "fakeOuterStringSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input string as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterString" + } + } ], + "responses" : { + "200" : { + "description" : "Output string", + "schema" : { + "$ref" : "#/definitions/OuterString" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/boolean" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of outer boolean types", + "operationId" : "fakeOuterBooleanSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input boolean as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterBoolean" + } + } ], + "responses" : { + "200" : { + "description" : "Output boolean", + "schema" : { + "$ref" : "#/definitions/OuterBoolean" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/composite" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of object with outer number type", + "operationId" : "fakeOuterCompositeSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input composite as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterComposite" + } + } ], + "responses" : { + "200" : { + "description" : "Output composite", + "schema" : { + "$ref" : "#/definitions/OuterComposite" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/jsonFormData" : { + "get" : { + "tags" : [ "fake" ], + "summary" : "test json serialization of form data", + "description" : "", + "operationId" : "testJsonFormData", + "consumes" : [ "application/json" ], + "parameters" : [ { + "name" : "param", + "in" : "formData", + "description" : "field1", + "required" : true, + "type" : "string" + }, { + "name" : "param2", + "in" : "formData", + "description" : "field2", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation" + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/inline-additionalProperties" : { + "post" : { + "tags" : [ "fake" ], + "summary" : "test inline additionalProperties", + "description" : "", + "operationId" : "testInlineAdditionalProperties", + "consumes" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "param", + "description" : "request body", + "required" : true, + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation" + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/another-fake/dummy" : { + "patch" : { + "tags" : [ "$another-fake?" ], + "summary" : "To test special tags", + "description" : "To test special tags", + "operationId" : "test_special_tags", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "client model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Client" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Client" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } } }, "securityDefinitions" : { @@ -690,6 +1160,14 @@ "type" : "apiKey", "name" : "api_key", "in" : "header" + }, + "api_key_query" : { + "type" : "apiKey", + "name" : "api_key_query", + "in" : "query" + }, + "http_basic_test" : { + "type" : "basic" } }, "definitions" : { @@ -722,8 +1200,6 @@ "default" : false } }, - "title" : "Pet Order", - "description" : "An order for a pets from the pet store", "xml" : { "name" : "Order" } @@ -739,8 +1215,6 @@ "type" : "string" } }, - "title" : "Pet catehgry", - "description" : "A category for a pet", "xml" : { "name" : "Category" } @@ -750,7 +1224,8 @@ "properties" : { "id" : { "type" : "integer", - "format" : "int64" + "format" : "int64", + "x-is-unique" : true }, "username" : { "type" : "string" @@ -776,8 +1251,6 @@ "description" : "User Status" } }, - "title" : "a User", - "description" : "A User who is purchasing from the pet store", "xml" : { "name" : "User" } @@ -793,8 +1266,6 @@ "type" : "string" } }, - "title" : "Pet Tag", - "description" : "A tag for a pet", "xml" : { "name" : "Tag" } @@ -805,7 +1276,8 @@ "properties" : { "id" : { "type" : "integer", - "format" : "int64" + "format" : "int64", + "x-is-unique" : true }, "category" : { "$ref" : "#/definitions/Category" @@ -840,8 +1312,6 @@ "enum" : [ "available", "pending", "sold" ] } }, - "title" : "a Pet", - "description" : "A pet for sale in the pet store", "xml" : { "name" : "Pet" } @@ -859,9 +1329,449 @@ "message" : { "type" : "string" } + } + }, + "$special[model.name]" : { + "properties" : { + "$special[property.name]" : { + "type" : "integer", + "format" : "int64" + } + }, + "xml" : { + "name" : "$special[model.name]" + } + }, + "Return" : { + "properties" : { + "return" : { + "type" : "integer", + "format" : "int32" + } + }, + "description" : "Model for testing reserved words", + "xml" : { + "name" : "Return" + } + }, + "Name" : { + "required" : [ "name" ], + "properties" : { + "name" : { + "type" : "integer", + "format" : "int32" + }, + "snake_case" : { + "type" : "integer", + "format" : "int32", + "readOnly" : true + }, + "property" : { + "type" : "string" + }, + "123Number" : { + "type" : "integer", + "readOnly" : true + } + }, + "description" : "Model for testing model name same as property name", + "xml" : { + "name" : "Name" + } + }, + "200_response" : { + "properties" : { + "name" : { + "type" : "integer", + "format" : "int32" + }, + "class" : { + "type" : "string" + } + }, + "description" : "Model for testing model name starting with number", + "xml" : { + "name" : "Name" + } + }, + "ClassModel" : { + "properties" : { + "_class" : { + "type" : "string" + } }, - "title" : "An uploaded response", - "description" : "Describes the result of uploading an image resource" + "description" : "Model for testing model with \"_class\" property" + }, + "Dog" : { + "allOf" : [ { + "$ref" : "#/definitions/Animal" + }, { + "type" : "object", + "properties" : { + "breed" : { + "type" : "string" + } + } + } ] + }, + "Cat" : { + "allOf" : [ { + "$ref" : "#/definitions/Animal" + }, { + "type" : "object", + "properties" : { + "declawed" : { + "type" : "boolean" + } + } + } ] + }, + "Animal" : { + "type" : "object", + "required" : [ "className" ], + "discriminator" : "className", + "properties" : { + "className" : { + "type" : "string" + }, + "color" : { + "type" : "string", + "default" : "red" + } + } + }, + "AnimalFarm" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Animal" + } + }, + "format_test" : { + "type" : "object", + "required" : [ "byte", "date", "number", "password" ], + "properties" : { + "integer" : { + "type" : "integer", + "minimum" : 10, + "maximum" : 100 + }, + "int32" : { + "type" : "integer", + "format" : "int32", + "minimum" : 20, + "maximum" : 200 + }, + "int64" : { + "type" : "integer", + "format" : "int64" + }, + "number" : { + "type" : "number", + "minimum" : 32.1, + "maximum" : 543.2 + }, + "float" : { + "type" : "number", + "format" : "float", + "minimum" : 54.3, + "maximum" : 987.6 + }, + "double" : { + "type" : "number", + "format" : "double", + "minimum" : 67.8, + "maximum" : 123.4 + }, + "string" : { + "type" : "string", + "pattern" : "/[a-z]/i" + }, + "byte" : { + "type" : "string", + "format" : "byte", + "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" + }, + "binary" : { + "type" : "string", + "format" : "binary" + }, + "date" : { + "type" : "string", + "format" : "date" + }, + "dateTime" : { + "type" : "string", + "format" : "date-time" + }, + "uuid" : { + "type" : "string", + "format" : "uuid" + }, + "password" : { + "type" : "string", + "format" : "password", + "minLength" : 10, + "maxLength" : 64 + } + } + }, + "EnumClass" : { + "type" : "string", + "enum" : [ "_abc", "-efg", "(xyz)" ], + "default" : "-efg" + }, + "Enum_Test" : { + "type" : "object", + "properties" : { + "enum_string" : { + "type" : "string", + "enum" : [ "UPPER", "lower", "" ] + }, + "enum_integer" : { + "type" : "integer", + "format" : "int32", + "enum" : [ 1, -1 ] + }, + "enum_number" : { + "type" : "number", + "format" : "double", + "enum" : [ 1.1, -1.2 ] + }, + "outerEnum" : { + "$ref" : "#/definitions/OuterEnum" + } + } + }, + "AdditionalPropertiesClass" : { + "type" : "object", + "properties" : { + "map_property" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "map_of_map_property" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + } + } + }, + "MixedPropertiesAndAdditionalPropertiesClass" : { + "type" : "object", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "uuid" + }, + "dateTime" : { + "type" : "string", + "format" : "date-time" + }, + "map" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/definitions/Animal" + } + } + } + }, + "List" : { + "type" : "object", + "properties" : { + "123-list" : { + "type" : "string" + } + } + }, + "Client" : { + "type" : "object", + "properties" : { + "client" : { + "type" : "string" + } + } + }, + "ReadOnlyFirst" : { + "type" : "object", + "properties" : { + "bar" : { + "type" : "string", + "readOnly" : true + }, + "baz" : { + "type" : "string" + } + } + }, + "hasOnlyReadOnly" : { + "type" : "object", + "properties" : { + "bar" : { + "type" : "string", + "readOnly" : true + }, + "foo" : { + "type" : "string", + "readOnly" : true + } + } + }, + "Capitalization" : { + "type" : "object", + "properties" : { + "smallCamel" : { + "type" : "string" + }, + "CapitalCamel" : { + "type" : "string" + }, + "small_Snake" : { + "type" : "string" + }, + "Capital_Snake" : { + "type" : "string" + }, + "SCA_ETH_Flow_Points" : { + "type" : "string" + }, + "ATT_NAME" : { + "type" : "string", + "description" : "Name of the pet\n" + } + } + }, + "MapTest" : { + "type" : "object", + "properties" : { + "map_map_of_string" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + }, + "map_of_enum_string" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "enum" : [ "UPPER", "lower" ] + } + } + } + }, + "ArrayTest" : { + "type" : "object", + "properties" : { + "array_of_string" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "array_array_of_integer" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "array_array_of_model" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ReadOnlyFirst" + } + } + } + } + }, + "NumberOnly" : { + "type" : "object", + "properties" : { + "JustNumber" : { + "type" : "number" + } + } + }, + "ArrayOfNumberOnly" : { + "type" : "object", + "properties" : { + "ArrayNumber" : { + "type" : "array", + "items" : { + "type" : "number" + } + } + } + }, + "ArrayOfArrayOfNumberOnly" : { + "type" : "object", + "properties" : { + "ArrayArrayNumber" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "type" : "number" + } + } + } + } + }, + "EnumArrays" : { + "type" : "object", + "properties" : { + "just_symbol" : { + "type" : "string", + "enum" : [ ">=", "$" ] + }, + "array_enum" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "fish", "crab" ] + } + } + } + }, + "OuterEnum" : { + "type" : "string", + "enum" : [ "placed", "approved", "delivered" ] + }, + "OuterComposite" : { + "type" : "object", + "properties" : { + "my_number" : { + "$ref" : "#/definitions/OuterNumber" + }, + "my_string" : { + "$ref" : "#/definitions/OuterString" + }, + "my_boolean" : { + "$ref" : "#/definitions/OuterBoolean" + } + } + }, + "OuterNumber" : { + "type" : "number" + }, + "OuterString" : { + "type" : "string" + }, + "OuterBoolean" : { + "type" : "boolean" } }, "externalDocs" : { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/MainApiVerticle.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/MainApiVerticle.java index 8fb3ae2f3cf..5939adbb1a9 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/MainApiVerticle.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/MainApiVerticle.java @@ -34,7 +34,7 @@ public void start(Future startFuture) throws Exception { vertx.createHttpServer() .requestHandler(swaggerRouter::accept) - .listen(8080); + .listen(80); startFuture.complete(); } else { startFuture.fail(readFile.cause()); @@ -44,6 +44,33 @@ public void start(Future startFuture) throws Exception { public void deployVerticles(Future startFuture) { + vertx.deployVerticle("io.swagger.server.api.verticle.AnotherFakeApiVerticle", res -> { + if (res.succeeded()) { + LOGGER.info("AnotherFakeApiVerticle : Deployed"); + } else { + startFuture.fail(res.cause()); + LOGGER.error("AnotherFakeApiVerticle : Deployement failed"); + } + }); + + vertx.deployVerticle("io.swagger.server.api.verticle.FakeApiVerticle", res -> { + if (res.succeeded()) { + LOGGER.info("FakeApiVerticle : Deployed"); + } else { + startFuture.fail(res.cause()); + LOGGER.error("FakeApiVerticle : Deployement failed"); + } + }); + + vertx.deployVerticle("io.swagger.server.api.verticle.FakeClassnameTags123ApiVerticle", res -> { + if (res.succeeded()) { + LOGGER.info("FakeClassnameTags123ApiVerticle : Deployed"); + } else { + startFuture.fail(res.cause()); + LOGGER.error("FakeClassnameTags123ApiVerticle : Deployement failed"); + } + }); + vertx.deployVerticle("io.swagger.server.api.verticle.PetApiVerticle", res -> { if (res.succeeded()) { LOGGER.info("PetApiVerticle : Deployed"); diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Category.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Category.java index 10659635427..fd984611ff5 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Category.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Category.java @@ -4,9 +4,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -/** - * A category for a pet - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Category { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/ModelApiResponse.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/ModelApiResponse.java index ef5261c7edb..747d3aafa88 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/ModelApiResponse.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/ModelApiResponse.java @@ -4,9 +4,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -/** - * Describes the result of uploading an image resource - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class ModelApiResponse { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java index 0eaaa46f352..c31f74d27bb 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java @@ -6,9 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue; import java.time.OffsetDateTime; -/** - * An order for a pets from the pet store - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Order { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java index e975a8dc2b2..1062b2295d6 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java @@ -9,9 +9,6 @@ import java.util.ArrayList; import java.util.List; -/** - * A pet for sale in the pet store - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Pet { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Tag.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Tag.java index f00a458e3d7..ce22ddfc29a 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Tag.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Tag.java @@ -4,9 +4,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -/** - * A tag for a pet - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Tag { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/User.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/User.java index 6e7331cd236..1d000fde501 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/User.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/User.java @@ -4,9 +4,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -/** - * A User who is purchasing from the pet store - **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class User { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java index b648fef0593..ceac2e7ab38 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java @@ -31,7 +31,7 @@ public void start() throws Exception { //Consumer for deleteOrder vertx.eventBus(). consumer(DELETEORDER_SERVICE_ID).handler(message -> { try { - String orderId = message.body().getString("orderId"); + String orderId = message.body().getString("order_id"); service.deleteOrder(orderId).subscribe( () -> { message.reply(null); @@ -64,7 +64,7 @@ public void start() throws Exception { //Consumer for getOrderById vertx.eventBus(). consumer(GETORDERBYID_SERVICE_ID).handler(message -> { try { - Long orderId = Json.mapper.readValue(message.body().getString("orderId"), Long.class); + Long orderId = Json.mapper.readValue(message.body().getString("order_id"), Long.class); service.getOrderById(orderId).subscribe( result -> { message.reply(new JsonObject(Json.encode(result)).encodePrettily()); diff --git a/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json b/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json index cc8c2b7d468..c977405fb28 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json +++ b/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "description" : "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "description" : "This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\", "version" : "1.0.0", "title" : "Swagger Petstore", "termsOfService" : "http://swagger.io/terms/", @@ -13,7 +13,7 @@ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, - "host" : "petstore.swagger.io", + "host" : "petstore.swagger.io:80", "basePath" : "/v2", "tags" : [ { "name" : "pet", @@ -383,7 +383,7 @@ "x-accepts" : "application/json" } }, - "/store/order/{orderId}" : { + "/store/order/{order_id}" : { "get" : { "tags" : [ "store" ], "summary" : "Find purchase order by ID", @@ -391,7 +391,7 @@ "operationId" : "getOrderById", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "orderId", + "name" : "order_id", "in" : "path", "description" : "ID of pet that needs to be fetched", "required" : true, @@ -424,7 +424,7 @@ "operationId" : "deleteOrder", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "orderId", + "name" : "order_id", "in" : "path", "description" : "ID of the order that needs to be deleted", "required" : true, @@ -674,6 +674,476 @@ "x-contentType" : "application/json", "x-accepts" : "application/json" } + }, + "/fake_classname_test" : { + "patch" : { + "tags" : [ "fake_classname_tags 123#$%^" ], + "summary" : "To test class name in snake case", + "operationId" : "testClassname", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "client model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Client" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Client" + } + } + }, + "security" : [ { + "api_key_query" : [ ] + } ], + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake" : { + "get" : { + "tags" : [ "fake" ], + "summary" : "To test enum parameters", + "description" : "To test enum parameters", + "operationId" : "testEnumParameters", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "enum_form_string_array", + "in" : "formData", + "description" : "Form parameter enum test (string array)", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "default" : "$", + "enum" : [ ">", "$" ] + } + }, { + "name" : "enum_form_string", + "in" : "formData", + "description" : "Form parameter enum test (string)", + "required" : false, + "type" : "string", + "default" : "-efg", + "enum" : [ "_abc", "-efg", "(xyz)" ] + }, { + "name" : "enum_header_string_array", + "in" : "header", + "description" : "Header parameter enum test (string array)", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "default" : "$", + "enum" : [ ">", "$" ] + } + }, { + "name" : "enum_header_string", + "in" : "header", + "description" : "Header parameter enum test (string)", + "required" : false, + "type" : "string", + "default" : "-efg", + "enum" : [ "_abc", "-efg", "(xyz)" ] + }, { + "name" : "enum_query_string_array", + "in" : "query", + "description" : "Query parameter enum test (string array)", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "default" : "$", + "enum" : [ ">", "$" ] + } + }, { + "name" : "enum_query_string", + "in" : "query", + "description" : "Query parameter enum test (string)", + "required" : false, + "type" : "string", + "default" : "-efg", + "enum" : [ "_abc", "-efg", "(xyz)" ] + }, { + "name" : "enum_query_integer", + "in" : "query", + "description" : "Query parameter enum test (double)", + "required" : false, + "type" : "integer", + "format" : "int32", + "enum" : [ 1, -2 ] + }, { + "name" : "enum_query_double", + "in" : "formData", + "description" : "Query parameter enum test (double)", + "required" : false, + "type" : "number", + "format" : "double", + "enum" : [ 1.1, -1.2 ] + } ], + "responses" : { + "400" : { + "description" : "Invalid request" + }, + "404" : { + "description" : "Not found" + } + }, + "x-contentType" : "*/*", + "x-accepts" : "*/*" + }, + "post" : { + "tags" : [ "fake" ], + "summary" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", + "description" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", + "operationId" : "testEndpointParameters", + "consumes" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], + "produces" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], + "parameters" : [ { + "name" : "integer", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "integer", + "maximum" : 100, + "minimum" : 10 + }, { + "name" : "int32", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "integer", + "maximum" : 200, + "minimum" : 20, + "format" : "int32" + }, { + "name" : "int64", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "integer", + "format" : "int64" + }, { + "name" : "number", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "number", + "maximum" : 543.2, + "minimum" : 32.1 + }, { + "name" : "float", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "number", + "maximum" : 987.6, + "format" : "float" + }, { + "name" : "double", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "number", + "maximum" : 123.4, + "minimum" : 67.8, + "format" : "double" + }, { + "name" : "string", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "pattern" : "/[a-z]/i" + }, { + "name" : "pattern_without_delimiter", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "string", + "pattern" : "^[A-Z].*" + }, { + "name" : "byte", + "in" : "formData", + "description" : "None", + "required" : true, + "type" : "string", + "format" : "byte" + }, { + "name" : "binary", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "format" : "binary" + }, { + "name" : "date", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "format" : "date" + }, { + "name" : "dateTime", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "format" : "date-time" + }, { + "name" : "password", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string", + "maxLength" : 64, + "minLength" : 10, + "format" : "password" + }, { + "name" : "callback", + "in" : "formData", + "description" : "None", + "required" : false, + "type" : "string" + } ], + "responses" : { + "400" : { + "description" : "Invalid username supplied" + }, + "404" : { + "description" : "User not found" + } + }, + "security" : [ { + "http_basic_test" : [ ] + } ], + "x-contentType" : "application/xml; charset=utf-8", + "x-accepts" : "application/xml; charset=utf-8,application/json; charset=utf-8" + }, + "patch" : { + "tags" : [ "fake" ], + "summary" : "To test \"client\" model", + "description" : "To test \"client\" model", + "operationId" : "testClientModel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "client model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Client" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Client" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/number" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of outer number types", + "operationId" : "fakeOuterNumberSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input number as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterNumber" + } + } ], + "responses" : { + "200" : { + "description" : "Output number", + "schema" : { + "$ref" : "#/definitions/OuterNumber" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/string" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of outer string types", + "operationId" : "fakeOuterStringSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input string as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterString" + } + } ], + "responses" : { + "200" : { + "description" : "Output string", + "schema" : { + "$ref" : "#/definitions/OuterString" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/boolean" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of outer boolean types", + "operationId" : "fakeOuterBooleanSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input boolean as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterBoolean" + } + } ], + "responses" : { + "200" : { + "description" : "Output boolean", + "schema" : { + "$ref" : "#/definitions/OuterBoolean" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/outer/composite" : { + "post" : { + "tags" : [ "fake" ], + "description" : "Test serialization of object with outer number type", + "operationId" : "fakeOuterCompositeSerialize", + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "Input composite as post body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/OuterComposite" + } + } ], + "responses" : { + "200" : { + "description" : "Output composite", + "schema" : { + "$ref" : "#/definitions/OuterComposite" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/jsonFormData" : { + "get" : { + "tags" : [ "fake" ], + "summary" : "test json serialization of form data", + "description" : "", + "operationId" : "testJsonFormData", + "consumes" : [ "application/json" ], + "parameters" : [ { + "name" : "param", + "in" : "formData", + "description" : "field1", + "required" : true, + "type" : "string" + }, { + "name" : "param2", + "in" : "formData", + "description" : "field2", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation" + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/fake/inline-additionalProperties" : { + "post" : { + "tags" : [ "fake" ], + "summary" : "test inline additionalProperties", + "description" : "", + "operationId" : "testInlineAdditionalProperties", + "consumes" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "param", + "description" : "request body", + "required" : true, + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "successful operation" + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } + }, + "/another-fake/dummy" : { + "patch" : { + "tags" : [ "$another-fake?" ], + "summary" : "To test special tags", + "description" : "To test special tags", + "operationId" : "test_special_tags", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "client model", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Client" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Client" + } + } + }, + "x-contentType" : "application/json", + "x-accepts" : "application/json" + } } }, "securityDefinitions" : { @@ -690,6 +1160,14 @@ "type" : "apiKey", "name" : "api_key", "in" : "header" + }, + "api_key_query" : { + "type" : "apiKey", + "name" : "api_key_query", + "in" : "query" + }, + "http_basic_test" : { + "type" : "basic" } }, "definitions" : { @@ -722,8 +1200,6 @@ "default" : false } }, - "title" : "Pet Order", - "description" : "An order for a pets from the pet store", "xml" : { "name" : "Order" } @@ -739,8 +1215,6 @@ "type" : "string" } }, - "title" : "Pet catehgry", - "description" : "A category for a pet", "xml" : { "name" : "Category" } @@ -750,7 +1224,8 @@ "properties" : { "id" : { "type" : "integer", - "format" : "int64" + "format" : "int64", + "x-is-unique" : true }, "username" : { "type" : "string" @@ -776,8 +1251,6 @@ "description" : "User Status" } }, - "title" : "a User", - "description" : "A User who is purchasing from the pet store", "xml" : { "name" : "User" } @@ -793,8 +1266,6 @@ "type" : "string" } }, - "title" : "Pet Tag", - "description" : "A tag for a pet", "xml" : { "name" : "Tag" } @@ -805,7 +1276,8 @@ "properties" : { "id" : { "type" : "integer", - "format" : "int64" + "format" : "int64", + "x-is-unique" : true }, "category" : { "$ref" : "#/definitions/Category" @@ -840,8 +1312,6 @@ "enum" : [ "available", "pending", "sold" ] } }, - "title" : "a Pet", - "description" : "A pet for sale in the pet store", "xml" : { "name" : "Pet" } @@ -859,9 +1329,449 @@ "message" : { "type" : "string" } + } + }, + "$special[model.name]" : { + "properties" : { + "$special[property.name]" : { + "type" : "integer", + "format" : "int64" + } + }, + "xml" : { + "name" : "$special[model.name]" + } + }, + "Return" : { + "properties" : { + "return" : { + "type" : "integer", + "format" : "int32" + } + }, + "description" : "Model for testing reserved words", + "xml" : { + "name" : "Return" + } + }, + "Name" : { + "required" : [ "name" ], + "properties" : { + "name" : { + "type" : "integer", + "format" : "int32" + }, + "snake_case" : { + "type" : "integer", + "format" : "int32", + "readOnly" : true + }, + "property" : { + "type" : "string" + }, + "123Number" : { + "type" : "integer", + "readOnly" : true + } + }, + "description" : "Model for testing model name same as property name", + "xml" : { + "name" : "Name" + } + }, + "200_response" : { + "properties" : { + "name" : { + "type" : "integer", + "format" : "int32" + }, + "class" : { + "type" : "string" + } + }, + "description" : "Model for testing model name starting with number", + "xml" : { + "name" : "Name" + } + }, + "ClassModel" : { + "properties" : { + "_class" : { + "type" : "string" + } }, - "title" : "An uploaded response", - "description" : "Describes the result of uploading an image resource" + "description" : "Model for testing model with \"_class\" property" + }, + "Dog" : { + "allOf" : [ { + "$ref" : "#/definitions/Animal" + }, { + "type" : "object", + "properties" : { + "breed" : { + "type" : "string" + } + } + } ] + }, + "Cat" : { + "allOf" : [ { + "$ref" : "#/definitions/Animal" + }, { + "type" : "object", + "properties" : { + "declawed" : { + "type" : "boolean" + } + } + } ] + }, + "Animal" : { + "type" : "object", + "required" : [ "className" ], + "discriminator" : "className", + "properties" : { + "className" : { + "type" : "string" + }, + "color" : { + "type" : "string", + "default" : "red" + } + } + }, + "AnimalFarm" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Animal" + } + }, + "format_test" : { + "type" : "object", + "required" : [ "byte", "date", "number", "password" ], + "properties" : { + "integer" : { + "type" : "integer", + "minimum" : 10, + "maximum" : 100 + }, + "int32" : { + "type" : "integer", + "format" : "int32", + "minimum" : 20, + "maximum" : 200 + }, + "int64" : { + "type" : "integer", + "format" : "int64" + }, + "number" : { + "type" : "number", + "minimum" : 32.1, + "maximum" : 543.2 + }, + "float" : { + "type" : "number", + "format" : "float", + "minimum" : 54.3, + "maximum" : 987.6 + }, + "double" : { + "type" : "number", + "format" : "double", + "minimum" : 67.8, + "maximum" : 123.4 + }, + "string" : { + "type" : "string", + "pattern" : "/[a-z]/i" + }, + "byte" : { + "type" : "string", + "format" : "byte", + "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" + }, + "binary" : { + "type" : "string", + "format" : "binary" + }, + "date" : { + "type" : "string", + "format" : "date" + }, + "dateTime" : { + "type" : "string", + "format" : "date-time" + }, + "uuid" : { + "type" : "string", + "format" : "uuid" + }, + "password" : { + "type" : "string", + "format" : "password", + "minLength" : 10, + "maxLength" : 64 + } + } + }, + "EnumClass" : { + "type" : "string", + "enum" : [ "_abc", "-efg", "(xyz)" ], + "default" : "-efg" + }, + "Enum_Test" : { + "type" : "object", + "properties" : { + "enum_string" : { + "type" : "string", + "enum" : [ "UPPER", "lower", "" ] + }, + "enum_integer" : { + "type" : "integer", + "format" : "int32", + "enum" : [ 1, -1 ] + }, + "enum_number" : { + "type" : "number", + "format" : "double", + "enum" : [ 1.1, -1.2 ] + }, + "outerEnum" : { + "$ref" : "#/definitions/OuterEnum" + } + } + }, + "AdditionalPropertiesClass" : { + "type" : "object", + "properties" : { + "map_property" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "map_of_map_property" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + } + } + }, + "MixedPropertiesAndAdditionalPropertiesClass" : { + "type" : "object", + "properties" : { + "uuid" : { + "type" : "string", + "format" : "uuid" + }, + "dateTime" : { + "type" : "string", + "format" : "date-time" + }, + "map" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/definitions/Animal" + } + } + } + }, + "List" : { + "type" : "object", + "properties" : { + "123-list" : { + "type" : "string" + } + } + }, + "Client" : { + "type" : "object", + "properties" : { + "client" : { + "type" : "string" + } + } + }, + "ReadOnlyFirst" : { + "type" : "object", + "properties" : { + "bar" : { + "type" : "string", + "readOnly" : true + }, + "baz" : { + "type" : "string" + } + } + }, + "hasOnlyReadOnly" : { + "type" : "object", + "properties" : { + "bar" : { + "type" : "string", + "readOnly" : true + }, + "foo" : { + "type" : "string", + "readOnly" : true + } + } + }, + "Capitalization" : { + "type" : "object", + "properties" : { + "smallCamel" : { + "type" : "string" + }, + "CapitalCamel" : { + "type" : "string" + }, + "small_Snake" : { + "type" : "string" + }, + "Capital_Snake" : { + "type" : "string" + }, + "SCA_ETH_Flow_Points" : { + "type" : "string" + }, + "ATT_NAME" : { + "type" : "string", + "description" : "Name of the pet\n" + } + } + }, + "MapTest" : { + "type" : "object", + "properties" : { + "map_map_of_string" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + }, + "map_of_enum_string" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "enum" : [ "UPPER", "lower" ] + } + } + } + }, + "ArrayTest" : { + "type" : "object", + "properties" : { + "array_of_string" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "array_array_of_integer" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "array_array_of_model" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ReadOnlyFirst" + } + } + } + } + }, + "NumberOnly" : { + "type" : "object", + "properties" : { + "JustNumber" : { + "type" : "number" + } + } + }, + "ArrayOfNumberOnly" : { + "type" : "object", + "properties" : { + "ArrayNumber" : { + "type" : "array", + "items" : { + "type" : "number" + } + } + } + }, + "ArrayOfArrayOfNumberOnly" : { + "type" : "object", + "properties" : { + "ArrayArrayNumber" : { + "type" : "array", + "items" : { + "type" : "array", + "items" : { + "type" : "number" + } + } + } + } + }, + "EnumArrays" : { + "type" : "object", + "properties" : { + "just_symbol" : { + "type" : "string", + "enum" : [ ">=", "$" ] + }, + "array_enum" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "fish", "crab" ] + } + } + } + }, + "OuterEnum" : { + "type" : "string", + "enum" : [ "placed", "approved", "delivered" ] + }, + "OuterComposite" : { + "type" : "object", + "properties" : { + "my_number" : { + "$ref" : "#/definitions/OuterNumber" + }, + "my_string" : { + "$ref" : "#/definitions/OuterString" + }, + "my_boolean" : { + "$ref" : "#/definitions/OuterBoolean" + } + } + }, + "OuterNumber" : { + "type" : "number" + }, + "OuterString" : { + "type" : "string" + }, + "OuterBoolean" : { + "type" : "boolean" } }, "externalDocs" : { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/AnotherFakeApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/AnotherFakeApi.java index c2e845dce90..c902b2d20a2 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/AnotherFakeApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/AnotherFakeApi.java @@ -54,7 +54,8 @@ default Optional getAcceptHeader() { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - default CompletableFuture> testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + default CompletableFuture> testSpecialTags( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeApi.java index 5c946bfb707..b8ffa5089c8 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeApi.java @@ -56,7 +56,8 @@ default Optional getAcceptHeader() { @ApiResponse(code = 200, message = "Output boolean", response = Boolean.class) }) @RequestMapping(value = "/fake/outer/boolean", method = RequestMethod.POST) - default CompletableFuture> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { + default CompletableFuture> fakeOuterBooleanSerialize( +@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -78,7 +79,8 @@ default CompletableFuture> fakeOuterBooleanSerialize(@Ap @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) }) @RequestMapping(value = "/fake/outer/composite", method = RequestMethod.POST) - default CompletableFuture> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { + default CompletableFuture> fakeOuterCompositeSerialize( +@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -100,7 +102,8 @@ default CompletableFuture> fakeOuterCompositeSeri @ApiResponse(code = 200, message = "Output number", response = BigDecimal.class) }) @RequestMapping(value = "/fake/outer/number", method = RequestMethod.POST) - default CompletableFuture> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { + default CompletableFuture> fakeOuterNumberSerialize( +@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -122,7 +125,8 @@ default CompletableFuture> fakeOuterNumberSerialize(@ @ApiResponse(code = 200, message = "Output string", response = String.class) }) @RequestMapping(value = "/fake/outer/string", method = RequestMethod.POST) - default CompletableFuture> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { + default CompletableFuture> fakeOuterStringSerialize( +@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -146,7 +150,8 @@ default CompletableFuture> fakeOuterStringSerialize(@ApiP produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - default CompletableFuture> testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + default CompletableFuture> testClientModel( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -173,7 +178,21 @@ default CompletableFuture> testClientModel(@ApiParam(valu produces = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, consumes = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, method = RequestMethod.POST) - default CompletableFuture> testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { + default CompletableFuture> testEndpointParameters( +@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, +@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, +@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, +@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, +@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, +@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, +@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, +@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, +@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, +@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, +@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, +@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, +@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, +@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default FakeApi interface so no example is generated"); @@ -190,7 +209,15 @@ default CompletableFuture> testEndpointParameters(@ApiParam produces = { "*/*" }, consumes = { "*/*" }, method = RequestMethod.GET) - default CompletableFuture> testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { + default CompletableFuture> testEnumParameters( +@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, +@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, +@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, +@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray +,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString +,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger +, +@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default FakeApi interface so no example is generated"); @@ -205,7 +232,8 @@ default CompletableFuture> testEnumParameters(@ApiParam(val @RequestMapping(value = "/fake/inline-additionalProperties", consumes = { "application/json" }, method = RequestMethod.POST) - default CompletableFuture> testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { + default CompletableFuture> testInlineAdditionalProperties( +@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default FakeApi interface so no example is generated"); @@ -220,7 +248,9 @@ default CompletableFuture> testInlineAdditionalProperties(@ @RequestMapping(value = "/fake/jsonFormData", consumes = { "application/json" }, method = RequestMethod.GET) - default CompletableFuture> testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { + default CompletableFuture> testJsonFormData( +@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, +@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default FakeApi interface so no example is generated"); diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeClassnameTestApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeClassnameTestApi.java index 1382f6a44f9..1cdab1ddbfd 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeClassnameTestApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeClassnameTestApi.java @@ -56,7 +56,8 @@ default Optional getAcceptHeader() { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - default CompletableFuture> testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + default CompletableFuture> testClassname( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java index e007e50daae..6834bbcf6c7 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java @@ -52,10 +52,10 @@ default Optional getAcceptHeader() { @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{orderId}", + @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - default CompletableFuture> deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId + default CompletableFuture> deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId ) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { @@ -95,10 +95,10 @@ default CompletableFuture>> getInventory() { @ApiResponse(code = 200, message = "successful operation", response = Order.class), @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{orderId}", + @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture> getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId + default CompletableFuture> getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId ) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java index 6ec5d0d2614..301e80043ba 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java @@ -17,7 +17,7 @@ public class SwaggerDocumentationConfig { ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Swagger Petstore") - .description("This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.") + .description("This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\") .license("Apache-2.0") .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html") .termsOfServiceUrl("") diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Category.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Category.java index ec5cb00ee16..1e0ea848c21 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Category.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Category.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * A category for a pet + * Category */ -@ApiModel(description = "A category for a pet") @Validated public class Category { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/ModelApiResponse.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/ModelApiResponse.java index 050d15d9b01..ab88a41e0eb 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/ModelApiResponse.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/ModelApiResponse.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * Describes the result of uploading an image resource + * ModelApiResponse */ -@ApiModel(description = "Describes the result of uploading an image resource") @Validated public class ModelApiResponse { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Order.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Order.java index 2862ac1af36..1d8ee746517 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Order.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Order.java @@ -12,9 +12,8 @@ import javax.validation.constraints.*; /** - * An order for a pets from the pet store + * Order */ -@ApiModel(description = "An order for a pets from the pet store") @Validated public class Order { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Pet.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Pet.java index f4d084d8ddc..406db97bb61 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Pet.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Pet.java @@ -15,9 +15,8 @@ import javax.validation.constraints.*; /** - * A pet for sale in the pet store + * Pet */ -@ApiModel(description = "A pet for sale in the pet store") @Validated public class Pet { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Tag.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Tag.java index 0370fd0e4c6..e993412e9cf 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Tag.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/Tag.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * A tag for a pet + * Tag */ -@ApiModel(description = "A tag for a pet") @Validated public class Tag { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/User.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/User.java index ded14da7cc0..0cbec699d47 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/User.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/model/User.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * A User who is purchasing from the pet store + * User */ -@ApiModel(description = "A User who is purchasing from the pet store") @Validated public class User { diff --git a/samples/server/petstore/spring-mvc/pom.xml b/samples/server/petstore/spring-mvc/pom.xml index 673178a791b..10c6a72cac7 100644 --- a/samples/server/petstore/spring-mvc/pom.xml +++ b/samples/server/petstore/spring-mvc/pom.xml @@ -1,9 +1,9 @@ 4.0.0 io.swagger - swagger-spring-mvc-server + swagger-spring jar - swagger-spring-mvc-server + swagger-spring 1.0.0 src/main/java diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApi.java index 6f6dd920913..df224bc6d1a 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApi.java @@ -32,6 +32,7 @@ public interface AnotherFakeApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testSpecialTags( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApiController.java index 1f969f15713..7801a972880 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApiController.java @@ -36,7 +36,8 @@ public AnotherFakeApiController(ObjectMapper objectMapper, HttpServletRequest re this.request = request; } - public ResponseEntity testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testSpecialTags( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApi.java index 92b47fb2a37..a844778f163 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApi.java @@ -34,7 +34,8 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output boolean", response = Boolean.class) }) @RequestMapping(value = "/fake/outer/boolean", method = RequestMethod.POST) - ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body); + ResponseEntity fakeOuterBooleanSerialize( +@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body); @ApiOperation(value = "", nickname = "fakeOuterCompositeSerialize", notes = "Test serialization of object with outer number type", response = OuterComposite.class, tags={ "fake", }) @@ -42,7 +43,8 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) }) @RequestMapping(value = "/fake/outer/composite", method = RequestMethod.POST) - ResponseEntity fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body); + ResponseEntity fakeOuterCompositeSerialize( +@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body); @ApiOperation(value = "", nickname = "fakeOuterNumberSerialize", notes = "Test serialization of outer number types", response = BigDecimal.class, tags={ "fake", }) @@ -50,7 +52,8 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output number", response = BigDecimal.class) }) @RequestMapping(value = "/fake/outer/number", method = RequestMethod.POST) - ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body); + ResponseEntity fakeOuterNumberSerialize( +@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body); @ApiOperation(value = "", nickname = "fakeOuterStringSerialize", notes = "Test serialization of outer string types", response = String.class, tags={ "fake", }) @@ -58,7 +61,8 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output string", response = String.class) }) @RequestMapping(value = "/fake/outer/string", method = RequestMethod.POST) - ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body); + ResponseEntity fakeOuterStringSerialize( +@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body); @ApiOperation(value = "To test \"client\" model", nickname = "testClientModel", notes = "To test \"client\" model", response = Client.class, tags={ "fake", }) @@ -68,7 +72,8 @@ public interface FakeApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testClientModel( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); @ApiOperation(value = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", nickname = "testEndpointParameters", notes = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", authorizations = { @@ -81,7 +86,21 @@ public interface FakeApi { produces = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, consumes = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, method = RequestMethod.POST) - ResponseEntity testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback); + ResponseEntity testEndpointParameters( +@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, +@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, +@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, +@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, +@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, +@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, +@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, +@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, +@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, +@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, +@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, +@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, +@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, +@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback); @ApiOperation(value = "To test enum parameters", nickname = "testEnumParameters", notes = "To test enum parameters", tags={ "fake", }) @@ -92,7 +111,15 @@ public interface FakeApi { produces = { "*/*" }, consumes = { "*/*" }, method = RequestMethod.GET) - ResponseEntity testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble); + ResponseEntity testEnumParameters( +@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, +@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, +@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, +@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray +,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString +,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger +, +@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble); @ApiOperation(value = "test inline additionalProperties", nickname = "testInlineAdditionalProperties", notes = "", tags={ "fake", }) @@ -101,7 +128,8 @@ public interface FakeApi { @RequestMapping(value = "/fake/inline-additionalProperties", consumes = { "application/json" }, method = RequestMethod.POST) - ResponseEntity testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param); + ResponseEntity testInlineAdditionalProperties( +@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param); @ApiOperation(value = "test json serialization of form data", nickname = "testJsonFormData", notes = "", tags={ "fake", }) @@ -110,6 +138,8 @@ public interface FakeApi { @RequestMapping(value = "/fake/jsonFormData", consumes = { "application/json" }, method = RequestMethod.GET) - ResponseEntity testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2); + ResponseEntity testJsonFormData( +@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, +@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApiController.java index 360e1d910d7..aa09efaaa79 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApiController.java @@ -40,7 +40,8 @@ public FakeApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { + public ResponseEntity fakeOuterBooleanSerialize( +@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -54,7 +55,8 @@ public ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Inpu return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { + public ResponseEntity fakeOuterCompositeSerialize( +@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -68,7 +70,8 @@ public ResponseEntity fakeOuterCompositeSerialize(@ApiParam(valu return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { + public ResponseEntity fakeOuterNumberSerialize( +@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -82,7 +85,8 @@ public ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "In return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { + public ResponseEntity fakeOuterStringSerialize( +@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -96,7 +100,8 @@ public ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testClientModel( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -110,22 +115,47 @@ public ResponseEntity testClientModel(@ApiParam(value = "client model" , return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { + public ResponseEntity testEndpointParameters( +@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, +@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, +@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, +@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, +@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, +@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, +@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, +@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, +@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, +@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, +@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, +@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, +@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, +@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { + public ResponseEntity testEnumParameters( +@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, +@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, +@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, +@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray +,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString +,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger +, +@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { + public ResponseEntity testInlineAdditionalProperties( +@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { + public ResponseEntity testJsonFormData( +@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, +@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApi.java index 8316190673c..5365c864e23 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApi.java @@ -34,6 +34,7 @@ public interface FakeClassnameTestApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testClassname( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApiController.java index 37288b4c860..c050c39cf94 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApiController.java @@ -36,7 +36,8 @@ public FakeClassnameTestApiController(ObjectMapper objectMapper, HttpServletRequ this.request = request; } - public ResponseEntity testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testClassname( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java index 85b78743bfa..acc35b8c24e 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java @@ -30,10 +30,10 @@ public interface StoreApi { @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{orderId}", + @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId + ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId ); @@ -53,10 +53,10 @@ ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs t @ApiResponse(code = 200, message = "successful operation", response = Order.class), @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{orderId}", + @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId + ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId ); diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java index 655bb35bd08..311a406d3d6 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java @@ -37,7 +37,7 @@ public StoreApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId + public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId ) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); @@ -57,7 +57,7 @@ public ResponseEntity> getInventory() { return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId + public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId ) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java index 26d4fc0e1f9..01bdae11a8e 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java @@ -17,7 +17,7 @@ public class SwaggerDocumentationConfig { ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Swagger Petstore") - .description("This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.") + .description("This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\") .license("Apache-2.0") .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html") .termsOfServiceUrl("") diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Category.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Category.java index ec5cb00ee16..1e0ea848c21 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Category.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Category.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * A category for a pet + * Category */ -@ApiModel(description = "A category for a pet") @Validated public class Category { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/ModelApiResponse.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/ModelApiResponse.java index 050d15d9b01..ab88a41e0eb 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/ModelApiResponse.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/ModelApiResponse.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * Describes the result of uploading an image resource + * ModelApiResponse */ -@ApiModel(description = "Describes the result of uploading an image resource") @Validated public class ModelApiResponse { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Order.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Order.java index 51394f276d1..8b87b88b024 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Order.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Order.java @@ -12,9 +12,8 @@ import javax.validation.constraints.*; /** - * An order for a pets from the pet store + * Order */ -@ApiModel(description = "An order for a pets from the pet store") @Validated public class Order { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Pet.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Pet.java index c25439608c9..2f4545d717a 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Pet.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Pet.java @@ -15,9 +15,8 @@ import javax.validation.constraints.*; /** - * A pet for sale in the pet store + * Pet */ -@ApiModel(description = "A pet for sale in the pet store") @Validated public class Pet { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Tag.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Tag.java index 0370fd0e4c6..e993412e9cf 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Tag.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/Tag.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * A tag for a pet + * Tag */ -@ApiModel(description = "A tag for a pet") @Validated public class Tag { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/User.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/User.java index ded14da7cc0..0cbec699d47 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/User.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/model/User.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * A User who is purchasing from the pet store + * User */ -@ApiModel(description = "A User who is purchasing from the pet store") @Validated public class User { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApi.java index 6f6dd920913..df224bc6d1a 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApi.java @@ -32,6 +32,7 @@ public interface AnotherFakeApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testSpecialTags( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApiController.java index 1f969f15713..7801a972880 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApiController.java @@ -36,7 +36,8 @@ public AnotherFakeApiController(ObjectMapper objectMapper, HttpServletRequest re this.request = request; } - public ResponseEntity testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testSpecialTags( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApi.java index 92b47fb2a37..a844778f163 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApi.java @@ -34,7 +34,8 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output boolean", response = Boolean.class) }) @RequestMapping(value = "/fake/outer/boolean", method = RequestMethod.POST) - ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body); + ResponseEntity fakeOuterBooleanSerialize( +@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body); @ApiOperation(value = "", nickname = "fakeOuterCompositeSerialize", notes = "Test serialization of object with outer number type", response = OuterComposite.class, tags={ "fake", }) @@ -42,7 +43,8 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) }) @RequestMapping(value = "/fake/outer/composite", method = RequestMethod.POST) - ResponseEntity fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body); + ResponseEntity fakeOuterCompositeSerialize( +@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body); @ApiOperation(value = "", nickname = "fakeOuterNumberSerialize", notes = "Test serialization of outer number types", response = BigDecimal.class, tags={ "fake", }) @@ -50,7 +52,8 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output number", response = BigDecimal.class) }) @RequestMapping(value = "/fake/outer/number", method = RequestMethod.POST) - ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body); + ResponseEntity fakeOuterNumberSerialize( +@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body); @ApiOperation(value = "", nickname = "fakeOuterStringSerialize", notes = "Test serialization of outer string types", response = String.class, tags={ "fake", }) @@ -58,7 +61,8 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output string", response = String.class) }) @RequestMapping(value = "/fake/outer/string", method = RequestMethod.POST) - ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body); + ResponseEntity fakeOuterStringSerialize( +@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body); @ApiOperation(value = "To test \"client\" model", nickname = "testClientModel", notes = "To test \"client\" model", response = Client.class, tags={ "fake", }) @@ -68,7 +72,8 @@ public interface FakeApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testClientModel( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); @ApiOperation(value = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", nickname = "testEndpointParameters", notes = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", authorizations = { @@ -81,7 +86,21 @@ public interface FakeApi { produces = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, consumes = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, method = RequestMethod.POST) - ResponseEntity testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback); + ResponseEntity testEndpointParameters( +@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, +@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, +@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, +@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, +@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, +@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, +@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, +@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, +@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, +@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, +@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, +@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, +@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, +@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback); @ApiOperation(value = "To test enum parameters", nickname = "testEnumParameters", notes = "To test enum parameters", tags={ "fake", }) @@ -92,7 +111,15 @@ public interface FakeApi { produces = { "*/*" }, consumes = { "*/*" }, method = RequestMethod.GET) - ResponseEntity testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble); + ResponseEntity testEnumParameters( +@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, +@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, +@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, +@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray +,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString +,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger +, +@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble); @ApiOperation(value = "test inline additionalProperties", nickname = "testInlineAdditionalProperties", notes = "", tags={ "fake", }) @@ -101,7 +128,8 @@ public interface FakeApi { @RequestMapping(value = "/fake/inline-additionalProperties", consumes = { "application/json" }, method = RequestMethod.POST) - ResponseEntity testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param); + ResponseEntity testInlineAdditionalProperties( +@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param); @ApiOperation(value = "test json serialization of form data", nickname = "testJsonFormData", notes = "", tags={ "fake", }) @@ -110,6 +138,8 @@ public interface FakeApi { @RequestMapping(value = "/fake/jsonFormData", consumes = { "application/json" }, method = RequestMethod.GET) - ResponseEntity testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2); + ResponseEntity testJsonFormData( +@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, +@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApiController.java index 360e1d910d7..aa09efaaa79 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApiController.java @@ -40,7 +40,8 @@ public FakeApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { + public ResponseEntity fakeOuterBooleanSerialize( +@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -54,7 +55,8 @@ public ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Inpu return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { + public ResponseEntity fakeOuterCompositeSerialize( +@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -68,7 +70,8 @@ public ResponseEntity fakeOuterCompositeSerialize(@ApiParam(valu return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { + public ResponseEntity fakeOuterNumberSerialize( +@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -82,7 +85,8 @@ public ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "In return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { + public ResponseEntity fakeOuterStringSerialize( +@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -96,7 +100,8 @@ public ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testClientModel( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -110,22 +115,47 @@ public ResponseEntity testClientModel(@ApiParam(value = "client model" , return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { + public ResponseEntity testEndpointParameters( +@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, +@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, +@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, +@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, +@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, +@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, +@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, +@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, +@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, +@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, +@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, +@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, +@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, +@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { + public ResponseEntity testEnumParameters( +@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, +@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, +@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, +@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray +,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString +,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger +, +@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { + public ResponseEntity testInlineAdditionalProperties( +@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { + public ResponseEntity testJsonFormData( +@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, +@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApi.java index 8316190673c..5365c864e23 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApi.java @@ -34,6 +34,7 @@ public interface FakeClassnameTestApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testClassname( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApiController.java index 37288b4c860..c050c39cf94 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApiController.java @@ -36,7 +36,8 @@ public FakeClassnameTestApiController(ObjectMapper objectMapper, HttpServletRequ this.request = request; } - public ResponseEntity testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testClassname( +@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java index 85b78743bfa..acc35b8c24e 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java @@ -30,10 +30,10 @@ public interface StoreApi { @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{orderId}", + @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId + ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId ); @@ -53,10 +53,10 @@ ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs t @ApiResponse(code = 200, message = "successful operation", response = Order.class), @ApiResponse(code = 400, message = "Invalid ID supplied"), @ApiResponse(code = 404, message = "Order not found") }) - @RequestMapping(value = "/store/order/{orderId}", + @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId + ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId ); diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java index 655bb35bd08..311a406d3d6 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java @@ -37,7 +37,7 @@ public StoreApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("orderId") String orderId + public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId ) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); @@ -57,7 +57,7 @@ public ResponseEntity> getInventory() { return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("orderId") Long orderId + public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId ) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java b/samples/server/petstore/springboot/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java index 26d4fc0e1f9..01bdae11a8e 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/configuration/SwaggerDocumentationConfig.java @@ -17,7 +17,7 @@ public class SwaggerDocumentationConfig { ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Swagger Petstore") - .description("This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.") + .description("This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\") .license("Apache-2.0") .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html") .termsOfServiceUrl("") diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Category.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Category.java index ec5cb00ee16..1e0ea848c21 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Category.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Category.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * A category for a pet + * Category */ -@ApiModel(description = "A category for a pet") @Validated public class Category { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/ModelApiResponse.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/ModelApiResponse.java index 050d15d9b01..ab88a41e0eb 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/ModelApiResponse.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/ModelApiResponse.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * Describes the result of uploading an image resource + * ModelApiResponse */ -@ApiModel(description = "Describes the result of uploading an image resource") @Validated public class ModelApiResponse { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Order.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Order.java index 51394f276d1..8b87b88b024 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Order.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Order.java @@ -12,9 +12,8 @@ import javax.validation.constraints.*; /** - * An order for a pets from the pet store + * Order */ -@ApiModel(description = "An order for a pets from the pet store") @Validated public class Order { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Pet.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Pet.java index c25439608c9..2f4545d717a 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Pet.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Pet.java @@ -15,9 +15,8 @@ import javax.validation.constraints.*; /** - * A pet for sale in the pet store + * Pet */ -@ApiModel(description = "A pet for sale in the pet store") @Validated public class Pet { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Tag.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Tag.java index 0370fd0e4c6..e993412e9cf 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/Tag.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/Tag.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * A tag for a pet + * Tag */ -@ApiModel(description = "A tag for a pet") @Validated public class Tag { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/model/User.java b/samples/server/petstore/springboot/src/main/java/io/swagger/model/User.java index ded14da7cc0..0cbec699d47 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/model/User.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/model/User.java @@ -10,9 +10,8 @@ import javax.validation.constraints.*; /** - * A User who is purchasing from the pet store + * User */ -@ApiModel(description = "A User who is purchasing from the pet store") @Validated public class User { diff --git a/samples/server/petstore/springboot/src/main/resources/application.properties b/samples/server/petstore/springboot/src/main/resources/application.properties index a2ef8627027..a72d110dea9 100644 --- a/samples/server/petstore/springboot/src/main/resources/application.properties +++ b/samples/server/petstore/springboot/src/main/resources/application.properties @@ -1,5 +1,5 @@ springfox.documentation.swagger.v2.path=/api-docs server.contextPath=/v2 -server.port=8080 +server.port=80 spring.jackson.date-format=io.swagger.RFC3339DateFormat spring.jackson.serialization.WRITE_DATES_AS_TIMESTAMPS=false \ No newline at end of file From 363e5003b1454978a006e6a33e0c54330da9bb26 Mon Sep 17 00:00:00 2001 From: mzinchenko Date: Tue, 21 Nov 2017 14:45:20 +0300 Subject: [PATCH 4/5] Issue #4680 fixed scripts --- bin/windows/java-petstore-okhttp-gson.bat | 2 +- bin/windows/java-petstore.bat | 2 +- .../spring-mvc-petstore-j8-async-server.bat | 2 +- bin/windows/spring-mvc-petstore-server.bat | 2 +- bin/windows/springboot-petstore-server.bat | 2 +- .../java-play-framework/app/Module.java | 3 - .../app/apimodels/Category.java | 2 +- .../app/apimodels/ModelApiResponse.java | 2 +- .../app/apimodels/Order.java | 2 +- .../app/apimodels/Pet.java | 2 +- .../app/apimodels/Tag.java | 2 +- .../app/apimodels/User.java | 2 +- .../petstore/java-play-framework/conf/routes | 17 - .../java-play-framework/public/swagger.json | 1252 +++-------------- .../swagger/server/api/MainApiVerticle.java | 29 +- .../io/swagger/server/api/model/Category.java | 3 + .../server/api/model/ModelApiResponse.java | 3 + .../io/swagger/server/api/model/Order.java | 3 + .../java/io/swagger/server/api/model/Pet.java | 3 + .../java/io/swagger/server/api/model/Tag.java | 3 + .../io/swagger/server/api/model/User.java | 3 + .../server/api/verticle/StoreApiVerticle.java | 4 +- .../async/src/main/resources/swagger.json | 948 +------------ .../swagger/server/api/MainApiVerticle.java | 29 +- .../io/swagger/server/api/model/Category.java | 3 + .../server/api/model/ModelApiResponse.java | 3 + .../io/swagger/server/api/model/Order.java | 3 + .../java/io/swagger/server/api/model/Pet.java | 3 + .../java/io/swagger/server/api/model/Tag.java | 3 + .../io/swagger/server/api/model/User.java | 3 + .../server/api/verticle/StoreApiVerticle.java | 4 +- .../rx/src/main/resources/swagger.json | 948 +------------ samples/server/petstore/spring-mvc/pom.xml | 4 +- 33 files changed, 259 insertions(+), 3037 deletions(-) diff --git a/bin/windows/java-petstore-okhttp-gson.bat b/bin/windows/java-petstore-okhttp-gson.bat index 5341168eee1..2b61d1decbd 100755 --- a/bin/windows/java-petstore-okhttp-gson.bat +++ b/bin/windows/java-petstore-okhttp-gson.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java -o samples\client\petstore\java --library=okhttp-gson -DdateLibrary=joda -DhideGenerationTimestamp=true +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore-with-fake-endpoints-models-for-testing.yaml -l java -o samples\client\petstore\java --library=okhttp-gson -DdateLibrary=joda -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/java-petstore.bat b/bin/windows/java-petstore.bat index 1bef8a0c699..dfcb8393335 100755 --- a/bin/windows/java-petstore.bat +++ b/bin/windows/java-petstore.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l java -o samples\client\petstore\java -DdateLibrary=joda -DhideGenerationTimestamp=true +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore-with-fake-endpoints-models-for-testing.yaml -l java -o samples\client\petstore\java -DdateLibrary=joda -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/spring-mvc-petstore-j8-async-server.bat b/bin/windows/spring-mvc-petstore-j8-async-server.bat index 13526e78e92..9fc1c4e20d1 100644 --- a/bin/windows/spring-mvc-petstore-j8-async-server.bat +++ b/bin/windows/spring-mvc-petstore-j8-async-server.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l spring --library=spring-mvc -o samples\server\petstore\spring-mvc-j8-async -c bin\spring-mvc-petstore-j8-async.json -DhideGenerationTimestamp=true +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore-with-fake-endpoints-models-for-testing.yaml -l spring --library=spring-mvc -o samples\server\petstore\spring-mvc-j8-async -c bin\spring-mvc-petstore-j8-async.json -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/spring-mvc-petstore-server.bat b/bin/windows/spring-mvc-petstore-server.bat index c6aa4933b5d..ebac66c3c15 100644 --- a/bin/windows/spring-mvc-petstore-server.bat +++ b/bin/windows/spring-mvc-petstore-server.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l spring --library=spring-mvc -o samples\server\petstore\spring-mvc -DhideGenerationTimestamp=true +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore-with-fake-endpoints-models-for-testing.yaml -c bin\spring-mvc-petstore-server.json -l spring --library=spring-mvc -o samples\server\petstore\spring-mvc -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/bin/windows/springboot-petstore-server.bat b/bin/windows/springboot-petstore-server.bat index 530bc5b5d86..886c6204371 100644 --- a/bin/windows/springboot-petstore-server.bat +++ b/bin/windows/springboot-petstore-server.bat @@ -5,6 +5,6 @@ If Not Exist %executable% ( ) REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l spring -o samples\server\petstore\springboot -DhideGenerationTimestamp=true +set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore-with-fake-endpoints-models-for-testing.yaml -l spring -o samples\server\petstore\springboot -DhideGenerationTimestamp=true java %JAVA_OPTS% -jar %executable% %ags% diff --git a/samples/server/petstore/java-play-framework/app/Module.java b/samples/server/petstore/java-play-framework/app/Module.java index eea2541f91c..f1b062c2934 100644 --- a/samples/server/petstore/java-play-framework/app/Module.java +++ b/samples/server/petstore/java-play-framework/app/Module.java @@ -6,9 +6,6 @@ public class Module extends AbstractModule { @Override protected void configure() { - bind(AnotherFakeApiControllerImpInterface.class).to(AnotherFakeApiControllerImp.class); - bind(FakeApiControllerImpInterface.class).to(FakeApiControllerImp.class); - bind(FakeClassnameTags123ApiControllerImpInterface.class).to(FakeClassnameTags123ApiControllerImp.class); bind(PetApiControllerImpInterface.class).to(PetApiControllerImp.class); bind(StoreApiControllerImpInterface.class).to(StoreApiControllerImp.class); bind(UserApiControllerImpInterface.class).to(UserApiControllerImp.class); diff --git a/samples/server/petstore/java-play-framework/app/apimodels/Category.java b/samples/server/petstore/java-play-framework/app/apimodels/Category.java index c2a4222a8aa..9f0206575f5 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/Category.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/Category.java @@ -6,7 +6,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * Category + * A category for a pet */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/ModelApiResponse.java b/samples/server/petstore/java-play-framework/app/apimodels/ModelApiResponse.java index a5505482e08..07493e84825 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/ModelApiResponse.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/ModelApiResponse.java @@ -6,7 +6,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * ModelApiResponse + * Describes the result of uploading an image resource */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/Order.java b/samples/server/petstore/java-play-framework/app/apimodels/Order.java index 50990892750..cdc21f722c9 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/Order.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/Order.java @@ -7,7 +7,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * Order + * An order for a pets from the pet store */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/Pet.java b/samples/server/petstore/java-play-framework/app/apimodels/Pet.java index aaa139c566d..5e5ff376294 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/Pet.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/Pet.java @@ -10,7 +10,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * Pet + * A pet for sale in the pet store */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/Tag.java b/samples/server/petstore/java-play-framework/app/apimodels/Tag.java index 5426c883569..15a8774252a 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/Tag.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/Tag.java @@ -6,7 +6,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * Tag + * A tag for a pet */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/app/apimodels/User.java b/samples/server/petstore/java-play-framework/app/apimodels/User.java index 0308cc92681..689de768893 100644 --- a/samples/server/petstore/java-play-framework/app/apimodels/User.java +++ b/samples/server/petstore/java-play-framework/app/apimodels/User.java @@ -6,7 +6,7 @@ import java.util.Objects; import javax.validation.constraints.*; /** - * User + * A User who is purchasing from the pet store */ @SuppressWarnings({"UnusedReturnValue", "WeakerAccess"}) diff --git a/samples/server/petstore/java-play-framework/conf/routes b/samples/server/petstore/java-play-framework/conf/routes index 6a342645b5d..775497a59fc 100644 --- a/samples/server/petstore/java-play-framework/conf/routes +++ b/samples/server/petstore/java-play-framework/conf/routes @@ -5,23 +5,6 @@ GET /api controllers.ApiDocController.api -#Functions for AnotherFake API -PATCH /v2/another-fake/dummy controllers.AnotherFakeApiController.testSpecialTags() - -#Functions for Fake API -POST /v2/fake/outer/boolean controllers.FakeApiController.fakeOuterBooleanSerialize() -POST /v2/fake/outer/composite controllers.FakeApiController.fakeOuterCompositeSerialize() -POST /v2/fake/outer/number controllers.FakeApiController.fakeOuterNumberSerialize() -POST /v2/fake/outer/string controllers.FakeApiController.fakeOuterStringSerialize() -PATCH /v2/fake controllers.FakeApiController.testClientModel() -POST /v2/fake controllers.FakeApiController.testEndpointParameters() -GET /v2/fake controllers.FakeApiController.testEnumParameters() -POST /v2/fake/inline-additionalProperties controllers.FakeApiController.testInlineAdditionalProperties() -GET /v2/fake/jsonFormData controllers.FakeApiController.testJsonFormData() - -#Functions for FakeClassnameTags123 API -PATCH /v2/fake_classname_test controllers.FakeClassnameTags123ApiController.testClassname() - #Functions for Pet API POST /v2/pet controllers.PetApiController.addPet() DELETE /v2/pet/:petId controllers.PetApiController.deletePet(petId: Long) diff --git a/samples/server/petstore/java-play-framework/public/swagger.json b/samples/server/petstore/java-play-framework/public/swagger.json index 8943dddcaa2..7b8017053a1 100644 --- a/samples/server/petstore/java-play-framework/public/swagger.json +++ b/samples/server/petstore/java-play-framework/public/swagger.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "description" : "This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\", + "description" : "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version" : "1.0.0", "title" : "Swagger Petstore", "termsOfService" : "http://swagger.io/terms/", @@ -13,7 +13,7 @@ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, - "host" : "petstore.swagger.io:80", + "host" : "petstore.swagger.io", "basePath" : "/v2", "tags" : [ { "name" : "pet", @@ -383,7 +383,7 @@ "x-accepts" : "application/json" } }, - "/store/order/{order_id}" : { + "/store/order/{orderId}" : { "get" : { "tags" : [ "store" ], "summary" : "Find purchase order by ID", @@ -391,7 +391,7 @@ "operationId" : "getOrderById", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "order_id", + "name" : "orderId", "in" : "path", "description" : "ID of pet that needs to be fetched", "required" : true, @@ -424,7 +424,7 @@ "operationId" : "deleteOrder", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "order_id", + "name" : "orderId", "in" : "path", "description" : "ID of the order that needs to be deleted", "required" : true, @@ -674,1162 +674,242 @@ "x-contentType" : "application/json", "x-accepts" : "application/json" } - }, - "/fake_classname_test" : { - "patch" : { - "tags" : [ "fake_classname_tags 123#$%^" ], - "summary" : "To test class name in snake case", - "operationId" : "testClassname", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "client model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Client" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Client" - } - } - }, - "security" : [ { - "api_key_query" : [ ] - } ], - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake" : { - "get" : { - "tags" : [ "fake" ], - "summary" : "To test enum parameters", - "description" : "To test enum parameters", - "operationId" : "testEnumParameters", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "enum_form_string_array", - "in" : "formData", - "description" : "Form parameter enum test (string array)", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] - } - }, { - "name" : "enum_form_string", - "in" : "formData", - "description" : "Form parameter enum test (string)", - "required" : false, - "type" : "string", - "default" : "-efg", - "enum" : [ "_abc", "-efg", "(xyz)" ] - }, { - "name" : "enum_header_string_array", - "in" : "header", - "description" : "Header parameter enum test (string array)", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] - } - }, { - "name" : "enum_header_string", - "in" : "header", - "description" : "Header parameter enum test (string)", - "required" : false, - "type" : "string", - "default" : "-efg", - "enum" : [ "_abc", "-efg", "(xyz)" ] - }, { - "name" : "enum_query_string_array", - "in" : "query", - "description" : "Query parameter enum test (string array)", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] - } - }, { - "name" : "enum_query_string", - "in" : "query", - "description" : "Query parameter enum test (string)", - "required" : false, - "type" : "string", - "default" : "-efg", - "enum" : [ "_abc", "-efg", "(xyz)" ] - }, { - "name" : "enum_query_integer", - "in" : "query", - "description" : "Query parameter enum test (double)", - "required" : false, - "type" : "integer", - "format" : "int32", - "enum" : [ 1, -2 ] - }, { - "name" : "enum_query_double", - "in" : "formData", - "description" : "Query parameter enum test (double)", - "required" : false, - "type" : "number", - "format" : "double", - "enum" : [ 1.1, -1.2 ] - } ], - "responses" : { - "400" : { - "description" : "Invalid request" - }, - "404" : { - "description" : "Not found" - } - }, - "x-contentType" : "*/*", - "x-accepts" : "*/*" - }, - "post" : { - "tags" : [ "fake" ], - "summary" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", - "description" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", - "operationId" : "testEndpointParameters", - "consumes" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], - "produces" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], - "parameters" : [ { - "name" : "integer", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "integer", - "maximum" : 100, - "minimum" : 10 - }, { - "name" : "int32", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "integer", - "maximum" : 200, - "minimum" : 20, - "format" : "int32" - }, { - "name" : "int64", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "integer", - "format" : "int64" - }, { - "name" : "number", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "number", - "maximum" : 543.2, - "minimum" : 32.1 - }, { - "name" : "float", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "number", - "maximum" : 987.6, - "format" : "float" - }, { - "name" : "double", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "number", - "maximum" : 123.4, - "minimum" : 67.8, - "format" : "double" - }, { - "name" : "string", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "pattern" : "/[a-z]/i" - }, { - "name" : "pattern_without_delimiter", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "string", - "pattern" : "^[A-Z].*" - }, { - "name" : "byte", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "string", - "format" : "byte" - }, { - "name" : "binary", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "format" : "binary" - }, { - "name" : "date", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "format" : "date" - }, { - "name" : "dateTime", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "format" : "date-time" - }, { - "name" : "password", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "maxLength" : 64, - "minLength" : 10, - "format" : "password" - }, { - "name" : "callback", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "Invalid username supplied" - }, - "404" : { - "description" : "User not found" - } - }, - "security" : [ { - "http_basic_test" : [ ] - } ], - "x-contentType" : "application/xml; charset=utf-8", - "x-accepts" : "application/xml; charset=utf-8,application/json; charset=utf-8" - }, - "patch" : { - "tags" : [ "fake" ], - "summary" : "To test \"client\" model", - "description" : "To test \"client\" model", - "operationId" : "testClientModel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "client model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Client" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Client" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/number" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of outer number types", - "operationId" : "fakeOuterNumberSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input number as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterNumber" - } - } ], - "responses" : { - "200" : { - "description" : "Output number", - "schema" : { - "$ref" : "#/definitions/OuterNumber" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json", - "missingReturnInfoIfNeeded" : "1.0" - } - }, - "/fake/outer/string" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of outer string types", - "operationId" : "fakeOuterStringSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input string as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterString" - } - } ], - "responses" : { - "200" : { - "description" : "Output string", - "schema" : { - "$ref" : "#/definitions/OuterString" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/boolean" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of outer boolean types", - "operationId" : "fakeOuterBooleanSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input boolean as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterBoolean" - } - } ], - "responses" : { - "200" : { - "description" : "Output boolean", - "schema" : { - "$ref" : "#/definitions/OuterBoolean" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json", - "missingReturnInfoIfNeeded" : "true" - } - }, - "/fake/outer/composite" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of object with outer number type", - "operationId" : "fakeOuterCompositeSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input composite as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterComposite" - } - } ], - "responses" : { - "200" : { - "description" : "Output composite", - "schema" : { - "$ref" : "#/definitions/OuterComposite" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/jsonFormData" : { - "get" : { - "tags" : [ "fake" ], - "summary" : "test json serialization of form data", - "description" : "", - "operationId" : "testJsonFormData", - "consumes" : [ "application/json" ], - "parameters" : [ { - "name" : "param", - "in" : "formData", - "description" : "field1", - "required" : true, - "type" : "string" - }, { - "name" : "param2", - "in" : "formData", - "description" : "field2", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation" - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/inline-additionalProperties" : { - "post" : { - "tags" : [ "fake" ], - "summary" : "test inline additionalProperties", - "description" : "", - "operationId" : "testInlineAdditionalProperties", - "consumes" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "param", - "description" : "request body", - "required" : true, - "schema" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - } ], - "responses" : { - "200" : { - "description" : "successful operation" - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/another-fake/dummy" : { - "patch" : { - "tags" : [ "$another-fake?" ], - "summary" : "To test special tags", - "description" : "To test special tags", - "operationId" : "test_special_tags", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "client model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Client" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Client" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - } - }, - "securityDefinitions" : { - "petstore_auth" : { - "type" : "oauth2", - "authorizationUrl" : "http://petstore.swagger.io/api/oauth/dialog", - "flow" : "implicit", - "scopes" : { - "write:pets" : "modify pets in your account", - "read:pets" : "read your pets" - } - }, - "api_key" : { - "type" : "apiKey", - "name" : "api_key", - "in" : "header" - }, - "api_key_query" : { - "type" : "apiKey", - "name" : "api_key_query", - "in" : "query" - }, - "http_basic_test" : { - "type" : "basic" - } - }, - "definitions" : { - "Order" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "petId" : { - "type" : "integer", - "format" : "int64" - }, - "quantity" : { - "type" : "integer", - "format" : "int32" - }, - "shipDate" : { - "type" : "string", - "format" : "date-time" - }, - "status" : { - "type" : "string", - "description" : "Order Status", - "enum" : [ "placed", "approved", "delivered" ] - }, - "complete" : { - "type" : "boolean", - "default" : false - } - }, - "example" : { - "petId" : 6, - "quantity" : 1, - "id" : 0, - "shipDate" : "2000-01-23T04:56:07.000+00:00", - "complete" : false, - "status" : "placed" - }, - "xml" : { - "name" : "Order" - } - }, - "Category" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "name" : { - "type" : "string" - } - }, - "example" : { - "name" : "name", - "id" : 6 - }, - "xml" : { - "name" : "Category" - } - }, - "User" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "x-is-unique" : true - }, - "username" : { - "type" : "string" - }, - "firstName" : { - "type" : "string" - }, - "lastName" : { - "type" : "string" - }, - "email" : { - "type" : "string" - }, - "password" : { - "type" : "string" - }, - "phone" : { - "type" : "string" - }, - "userStatus" : { - "type" : "integer", - "format" : "int32", - "description" : "User Status" - } - }, - "example" : { - "firstName" : "firstName", - "lastName" : "lastName", - "password" : "password", - "userStatus" : 6, - "phone" : "phone", - "id" : 0, - "email" : "email", - "username" : "username" - }, - "xml" : { - "name" : "User" - } - }, - "Tag" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "name" : { - "type" : "string" - } - }, - "example" : { - "name" : "name", - "id" : 1 - }, - "xml" : { - "name" : "Tag" - } - }, - "Pet" : { - "type" : "object", - "required" : [ "name", "photoUrls" ], - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "x-is-unique" : true - }, - "category" : { - "$ref" : "#/definitions/Category" - }, - "name" : { - "type" : "string", - "example" : "doggie" - }, - "photoUrls" : { - "type" : "array", - "xml" : { - "name" : "photoUrl", - "wrapped" : true - }, - "items" : { - "type" : "string" - } - }, - "tags" : { - "type" : "array", - "xml" : { - "name" : "tag", - "wrapped" : true - }, - "items" : { - "$ref" : "#/definitions/Tag" - } - }, - "status" : { - "type" : "string", - "description" : "pet status in the store", - "enum" : [ "available", "pending", "sold" ] - } - }, - "example" : { - "photoUrls" : [ "photoUrls", "photoUrls" ], - "name" : "doggie", - "id" : 0, - "category" : { - "name" : "name", - "id" : 6 - }, - "tags" : [ { - "name" : "name", - "id" : 1 - }, { - "name" : "name", - "id" : 1 - } ], - "status" : "available" - }, - "xml" : { - "name" : "Pet" - } - }, - "ApiResponse" : { - "type" : "object", - "properties" : { - "code" : { - "type" : "integer", - "format" : "int32" - }, - "type" : { - "type" : "string" - }, - "message" : { - "type" : "string" - } - }, - "example" : { - "code" : 0, - "type" : "type", - "message" : "message" - } - }, - "$special[model.name]" : { - "properties" : { - "$special[property.name]" : { - "type" : "integer", - "format" : "int64" - } - }, - "xml" : { - "name" : "$special[model.name]" - } - }, - "Return" : { - "properties" : { - "return" : { - "type" : "integer", - "format" : "int32" - } - }, - "description" : "Model for testing reserved words", - "xml" : { - "name" : "Return" - } - }, - "Name" : { - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "integer", - "format" : "int32" - }, - "snake_case" : { - "type" : "integer", - "format" : "int32", - "readOnly" : true - }, - "property" : { - "type" : "string" - }, - "123Number" : { - "type" : "integer", - "readOnly" : true - } - }, - "description" : "Model for testing model name same as property name", - "xml" : { - "name" : "Name" - } - }, - "200_response" : { - "properties" : { - "name" : { - "type" : "integer", - "format" : "int32" - }, - "class" : { - "type" : "string" - } - }, - "description" : "Model for testing model name starting with number", - "xml" : { - "name" : "Name" - } - }, - "ClassModel" : { - "properties" : { - "_class" : { - "type" : "string" - } - }, - "description" : "Model for testing model with \"_class\" property" - }, - "Dog" : { - "allOf" : [ { - "$ref" : "#/definitions/Animal" - }, { - "type" : "object", - "properties" : { - "breed" : { - "type" : "string" - } - } - } ] - }, - "Cat" : { - "allOf" : [ { - "$ref" : "#/definitions/Animal" - }, { - "type" : "object", - "properties" : { - "declawed" : { - "type" : "boolean" - } - } - } ] - }, - "Animal" : { - "type" : "object", - "required" : [ "className" ], - "discriminator" : "className", - "properties" : { - "className" : { - "type" : "string" - }, - "color" : { - "type" : "string", - "default" : "red" - } - } - }, - "AnimalFarm" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Animal" + } + }, + "securityDefinitions" : { + "petstore_auth" : { + "type" : "oauth2", + "authorizationUrl" : "http://petstore.swagger.io/api/oauth/dialog", + "flow" : "implicit", + "scopes" : { + "write:pets" : "modify pets in your account", + "read:pets" : "read your pets" } }, - "format_test" : { + "api_key" : { + "type" : "apiKey", + "name" : "api_key", + "in" : "header" + } + }, + "definitions" : { + "Order" : { "type" : "object", - "required" : [ "byte", "date", "number", "password" ], "properties" : { - "integer" : { - "type" : "integer", - "minimum" : 10, - "maximum" : 100 - }, - "int32" : { + "id" : { "type" : "integer", - "format" : "int32", - "minimum" : 20, - "maximum" : 200 + "format" : "int64" }, - "int64" : { + "petId" : { "type" : "integer", "format" : "int64" }, - "number" : { - "type" : "number", - "minimum" : 32.1, - "maximum" : 543.2 - }, - "float" : { - "type" : "number", - "format" : "float", - "minimum" : 54.3, - "maximum" : 987.6 - }, - "double" : { - "type" : "number", - "format" : "double", - "minimum" : 67.8, - "maximum" : 123.4 - }, - "string" : { - "type" : "string", - "pattern" : "/[a-z]/i" - }, - "byte" : { - "type" : "string", - "format" : "byte", - "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" - }, - "binary" : { - "type" : "string", - "format" : "binary" - }, - "date" : { - "type" : "string", - "format" : "date" + "quantity" : { + "type" : "integer", + "format" : "int32" }, - "dateTime" : { + "shipDate" : { "type" : "string", "format" : "date-time" }, - "uuid" : { + "status" : { "type" : "string", - "format" : "uuid" + "description" : "Order Status", + "enum" : [ "placed", "approved", "delivered" ] }, - "password" : { - "type" : "string", - "format" : "password", - "minLength" : 10, - "maxLength" : 64 + "complete" : { + "type" : "boolean", + "default" : false } + }, + "title" : "Pet Order", + "description" : "An order for a pets from the pet store", + "example" : { + "petId" : 6, + "quantity" : 1, + "id" : 0, + "shipDate" : "2000-01-23T04:56:07.000+00:00", + "complete" : false, + "status" : "placed" + }, + "xml" : { + "name" : "Order" } }, - "EnumClass" : { - "type" : "string", - "enum" : [ "_abc", "-efg", "(xyz)" ], - "default" : "-efg" - }, - "Enum_Test" : { + "Category" : { "type" : "object", "properties" : { - "enum_string" : { - "type" : "string", - "enum" : [ "UPPER", "lower", "" ] - }, - "enum_integer" : { + "id" : { "type" : "integer", - "format" : "int32", - "enum" : [ 1, -1 ] - }, - "enum_number" : { - "type" : "number", - "format" : "double", - "enum" : [ 1.1, -1.2 ] - }, - "outerEnum" : { - "$ref" : "#/definitions/OuterEnum" - } - } - }, - "AdditionalPropertiesClass" : { - "type" : "object", - "properties" : { - "map_property" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "map_of_map_property" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - } - } - }, - "MixedPropertiesAndAdditionalPropertiesClass" : { - "type" : "object", - "properties" : { - "uuid" : { - "type" : "string", - "format" : "uuid" - }, - "dateTime" : { - "type" : "string", - "format" : "date-time" + "format" : "int64" }, - "map" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/Animal" - } - } - } - }, - "List" : { - "type" : "object", - "properties" : { - "123-list" : { - "type" : "string" - } - } - }, - "Client" : { - "type" : "object", - "properties" : { - "client" : { + "name" : { "type" : "string" } }, + "title" : "Pet catehgry", + "description" : "A category for a pet", "example" : { - "client" : "client" + "name" : "name", + "id" : 6 + }, + "xml" : { + "name" : "Category" } }, - "ReadOnlyFirst" : { + "User" : { "type" : "object", "properties" : { - "bar" : { - "type" : "string", - "readOnly" : true + "id" : { + "type" : "integer", + "format" : "int64" }, - "baz" : { + "username" : { "type" : "string" - } - } - }, - "hasOnlyReadOnly" : { - "type" : "object", - "properties" : { - "bar" : { - "type" : "string", - "readOnly" : true }, - "foo" : { - "type" : "string", - "readOnly" : true - } - } - }, - "Capitalization" : { - "type" : "object", - "properties" : { - "smallCamel" : { + "firstName" : { "type" : "string" }, - "CapitalCamel" : { + "lastName" : { "type" : "string" }, - "small_Snake" : { + "email" : { "type" : "string" }, - "Capital_Snake" : { + "password" : { "type" : "string" }, - "SCA_ETH_Flow_Points" : { + "phone" : { "type" : "string" }, - "ATT_NAME" : { - "type" : "string", - "description" : "Name of the pet\n" + "userStatus" : { + "type" : "integer", + "format" : "int32", + "description" : "User Status" } + }, + "title" : "a User", + "description" : "A User who is purchasing from the pet store", + "example" : { + "firstName" : "firstName", + "lastName" : "lastName", + "password" : "password", + "userStatus" : 6, + "phone" : "phone", + "id" : 0, + "email" : "email", + "username" : "username" + }, + "xml" : { + "name" : "User" } }, - "MapTest" : { + "Tag" : { "type" : "object", "properties" : { - "map_map_of_string" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } + "id" : { + "type" : "integer", + "format" : "int64" }, - "map_of_enum_string" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "enum" : [ "UPPER", "lower" ] - } + "name" : { + "type" : "string" } + }, + "title" : "Pet Tag", + "description" : "A tag for a pet", + "example" : { + "name" : "name", + "id" : 1 + }, + "xml" : { + "name" : "Tag" } }, - "ArrayTest" : { + "Pet" : { "type" : "object", + "required" : [ "name", "photoUrls" ], "properties" : { - "array_of_string" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "category" : { + "$ref" : "#/definitions/Category" + }, + "name" : { + "type" : "string", + "example" : "doggie" + }, + "photoUrls" : { "type" : "array", + "xml" : { + "name" : "photoUrl", + "wrapped" : true + }, "items" : { "type" : "string" } }, - "array_array_of_integer" : { + "tags" : { "type" : "array", + "xml" : { + "name" : "tag", + "wrapped" : true + }, "items" : { - "type" : "array", - "items" : { - "type" : "integer", - "format" : "int64" - } + "$ref" : "#/definitions/Tag" } }, - "array_array_of_model" : { - "type" : "array", - "items" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ReadOnlyFirst" - } - } - } - } - }, - "NumberOnly" : { - "type" : "object", - "properties" : { - "JustNumber" : { - "type" : "number" - } - } - }, - "ArrayOfNumberOnly" : { - "type" : "object", - "properties" : { - "ArrayNumber" : { - "type" : "array", - "items" : { - "type" : "number" - } - } - } - }, - "ArrayOfArrayOfNumberOnly" : { - "type" : "object", - "properties" : { - "ArrayArrayNumber" : { - "type" : "array", - "items" : { - "type" : "array", - "items" : { - "type" : "number" - } - } - } - } - }, - "EnumArrays" : { - "type" : "object", - "properties" : { - "just_symbol" : { + "status" : { "type" : "string", - "enum" : [ ">=", "$" ] - }, - "array_enum" : { - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "fish", "crab" ] - } + "description" : "pet status in the store", + "enum" : [ "available", "pending", "sold" ] } + }, + "title" : "a Pet", + "description" : "A pet for sale in the pet store", + "example" : { + "photoUrls" : [ "photoUrls", "photoUrls" ], + "name" : "doggie", + "id" : 0, + "category" : { + "name" : "name", + "id" : 6 + }, + "tags" : [ { + "name" : "name", + "id" : 1 + }, { + "name" : "name", + "id" : 1 + } ], + "status" : "available" + }, + "xml" : { + "name" : "Pet" } }, - "OuterEnum" : { - "type" : "string", - "enum" : [ "placed", "approved", "delivered" ] - }, - "OuterComposite" : { + "ApiResponse" : { "type" : "object", "properties" : { - "my_number" : { - "$ref" : "#/definitions/OuterNumber" + "code" : { + "type" : "integer", + "format" : "int32" }, - "my_string" : { - "$ref" : "#/definitions/OuterString" + "type" : { + "type" : "string" }, - "my_boolean" : { - "$ref" : "#/definitions/OuterBoolean" + "message" : { + "type" : "string" } }, + "title" : "An uploaded response", + "description" : "Describes the result of uploading an image resource", "example" : { - "my_string" : { }, - "my_number" : { }, - "my_boolean" : { } + "code" : 0, + "type" : "type", + "message" : "message" } - }, - "OuterNumber" : { - "type" : "number" - }, - "OuterString" : { - "type" : "string" - }, - "OuterBoolean" : { - "type" : "boolean" } }, "externalDocs" : { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/MainApiVerticle.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/MainApiVerticle.java index 5939adbb1a9..8fb3ae2f3cf 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/MainApiVerticle.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/MainApiVerticle.java @@ -34,7 +34,7 @@ public void start(Future startFuture) throws Exception { vertx.createHttpServer() .requestHandler(swaggerRouter::accept) - .listen(80); + .listen(8080); startFuture.complete(); } else { startFuture.fail(readFile.cause()); @@ -44,33 +44,6 @@ public void start(Future startFuture) throws Exception { public void deployVerticles(Future startFuture) { - vertx.deployVerticle("io.swagger.server.api.verticle.AnotherFakeApiVerticle", res -> { - if (res.succeeded()) { - LOGGER.info("AnotherFakeApiVerticle : Deployed"); - } else { - startFuture.fail(res.cause()); - LOGGER.error("AnotherFakeApiVerticle : Deployement failed"); - } - }); - - vertx.deployVerticle("io.swagger.server.api.verticle.FakeApiVerticle", res -> { - if (res.succeeded()) { - LOGGER.info("FakeApiVerticle : Deployed"); - } else { - startFuture.fail(res.cause()); - LOGGER.error("FakeApiVerticle : Deployement failed"); - } - }); - - vertx.deployVerticle("io.swagger.server.api.verticle.FakeClassnameTags123ApiVerticle", res -> { - if (res.succeeded()) { - LOGGER.info("FakeClassnameTags123ApiVerticle : Deployed"); - } else { - startFuture.fail(res.cause()); - LOGGER.error("FakeClassnameTags123ApiVerticle : Deployement failed"); - } - }); - vertx.deployVerticle("io.swagger.server.api.verticle.PetApiVerticle", res -> { if (res.succeeded()) { LOGGER.info("PetApiVerticle : Deployed"); diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Category.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Category.java index fd984611ff5..10659635427 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Category.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Category.java @@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * A category for a pet + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Category { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/ModelApiResponse.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/ModelApiResponse.java index 747d3aafa88..ef5261c7edb 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/ModelApiResponse.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/ModelApiResponse.java @@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * Describes the result of uploading an image resource + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class ModelApiResponse { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java index c31f74d27bb..0eaaa46f352 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Order.java @@ -6,6 +6,9 @@ import com.fasterxml.jackson.annotation.JsonValue; import java.time.OffsetDateTime; +/** + * An order for a pets from the pet store + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Order { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java index 1062b2295d6..e975a8dc2b2 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Pet.java @@ -9,6 +9,9 @@ import java.util.ArrayList; import java.util.List; +/** + * A pet for sale in the pet store + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Pet { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Tag.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Tag.java index ce22ddfc29a..f00a458e3d7 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Tag.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/Tag.java @@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * A tag for a pet + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Tag { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/User.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/User.java index 1d000fde501..6e7331cd236 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/User.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/model/User.java @@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * A User who is purchasing from the pet store + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class User { diff --git a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java index 5261eedbf70..9299a08e013 100644 --- a/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java +++ b/samples/server/petstore/java-vertx/async/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java @@ -31,7 +31,7 @@ public void start() throws Exception { //Consumer for deleteOrder vertx.eventBus(). consumer(DELETEORDER_SERVICE_ID).handler(message -> { try { - String orderId = message.body().getString("order_id"); + String orderId = message.body().getString("orderId"); service.deleteOrder(orderId, result -> { if (result.succeeded()) message.reply(null); @@ -66,7 +66,7 @@ public void start() throws Exception { //Consumer for getOrderById vertx.eventBus(). consumer(GETORDERBYID_SERVICE_ID).handler(message -> { try { - Long orderId = Json.mapper.readValue(message.body().getString("order_id"), Long.class); + Long orderId = Json.mapper.readValue(message.body().getString("orderId"), Long.class); service.getOrderById(orderId, result -> { if (result.succeeded()) message.reply(new JsonObject(Json.encode(result.result())).encodePrettily()); diff --git a/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json b/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json index c977405fb28..cc8c2b7d468 100644 --- a/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json +++ b/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "description" : "This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\", + "description" : "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version" : "1.0.0", "title" : "Swagger Petstore", "termsOfService" : "http://swagger.io/terms/", @@ -13,7 +13,7 @@ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, - "host" : "petstore.swagger.io:80", + "host" : "petstore.swagger.io", "basePath" : "/v2", "tags" : [ { "name" : "pet", @@ -383,7 +383,7 @@ "x-accepts" : "application/json" } }, - "/store/order/{order_id}" : { + "/store/order/{orderId}" : { "get" : { "tags" : [ "store" ], "summary" : "Find purchase order by ID", @@ -391,7 +391,7 @@ "operationId" : "getOrderById", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "order_id", + "name" : "orderId", "in" : "path", "description" : "ID of pet that needs to be fetched", "required" : true, @@ -424,7 +424,7 @@ "operationId" : "deleteOrder", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "order_id", + "name" : "orderId", "in" : "path", "description" : "ID of the order that needs to be deleted", "required" : true, @@ -674,476 +674,6 @@ "x-contentType" : "application/json", "x-accepts" : "application/json" } - }, - "/fake_classname_test" : { - "patch" : { - "tags" : [ "fake_classname_tags 123#$%^" ], - "summary" : "To test class name in snake case", - "operationId" : "testClassname", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "client model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Client" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Client" - } - } - }, - "security" : [ { - "api_key_query" : [ ] - } ], - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake" : { - "get" : { - "tags" : [ "fake" ], - "summary" : "To test enum parameters", - "description" : "To test enum parameters", - "operationId" : "testEnumParameters", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "enum_form_string_array", - "in" : "formData", - "description" : "Form parameter enum test (string array)", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] - } - }, { - "name" : "enum_form_string", - "in" : "formData", - "description" : "Form parameter enum test (string)", - "required" : false, - "type" : "string", - "default" : "-efg", - "enum" : [ "_abc", "-efg", "(xyz)" ] - }, { - "name" : "enum_header_string_array", - "in" : "header", - "description" : "Header parameter enum test (string array)", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] - } - }, { - "name" : "enum_header_string", - "in" : "header", - "description" : "Header parameter enum test (string)", - "required" : false, - "type" : "string", - "default" : "-efg", - "enum" : [ "_abc", "-efg", "(xyz)" ] - }, { - "name" : "enum_query_string_array", - "in" : "query", - "description" : "Query parameter enum test (string array)", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] - } - }, { - "name" : "enum_query_string", - "in" : "query", - "description" : "Query parameter enum test (string)", - "required" : false, - "type" : "string", - "default" : "-efg", - "enum" : [ "_abc", "-efg", "(xyz)" ] - }, { - "name" : "enum_query_integer", - "in" : "query", - "description" : "Query parameter enum test (double)", - "required" : false, - "type" : "integer", - "format" : "int32", - "enum" : [ 1, -2 ] - }, { - "name" : "enum_query_double", - "in" : "formData", - "description" : "Query parameter enum test (double)", - "required" : false, - "type" : "number", - "format" : "double", - "enum" : [ 1.1, -1.2 ] - } ], - "responses" : { - "400" : { - "description" : "Invalid request" - }, - "404" : { - "description" : "Not found" - } - }, - "x-contentType" : "*/*", - "x-accepts" : "*/*" - }, - "post" : { - "tags" : [ "fake" ], - "summary" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", - "description" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", - "operationId" : "testEndpointParameters", - "consumes" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], - "produces" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], - "parameters" : [ { - "name" : "integer", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "integer", - "maximum" : 100, - "minimum" : 10 - }, { - "name" : "int32", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "integer", - "maximum" : 200, - "minimum" : 20, - "format" : "int32" - }, { - "name" : "int64", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "integer", - "format" : "int64" - }, { - "name" : "number", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "number", - "maximum" : 543.2, - "minimum" : 32.1 - }, { - "name" : "float", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "number", - "maximum" : 987.6, - "format" : "float" - }, { - "name" : "double", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "number", - "maximum" : 123.4, - "minimum" : 67.8, - "format" : "double" - }, { - "name" : "string", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "pattern" : "/[a-z]/i" - }, { - "name" : "pattern_without_delimiter", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "string", - "pattern" : "^[A-Z].*" - }, { - "name" : "byte", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "string", - "format" : "byte" - }, { - "name" : "binary", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "format" : "binary" - }, { - "name" : "date", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "format" : "date" - }, { - "name" : "dateTime", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "format" : "date-time" - }, { - "name" : "password", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "maxLength" : 64, - "minLength" : 10, - "format" : "password" - }, { - "name" : "callback", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "Invalid username supplied" - }, - "404" : { - "description" : "User not found" - } - }, - "security" : [ { - "http_basic_test" : [ ] - } ], - "x-contentType" : "application/xml; charset=utf-8", - "x-accepts" : "application/xml; charset=utf-8,application/json; charset=utf-8" - }, - "patch" : { - "tags" : [ "fake" ], - "summary" : "To test \"client\" model", - "description" : "To test \"client\" model", - "operationId" : "testClientModel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "client model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Client" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Client" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/number" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of outer number types", - "operationId" : "fakeOuterNumberSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input number as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterNumber" - } - } ], - "responses" : { - "200" : { - "description" : "Output number", - "schema" : { - "$ref" : "#/definitions/OuterNumber" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/string" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of outer string types", - "operationId" : "fakeOuterStringSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input string as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterString" - } - } ], - "responses" : { - "200" : { - "description" : "Output string", - "schema" : { - "$ref" : "#/definitions/OuterString" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/boolean" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of outer boolean types", - "operationId" : "fakeOuterBooleanSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input boolean as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterBoolean" - } - } ], - "responses" : { - "200" : { - "description" : "Output boolean", - "schema" : { - "$ref" : "#/definitions/OuterBoolean" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/composite" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of object with outer number type", - "operationId" : "fakeOuterCompositeSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input composite as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterComposite" - } - } ], - "responses" : { - "200" : { - "description" : "Output composite", - "schema" : { - "$ref" : "#/definitions/OuterComposite" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/jsonFormData" : { - "get" : { - "tags" : [ "fake" ], - "summary" : "test json serialization of form data", - "description" : "", - "operationId" : "testJsonFormData", - "consumes" : [ "application/json" ], - "parameters" : [ { - "name" : "param", - "in" : "formData", - "description" : "field1", - "required" : true, - "type" : "string" - }, { - "name" : "param2", - "in" : "formData", - "description" : "field2", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation" - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/inline-additionalProperties" : { - "post" : { - "tags" : [ "fake" ], - "summary" : "test inline additionalProperties", - "description" : "", - "operationId" : "testInlineAdditionalProperties", - "consumes" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "param", - "description" : "request body", - "required" : true, - "schema" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - } ], - "responses" : { - "200" : { - "description" : "successful operation" - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/another-fake/dummy" : { - "patch" : { - "tags" : [ "$another-fake?" ], - "summary" : "To test special tags", - "description" : "To test special tags", - "operationId" : "test_special_tags", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "client model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Client" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Client" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } } }, "securityDefinitions" : { @@ -1160,14 +690,6 @@ "type" : "apiKey", "name" : "api_key", "in" : "header" - }, - "api_key_query" : { - "type" : "apiKey", - "name" : "api_key_query", - "in" : "query" - }, - "http_basic_test" : { - "type" : "basic" } }, "definitions" : { @@ -1200,6 +722,8 @@ "default" : false } }, + "title" : "Pet Order", + "description" : "An order for a pets from the pet store", "xml" : { "name" : "Order" } @@ -1215,6 +739,8 @@ "type" : "string" } }, + "title" : "Pet catehgry", + "description" : "A category for a pet", "xml" : { "name" : "Category" } @@ -1224,8 +750,7 @@ "properties" : { "id" : { "type" : "integer", - "format" : "int64", - "x-is-unique" : true + "format" : "int64" }, "username" : { "type" : "string" @@ -1251,6 +776,8 @@ "description" : "User Status" } }, + "title" : "a User", + "description" : "A User who is purchasing from the pet store", "xml" : { "name" : "User" } @@ -1266,6 +793,8 @@ "type" : "string" } }, + "title" : "Pet Tag", + "description" : "A tag for a pet", "xml" : { "name" : "Tag" } @@ -1276,8 +805,7 @@ "properties" : { "id" : { "type" : "integer", - "format" : "int64", - "x-is-unique" : true + "format" : "int64" }, "category" : { "$ref" : "#/definitions/Category" @@ -1312,6 +840,8 @@ "enum" : [ "available", "pending", "sold" ] } }, + "title" : "a Pet", + "description" : "A pet for sale in the pet store", "xml" : { "name" : "Pet" } @@ -1329,449 +859,9 @@ "message" : { "type" : "string" } - } - }, - "$special[model.name]" : { - "properties" : { - "$special[property.name]" : { - "type" : "integer", - "format" : "int64" - } - }, - "xml" : { - "name" : "$special[model.name]" - } - }, - "Return" : { - "properties" : { - "return" : { - "type" : "integer", - "format" : "int32" - } - }, - "description" : "Model for testing reserved words", - "xml" : { - "name" : "Return" - } - }, - "Name" : { - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "integer", - "format" : "int32" - }, - "snake_case" : { - "type" : "integer", - "format" : "int32", - "readOnly" : true - }, - "property" : { - "type" : "string" - }, - "123Number" : { - "type" : "integer", - "readOnly" : true - } - }, - "description" : "Model for testing model name same as property name", - "xml" : { - "name" : "Name" - } - }, - "200_response" : { - "properties" : { - "name" : { - "type" : "integer", - "format" : "int32" - }, - "class" : { - "type" : "string" - } - }, - "description" : "Model for testing model name starting with number", - "xml" : { - "name" : "Name" - } - }, - "ClassModel" : { - "properties" : { - "_class" : { - "type" : "string" - } }, - "description" : "Model for testing model with \"_class\" property" - }, - "Dog" : { - "allOf" : [ { - "$ref" : "#/definitions/Animal" - }, { - "type" : "object", - "properties" : { - "breed" : { - "type" : "string" - } - } - } ] - }, - "Cat" : { - "allOf" : [ { - "$ref" : "#/definitions/Animal" - }, { - "type" : "object", - "properties" : { - "declawed" : { - "type" : "boolean" - } - } - } ] - }, - "Animal" : { - "type" : "object", - "required" : [ "className" ], - "discriminator" : "className", - "properties" : { - "className" : { - "type" : "string" - }, - "color" : { - "type" : "string", - "default" : "red" - } - } - }, - "AnimalFarm" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Animal" - } - }, - "format_test" : { - "type" : "object", - "required" : [ "byte", "date", "number", "password" ], - "properties" : { - "integer" : { - "type" : "integer", - "minimum" : 10, - "maximum" : 100 - }, - "int32" : { - "type" : "integer", - "format" : "int32", - "minimum" : 20, - "maximum" : 200 - }, - "int64" : { - "type" : "integer", - "format" : "int64" - }, - "number" : { - "type" : "number", - "minimum" : 32.1, - "maximum" : 543.2 - }, - "float" : { - "type" : "number", - "format" : "float", - "minimum" : 54.3, - "maximum" : 987.6 - }, - "double" : { - "type" : "number", - "format" : "double", - "minimum" : 67.8, - "maximum" : 123.4 - }, - "string" : { - "type" : "string", - "pattern" : "/[a-z]/i" - }, - "byte" : { - "type" : "string", - "format" : "byte", - "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" - }, - "binary" : { - "type" : "string", - "format" : "binary" - }, - "date" : { - "type" : "string", - "format" : "date" - }, - "dateTime" : { - "type" : "string", - "format" : "date-time" - }, - "uuid" : { - "type" : "string", - "format" : "uuid" - }, - "password" : { - "type" : "string", - "format" : "password", - "minLength" : 10, - "maxLength" : 64 - } - } - }, - "EnumClass" : { - "type" : "string", - "enum" : [ "_abc", "-efg", "(xyz)" ], - "default" : "-efg" - }, - "Enum_Test" : { - "type" : "object", - "properties" : { - "enum_string" : { - "type" : "string", - "enum" : [ "UPPER", "lower", "" ] - }, - "enum_integer" : { - "type" : "integer", - "format" : "int32", - "enum" : [ 1, -1 ] - }, - "enum_number" : { - "type" : "number", - "format" : "double", - "enum" : [ 1.1, -1.2 ] - }, - "outerEnum" : { - "$ref" : "#/definitions/OuterEnum" - } - } - }, - "AdditionalPropertiesClass" : { - "type" : "object", - "properties" : { - "map_property" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "map_of_map_property" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - } - } - }, - "MixedPropertiesAndAdditionalPropertiesClass" : { - "type" : "object", - "properties" : { - "uuid" : { - "type" : "string", - "format" : "uuid" - }, - "dateTime" : { - "type" : "string", - "format" : "date-time" - }, - "map" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/Animal" - } - } - } - }, - "List" : { - "type" : "object", - "properties" : { - "123-list" : { - "type" : "string" - } - } - }, - "Client" : { - "type" : "object", - "properties" : { - "client" : { - "type" : "string" - } - } - }, - "ReadOnlyFirst" : { - "type" : "object", - "properties" : { - "bar" : { - "type" : "string", - "readOnly" : true - }, - "baz" : { - "type" : "string" - } - } - }, - "hasOnlyReadOnly" : { - "type" : "object", - "properties" : { - "bar" : { - "type" : "string", - "readOnly" : true - }, - "foo" : { - "type" : "string", - "readOnly" : true - } - } - }, - "Capitalization" : { - "type" : "object", - "properties" : { - "smallCamel" : { - "type" : "string" - }, - "CapitalCamel" : { - "type" : "string" - }, - "small_Snake" : { - "type" : "string" - }, - "Capital_Snake" : { - "type" : "string" - }, - "SCA_ETH_Flow_Points" : { - "type" : "string" - }, - "ATT_NAME" : { - "type" : "string", - "description" : "Name of the pet\n" - } - } - }, - "MapTest" : { - "type" : "object", - "properties" : { - "map_map_of_string" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - }, - "map_of_enum_string" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "enum" : [ "UPPER", "lower" ] - } - } - } - }, - "ArrayTest" : { - "type" : "object", - "properties" : { - "array_of_string" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "array_array_of_integer" : { - "type" : "array", - "items" : { - "type" : "array", - "items" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "array_array_of_model" : { - "type" : "array", - "items" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ReadOnlyFirst" - } - } - } - } - }, - "NumberOnly" : { - "type" : "object", - "properties" : { - "JustNumber" : { - "type" : "number" - } - } - }, - "ArrayOfNumberOnly" : { - "type" : "object", - "properties" : { - "ArrayNumber" : { - "type" : "array", - "items" : { - "type" : "number" - } - } - } - }, - "ArrayOfArrayOfNumberOnly" : { - "type" : "object", - "properties" : { - "ArrayArrayNumber" : { - "type" : "array", - "items" : { - "type" : "array", - "items" : { - "type" : "number" - } - } - } - } - }, - "EnumArrays" : { - "type" : "object", - "properties" : { - "just_symbol" : { - "type" : "string", - "enum" : [ ">=", "$" ] - }, - "array_enum" : { - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "fish", "crab" ] - } - } - } - }, - "OuterEnum" : { - "type" : "string", - "enum" : [ "placed", "approved", "delivered" ] - }, - "OuterComposite" : { - "type" : "object", - "properties" : { - "my_number" : { - "$ref" : "#/definitions/OuterNumber" - }, - "my_string" : { - "$ref" : "#/definitions/OuterString" - }, - "my_boolean" : { - "$ref" : "#/definitions/OuterBoolean" - } - } - }, - "OuterNumber" : { - "type" : "number" - }, - "OuterString" : { - "type" : "string" - }, - "OuterBoolean" : { - "type" : "boolean" + "title" : "An uploaded response", + "description" : "Describes the result of uploading an image resource" } }, "externalDocs" : { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/MainApiVerticle.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/MainApiVerticle.java index 5939adbb1a9..8fb3ae2f3cf 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/MainApiVerticle.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/MainApiVerticle.java @@ -34,7 +34,7 @@ public void start(Future startFuture) throws Exception { vertx.createHttpServer() .requestHandler(swaggerRouter::accept) - .listen(80); + .listen(8080); startFuture.complete(); } else { startFuture.fail(readFile.cause()); @@ -44,33 +44,6 @@ public void start(Future startFuture) throws Exception { public void deployVerticles(Future startFuture) { - vertx.deployVerticle("io.swagger.server.api.verticle.AnotherFakeApiVerticle", res -> { - if (res.succeeded()) { - LOGGER.info("AnotherFakeApiVerticle : Deployed"); - } else { - startFuture.fail(res.cause()); - LOGGER.error("AnotherFakeApiVerticle : Deployement failed"); - } - }); - - vertx.deployVerticle("io.swagger.server.api.verticle.FakeApiVerticle", res -> { - if (res.succeeded()) { - LOGGER.info("FakeApiVerticle : Deployed"); - } else { - startFuture.fail(res.cause()); - LOGGER.error("FakeApiVerticle : Deployement failed"); - } - }); - - vertx.deployVerticle("io.swagger.server.api.verticle.FakeClassnameTags123ApiVerticle", res -> { - if (res.succeeded()) { - LOGGER.info("FakeClassnameTags123ApiVerticle : Deployed"); - } else { - startFuture.fail(res.cause()); - LOGGER.error("FakeClassnameTags123ApiVerticle : Deployement failed"); - } - }); - vertx.deployVerticle("io.swagger.server.api.verticle.PetApiVerticle", res -> { if (res.succeeded()) { LOGGER.info("PetApiVerticle : Deployed"); diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Category.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Category.java index fd984611ff5..10659635427 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Category.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Category.java @@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * A category for a pet + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Category { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/ModelApiResponse.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/ModelApiResponse.java index 747d3aafa88..ef5261c7edb 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/ModelApiResponse.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/ModelApiResponse.java @@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * Describes the result of uploading an image resource + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class ModelApiResponse { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java index c31f74d27bb..0eaaa46f352 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Order.java @@ -6,6 +6,9 @@ import com.fasterxml.jackson.annotation.JsonValue; import java.time.OffsetDateTime; +/** + * An order for a pets from the pet store + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Order { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java index 1062b2295d6..e975a8dc2b2 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Pet.java @@ -9,6 +9,9 @@ import java.util.ArrayList; import java.util.List; +/** + * A pet for sale in the pet store + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Pet { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Tag.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Tag.java index ce22ddfc29a..f00a458e3d7 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Tag.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/Tag.java @@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * A tag for a pet + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class Tag { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/User.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/User.java index 1d000fde501..6e7331cd236 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/User.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/model/User.java @@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; +/** + * A User who is purchasing from the pet store + **/ @JsonInclude(JsonInclude.Include.NON_NULL) public class User { diff --git a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java index ceac2e7ab38..b648fef0593 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java +++ b/samples/server/petstore/java-vertx/rx/src/main/java/io/swagger/server/api/verticle/StoreApiVerticle.java @@ -31,7 +31,7 @@ public void start() throws Exception { //Consumer for deleteOrder vertx.eventBus(). consumer(DELETEORDER_SERVICE_ID).handler(message -> { try { - String orderId = message.body().getString("order_id"); + String orderId = message.body().getString("orderId"); service.deleteOrder(orderId).subscribe( () -> { message.reply(null); @@ -64,7 +64,7 @@ public void start() throws Exception { //Consumer for getOrderById vertx.eventBus(). consumer(GETORDERBYID_SERVICE_ID).handler(message -> { try { - Long orderId = Json.mapper.readValue(message.body().getString("order_id"), Long.class); + Long orderId = Json.mapper.readValue(message.body().getString("orderId"), Long.class); service.getOrderById(orderId).subscribe( result -> { message.reply(new JsonObject(Json.encode(result)).encodePrettily()); diff --git a/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json b/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json index c977405fb28..cc8c2b7d468 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json +++ b/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "description" : "This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\", + "description" : "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version" : "1.0.0", "title" : "Swagger Petstore", "termsOfService" : "http://swagger.io/terms/", @@ -13,7 +13,7 @@ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, - "host" : "petstore.swagger.io:80", + "host" : "petstore.swagger.io", "basePath" : "/v2", "tags" : [ { "name" : "pet", @@ -383,7 +383,7 @@ "x-accepts" : "application/json" } }, - "/store/order/{order_id}" : { + "/store/order/{orderId}" : { "get" : { "tags" : [ "store" ], "summary" : "Find purchase order by ID", @@ -391,7 +391,7 @@ "operationId" : "getOrderById", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "order_id", + "name" : "orderId", "in" : "path", "description" : "ID of pet that needs to be fetched", "required" : true, @@ -424,7 +424,7 @@ "operationId" : "deleteOrder", "produces" : [ "application/xml", "application/json" ], "parameters" : [ { - "name" : "order_id", + "name" : "orderId", "in" : "path", "description" : "ID of the order that needs to be deleted", "required" : true, @@ -674,476 +674,6 @@ "x-contentType" : "application/json", "x-accepts" : "application/json" } - }, - "/fake_classname_test" : { - "patch" : { - "tags" : [ "fake_classname_tags 123#$%^" ], - "summary" : "To test class name in snake case", - "operationId" : "testClassname", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "client model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Client" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Client" - } - } - }, - "security" : [ { - "api_key_query" : [ ] - } ], - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake" : { - "get" : { - "tags" : [ "fake" ], - "summary" : "To test enum parameters", - "description" : "To test enum parameters", - "operationId" : "testEnumParameters", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "enum_form_string_array", - "in" : "formData", - "description" : "Form parameter enum test (string array)", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] - } - }, { - "name" : "enum_form_string", - "in" : "formData", - "description" : "Form parameter enum test (string)", - "required" : false, - "type" : "string", - "default" : "-efg", - "enum" : [ "_abc", "-efg", "(xyz)" ] - }, { - "name" : "enum_header_string_array", - "in" : "header", - "description" : "Header parameter enum test (string array)", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] - } - }, { - "name" : "enum_header_string", - "in" : "header", - "description" : "Header parameter enum test (string)", - "required" : false, - "type" : "string", - "default" : "-efg", - "enum" : [ "_abc", "-efg", "(xyz)" ] - }, { - "name" : "enum_query_string_array", - "in" : "query", - "description" : "Query parameter enum test (string array)", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] - } - }, { - "name" : "enum_query_string", - "in" : "query", - "description" : "Query parameter enum test (string)", - "required" : false, - "type" : "string", - "default" : "-efg", - "enum" : [ "_abc", "-efg", "(xyz)" ] - }, { - "name" : "enum_query_integer", - "in" : "query", - "description" : "Query parameter enum test (double)", - "required" : false, - "type" : "integer", - "format" : "int32", - "enum" : [ 1, -2 ] - }, { - "name" : "enum_query_double", - "in" : "formData", - "description" : "Query parameter enum test (double)", - "required" : false, - "type" : "number", - "format" : "double", - "enum" : [ 1.1, -1.2 ] - } ], - "responses" : { - "400" : { - "description" : "Invalid request" - }, - "404" : { - "description" : "Not found" - } - }, - "x-contentType" : "*/*", - "x-accepts" : "*/*" - }, - "post" : { - "tags" : [ "fake" ], - "summary" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", - "description" : "Fake endpoint for testing various parameters\n假端點\n偽のエンドポイント\n가짜 엔드 포인트\n", - "operationId" : "testEndpointParameters", - "consumes" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], - "produces" : [ "application/xml; charset=utf-8", "application/json; charset=utf-8" ], - "parameters" : [ { - "name" : "integer", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "integer", - "maximum" : 100, - "minimum" : 10 - }, { - "name" : "int32", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "integer", - "maximum" : 200, - "minimum" : 20, - "format" : "int32" - }, { - "name" : "int64", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "integer", - "format" : "int64" - }, { - "name" : "number", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "number", - "maximum" : 543.2, - "minimum" : 32.1 - }, { - "name" : "float", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "number", - "maximum" : 987.6, - "format" : "float" - }, { - "name" : "double", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "number", - "maximum" : 123.4, - "minimum" : 67.8, - "format" : "double" - }, { - "name" : "string", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "pattern" : "/[a-z]/i" - }, { - "name" : "pattern_without_delimiter", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "string", - "pattern" : "^[A-Z].*" - }, { - "name" : "byte", - "in" : "formData", - "description" : "None", - "required" : true, - "type" : "string", - "format" : "byte" - }, { - "name" : "binary", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "format" : "binary" - }, { - "name" : "date", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "format" : "date" - }, { - "name" : "dateTime", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "format" : "date-time" - }, { - "name" : "password", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string", - "maxLength" : 64, - "minLength" : 10, - "format" : "password" - }, { - "name" : "callback", - "in" : "formData", - "description" : "None", - "required" : false, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "Invalid username supplied" - }, - "404" : { - "description" : "User not found" - } - }, - "security" : [ { - "http_basic_test" : [ ] - } ], - "x-contentType" : "application/xml; charset=utf-8", - "x-accepts" : "application/xml; charset=utf-8,application/json; charset=utf-8" - }, - "patch" : { - "tags" : [ "fake" ], - "summary" : "To test \"client\" model", - "description" : "To test \"client\" model", - "operationId" : "testClientModel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "client model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Client" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Client" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/number" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of outer number types", - "operationId" : "fakeOuterNumberSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input number as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterNumber" - } - } ], - "responses" : { - "200" : { - "description" : "Output number", - "schema" : { - "$ref" : "#/definitions/OuterNumber" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/string" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of outer string types", - "operationId" : "fakeOuterStringSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input string as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterString" - } - } ], - "responses" : { - "200" : { - "description" : "Output string", - "schema" : { - "$ref" : "#/definitions/OuterString" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/boolean" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of outer boolean types", - "operationId" : "fakeOuterBooleanSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input boolean as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterBoolean" - } - } ], - "responses" : { - "200" : { - "description" : "Output boolean", - "schema" : { - "$ref" : "#/definitions/OuterBoolean" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/outer/composite" : { - "post" : { - "tags" : [ "fake" ], - "description" : "Test serialization of object with outer number type", - "operationId" : "fakeOuterCompositeSerialize", - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Input composite as post body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/OuterComposite" - } - } ], - "responses" : { - "200" : { - "description" : "Output composite", - "schema" : { - "$ref" : "#/definitions/OuterComposite" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/jsonFormData" : { - "get" : { - "tags" : [ "fake" ], - "summary" : "test json serialization of form data", - "description" : "", - "operationId" : "testJsonFormData", - "consumes" : [ "application/json" ], - "parameters" : [ { - "name" : "param", - "in" : "formData", - "description" : "field1", - "required" : true, - "type" : "string" - }, { - "name" : "param2", - "in" : "formData", - "description" : "field2", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation" - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/fake/inline-additionalProperties" : { - "post" : { - "tags" : [ "fake" ], - "summary" : "test inline additionalProperties", - "description" : "", - "operationId" : "testInlineAdditionalProperties", - "consumes" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "param", - "description" : "request body", - "required" : true, - "schema" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - } ], - "responses" : { - "200" : { - "description" : "successful operation" - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } - }, - "/another-fake/dummy" : { - "patch" : { - "tags" : [ "$another-fake?" ], - "summary" : "To test special tags", - "description" : "To test special tags", - "operationId" : "test_special_tags", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "client model", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Client" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Client" - } - } - }, - "x-contentType" : "application/json", - "x-accepts" : "application/json" - } } }, "securityDefinitions" : { @@ -1160,14 +690,6 @@ "type" : "apiKey", "name" : "api_key", "in" : "header" - }, - "api_key_query" : { - "type" : "apiKey", - "name" : "api_key_query", - "in" : "query" - }, - "http_basic_test" : { - "type" : "basic" } }, "definitions" : { @@ -1200,6 +722,8 @@ "default" : false } }, + "title" : "Pet Order", + "description" : "An order for a pets from the pet store", "xml" : { "name" : "Order" } @@ -1215,6 +739,8 @@ "type" : "string" } }, + "title" : "Pet catehgry", + "description" : "A category for a pet", "xml" : { "name" : "Category" } @@ -1224,8 +750,7 @@ "properties" : { "id" : { "type" : "integer", - "format" : "int64", - "x-is-unique" : true + "format" : "int64" }, "username" : { "type" : "string" @@ -1251,6 +776,8 @@ "description" : "User Status" } }, + "title" : "a User", + "description" : "A User who is purchasing from the pet store", "xml" : { "name" : "User" } @@ -1266,6 +793,8 @@ "type" : "string" } }, + "title" : "Pet Tag", + "description" : "A tag for a pet", "xml" : { "name" : "Tag" } @@ -1276,8 +805,7 @@ "properties" : { "id" : { "type" : "integer", - "format" : "int64", - "x-is-unique" : true + "format" : "int64" }, "category" : { "$ref" : "#/definitions/Category" @@ -1312,6 +840,8 @@ "enum" : [ "available", "pending", "sold" ] } }, + "title" : "a Pet", + "description" : "A pet for sale in the pet store", "xml" : { "name" : "Pet" } @@ -1329,449 +859,9 @@ "message" : { "type" : "string" } - } - }, - "$special[model.name]" : { - "properties" : { - "$special[property.name]" : { - "type" : "integer", - "format" : "int64" - } - }, - "xml" : { - "name" : "$special[model.name]" - } - }, - "Return" : { - "properties" : { - "return" : { - "type" : "integer", - "format" : "int32" - } - }, - "description" : "Model for testing reserved words", - "xml" : { - "name" : "Return" - } - }, - "Name" : { - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "integer", - "format" : "int32" - }, - "snake_case" : { - "type" : "integer", - "format" : "int32", - "readOnly" : true - }, - "property" : { - "type" : "string" - }, - "123Number" : { - "type" : "integer", - "readOnly" : true - } - }, - "description" : "Model for testing model name same as property name", - "xml" : { - "name" : "Name" - } - }, - "200_response" : { - "properties" : { - "name" : { - "type" : "integer", - "format" : "int32" - }, - "class" : { - "type" : "string" - } - }, - "description" : "Model for testing model name starting with number", - "xml" : { - "name" : "Name" - } - }, - "ClassModel" : { - "properties" : { - "_class" : { - "type" : "string" - } }, - "description" : "Model for testing model with \"_class\" property" - }, - "Dog" : { - "allOf" : [ { - "$ref" : "#/definitions/Animal" - }, { - "type" : "object", - "properties" : { - "breed" : { - "type" : "string" - } - } - } ] - }, - "Cat" : { - "allOf" : [ { - "$ref" : "#/definitions/Animal" - }, { - "type" : "object", - "properties" : { - "declawed" : { - "type" : "boolean" - } - } - } ] - }, - "Animal" : { - "type" : "object", - "required" : [ "className" ], - "discriminator" : "className", - "properties" : { - "className" : { - "type" : "string" - }, - "color" : { - "type" : "string", - "default" : "red" - } - } - }, - "AnimalFarm" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Animal" - } - }, - "format_test" : { - "type" : "object", - "required" : [ "byte", "date", "number", "password" ], - "properties" : { - "integer" : { - "type" : "integer", - "minimum" : 10, - "maximum" : 100 - }, - "int32" : { - "type" : "integer", - "format" : "int32", - "minimum" : 20, - "maximum" : 200 - }, - "int64" : { - "type" : "integer", - "format" : "int64" - }, - "number" : { - "type" : "number", - "minimum" : 32.1, - "maximum" : 543.2 - }, - "float" : { - "type" : "number", - "format" : "float", - "minimum" : 54.3, - "maximum" : 987.6 - }, - "double" : { - "type" : "number", - "format" : "double", - "minimum" : 67.8, - "maximum" : 123.4 - }, - "string" : { - "type" : "string", - "pattern" : "/[a-z]/i" - }, - "byte" : { - "type" : "string", - "format" : "byte", - "pattern" : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" - }, - "binary" : { - "type" : "string", - "format" : "binary" - }, - "date" : { - "type" : "string", - "format" : "date" - }, - "dateTime" : { - "type" : "string", - "format" : "date-time" - }, - "uuid" : { - "type" : "string", - "format" : "uuid" - }, - "password" : { - "type" : "string", - "format" : "password", - "minLength" : 10, - "maxLength" : 64 - } - } - }, - "EnumClass" : { - "type" : "string", - "enum" : [ "_abc", "-efg", "(xyz)" ], - "default" : "-efg" - }, - "Enum_Test" : { - "type" : "object", - "properties" : { - "enum_string" : { - "type" : "string", - "enum" : [ "UPPER", "lower", "" ] - }, - "enum_integer" : { - "type" : "integer", - "format" : "int32", - "enum" : [ 1, -1 ] - }, - "enum_number" : { - "type" : "number", - "format" : "double", - "enum" : [ 1.1, -1.2 ] - }, - "outerEnum" : { - "$ref" : "#/definitions/OuterEnum" - } - } - }, - "AdditionalPropertiesClass" : { - "type" : "object", - "properties" : { - "map_property" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "map_of_map_property" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - } - } - }, - "MixedPropertiesAndAdditionalPropertiesClass" : { - "type" : "object", - "properties" : { - "uuid" : { - "type" : "string", - "format" : "uuid" - }, - "dateTime" : { - "type" : "string", - "format" : "date-time" - }, - "map" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/Animal" - } - } - } - }, - "List" : { - "type" : "object", - "properties" : { - "123-list" : { - "type" : "string" - } - } - }, - "Client" : { - "type" : "object", - "properties" : { - "client" : { - "type" : "string" - } - } - }, - "ReadOnlyFirst" : { - "type" : "object", - "properties" : { - "bar" : { - "type" : "string", - "readOnly" : true - }, - "baz" : { - "type" : "string" - } - } - }, - "hasOnlyReadOnly" : { - "type" : "object", - "properties" : { - "bar" : { - "type" : "string", - "readOnly" : true - }, - "foo" : { - "type" : "string", - "readOnly" : true - } - } - }, - "Capitalization" : { - "type" : "object", - "properties" : { - "smallCamel" : { - "type" : "string" - }, - "CapitalCamel" : { - "type" : "string" - }, - "small_Snake" : { - "type" : "string" - }, - "Capital_Snake" : { - "type" : "string" - }, - "SCA_ETH_Flow_Points" : { - "type" : "string" - }, - "ATT_NAME" : { - "type" : "string", - "description" : "Name of the pet\n" - } - } - }, - "MapTest" : { - "type" : "object", - "properties" : { - "map_map_of_string" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - }, - "map_of_enum_string" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "enum" : [ "UPPER", "lower" ] - } - } - } - }, - "ArrayTest" : { - "type" : "object", - "properties" : { - "array_of_string" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "array_array_of_integer" : { - "type" : "array", - "items" : { - "type" : "array", - "items" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "array_array_of_model" : { - "type" : "array", - "items" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ReadOnlyFirst" - } - } - } - } - }, - "NumberOnly" : { - "type" : "object", - "properties" : { - "JustNumber" : { - "type" : "number" - } - } - }, - "ArrayOfNumberOnly" : { - "type" : "object", - "properties" : { - "ArrayNumber" : { - "type" : "array", - "items" : { - "type" : "number" - } - } - } - }, - "ArrayOfArrayOfNumberOnly" : { - "type" : "object", - "properties" : { - "ArrayArrayNumber" : { - "type" : "array", - "items" : { - "type" : "array", - "items" : { - "type" : "number" - } - } - } - } - }, - "EnumArrays" : { - "type" : "object", - "properties" : { - "just_symbol" : { - "type" : "string", - "enum" : [ ">=", "$" ] - }, - "array_enum" : { - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "fish", "crab" ] - } - } - } - }, - "OuterEnum" : { - "type" : "string", - "enum" : [ "placed", "approved", "delivered" ] - }, - "OuterComposite" : { - "type" : "object", - "properties" : { - "my_number" : { - "$ref" : "#/definitions/OuterNumber" - }, - "my_string" : { - "$ref" : "#/definitions/OuterString" - }, - "my_boolean" : { - "$ref" : "#/definitions/OuterBoolean" - } - } - }, - "OuterNumber" : { - "type" : "number" - }, - "OuterString" : { - "type" : "string" - }, - "OuterBoolean" : { - "type" : "boolean" + "title" : "An uploaded response", + "description" : "Describes the result of uploading an image resource" } }, "externalDocs" : { diff --git a/samples/server/petstore/spring-mvc/pom.xml b/samples/server/petstore/spring-mvc/pom.xml index 10c6a72cac7..673178a791b 100644 --- a/samples/server/petstore/spring-mvc/pom.xml +++ b/samples/server/petstore/spring-mvc/pom.xml @@ -1,9 +1,9 @@ 4.0.0 io.swagger - swagger-spring + swagger-spring-mvc-server jar - swagger-spring + swagger-spring-mvc-server 1.0.0 src/main/java From 5d9bacbb8d07cf8319ea457070724e0d23013859 Mon Sep 17 00:00:00 2001 From: mzinchenko Date: Tue, 21 Nov 2017 16:22:09 +0300 Subject: [PATCH 5/5] Issue #4680 update samples under CentOS --- .../docs/images/interoperating_containers.png | Bin 35971 -> 36121 bytes .../docs/images/priority.png | Bin 22949 -> 23031 bytes .../docs/images/side_by_side_containers.png | Bin 22519 -> 22624 bytes .../public/swagger.json | 4 +- .../public/swagger.json | 16 +++--- .../public/swagger.json | 4 +- .../public/swagger.json | 4 +- .../public/swagger.json | 4 +- .../public/swagger.json | 4 +- .../java-play-framework/public/swagger.json | 4 +- .../async/src/main/resources/swagger.json | 4 +- .../rx/src/main/resources/swagger.json | 4 +- .../docs/images/interoperating_containers.png | Bin 35971 -> 36121 bytes .../docs/images/priority.png | Bin 22949 -> 23031 bytes .../docs/images/side_by_side_containers.png | Bin 22519 -> 22624 bytes .../java/io/swagger/api/AnotherFakeApi.java | 3 +- .../src/main/java/io/swagger/api/FakeApi.java | 48 ++++-------------- .../io/swagger/api/FakeClassnameTestApi.java | 3 +- .../src/main/java/io/swagger/api/PetApi.java | 29 +++-------- .../main/java/io/swagger/api/StoreApi.java | 9 ++-- .../src/main/java/io/swagger/api/UserApi.java | 23 +++------ .../java/io/swagger/api/AnotherFakeApi.java | 3 +- .../swagger/api/AnotherFakeApiController.java | 3 +- .../src/main/java/io/swagger/api/FakeApi.java | 48 ++++-------------- .../io/swagger/api/FakeApiController.java | 48 ++++-------------- .../io/swagger/api/FakeClassnameTestApi.java | 3 +- .../api/FakeClassnameTestApiController.java | 3 +- .../src/main/java/io/swagger/api/PetApi.java | 29 +++-------- .../java/io/swagger/api/PetApiController.java | 29 +++-------- .../main/java/io/swagger/api/StoreApi.java | 9 ++-- .../io/swagger/api/StoreApiController.java | 9 ++-- .../src/main/java/io/swagger/api/UserApi.java | 23 +++------ .../io/swagger/api/UserApiController.java | 23 +++------ .../java/io/swagger/api/AnotherFakeApi.java | 3 +- .../swagger/api/AnotherFakeApiController.java | 3 +- .../src/main/java/io/swagger/api/FakeApi.java | 48 ++++-------------- .../io/swagger/api/FakeApiController.java | 48 ++++-------------- .../io/swagger/api/FakeClassnameTestApi.java | 3 +- .../api/FakeClassnameTestApiController.java | 3 +- .../src/main/java/io/swagger/api/PetApi.java | 29 +++-------- .../java/io/swagger/api/PetApiController.java | 29 +++-------- .../main/java/io/swagger/api/StoreApi.java | 9 ++-- .../io/swagger/api/StoreApiController.java | 9 ++-- .../src/main/java/io/swagger/api/UserApi.java | 23 +++------ .../io/swagger/api/UserApiController.java | 23 +++------ .../src/main/java/io/swagger/model/Order.java | 2 +- .../src/main/resources/config/swagger.json | 36 +++++++------ 47 files changed, 190 insertions(+), 471 deletions(-) diff --git a/samples/server/petstore-security-test/slim/vendor/container-interop/container-interop/docs/images/interoperating_containers.png b/samples/server/petstore-security-test/slim/vendor/container-interop/container-interop/docs/images/interoperating_containers.png index 9c672e16c72a08708ea5bdeb51757c2951d3ee66..eddc8a52906d53746438e09c9bdf2bc503902b6e 100644 GIT binary patch delta 1117 zcmW-gdrVVz6vxM_z%4(Dbk0)j)?Q%<)LEEd-9-?sAcaB8!o!IRMTA)7y;-{&-3kH~ z72Q>%5)32E#0L&@$%1Tu_*jN1YUT*qfy)+=WGsQrk!&*?W8bs;$LHicf9IV0`?Z|& zKX=|g#AC_NW}KQ`53cm{V^WP@ls`mkzyvgLd(a4|l%*_Z+(lpMXLovE^%n0uHn;Ta zkH)`dn7Bi>8~&TJ2Ba8*qbMaOBo90t@)UH0E`slK)!-CI_Bi<^@LPF07#`*ZPlOr4 zyJ2=Pne73)Sqb<%bAmPDS>W~XY$fCN<$cl7vAVZ$^+~rzT*LEB3{^b9!H*StsPj$B zexmcW%1W?R84J@Tr9i_xTfQOy;%`+MiISCTDZEXS3{4!?N>FNa8DzW6FOcYoi6wD6 z)=Ck|_%0}Y@tLrR(+SOBapDlj>8;=ny#Suk$ABaHqhQvWaWLwQC8Vj=#!*^^;U7>) zngO-R(QpXK`^h1_c_4;yv-Ym9s>iN8@?MKG{gPB`VjSbV>cJUH(4^|NVw-G$i3RJv zL%1&GOXNODF;jo9uTP~CWyS-b&o~c$vjIz!GTt(fqh9zBoE3Obo>m1mrqO;U(|Tl# ztGoI=6I~nCFr41l4I0vOKxcY;B;%gFGGW_fkEy%x@U_LldmT)Q$WUXGVnXH_)W4aj zBxQU{J(SI+cxt9*YZwVf*6u)vC+2y-08Al`+HD8#0o3*bH(aWG0rul|HwA>_3&KQsi%*kD+6`f z{??b7XfAw#!?wI*p}#B^S!n9%;zM9XNjo@OVgt>kEpXp2)lq}<+cgv{FIz!<^5vmq zOtf{8ab#CF%~e#@59LKw5V`)X4klZWeI2;L?tp2~-bo%|Z$5K z>Z8e#*f0S48WzB@#~O}PkKYP#|N_1h=#jQj0S?%W@C-v|9sQ;PM|4R1#u zpKzFl3;BiIBa+RYi96`PP|_z3BNg`Ur}vcPEC)|IQxuGwQZ$dG3d-il$le4djXT{G zR^-|X-f|g``P}s<4fylHhcwKMk58;*+^RObA->O0;p2~J?@!+vU0Mu$_js{tCmMC* ztxBJ}y%g;{{1}R*?I4Ou584Z;w#IW2${kN21&nqML@gK delta 889 zcmWO4jZ@Qg90%~ezm2Ca4+~~6h9C@fNTLGCm<&+30l@$_JcS61aUil_B0EJM3LOgL zN#x$Bnc*R!cShK}k9A~rJz#-IomLn@o+NP{6q0dg4;PWIzu|TEO`-9u;MAheN_FS* ztIoxYDwwZ8&7uj00*C96IYvwQrODij!@U7xy9+uNSC<~B|C&RQV+lqbD`~5fFT+mf z4D>obM5D_Jj`C8>^9-n5FJs0v0qfkX=yOwJ+RcO%_cGYsbKvYz1FJ_0Zh547@253KL9`eUO)fndqk^oOL3QNHI4L%g&YeNrWjN;LwBy?sQq);C{7HETCBy6hh% z!jFMOCxf;zx}#WTbTdTBXhCTZAugs&qyrF)D_))b;S) z`UuXkHDryAU?5E`HpMAmh}(;yxH2f>djh!m-5^40mqM)b^UVVv{9O@I&@MS{tv;1f83FCHCi23~8bt~E9HhN{7TtIE&Y4S{x3Q%hI(%cth$%|AynSq?zsb$J{}-{eBGnm4nDWu#A+dH}Ig!fJlpuUbB2CLQJ(L zkpJGGTYO@gJlO9$Es2?}%=9}kQLP=yRxImU$!JPMcXb1;Ijm;LtSQC&HHGl5jdthL z63ca!Mr!f$>V2N_YOM_S>&lT{A3=5Xe+p!2xGNypdQ#4Vo1X4e^hFd+Dp~`-n*D5K zbw!+aVz;aSkF6P$&^RW*rRjV6sp)k_g|;0G_LfVO(<&B_-##eeiu7lmN=wetUP&sn F{tpO$aoYd@ diff --git a/samples/server/petstore-security-test/slim/vendor/container-interop/container-interop/docs/images/priority.png b/samples/server/petstore-security-test/slim/vendor/container-interop/container-interop/docs/images/priority.png index 5760dc71b557fea7ec5bd5699adfd1c228b9cdec..d2ae7942a64fc82cea3b0569d1efffd8d884a269 100644 GIT binary patch delta 565 zcmZ3wneqE(Mvl$^KX+a(Dc+6jJDC`HCm&$C2PEe)rvph=mTio@n|HG$G6E?Xw!a`s zl7kbdY_k#<4-+#l7w=|$9#&?cQWO4EAUTs?3n+J(pAD#T@=1XsKu)h>_#9bRIU@mxu>8GBv}<(fI^*$@{C|(S1SDinXypt8+A`rAONnT&FPWS&ttQ0S=90Y*7qF2N~tS|(hHlRMq=^?m<=A1opA zRvgu_v8x}4$ns8JXi^VUuV5MsR9|d*4HO=p<|ZJA)>;6AYO=BAKA_M?%S#}c!`8Yi zK(P<@Pk@{&4y7P_J)O6J?EUMS2_)0pmI6s`cTi9lx&H)`*&aGTMbkahKta0Kdlok@ zm+#+ixl)xcm-0?d@UaDo&h;q*D&hCN1+w*}A22W`{|qoBiPQ@G2vjc}R0<>~1SJ8D m`xJB( delta 371 zcmaLO%`3xk90%~e-_4$yMx5qxi_O*~Yl}@|sBL8%CPOaB8pQ!kDRSYklfyd)BE&9M zYJK$6N*dY8g{>$nCkGA=Bt|Lz0*BY}^+_y7Od9R+y9*WSge=K%!5^?E3PUayC?y_c zq?PuQs(3kDiSnN8RdAZ z)@}qs0_K!c>B^$wkWg zaZWQ00!N*B3hU+pdNHRMjx6Q4vMi&^+DALqTSoIu7KV7UfHB({Y3vzB?=AIWXq}HF zZI5tT>OAH!yC$*ailM_D#-aNQ2ObmMcyuDSZLb44?=1O!_Y8*a sB-(o$|25b9iclbeTwsh^`_hcW{aOZnFpg~SiB1PH3~NK3$PU%~0zYSyr2qf` diff --git a/samples/server/petstore-security-test/slim/vendor/container-interop/container-interop/docs/images/side_by_side_containers.png b/samples/server/petstore-security-test/slim/vendor/container-interop/container-interop/docs/images/side_by_side_containers.png index 24ca03c7cfd77afd6bd70094bcd532e4aef9f8e9..f24d4b16b65eb4f86631d20e1ca03b154bc7b358 100644 GIT binary patch delta 792 zcmaiy?MqW(7{)m}rg`k1X2)>mY@2JoolRYCQ>QtnTP)vSlZk1GWd)HLvLTcrVt#PU zo?wtg(hCd;oGha3lh7B@#PuNvGfjwEfzwnZ1nYkK2m126&UL?BJkP_~on%&h%)#O6 z%G1Clz-UB21EY6BJaG0vAn!HS>&i`JMRWAORkCw9JZzc zu_wE5;d`2L9$070u{REkn+y4k7E(=2_stFH7&Gt+5Op zaxtS6$qO=Mj&K$ENH8A(?p)%Msb#RRc6q2T)DhF}2J%ZN!n0+ob-3)msEMJ{letP? zrcwI@h5XJrMzeHF$dJy8)ai}L>-yK>!0`=(K-2~a7OaM}qrlZv49rW$Ma|ul^;;J9 z-Jj)c1CRj&J;S=ejImj{r8M?teytQZv)JSEoXT@7?8V))Z+>*GX}sP`7u*Vk0?3zq z9>;g`x9MSmg?0331x03h%Uh;&G+vW~8kuikfbyixCT~%r1T6u&B sXa4u;@2WD=#pl&{S+ZWO$1G)y7Jod_SbqZ9TR(#=Xc)o9Y=cJh7uWRk<^TWy delta 601 zcmZ9`Pe{{Y7{GDfcRKSmr(3^b{+n}c)9KIICfm%RoAXbs>1nh!eobHJw=IS1YyGhZJnL?m7YXO9^256Bz!|d!&1Y+_c z)aK|3bSh#;*vUeF(D=yWb#-(G*s&b-;jp+S54=YwAVH~zQY8<)%4@K#lp#}D2{_ah z;8(jLqV{T-_0L3W@abIo!kv!Q=zxwde!soLMiMKhetvB0dTZ8l+PdJ-aC{tI&s7t+ zpXY#Ro)3mKuLwhD{$&C$3k*|y6;$(b=;8a|9d8q}vzhDGw$U>8hHqr2JGCnSxrG+& zEi@3E)us|$EQ(OPp}$Krn7wvIzTG1hiwEO{n$TS6$_B4cC@h;&4b&Ufp}<%J{YEn^ z8lS{5u4xo5n9{&!(!jEbgBPYg(3jY7u%wDYsMHO~<_wOxU$3pqJUH`h&oJ{N;_(Fb zIV?B-rdV9wK+tEg?JryNanI@{aM8Am@=7TYGVY+O!Uy6q6`reVA`q%>#zQsj0>WU> zejJwUC5(B8y1Q>(`Yh", "$" ] + "enum" : [ ">", "$" ], + "default" : "$" } }, { "name" : "enum_form_string", @@ -741,8 +741,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] + "enum" : [ ">", "$" ], + "default" : "$" } }, { "name" : "enum_header_string", @@ -760,8 +760,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "$", - "enum" : [ ">", "$" ] + "enum" : [ ">", "$" ], + "default" : "$" } }, { "name" : "enum_query_string", diff --git a/samples/server/petstore/java-play-framework-no-bean-validation/public/swagger.json b/samples/server/petstore/java-play-framework-no-bean-validation/public/swagger.json index 7b8017053a1..c54baaa89cf 100644 --- a/samples/server/petstore/java-play-framework-no-bean-validation/public/swagger.json +++ b/samples/server/petstore/java-play-framework-no-bean-validation/public/swagger.json @@ -112,8 +112,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "available", - "enum" : [ "available", "pending", "sold" ] + "enum" : [ "available", "pending", "sold" ], + "default" : "available" }, "collectionFormat" : "csv" } ], diff --git a/samples/server/petstore/java-play-framework-no-exception-handling/public/swagger.json b/samples/server/petstore/java-play-framework-no-exception-handling/public/swagger.json index 7b8017053a1..c54baaa89cf 100644 --- a/samples/server/petstore/java-play-framework-no-exception-handling/public/swagger.json +++ b/samples/server/petstore/java-play-framework-no-exception-handling/public/swagger.json @@ -112,8 +112,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "available", - "enum" : [ "available", "pending", "sold" ] + "enum" : [ "available", "pending", "sold" ], + "default" : "available" }, "collectionFormat" : "csv" } ], diff --git a/samples/server/petstore/java-play-framework-no-interface/public/swagger.json b/samples/server/petstore/java-play-framework-no-interface/public/swagger.json index 7b8017053a1..c54baaa89cf 100644 --- a/samples/server/petstore/java-play-framework-no-interface/public/swagger.json +++ b/samples/server/petstore/java-play-framework-no-interface/public/swagger.json @@ -112,8 +112,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "available", - "enum" : [ "available", "pending", "sold" ] + "enum" : [ "available", "pending", "sold" ], + "default" : "available" }, "collectionFormat" : "csv" } ], diff --git a/samples/server/petstore/java-play-framework-no-wrap-calls/public/swagger.json b/samples/server/petstore/java-play-framework-no-wrap-calls/public/swagger.json index 7b8017053a1..c54baaa89cf 100644 --- a/samples/server/petstore/java-play-framework-no-wrap-calls/public/swagger.json +++ b/samples/server/petstore/java-play-framework-no-wrap-calls/public/swagger.json @@ -112,8 +112,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "available", - "enum" : [ "available", "pending", "sold" ] + "enum" : [ "available", "pending", "sold" ], + "default" : "available" }, "collectionFormat" : "csv" } ], diff --git a/samples/server/petstore/java-play-framework/public/swagger.json b/samples/server/petstore/java-play-framework/public/swagger.json index 7b8017053a1..c54baaa89cf 100644 --- a/samples/server/petstore/java-play-framework/public/swagger.json +++ b/samples/server/petstore/java-play-framework/public/swagger.json @@ -112,8 +112,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "available", - "enum" : [ "available", "pending", "sold" ] + "enum" : [ "available", "pending", "sold" ], + "default" : "available" }, "collectionFormat" : "csv" } ], diff --git a/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json b/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json index cc8c2b7d468..fb60866f1b8 100644 --- a/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json +++ b/samples/server/petstore/java-vertx/async/src/main/resources/swagger.json @@ -112,8 +112,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "available", - "enum" : [ "available", "pending", "sold" ] + "enum" : [ "available", "pending", "sold" ], + "default" : "available" }, "collectionFormat" : "csv" } ], diff --git a/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json b/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json index cc8c2b7d468..fb60866f1b8 100644 --- a/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json +++ b/samples/server/petstore/java-vertx/rx/src/main/resources/swagger.json @@ -112,8 +112,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "available", - "enum" : [ "available", "pending", "sold" ] + "enum" : [ "available", "pending", "sold" ], + "default" : "available" }, "collectionFormat" : "csv" } ], diff --git a/samples/server/petstore/slim/vendor/container-interop/container-interop/docs/images/interoperating_containers.png b/samples/server/petstore/slim/vendor/container-interop/container-interop/docs/images/interoperating_containers.png index 9c672e16c72a08708ea5bdeb51757c2951d3ee66..eddc8a52906d53746438e09c9bdf2bc503902b6e 100644 GIT binary patch delta 1117 zcmW-gdrVVz6vxM_z%4(Dbk0)j)?Q%<)LEEd-9-?sAcaB8!o!IRMTA)7y;-{&-3kH~ z72Q>%5)32E#0L&@$%1Tu_*jN1YUT*qfy)+=WGsQrk!&*?W8bs;$LHicf9IV0`?Z|& zKX=|g#AC_NW}KQ`53cm{V^WP@ls`mkzyvgLd(a4|l%*_Z+(lpMXLovE^%n0uHn;Ta zkH)`dn7Bi>8~&TJ2Ba8*qbMaOBo90t@)UH0E`slK)!-CI_Bi<^@LPF07#`*ZPlOr4 zyJ2=Pne73)Sqb<%bAmPDS>W~XY$fCN<$cl7vAVZ$^+~rzT*LEB3{^b9!H*StsPj$B zexmcW%1W?R84J@Tr9i_xTfQOy;%`+MiISCTDZEXS3{4!?N>FNa8DzW6FOcYoi6wD6 z)=Ck|_%0}Y@tLrR(+SOBapDlj>8;=ny#Suk$ABaHqhQvWaWLwQC8Vj=#!*^^;U7>) zngO-R(QpXK`^h1_c_4;yv-Ym9s>iN8@?MKG{gPB`VjSbV>cJUH(4^|NVw-G$i3RJv zL%1&GOXNODF;jo9uTP~CWyS-b&o~c$vjIz!GTt(fqh9zBoE3Obo>m1mrqO;U(|Tl# ztGoI=6I~nCFr41l4I0vOKxcY;B;%gFGGW_fkEy%x@U_LldmT)Q$WUXGVnXH_)W4aj zBxQU{J(SI+cxt9*YZwVf*6u)vC+2y-08Al`+HD8#0o3*bH(aWG0rul|HwA>_3&KQsi%*kD+6`f z{??b7XfAw#!?wI*p}#B^S!n9%;zM9XNjo@OVgt>kEpXp2)lq}<+cgv{FIz!<^5vmq zOtf{8ab#CF%~e#@59LKw5V`)X4klZWeI2;L?tp2~-bo%|Z$5K z>Z8e#*f0S48WzB@#~O}PkKYP#|N_1h=#jQj0S?%W@C-v|9sQ;PM|4R1#u zpKzFl3;BiIBa+RYi96`PP|_z3BNg`Ur}vcPEC)|IQxuGwQZ$dG3d-il$le4djXT{G zR^-|X-f|g``P}s<4fylHhcwKMk58;*+^RObA->O0;p2~J?@!+vU0Mu$_js{tCmMC* ztxBJ}y%g;{{1}R*?I4Ou584Z;w#IW2${kN21&nqML@gK delta 889 zcmWO4jZ@Qg90%~ezm2Ca4+~~6h9C@fNTLGCm<&+30l@$_JcS61aUil_B0EJM3LOgL zN#x$Bnc*R!cShK}k9A~rJz#-IomLn@o+NP{6q0dg4;PWIzu|TEO`-9u;MAheN_FS* ztIoxYDwwZ8&7uj00*C96IYvwQrODij!@U7xy9+uNSC<~B|C&RQV+lqbD`~5fFT+mf z4D>obM5D_Jj`C8>^9-n5FJs0v0qfkX=yOwJ+RcO%_cGYsbKvYz1FJ_0Zh547@253KL9`eUO)fndqk^oOL3QNHI4L%g&YeNrWjN;LwBy?sQq);C{7HETCBy6hh% z!jFMOCxf;zx}#WTbTdTBXhCTZAugs&qyrF)D_))b;S) z`UuXkHDryAU?5E`HpMAmh}(;yxH2f>djh!m-5^40mqM)b^UVVv{9O@I&@MS{tv;1f83FCHCi23~8bt~E9HhN{7TtIE&Y4S{x3Q%hI(%cth$%|AynSq?zsb$J{}-{eBGnm4nDWu#A+dH}Ig!fJlpuUbB2CLQJ(L zkpJGGTYO@gJlO9$Es2?}%=9}kQLP=yRxImU$!JPMcXb1;Ijm;LtSQC&HHGl5jdthL z63ca!Mr!f$>V2N_YOM_S>&lT{A3=5Xe+p!2xGNypdQ#4Vo1X4e^hFd+Dp~`-n*D5K zbw!+aVz;aSkF6P$&^RW*rRjV6sp)k_g|;0G_LfVO(<&B_-##eeiu7lmN=wetUP&sn F{tpO$aoYd@ diff --git a/samples/server/petstore/slim/vendor/container-interop/container-interop/docs/images/priority.png b/samples/server/petstore/slim/vendor/container-interop/container-interop/docs/images/priority.png index 5760dc71b557fea7ec5bd5699adfd1c228b9cdec..d2ae7942a64fc82cea3b0569d1efffd8d884a269 100644 GIT binary patch delta 565 zcmZ3wneqE(Mvl$^KX+a(Dc+6jJDC`HCm&$C2PEe)rvph=mTio@n|HG$G6E?Xw!a`s zl7kbdY_k#<4-+#l7w=|$9#&?cQWO4EAUTs?3n+J(pAD#T@=1XsKu)h>_#9bRIU@mxu>8GBv}<(fI^*$@{C|(S1SDinXypt8+A`rAONnT&FPWS&ttQ0S=90Y*7qF2N~tS|(hHlRMq=^?m<=A1opA zRvgu_v8x}4$ns8JXi^VUuV5MsR9|d*4HO=p<|ZJA)>;6AYO=BAKA_M?%S#}c!`8Yi zK(P<@Pk@{&4y7P_J)O6J?EUMS2_)0pmI6s`cTi9lx&H)`*&aGTMbkahKta0Kdlok@ zm+#+ixl)xcm-0?d@UaDo&h;q*D&hCN1+w*}A22W`{|qoBiPQ@G2vjc}R0<>~1SJ8D m`xJB( delta 371 zcmaLO%`3xk90%~e-_4$yMx5qxi_O*~Yl}@|sBL8%CPOaB8pQ!kDRSYklfyd)BE&9M zYJK$6N*dY8g{>$nCkGA=Bt|Lz0*BY}^+_y7Od9R+y9*WSge=K%!5^?E3PUayC?y_c zq?PuQs(3kDiSnN8RdAZ z)@}qs0_K!c>B^$wkWg zaZWQ00!N*B3hU+pdNHRMjx6Q4vMi&^+DALqTSoIu7KV7UfHB({Y3vzB?=AIWXq}HF zZI5tT>OAH!yC$*ailM_D#-aNQ2ObmMcyuDSZLb44?=1O!_Y8*a sB-(o$|25b9iclbeTwsh^`_hcW{aOZnFpg~SiB1PH3~NK3$PU%~0zYSyr2qf` diff --git a/samples/server/petstore/slim/vendor/container-interop/container-interop/docs/images/side_by_side_containers.png b/samples/server/petstore/slim/vendor/container-interop/container-interop/docs/images/side_by_side_containers.png index 24ca03c7cfd77afd6bd70094bcd532e4aef9f8e9..f24d4b16b65eb4f86631d20e1ca03b154bc7b358 100644 GIT binary patch delta 792 zcmaiy?MqW(7{)m}rg`k1X2)>mY@2JoolRYCQ>QtnTP)vSlZk1GWd)HLvLTcrVt#PU zo?wtg(hCd;oGha3lh7B@#PuNvGfjwEfzwnZ1nYkK2m126&UL?BJkP_~on%&h%)#O6 z%G1Clz-UB21EY6BJaG0vAn!HS>&i`JMRWAORkCw9JZzc zu_wE5;d`2L9$070u{REkn+y4k7E(=2_stFH7&Gt+5Op zaxtS6$qO=Mj&K$ENH8A(?p)%Msb#RRc6q2T)DhF}2J%ZN!n0+ob-3)msEMJ{letP? zrcwI@h5XJrMzeHF$dJy8)ai}L>-yK>!0`=(K-2~a7OaM}qrlZv49rW$Ma|ul^;;J9 z-Jj)c1CRj&J;S=ejImj{r8M?teytQZv)JSEoXT@7?8V))Z+>*GX}sP`7u*Vk0?3zq z9>;g`x9MSmg?0331x03h%Uh;&G+vW~8kuikfbyixCT~%r1T6u&B sXa4u;@2WD=#pl&{S+ZWO$1G)y7Jod_SbqZ9TR(#=Xc)o9Y=cJh7uWRk<^TWy delta 601 zcmZ9`Pe{{Y7{GDfcRKSmr(3^b{+n}c)9KIICfm%RoAXbs>1nh!eobHJw=IS1YyGhZJnL?m7YXO9^256Bz!|d!&1Y+_c z)aK|3bSh#;*vUeF(D=yWb#-(G*s&b-;jp+S54=YwAVH~zQY8<)%4@K#lp#}D2{_ah z;8(jLqV{T-_0L3W@abIo!kv!Q=zxwde!soLMiMKhetvB0dTZ8l+PdJ-aC{tI&s7t+ zpXY#Ro)3mKuLwhD{$&C$3k*|y6;$(b=;8a|9d8q}vzhDGw$U>8hHqr2JGCnSxrG+& zEi@3E)us|$EQ(OPp}$Krn7wvIzTG1hiwEO{n$TS6$_B4cC@h;&4b&Ufp}<%J{YEn^ z8lS{5u4xo5n9{&!(!jEbgBPYg(3jY7u%wDYsMHO~<_wOxU$3pqJUH`h&oJ{N;_(Fb zIV?B-rdV9wK+tEg?JryNanI@{aM8Am@=7TYGVY+O!Uy6q6`reVA`q%>#zQsj0>WU> zejJwUC5(B8y1Q>(`Yh getAcceptHeader() { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - default CompletableFuture> testSpecialTags( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + default CompletableFuture> testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeApi.java index b8ffa5089c8..5c946bfb707 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeApi.java @@ -56,8 +56,7 @@ default Optional getAcceptHeader() { @ApiResponse(code = 200, message = "Output boolean", response = Boolean.class) }) @RequestMapping(value = "/fake/outer/boolean", method = RequestMethod.POST) - default CompletableFuture> fakeOuterBooleanSerialize( -@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { + default CompletableFuture> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -79,8 +78,7 @@ default CompletableFuture> fakeOuterBooleanSerialize( @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) }) @RequestMapping(value = "/fake/outer/composite", method = RequestMethod.POST) - default CompletableFuture> fakeOuterCompositeSerialize( -@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { + default CompletableFuture> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -102,8 +100,7 @@ default CompletableFuture> fakeOuterCompositeSeri @ApiResponse(code = 200, message = "Output number", response = BigDecimal.class) }) @RequestMapping(value = "/fake/outer/number", method = RequestMethod.POST) - default CompletableFuture> fakeOuterNumberSerialize( -@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { + default CompletableFuture> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -125,8 +122,7 @@ default CompletableFuture> fakeOuterNumberSerialize( @ApiResponse(code = 200, message = "Output string", response = String.class) }) @RequestMapping(value = "/fake/outer/string", method = RequestMethod.POST) - default CompletableFuture> fakeOuterStringSerialize( -@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { + default CompletableFuture> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -150,8 +146,7 @@ default CompletableFuture> fakeOuterStringSerialize( produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - default CompletableFuture> testClientModel( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + default CompletableFuture> testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { @@ -178,21 +173,7 @@ default CompletableFuture> testClientModel( produces = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, consumes = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, method = RequestMethod.POST) - default CompletableFuture> testEndpointParameters( -@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, -@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, -@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, -@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, -@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, -@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, -@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, -@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, -@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, -@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, -@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, -@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, -@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, -@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { + default CompletableFuture> testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default FakeApi interface so no example is generated"); @@ -209,15 +190,7 @@ default CompletableFuture> testEndpointParameters( produces = { "*/*" }, consumes = { "*/*" }, method = RequestMethod.GET) - default CompletableFuture> testEnumParameters( -@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, -@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, -@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, -@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray -,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString -,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger -, -@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { + default CompletableFuture> testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default FakeApi interface so no example is generated"); @@ -232,8 +205,7 @@ default CompletableFuture> testEnumParameters( @RequestMapping(value = "/fake/inline-additionalProperties", consumes = { "application/json" }, method = RequestMethod.POST) - default CompletableFuture> testInlineAdditionalProperties( -@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { + default CompletableFuture> testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default FakeApi interface so no example is generated"); @@ -248,9 +220,7 @@ default CompletableFuture> testInlineAdditionalProperties( @RequestMapping(value = "/fake/jsonFormData", consumes = { "application/json" }, method = RequestMethod.GET) - default CompletableFuture> testJsonFormData( -@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, -@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { + default CompletableFuture> testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default FakeApi interface so no example is generated"); diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeClassnameTestApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeClassnameTestApi.java index 1cdab1ddbfd..1382f6a44f9 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeClassnameTestApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeClassnameTestApi.java @@ -56,8 +56,7 @@ default Optional getAcceptHeader() { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - default CompletableFuture> testClassname( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + default CompletableFuture> testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/PetApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/PetApi.java index b4bbba3a391..4681a226115 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/PetApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/PetApi.java @@ -61,8 +61,7 @@ default Optional getAcceptHeader() { produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.POST) - default CompletableFuture> addPet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + default CompletableFuture> addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default PetApi interface so no example is generated"); @@ -82,9 +81,7 @@ default CompletableFuture> addPet( @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - default CompletableFuture> deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { + default CompletableFuture> deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default PetApi interface so no example is generated"); @@ -105,8 +102,7 @@ default CompletableFuture> deletePet(@ApiParam(value = "Pet @RequestMapping(value = "/pet/findByStatus", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture>> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status -) { + default CompletableFuture>> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -143,8 +139,7 @@ default CompletableFuture>> findPetsByStatus(@NotNull @ @RequestMapping(value = "/pet/findByTags", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags -) { + default CompletableFuture>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -179,8 +174,7 @@ default CompletableFuture>> findPetsByTags(@NotNull @Ap @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture> getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId -) { + default CompletableFuture> getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -219,8 +213,7 @@ default CompletableFuture> getPetById(@ApiParam(value = "ID produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.PUT) - default CompletableFuture> updatePet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + default CompletableFuture> updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default PetApi interface so no example is generated"); @@ -241,10 +234,7 @@ default CompletableFuture> updatePet( produces = { "application/xml", "application/json" }, consumes = { "application/x-www-form-urlencoded" }, method = RequestMethod.POST) - default CompletableFuture> updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, -@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { + default CompletableFuture> updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default PetApi interface so no example is generated"); @@ -265,10 +255,7 @@ default CompletableFuture> updatePetWithForm(@ApiParam(valu produces = { "application/json" }, consumes = { "multipart/form-data" }, method = RequestMethod.POST) - default CompletableFuture> uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, -@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { + default CompletableFuture> uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java index 6834bbcf6c7..e77f2de7f70 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/StoreApi.java @@ -55,8 +55,7 @@ default Optional getAcceptHeader() { @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - default CompletableFuture> deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId -) { + default CompletableFuture> deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default StoreApi interface so no example is generated"); @@ -98,8 +97,7 @@ default CompletableFuture>> getInventory() { @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture> getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId -) { + default CompletableFuture> getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -131,8 +129,7 @@ default CompletableFuture> getOrderById(@Min(1) @Max(5) @A @RequestMapping(value = "/store/order", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - default CompletableFuture> placeOrder( -@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { + default CompletableFuture> placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { diff --git a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/UserApi.java b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/UserApi.java index d697caf9c64..4e755a2a73d 100644 --- a/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/UserApi.java +++ b/samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/UserApi.java @@ -54,8 +54,7 @@ default Optional getAcceptHeader() { @RequestMapping(value = "/user", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - default CompletableFuture> createUser( -@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { + default CompletableFuture> createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); @@ -70,8 +69,7 @@ default CompletableFuture> createUser( @RequestMapping(value = "/user/createWithArray", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - default CompletableFuture> createUsersWithArrayInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + default CompletableFuture> createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); @@ -86,8 +84,7 @@ default CompletableFuture> createUsersWithArrayInput( @RequestMapping(value = "/user/createWithList", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - default CompletableFuture> createUsersWithListInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + default CompletableFuture> createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); @@ -103,8 +100,7 @@ default CompletableFuture> createUsersWithListInput( @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - default CompletableFuture> deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username -) { + default CompletableFuture> deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); @@ -121,8 +117,7 @@ default CompletableFuture> deleteUser(@ApiParam(value = "Th @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture> getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username -) { + default CompletableFuture> getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -154,9 +149,7 @@ default CompletableFuture> getUserByName(@ApiParam(value = @RequestMapping(value = "/user/login", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - default CompletableFuture> loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username -,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password -) { + default CompletableFuture> loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { if (getAcceptHeader().get().contains("application/xml")) { try { @@ -203,9 +196,7 @@ default CompletableFuture> logoutUser() { @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.PUT) - default CompletableFuture> updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username -, -@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { + default CompletableFuture> updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { } else { log.warn("ObjectMapper or HttpServletRequest not configured in default UserApi interface so no example is generated"); diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApi.java index df224bc6d1a..6f6dd920913 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApi.java @@ -32,7 +32,6 @@ public interface AnotherFakeApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testSpecialTags( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApiController.java index 7801a972880..1f969f15713 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/AnotherFakeApiController.java @@ -36,8 +36,7 @@ public AnotherFakeApiController(ObjectMapper objectMapper, HttpServletRequest re this.request = request; } - public ResponseEntity testSpecialTags( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApi.java index a844778f163..92b47fb2a37 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApi.java @@ -34,8 +34,7 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output boolean", response = Boolean.class) }) @RequestMapping(value = "/fake/outer/boolean", method = RequestMethod.POST) - ResponseEntity fakeOuterBooleanSerialize( -@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body); + ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body); @ApiOperation(value = "", nickname = "fakeOuterCompositeSerialize", notes = "Test serialization of object with outer number type", response = OuterComposite.class, tags={ "fake", }) @@ -43,8 +42,7 @@ ResponseEntity fakeOuterBooleanSerialize( @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) }) @RequestMapping(value = "/fake/outer/composite", method = RequestMethod.POST) - ResponseEntity fakeOuterCompositeSerialize( -@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body); + ResponseEntity fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body); @ApiOperation(value = "", nickname = "fakeOuterNumberSerialize", notes = "Test serialization of outer number types", response = BigDecimal.class, tags={ "fake", }) @@ -52,8 +50,7 @@ ResponseEntity fakeOuterCompositeSerialize( @ApiResponse(code = 200, message = "Output number", response = BigDecimal.class) }) @RequestMapping(value = "/fake/outer/number", method = RequestMethod.POST) - ResponseEntity fakeOuterNumberSerialize( -@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body); + ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body); @ApiOperation(value = "", nickname = "fakeOuterStringSerialize", notes = "Test serialization of outer string types", response = String.class, tags={ "fake", }) @@ -61,8 +58,7 @@ ResponseEntity fakeOuterNumberSerialize( @ApiResponse(code = 200, message = "Output string", response = String.class) }) @RequestMapping(value = "/fake/outer/string", method = RequestMethod.POST) - ResponseEntity fakeOuterStringSerialize( -@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body); + ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body); @ApiOperation(value = "To test \"client\" model", nickname = "testClientModel", notes = "To test \"client\" model", response = Client.class, tags={ "fake", }) @@ -72,8 +68,7 @@ ResponseEntity fakeOuterStringSerialize( produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testClientModel( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); @ApiOperation(value = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", nickname = "testEndpointParameters", notes = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", authorizations = { @@ -86,21 +81,7 @@ ResponseEntity testClientModel( produces = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, consumes = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, method = RequestMethod.POST) - ResponseEntity testEndpointParameters( -@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, -@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, -@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, -@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, -@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, -@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, -@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, -@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, -@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, -@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, -@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, -@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, -@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, -@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback); + ResponseEntity testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback); @ApiOperation(value = "To test enum parameters", nickname = "testEnumParameters", notes = "To test enum parameters", tags={ "fake", }) @@ -111,15 +92,7 @@ ResponseEntity testEndpointParameters( produces = { "*/*" }, consumes = { "*/*" }, method = RequestMethod.GET) - ResponseEntity testEnumParameters( -@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, -@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, -@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, -@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray -,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString -,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger -, -@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble); + ResponseEntity testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble); @ApiOperation(value = "test inline additionalProperties", nickname = "testInlineAdditionalProperties", notes = "", tags={ "fake", }) @@ -128,8 +101,7 @@ ResponseEntity testEnumParameters( @RequestMapping(value = "/fake/inline-additionalProperties", consumes = { "application/json" }, method = RequestMethod.POST) - ResponseEntity testInlineAdditionalProperties( -@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param); + ResponseEntity testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param); @ApiOperation(value = "test json serialization of form data", nickname = "testJsonFormData", notes = "", tags={ "fake", }) @@ -138,8 +110,6 @@ ResponseEntity testInlineAdditionalProperties( @RequestMapping(value = "/fake/jsonFormData", consumes = { "application/json" }, method = RequestMethod.GET) - ResponseEntity testJsonFormData( -@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, -@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2); + ResponseEntity testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApiController.java index aa09efaaa79..360e1d910d7 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApiController.java @@ -40,8 +40,7 @@ public FakeApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity fakeOuterBooleanSerialize( -@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { + public ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -55,8 +54,7 @@ public ResponseEntity fakeOuterBooleanSerialize( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterCompositeSerialize( -@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { + public ResponseEntity fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -70,8 +68,7 @@ public ResponseEntity fakeOuterCompositeSerialize( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterNumberSerialize( -@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { + public ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -85,8 +82,7 @@ public ResponseEntity fakeOuterNumberSerialize( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterStringSerialize( -@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { + public ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -100,8 +96,7 @@ public ResponseEntity fakeOuterStringSerialize( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testClientModel( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -115,47 +110,22 @@ public ResponseEntity testClientModel( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testEndpointParameters( -@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, -@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, -@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, -@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, -@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, -@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, -@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, -@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, -@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, -@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, -@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, -@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, -@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, -@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { + public ResponseEntity testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testEnumParameters( -@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, -@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, -@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, -@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray -,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString -,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger -, -@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { + public ResponseEntity testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testInlineAdditionalProperties( -@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { + public ResponseEntity testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testJsonFormData( -@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, -@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { + public ResponseEntity testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApi.java index 5365c864e23..8316190673c 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApi.java @@ -34,7 +34,6 @@ public interface FakeClassnameTestApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testClassname( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApiController.java index c050c39cf94..37288b4c860 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeClassnameTestApiController.java @@ -36,8 +36,7 @@ public FakeClassnameTestApiController(ObjectMapper objectMapper, HttpServletRequ this.request = request; } - public ResponseEntity testClassname( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApi.java index 44a3c43b446..d4604e9380e 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApi.java @@ -39,8 +39,7 @@ public interface PetApi { produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.POST) - ResponseEntity addPet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); + ResponseEntity addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); @ApiOperation(value = "Deletes a pet", nickname = "deletePet", notes = "", authorizations = { @@ -54,9 +53,7 @@ ResponseEntity addPet( @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey); + ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey); @ApiOperation(value = "Finds Pets by status", nickname = "findPetsByStatus", notes = "Multiple status values can be provided with comma separated strings", response = Pet.class, responseContainer = "List", authorizations = { @@ -71,8 +68,7 @@ ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=tru @RequestMapping(value = "/pet/findByStatus", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status -); + ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status); @ApiOperation(value = "Finds Pets by tags", nickname = "findPetsByTags", notes = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", response = Pet.class, responseContainer = "List", authorizations = { @@ -87,8 +83,7 @@ ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status va @RequestMapping(value = "/pet/findByTags", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags -); + ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags); @ApiOperation(value = "Find pet by ID", nickname = "getPetById", notes = "Returns a single pet", response = Pet.class, authorizations = { @@ -101,8 +96,7 @@ ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to fil @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId -); + ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId); @ApiOperation(value = "Update an existing pet", nickname = "updatePet", notes = "", authorizations = { @@ -119,8 +113,7 @@ ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required= produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.PUT) - ResponseEntity updatePet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); + ResponseEntity updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); @ApiOperation(value = "Updates a pet in the store with form data", nickname = "updatePetWithForm", notes = "", authorizations = { @@ -135,10 +128,7 @@ ResponseEntity updatePet( produces = { "application/xml", "application/json" }, consumes = { "application/x-www-form-urlencoded" }, method = RequestMethod.POST) - ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, -@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status); + ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status); @ApiOperation(value = "uploads an image", nickname = "uploadFile", notes = "", response = ModelApiResponse.class, authorizations = { @@ -153,9 +143,6 @@ ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs t produces = { "application/json" }, consumes = { "multipart/form-data" }, method = RequestMethod.POST) - ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, -@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file); + ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApiController.java index b8f0525659d..a3890cf787d 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/PetApiController.java @@ -38,21 +38,17 @@ public PetApiController(ObjectMapper objectMapper, HttpServletRequest request) { this.request = request; } - public ResponseEntity addPet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + public ResponseEntity addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { + public ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status -) { + public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -75,8 +71,7 @@ public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "St return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags -) { + public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -99,8 +94,7 @@ public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId -) { + public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -123,24 +117,17 @@ public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",re return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updatePet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + public ResponseEntity updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, -@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { + public ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, -@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { + public ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java index acc35b8c24e..f23d712511f 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApi.java @@ -33,8 +33,7 @@ public interface StoreApi { @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId -); + ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId); @ApiOperation(value = "Returns pet inventories by status", nickname = "getInventory", notes = "Returns a map of status codes to quantities", response = Integer.class, responseContainer = "Map", authorizations = { @@ -56,8 +55,7 @@ ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs t @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId -); + ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId); @ApiOperation(value = "Place an order for a pet", nickname = "placeOrder", notes = "", response = Order.class, tags={ "store", }) @@ -67,7 +65,6 @@ ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet @RequestMapping(value = "/store/order", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity placeOrder( -@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body); + ResponseEntity placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java index 311a406d3d6..6e463e1307f 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/StoreApiController.java @@ -37,8 +37,7 @@ public StoreApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId -) { + public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } @@ -57,8 +56,7 @@ public ResponseEntity> getInventory() { return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId -) { + public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -81,8 +79,7 @@ public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity placeOrder( -@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { + public ResponseEntity placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApi.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApi.java index 8bb388b1d24..3dbcf7293cd 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApi.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApi.java @@ -32,8 +32,7 @@ public interface UserApi { @RequestMapping(value = "/user", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUser( -@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body); + ResponseEntity createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body); @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithArrayInput", notes = "", tags={ "user", }) @@ -42,8 +41,7 @@ ResponseEntity createUser( @RequestMapping(value = "/user/createWithArray", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUsersWithArrayInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); + ResponseEntity createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithListInput", notes = "", tags={ "user", }) @@ -52,8 +50,7 @@ ResponseEntity createUsersWithArrayInput( @RequestMapping(value = "/user/createWithList", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUsersWithListInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); + ResponseEntity createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); @ApiOperation(value = "Delete user", nickname = "deleteUser", notes = "This can only be done by the logged in user.", tags={ "user", }) @@ -63,8 +60,7 @@ ResponseEntity createUsersWithListInput( @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username -); + ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username); @ApiOperation(value = "Get user by user name", nickname = "getUserByName", notes = "", response = User.class, tags={ "user", }) @@ -75,8 +71,7 @@ ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be del @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username -); + ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username); @ApiOperation(value = "Logs user into the system", nickname = "loginUser", notes = "", response = String.class, tags={ "user", }) @@ -86,9 +81,7 @@ ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be @RequestMapping(value = "/user/login", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username -,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password -); + ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password); @ApiOperation(value = "Logs out current logged in user session", nickname = "logoutUser", notes = "", tags={ "user", }) @@ -107,8 +100,6 @@ ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for l @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.PUT) - ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username -, -@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body); + ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body); } diff --git a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApiController.java b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApiController.java index 404b1174b58..e96dfe648b4 100644 --- a/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApiController.java +++ b/samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/UserApiController.java @@ -37,32 +37,27 @@ public UserApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity createUser( -@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { + public ResponseEntity createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity createUsersWithArrayInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + public ResponseEntity createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity createUsersWithListInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + public ResponseEntity createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username -) { + public ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username -) { + public ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -85,9 +80,7 @@ public ResponseEntity getUserByName(@ApiParam(value = "The name that needs return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username -,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password -) { + public ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -115,9 +108,7 @@ public ResponseEntity logoutUser() { return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username -, -@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { + public ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApi.java index df224bc6d1a..6f6dd920913 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApi.java @@ -32,7 +32,6 @@ public interface AnotherFakeApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testSpecialTags( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApiController.java index 7801a972880..1f969f15713 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/AnotherFakeApiController.java @@ -36,8 +36,7 @@ public AnotherFakeApiController(ObjectMapper objectMapper, HttpServletRequest re this.request = request; } - public ResponseEntity testSpecialTags( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApi.java index a844778f163..92b47fb2a37 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApi.java @@ -34,8 +34,7 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output boolean", response = Boolean.class) }) @RequestMapping(value = "/fake/outer/boolean", method = RequestMethod.POST) - ResponseEntity fakeOuterBooleanSerialize( -@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body); + ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body); @ApiOperation(value = "", nickname = "fakeOuterCompositeSerialize", notes = "Test serialization of object with outer number type", response = OuterComposite.class, tags={ "fake", }) @@ -43,8 +42,7 @@ ResponseEntity fakeOuterBooleanSerialize( @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) }) @RequestMapping(value = "/fake/outer/composite", method = RequestMethod.POST) - ResponseEntity fakeOuterCompositeSerialize( -@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body); + ResponseEntity fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body); @ApiOperation(value = "", nickname = "fakeOuterNumberSerialize", notes = "Test serialization of outer number types", response = BigDecimal.class, tags={ "fake", }) @@ -52,8 +50,7 @@ ResponseEntity fakeOuterCompositeSerialize( @ApiResponse(code = 200, message = "Output number", response = BigDecimal.class) }) @RequestMapping(value = "/fake/outer/number", method = RequestMethod.POST) - ResponseEntity fakeOuterNumberSerialize( -@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body); + ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body); @ApiOperation(value = "", nickname = "fakeOuterStringSerialize", notes = "Test serialization of outer string types", response = String.class, tags={ "fake", }) @@ -61,8 +58,7 @@ ResponseEntity fakeOuterNumberSerialize( @ApiResponse(code = 200, message = "Output string", response = String.class) }) @RequestMapping(value = "/fake/outer/string", method = RequestMethod.POST) - ResponseEntity fakeOuterStringSerialize( -@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body); + ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body); @ApiOperation(value = "To test \"client\" model", nickname = "testClientModel", notes = "To test \"client\" model", response = Client.class, tags={ "fake", }) @@ -72,8 +68,7 @@ ResponseEntity fakeOuterStringSerialize( produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testClientModel( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); @ApiOperation(value = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", nickname = "testEndpointParameters", notes = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", authorizations = { @@ -86,21 +81,7 @@ ResponseEntity testClientModel( produces = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, consumes = { "application/xml; charset=utf-8", "application/json; charset=utf-8" }, method = RequestMethod.POST) - ResponseEntity testEndpointParameters( -@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, -@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, -@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, -@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, -@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, -@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, -@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, -@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, -@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, -@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, -@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, -@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, -@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, -@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback); + ResponseEntity testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback); @ApiOperation(value = "To test enum parameters", nickname = "testEnumParameters", notes = "To test enum parameters", tags={ "fake", }) @@ -111,15 +92,7 @@ ResponseEntity testEndpointParameters( produces = { "*/*" }, consumes = { "*/*" }, method = RequestMethod.GET) - ResponseEntity testEnumParameters( -@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, -@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, -@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, -@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray -,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString -,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger -, -@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble); + ResponseEntity testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble); @ApiOperation(value = "test inline additionalProperties", nickname = "testInlineAdditionalProperties", notes = "", tags={ "fake", }) @@ -128,8 +101,7 @@ ResponseEntity testEnumParameters( @RequestMapping(value = "/fake/inline-additionalProperties", consumes = { "application/json" }, method = RequestMethod.POST) - ResponseEntity testInlineAdditionalProperties( -@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param); + ResponseEntity testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param); @ApiOperation(value = "test json serialization of form data", nickname = "testJsonFormData", notes = "", tags={ "fake", }) @@ -138,8 +110,6 @@ ResponseEntity testInlineAdditionalProperties( @RequestMapping(value = "/fake/jsonFormData", consumes = { "application/json" }, method = RequestMethod.GET) - ResponseEntity testJsonFormData( -@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, -@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2); + ResponseEntity testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApiController.java index aa09efaaa79..360e1d910d7 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeApiController.java @@ -40,8 +40,7 @@ public FakeApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity fakeOuterBooleanSerialize( -@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { + public ResponseEntity fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -55,8 +54,7 @@ public ResponseEntity fakeOuterBooleanSerialize( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterCompositeSerialize( -@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { + public ResponseEntity fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -70,8 +68,7 @@ public ResponseEntity fakeOuterCompositeSerialize( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterNumberSerialize( -@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { + public ResponseEntity fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -85,8 +82,7 @@ public ResponseEntity fakeOuterNumberSerialize( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity fakeOuterStringSerialize( -@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { + public ResponseEntity fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -100,8 +96,7 @@ public ResponseEntity fakeOuterStringSerialize( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testClientModel( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testClientModel(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { @@ -115,47 +110,22 @@ public ResponseEntity testClientModel( return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testEndpointParameters( -@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number, -@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double, -@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter, -@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte, -@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer, -@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32, -@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64, -@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float, -@ApiParam(value = "None") @RequestPart(value="string", required=false) String string, -@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary, -@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date, -@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime, -@ApiParam(value = "None") @RequestPart(value="password", required=false) String password, -@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { + public ResponseEntity testEndpointParameters(@ApiParam(value = "None", required=true) @RequestPart(value="number", required=true) BigDecimal number,@ApiParam(value = "None", required=true) @RequestPart(value="double", required=true) Double _double,@ApiParam(value = "None", required=true) @RequestPart(value="pattern_without_delimiter", required=true) String patternWithoutDelimiter,@ApiParam(value = "None", required=true) @RequestPart(value="byte", required=true) byte[] _byte,@ApiParam(value = "None") @RequestPart(value="integer", required=false) Integer integer,@ApiParam(value = "None") @RequestPart(value="int32", required=false) Integer int32,@ApiParam(value = "None") @RequestPart(value="int64", required=false) Long int64,@ApiParam(value = "None") @RequestPart(value="float", required=false) Float _float,@ApiParam(value = "None") @RequestPart(value="string", required=false) String string,@ApiParam(value = "None") @RequestPart(value="binary", required=false) byte[] binary,@ApiParam(value = "None") @RequestPart(value="date", required=false) LocalDate date,@ApiParam(value = "None") @RequestPart(value="dateTime", required=false) OffsetDateTime dateTime,@ApiParam(value = "None") @RequestPart(value="password", required=false) String password,@ApiParam(value = "None") @RequestPart(value="callback", required=false) String paramCallback) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testEnumParameters( -@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray, -@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString, -@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray, -@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray -,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString -,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger -, -@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { + public ResponseEntity testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)", allowableValues=">, $") @RequestPart(value="enum_form_string_array", required=false) List enumFormStringArray,@ApiParam(value = "Form parameter enum test (string)", allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestPart(value="enum_form_string", required=false) String enumFormString,@ApiParam(value = "Header parameter enum test (string array)" , allowableValues=">, $") @RequestHeader(value="enum_header_string_array", required=false) List enumHeaderStringArray,@ApiParam(value = "Header parameter enum test (string)" , allowableValues="_abc, -efg, (xyz)", defaultValue="-efg") @RequestHeader(value="enum_header_string", required=false) String enumHeaderString,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List enumQueryStringArray,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)", allowableValues="1.1, -1.2") @RequestPart(value="enum_query_double", required=false) Double enumQueryDouble) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testInlineAdditionalProperties( -@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { + public ResponseEntity testInlineAdditionalProperties(@ApiParam(value = "request body" ,required=true ) @Valid @RequestBody Object param) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity testJsonFormData( -@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param, -@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { + public ResponseEntity testJsonFormData(@ApiParam(value = "field1", required=true) @RequestPart(value="param", required=true) String param,@ApiParam(value = "field2", required=true) @RequestPart(value="param2", required=true) String param2) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApi.java index 5365c864e23..8316190673c 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApi.java @@ -34,7 +34,6 @@ public interface FakeClassnameTestApi { produces = { "application/json" }, consumes = { "application/json" }, method = RequestMethod.PATCH) - ResponseEntity testClassname( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); + ResponseEntity testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApiController.java index c050c39cf94..37288b4c860 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/FakeClassnameTestApiController.java @@ -36,8 +36,7 @@ public FakeClassnameTestApiController(ObjectMapper objectMapper, HttpServletRequ this.request = request; } - public ResponseEntity testClassname( -@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { + public ResponseEntity testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Client body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApi.java index 44a3c43b446..d4604e9380e 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApi.java @@ -39,8 +39,7 @@ public interface PetApi { produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.POST) - ResponseEntity addPet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); + ResponseEntity addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); @ApiOperation(value = "Deletes a pet", nickname = "deletePet", notes = "", authorizations = { @@ -54,9 +53,7 @@ ResponseEntity addPet( @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey); + ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey); @ApiOperation(value = "Finds Pets by status", nickname = "findPetsByStatus", notes = "Multiple status values can be provided with comma separated strings", response = Pet.class, responseContainer = "List", authorizations = { @@ -71,8 +68,7 @@ ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=tru @RequestMapping(value = "/pet/findByStatus", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status -); + ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status); @ApiOperation(value = "Finds Pets by tags", nickname = "findPetsByTags", notes = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", response = Pet.class, responseContainer = "List", authorizations = { @@ -87,8 +83,7 @@ ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status va @RequestMapping(value = "/pet/findByTags", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags -); + ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags); @ApiOperation(value = "Find pet by ID", nickname = "getPetById", notes = "Returns a single pet", response = Pet.class, authorizations = { @@ -101,8 +96,7 @@ ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to fil @RequestMapping(value = "/pet/{petId}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId -); + ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId); @ApiOperation(value = "Update an existing pet", nickname = "updatePet", notes = "", authorizations = { @@ -119,8 +113,7 @@ ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required= produces = { "application/xml", "application/json" }, consumes = { "application/json", "application/xml" }, method = RequestMethod.PUT) - ResponseEntity updatePet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); + ResponseEntity updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body); @ApiOperation(value = "Updates a pet in the store with form data", nickname = "updatePetWithForm", notes = "", authorizations = { @@ -135,10 +128,7 @@ ResponseEntity updatePet( produces = { "application/xml", "application/json" }, consumes = { "application/x-www-form-urlencoded" }, method = RequestMethod.POST) - ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, -@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status); + ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status); @ApiOperation(value = "uploads an image", nickname = "uploadFile", notes = "", response = ModelApiResponse.class, authorizations = { @@ -153,9 +143,6 @@ ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs t produces = { "application/json" }, consumes = { "multipart/form-data" }, method = RequestMethod.POST) - ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, -@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file); + ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApiController.java index b8f0525659d..a3890cf787d 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/PetApiController.java @@ -38,21 +38,17 @@ public PetApiController(ObjectMapper objectMapper, HttpServletRequest request) { this.request = request; } - public ResponseEntity addPet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + public ResponseEntity addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { + public ResponseEntity deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status -) { + public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List status) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -75,8 +71,7 @@ public ResponseEntity> findPetsByStatus(@NotNull @ApiParam(value = "St return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags -) { + public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List tags) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -99,8 +94,7 @@ public ResponseEntity> findPetsByTags(@NotNull @ApiParam(value = "Tags return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId -) { + public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -123,24 +117,17 @@ public ResponseEntity getPetById(@ApiParam(value = "ID of pet to return",re return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updatePet( -@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { + public ResponseEntity updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Pet body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name, -@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { + public ResponseEntity updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet") @RequestPart(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet") @RequestPart(value="status", required=false) String status) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId -, -@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata, -@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { + public ResponseEntity uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server") @RequestPart(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/json")) { try { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java index acc35b8c24e..f23d712511f 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApi.java @@ -33,8 +33,7 @@ public interface StoreApi { @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId -); + ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId); @ApiOperation(value = "Returns pet inventories by status", nickname = "getInventory", notes = "Returns a map of status codes to quantities", response = Integer.class, responseContainer = "Map", authorizations = { @@ -56,8 +55,7 @@ ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs t @RequestMapping(value = "/store/order/{order_id}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId -); + ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId); @ApiOperation(value = "Place an order for a pet", nickname = "placeOrder", notes = "", response = Order.class, tags={ "store", }) @@ -67,7 +65,6 @@ ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet @RequestMapping(value = "/store/order", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity placeOrder( -@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body); + ResponseEntity placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java index 311a406d3d6..6e463e1307f 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/StoreApiController.java @@ -37,8 +37,7 @@ public StoreApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId -) { + public ResponseEntity deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted",required=true) @PathVariable("order_id") String orderId) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } @@ -57,8 +56,7 @@ public ResponseEntity> getInventory() { return new ResponseEntity>(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId -) { + public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID of pet that needs to be fetched",required=true) @PathVariable("order_id") Long orderId) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -81,8 +79,7 @@ public ResponseEntity getOrderById(@Min(1) @Max(5) @ApiParam(value = "ID return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity placeOrder( -@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { + public ResponseEntity placeOrder(@ApiParam(value = "order placed for purchasing the pet" ,required=true ) @Valid @RequestBody Order body) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApi.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApi.java index 8bb388b1d24..3dbcf7293cd 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApi.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApi.java @@ -32,8 +32,7 @@ public interface UserApi { @RequestMapping(value = "/user", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUser( -@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body); + ResponseEntity createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body); @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithArrayInput", notes = "", tags={ "user", }) @@ -42,8 +41,7 @@ ResponseEntity createUser( @RequestMapping(value = "/user/createWithArray", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUsersWithArrayInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); + ResponseEntity createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithListInput", notes = "", tags={ "user", }) @@ -52,8 +50,7 @@ ResponseEntity createUsersWithArrayInput( @RequestMapping(value = "/user/createWithList", produces = { "application/xml", "application/json" }, method = RequestMethod.POST) - ResponseEntity createUsersWithListInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); + ResponseEntity createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body); @ApiOperation(value = "Delete user", nickname = "deleteUser", notes = "This can only be done by the logged in user.", tags={ "user", }) @@ -63,8 +60,7 @@ ResponseEntity createUsersWithListInput( @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.DELETE) - ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username -); + ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username); @ApiOperation(value = "Get user by user name", nickname = "getUserByName", notes = "", response = User.class, tags={ "user", }) @@ -75,8 +71,7 @@ ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be del @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username -); + ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username); @ApiOperation(value = "Logs user into the system", nickname = "loginUser", notes = "", response = String.class, tags={ "user", }) @@ -86,9 +81,7 @@ ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be @RequestMapping(value = "/user/login", produces = { "application/xml", "application/json" }, method = RequestMethod.GET) - ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username -,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password -); + ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password); @ApiOperation(value = "Logs out current logged in user session", nickname = "logoutUser", notes = "", tags={ "user", }) @@ -107,8 +100,6 @@ ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for l @RequestMapping(value = "/user/{username}", produces = { "application/xml", "application/json" }, method = RequestMethod.PUT) - ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username -, -@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body); + ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body); } diff --git a/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApiController.java b/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApiController.java index 404b1174b58..e96dfe648b4 100644 --- a/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApiController.java +++ b/samples/server/petstore/springboot/src/main/java/io/swagger/api/UserApiController.java @@ -37,32 +37,27 @@ public UserApiController(ObjectMapper objectMapper, HttpServletRequest request) this.request = request; } - public ResponseEntity createUser( -@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { + public ResponseEntity createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity createUsersWithArrayInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + public ResponseEntity createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity createUsersWithListInput( -@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { + public ResponseEntity createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username -) { + public ResponseEntity deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username -) { + public ResponseEntity getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ",required=true) @PathVariable("username") String username) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -85,9 +80,7 @@ public ResponseEntity getUserByName(@ApiParam(value = "The name that needs return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username -,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password -) { + public ResponseEntity loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password) { String accept = request.getHeader("Accept"); if (accept != null && accept.contains("application/xml")) { try { @@ -115,9 +108,7 @@ public ResponseEntity logoutUser() { return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } - public ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username -, -@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { + public ResponseEntity updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) { String accept = request.getHeader("Accept"); return new ResponseEntity(HttpStatus.NOT_IMPLEMENTED); } diff --git a/samples/server/petstore/undertow/src/main/java/io/swagger/model/Order.java b/samples/server/petstore/undertow/src/main/java/io/swagger/model/Order.java index 3349d631671..fab631a5da6 100644 --- a/samples/server/petstore/undertow/src/main/java/io/swagger/model/Order.java +++ b/samples/server/petstore/undertow/src/main/java/io/swagger/model/Order.java @@ -141,7 +141,7 @@ public Order complete(Boolean complete) { @ApiModelProperty(value = "") @JsonProperty("complete") - public Boolean getComplete() { + public Boolean isComplete() { return complete; } public void setComplete(Boolean complete) { diff --git a/samples/server/petstore/undertow/src/main/resources/config/swagger.json b/samples/server/petstore/undertow/src/main/resources/config/swagger.json index c2d08f8e01f..c54baaa89cf 100644 --- a/samples/server/petstore/undertow/src/main/resources/config/swagger.json +++ b/samples/server/petstore/undertow/src/main/resources/config/swagger.json @@ -9,7 +9,7 @@ "email" : "apiteam@swagger.io" }, "license" : { - "name" : "Apache 2.0", + "name" : "Apache-2.0", "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" } }, @@ -112,8 +112,8 @@ "type" : "array", "items" : { "type" : "string", - "default" : "available", - "enum" : [ "available", "pending", "sold" ] + "enum" : [ "available", "pending", "sold" ], + "default" : "available" }, "collectionFormat" : "csv" } ], @@ -173,6 +173,7 @@ "security" : [ { "petstore_auth" : [ "write:pets", "read:pets" ] } ], + "deprecated" : true, "x-contentType" : "application/json", "x-accepts" : "application/json" } @@ -749,7 +750,7 @@ "title" : "Pet catehgry", "description" : "A category for a pet", "example" : { - "name" : "aeiou", + "name" : "name", "id" : 6 }, "xml" : { @@ -790,14 +791,14 @@ "title" : "a User", "description" : "A User who is purchasing from the pet store", "example" : { - "firstName" : "aeiou", - "lastName" : "aeiou", - "password" : "aeiou", + "firstName" : "firstName", + "lastName" : "lastName", + "password" : "password", "userStatus" : 6, - "phone" : "aeiou", + "phone" : "phone", "id" : 0, - "email" : "aeiou", - "username" : "aeiou" + "email" : "email", + "username" : "username" }, "xml" : { "name" : "User" @@ -817,7 +818,7 @@ "title" : "Pet Tag", "description" : "A tag for a pet", "example" : { - "name" : "aeiou", + "name" : "name", "id" : 1 }, "xml" : { @@ -868,15 +869,18 @@ "title" : "a Pet", "description" : "A pet for sale in the pet store", "example" : { - "photoUrls" : [ "aeiou" ], + "photoUrls" : [ "photoUrls", "photoUrls" ], "name" : "doggie", "id" : 0, "category" : { - "name" : "aeiou", + "name" : "name", "id" : 6 }, "tags" : [ { - "name" : "aeiou", + "name" : "name", + "id" : 1 + }, { + "name" : "name", "id" : 1 } ], "status" : "available" @@ -903,8 +907,8 @@ "description" : "Describes the result of uploading an image resource", "example" : { "code" : 0, - "type" : "aeiou", - "message" : "aeiou" + "type" : "type", + "message" : "message" } } },