Skip to content

[Java][Spring] fix default response code #14399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 1 commit into from
Jan 11, 2023
Merged

[Java][Spring] fix default response code #14399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/JavaSpring/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ public interface {{classname}} {
{{/vendorExtensions.x-tags.size}}
responses = {
{{#responses}}
@ApiResponse(responseCode = "{{{code}}}", description = "{{{message}}}"{{#baseType}}, content = {
@ApiResponse(responseCode = {{#isDefault}}"default"{{/isDefault}}{{^isDefault}}"{{{code}}}"{{/isDefault}}, description = "{{{message}}}"{{#baseType}}, content = {
Copy link
Copy Markdown
Contributor

@welshm welshm Jan 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code change looks great! Should there be a unit test for this? I'm also happy to add it if you think it adds value

Copy link
Copy Markdown
Member Author

@borsch borsch Jan 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, samples are updated. do you think we still need unit test for this? If yes I can add them quickly

Copy link
Copy Markdown
Contributor

@welshm welshm Jan 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry missed this. I do think unit tests still add value because if someone breaks it, the unit tests will block the submission (hopefully) or alert them that the samples were updated incorrectly. I can add these in a few days and send out for review

{{#produces}}
@Content(mediaType = "{{{mediaType}}}", {{#isArray}}array = @ArraySchema({{/isArray}}schema = @Schema(implementation = {{{baseType}}}.class){{#isArray}}){{/isArray}}){{^-last}},{{/-last}}
{{/produces}}
Expand Down
8 changes: 4 additions & 4 deletions ...s/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public interface UserApi {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -80,7 +80,7 @@ ResponseEntity<Void> createUser(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -109,7 +109,7 @@ ResponseEntity<Void> createUsersWithArrayInput(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -233,7 +233,7 @@ ResponseEntity<String> loginUser(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down
8 changes: 4 additions & 4 deletions ...enapi3/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public interface UserApi {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -75,7 +75,7 @@ CompletableFuture<ResponseEntity<Void>> createUser(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -98,7 +98,7 @@ CompletableFuture<ResponseEntity<Void>> createUsersWithArrayInput(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down Expand Up @@ -209,7 +209,7 @@ CompletableFuture<ResponseEntity<String>> loginUser(
summary = "Logs out current logged in user session",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down
8 changes: 4 additions & 4 deletions ...client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public interface UserApi {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -74,7 +74,7 @@ ResponseEntity<Void> createUser(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -97,7 +97,7 @@ ResponseEntity<Void> createUsersWithArrayInput(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down Expand Up @@ -208,7 +208,7 @@ ResponseEntity<String> loginUser(
summary = "Logs out current logged in user session",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down
10 changes: 5 additions & 5 deletions ...ent/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public interface UserApi {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -74,7 +74,7 @@ ResponseEntity<Void> createUser(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -97,7 +97,7 @@ ResponseEntity<Void> createUsersWithArrayInput(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down Expand Up @@ -208,7 +208,7 @@ ResponseEntity<String> loginUser(
summary = "Logs out current logged in user session",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -230,7 +230,7 @@ ResponseEntity<Void> logoutUser(
summary = "logoutUserOptions",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "endpoint configuration response")
@ApiResponse(responseCode = "default", description = "endpoint configuration response")
}
)
@RequestMapping(
Expand Down
8 changes: 4 additions & 4 deletions ...les/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public interface UserApi {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -80,7 +80,7 @@ ResponseEntity<Void> createUser(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -109,7 +109,7 @@ ResponseEntity<Void> createUsersWithArrayInput(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -233,7 +233,7 @@ ResponseEntity<String> loginUser(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down
8 changes: 4 additions & 4 deletions ...store/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public interface UserApi {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -74,7 +74,7 @@ ResponseEntity<Void> createUser(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -97,7 +97,7 @@ ResponseEntity<Void> createUsersWithArrayInput(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down Expand Up @@ -208,7 +208,7 @@ ResponseEntity<String> loginUser(
summary = "Logs out current logged in user session",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down
8 changes: 4 additions & 4 deletions ...les/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ default Optional<NativeWebRequest> getRequest() {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -81,7 +81,7 @@ default ResponseEntity<Void> createUser(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -107,7 +107,7 @@ default ResponseEntity<Void> createUsersWithArrayInput(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down Expand Up @@ -244,7 +244,7 @@ default ResponseEntity<String> loginUser(
summary = "Logs out current logged in user session",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down
8 changes: 4 additions & 4 deletions ...pi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ default Optional<NativeWebRequest> getRequest() {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -87,7 +87,7 @@ default ResponseEntity<Void> createUser(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -119,7 +119,7 @@ default ResponseEntity<Void> createUsersWithArrayInput(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -269,7 +269,7 @@ default ResponseEntity<String> loginUser(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down
8 changes: 4 additions & 4 deletions ...les/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ default Optional<NativeWebRequest> getRequest() {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -87,7 +87,7 @@ default ResponseEntity<Void> createUser(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -119,7 +119,7 @@ default ResponseEntity<Void> createUsersWithArrayInput(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down Expand Up @@ -269,7 +269,7 @@ default ResponseEntity<String> loginUser(
description = "",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
},
security = {
@SecurityRequirement(name = "api_key")
Expand Down
8 changes: 4 additions & 4 deletions ...ore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ default Optional<NativeWebRequest> getRequest() {
description = "This can only be done by the logged in user.",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -81,7 +81,7 @@ default ResponseEntity<Void> createUser(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand All @@ -107,7 +107,7 @@ default ResponseEntity<Void> createUsersWithArrayInput(
summary = "Creates list of users with given input array",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down Expand Up @@ -244,7 +244,7 @@ default ResponseEntity<String> loginUser(
summary = "Logs out current logged in user session",
tags = { "user" },
responses = {
@ApiResponse(responseCode = "200", description = "successful operation")
@ApiResponse(responseCode = "default", description = "successful operation")
}
)
@RequestMapping(
Expand Down
Loading