[jaxrs-spec][quarkus]: add @ResponseStatus annotation for non-200 success codes#23673
Open
Ignacio-Vidal wants to merge 1 commit intoOpenAPITools:masterfrom
Open
[jaxrs-spec][quarkus]: add @ResponseStatus annotation for non-200 success codes#23673Ignacio-Vidal wants to merge 1 commit intoOpenAPITools:masterfrom
Ignacio-Vidal wants to merge 1 commit intoOpenAPITools:masterfrom
Conversation
c258cbc to
86dc86b
Compare
Contributor
There was a problem hiding this comment.
1 issue found across 16 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="modules/openapi-generator/src/main/resources/JavaJaxRS/spec/libraries/quarkus/apiMethod.mustache">
<violation number="1" location="modules/openapi-generator/src/main/resources/JavaJaxRS/spec/libraries/quarkus/apiMethod.mustache:50">
P2: @ResponseStatus is emitted on a method that still returns Response, so in Quarkus RESTEasy Reactive it will be ignored and cannot enforce the non-200 status code.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
e13c88c to
1e82e41
Compare
Author
|
@chameleon82, @hiveship, @nickcmaynard or @jfiala - could you review this improvement to the jaxrs-spec/quarkus generator? There is a circle ci job failing in the internal setup during the environment setup, any suggestions for this:
|
…ess codes Adds @org.jboss.resteasy.reactive.ResponseStatus to generated Quarkus JAX-RS server stubs when the OpenAPI spec defines a non-200 success response code (2xx). This allows Quarkus to automatically set the correct HTTP status code without the user manually returning a Response object. Gated on useJakartaEe: true (Quarkus 3+ / Jakarta EE namespace) because @ResponseStatus is a RESTEasy Reactive feature, which is the default REST stack only in Quarkus 3+. Quarkus 1.x/2.x projects use quarkus-resteasy (classic) which does not process this annotation, and the quarkus-universe-bom 1.x provides a version of resteasy-reactive that predates ResponseStatus. - JavaJAXRSSpecServerCodegen: set x-java-success-response-code vendor extension for Quarkus+Jakarta EE+non-Response-returning operations - quarkus/apiMethod.mustache, api.mustache, apiInterface.mustache: emit @ResponseStatus(<code>) when the vendor extension is present - quarkus/pom.mustache: add resteasy-reactive dep when annotation is used - Tests and generated samples updated
1e82e41 to
b0e089e
Compare
This file contains hidden or 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
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.
Description
Adds @org.jboss.resteasy.reactive.ResponseStatus annotation to generated Quarkus JAX-RS server stubs when the OpenAPI spec defines a non-200 success response code (2xx). This allows Quarkus to automatically set the correct HTTP
status code on the response without the user having to manually return a Response object.
The annotation is gated on useJakartaEe: true (Quarkus 3+ / Jakarta EE namespace) because:
Changes:
PR checklist
Commit all changed files.
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*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Generate Quarkus JAX-RS stubs with
@ResponseStatuson interface methods to automatically set success HTTP codes for operations that don’t returnResponse/RestResponse. Applies to numeric 2xx responses (including 200) on Quarkus 3+ (Jakarta).New Features
@ResponseStatus(<code>)whenuseJakartaEe: true,library = quarkus, the operation has a numeric 2xx response, and does not returnResponse/RestResponse.interfaceOnly: true); class stubs returnResponseand are not annotated. ImportResponseStatusonly when used.x-java-success-response-codeper operation andhasResponseStatusAnnotations(file/global) to drive annotation, imports, and POM.returnResponseorreturnJbossResponseis true.Dependencies
io.quarkus.resteasy.reactive:resteasy-reactiveto the generated POM only when@ResponseStatusis emitted.Written for commit b0e089e. Summary will update on new commits.