OpenAPITools / OpenAPITools/openapi-generator
[request for clarification]: generating Java from Yaml: multiple "responses", but only one ResponseEntity<...>
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
The yaml file contains a call like this:
paths:
/foo/bar:
get:
...
responses:
'200':
description: OK
schema:
$ref: '#/definitions/FooResult'
'400':
description: BAD REQUEST
schema:
$ref: '#/definitions/FooError'
...
The generated API declares the method as returning a ResponseEntity<FooResult>, and I cannot see how my implementation can ever return a ResponseEntity<FooError> for cases that lead to a code 400.
I'd appreciate explanations, what I may be expecting wrong, or if this is a bug.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the YAML response definitions and the generated Java method described in the report. Determine whether multiple response schemas are supported or documented, then clarify the expected handling of the 400 response and whether a generator change is required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- backend-api-design, devtools
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100