[Java][JaxRS][Spring-MVC] Update samples for jaxrs with Jersey 1/2 and for spring-mvc #5212

ePaul · 2017-03-26T20:16:57Z

PR checklist

Read the contribution guidelines.
Ran the shell/batch script under ./bin/ to update Petstore sample so that CIs can verify the change.
→ bin/spring-mvc-petstore-j8-async-server.sh, bin/spring-mvc-petstore-server.sh, bin/jaxrs-petstore-server.sh, bin/jaxrs-jersey1-petstore-server.sh
Filed the PR against the correct branch: master for non-breaking changes.

Description of the PR

No code changes, just updating some samples so later updates show the actual changes.
I grouped those 4 samples together because the changes were quite similar.

FakeApi.testEnumParameters has some additional annotation parameters for enums in parameters.
Some of them look wrong.
In some model files line breaks for @Min/@Max annotations changed.

ePaul

Somehow we got not useful allowableValues in the @ApiParam annotations.
(Though I think some of the existing ones already were similarly non-useful, like "DOLLAR" for a string property which accepts "$".)

ePaul · 2017-03-26T20:20:25Z

samples/server/petstore/spring-mvc-j8-async/src/main/java/io/swagger/api/FakeApi.java

        consumes = { "*/*" },
        method = RequestMethod.GET)
-    default CompletableFuture<ResponseEntity<Void>> testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)" , allowableValues="GREATER_THAN, DOLLAR") @RequestPart(value="enum_form_string_array", required=false)  List<String> 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="GREATER_THAN, DOLLAR") @RequestHeader(value="enum_header_string_array", required=false) List<String> 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 = "GREATER_THAN, DOLLAR") @RequestParam(value = "enum_query_string_array", required = false) List<String> enumQueryStringArray, @ApiParam(value = "Query parameter enum test (string)", allowableValues = "_ABC, _EFG, _XYZ_", defaultValue = "-efg") @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString, @ApiParam(value = "Query parameter enum test (double)") @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)" ) @RequestPart(value="enum_query_double", required=false)  Double enumQueryDouble) {
+    default CompletableFuture<ResponseEntity<Void>> testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)" , allowableValues="GREATER_THAN, DOLLAR") @RequestPart(value="enum_form_string_array", required=false)  List<String> 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="GREATER_THAN, DOLLAR") @RequestHeader(value="enum_header_string_array", required=false) List<String> 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 = "GREATER_THAN, DOLLAR") @RequestParam(value = "enum_query_string_array", required = false) List<String> enumQueryStringArray, @ApiParam(value = "Query parameter enum test (string)", allowableValues = "_ABC, _EFG, _XYZ_", defaultValue = "-efg") @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString, @ApiParam(value = "Query parameter enum test (double)", allowableValues = "NUMBER_1, NUMBER_MINUS_2") @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)" , allowableValues="NUMBER_1_DOT_1, NUMBER_MINUS_1_DOT_2") @RequestPart(value="enum_query_double", required=false)  Double enumQueryDouble) {


This is difficult to see because it is all on one line.

We got allowableValues = "NUMBER_1, NUMBER_MINUS_2" on an Integer parameter, and ) allowableValues="NUMBER_1_DOT_1, NUMBER_MINUS_1_DOT_2" on a Double parameter (in @ApiParam).

I don't think this is useful for whoever is evaluating those annotations.

I've opened #5319 for tracking.

ePaul · 2017-03-26T20:21:06Z

samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApiController.java

-         @ApiParam(value = "Query parameter enum test (double)") @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,
-        @ApiParam(value = "Query parameter enum test (double)" ) @RequestPart(value="enum_query_double", required=false)  Double enumQueryDouble) {
+         @ApiParam(value = "Query parameter enum test (double)", allowableValues = "NUMBER_1, NUMBER_MINUS_2") @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,
+        @ApiParam(value = "Query parameter enum test (double)" , allowableValues="NUMBER_1_DOT_1, NUMBER_MINUS_1_DOT_2") @RequestPart(value="enum_query_double", required=false)  Double enumQueryDouble) {


Same here (but easier to read).

ePaul · 2017-03-26T20:21:56Z

samples/server/petstore/spring-mvc/src/main/java/io/swagger/api/FakeApi.java

        consumes = { "*/*" },
        method = RequestMethod.GET)
-    ResponseEntity<Void> testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)" , allowableValues="GREATER_THAN, DOLLAR") @RequestPart(value="enum_form_string_array", required=false)  List<String> 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="GREATER_THAN, DOLLAR") @RequestHeader(value="enum_header_string_array", required=false) List<String> 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 = "GREATER_THAN, DOLLAR") @RequestParam(value = "enum_query_string_array", required = false) List<String> enumQueryStringArray, @ApiParam(value = "Query parameter enum test (string)", allowableValues = "_ABC, _EFG, _XYZ_", defaultValue = "-efg") @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString, @ApiParam(value = "Query parameter enum test (double)") @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)" ) @RequestPart(value="enum_query_double", required=false)  Double enumQueryDouble);
+    ResponseEntity<Void> testEnumParameters(@ApiParam(value = "Form parameter enum test (string array)" , allowableValues="GREATER_THAN, DOLLAR") @RequestPart(value="enum_form_string_array", required=false)  List<String> 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="GREATER_THAN, DOLLAR") @RequestHeader(value="enum_header_string_array", required=false) List<String> 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 = "GREATER_THAN, DOLLAR") @RequestParam(value = "enum_query_string_array", required = false) List<String> enumQueryStringArray, @ApiParam(value = "Query parameter enum test (string)", allowableValues = "_ABC, _EFG, _XYZ_", defaultValue = "-efg") @RequestParam(value = "enum_query_string", required = false, defaultValue="-efg") String enumQueryString, @ApiParam(value = "Query parameter enum test (double)", allowableValues = "NUMBER_1, NUMBER_MINUS_2") @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,@ApiParam(value = "Query parameter enum test (double)" , allowableValues="NUMBER_1_DOT_1, NUMBER_MINUS_1_DOT_2") @RequestPart(value="enum_query_double", required=false)  Double enumQueryDouble);


Same change here.

ePaul · 2017-04-01T13:19:18Z

Rebased onto current master, and updated again. The parameter name change comes from #5267, which changed the underlying .yaml file.

…d for spring-mvc (swagger-api#5212) * Update samples for Spring-MVC. * Update samples for Spring-MVC-Jav8-async. * Update samples jaxrs/jersey1. * Update samples jaxrs/jersey2. * Update samples spring-mvc * Update samples spring-mvc-j8-async

ePaul commented Mar 26, 2017

View reviewed changes

ePaul force-pushed the update-samples-jaxrs+spring-mvc branch from dc55d58 to 0a86433 Compare March 26, 2017 23:15

This was referenced Mar 28, 2017

Updating samples after #5232. #5243

Merged

Fixes in escaping when generating Java from swagger.json (2) #5247

Merged

[CLI] #5147: make -D work like system properties #5191

Merged

ePaul force-pushed the update-samples-jaxrs+spring-mvc branch from 0a86433 to 089f126 Compare April 1, 2017 13:11

ePaul mentioned this pull request Apr 1, 2017

Updating (almost) all samples. #5281

Merged

3 tasks

Paŭlo Ebermann added 6 commits April 2, 2017 16:08

Update samples for Spring-MVC.

77328d0

Update samples for Spring-MVC-Jav8-async.

3bd2315

Update samples jaxrs/jersey1.

26ce55a

Update samples jaxrs/jersey2.

3b4ed83

Update samples spring-mvc

73cf7bc

Update samples spring-mvc-j8-async

2d61b27

ePaul force-pushed the update-samples-jaxrs+spring-mvc branch from 089f126 to 2d61b27 Compare April 2, 2017 14:14

wing328 mentioned this pull request Apr 4, 2017

[Java][Spring] allowableValues is incorrectly set to Enum name #5319

Closed

wing328 merged commit f0b0226 into swagger-api:master Apr 4, 2017

wing328 added this to the v2.2.3 milestone Apr 4, 2017

ePaul deleted the update-samples-jaxrs+spring-mvc branch April 4, 2017 13:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Java][JaxRS][Spring-MVC] Update samples for jaxrs with Jersey 1/2 and for spring-mvc #5212

[Java][JaxRS][Spring-MVC] Update samples for jaxrs with Jersey 1/2 and for spring-mvc #5212

Uh oh!

ePaul commented Mar 26, 2017

Uh oh!

ePaul left a comment

Uh oh!

ePaul Mar 26, 2017

Uh oh!

wing328 Apr 4, 2017

Uh oh!

ePaul Apr 4, 2017

Uh oh!

ePaul Mar 26, 2017

Uh oh!

ePaul Mar 26, 2017

Uh oh!

ePaul commented Apr 1, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

[Java][JaxRS][Spring-MVC] Update samples for jaxrs with Jersey 1/2 and for spring-mvc #5212

[Java][JaxRS][Spring-MVC] Update samples for jaxrs with Jersey 1/2 and for spring-mvc #5212

Uh oh!

Conversation

ePaul commented Mar 26, 2017

PR checklist

Description of the PR

Uh oh!

ePaul left a comment

Choose a reason for hiding this comment

Uh oh!

ePaul Mar 26, 2017

Choose a reason for hiding this comment

Uh oh!

wing328 Apr 4, 2017

Choose a reason for hiding this comment

Uh oh!

ePaul Apr 4, 2017

Choose a reason for hiding this comment

Uh oh!

ePaul Mar 26, 2017

Choose a reason for hiding this comment

Uh oh!

ePaul Mar 26, 2017

Choose a reason for hiding this comment

Uh oh!

ePaul commented Apr 1, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants