[java-micronaut] Allow default implementation to return HTTP 501 #12365
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
auke-
force-pushed
the
micronaut-not-implemented
branch
from
2e8b10c to
5032194
Compare
andriy-dmytruk
suggested changes
May 13, 2022
There was a problem hiding this comment.
@auke- Thank you for the PR.
Looks like a valuable contribution to me.
...i-generator/src/main/java/org/openapitools/codegen/languages/JavaMicronautServerCodegen.java
Outdated
Show resolved
Hide resolved
...i-generator/src/main/java/org/openapitools/codegen/languages/JavaMicronautServerCodegen.java
Outdated
Show resolved
Hide resolved
The default controller implementation returns an empty response. This might result in unexpected behavior when an operation isn't implemented, as a consumer of the API there is no way to notice the difference between an unimplemented method and an actual empty response. By changing the default behavior to return HTTP 501 Not Implemented the user will be made aware of unimplemented methods. The former default behavior, returning an empty response by default, can be activated with a configuration option.
auke-
force-pushed
the
micronaut-not-implemented
branch
from
5032194 to
97eb95f
Compare
andriy-dmytruk
approved these changes
May 15, 2022
There was a problem hiding this comment.
Tested locally - works as expected. Thanks.
@wing328 Can you merge?
|
Thanks again for the PR, which has been included in the v6.0.0 release: https://twitter.com/oas_generator/status/1529669733934841856 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The default controller implementation returns an empty response. While
this might be an expected default for some users we want the default
implementation to return HTTP 501 Not Implemented instead. This will
support rapid development when the specs aren't finalized yet and thus
change often while preventing the methods from being unimplemented by
accident without the user of the API noticing it.
By adding a property which allows the generation of default methods
which return HTTP 501 developers can opt-in for this behavior.
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.For Windows users, please run the script in Git BASH.
@andriy-dmytruk