[BUG][rust-axum] Range response codes (4XX, 5XX) generate code that does not compile
Maintainers usually reply within 1 day
Nobody has claimed this yet.
- #25294 by @teovillanueva — closed without merging
Assessment
- Difficulty
- 3/5
- Estimated time
- Half a day
- Newbie friendliness
- 35/100
Research direction
Start with server-operation.mustache and the generated response enum for the provided OpenAPI declaration, then reproduce the failures by generating the rust-axum server and running cargo check in out. Done means ranged response variants preserve a concrete u16 status with optional body/headers as appropriate, and generated servers compile and build responses using the status() builder.
Written by the indexing model from the issue text.
Description
Description
When an operation declares a range response code (4XX, 5XX, ...), the rust-axum server generator emits code that does not compile. For range responses, server-operation.mustache renders
response.status::<u16>(body.code.parse().unwrap()); // 4XX
which assumes the response body has a code field (error[E0609]: no field 'code' on type 'models::Error'), fails when the response has no body (error[E0425]: cannot find value 'body' in this scope), and drops the builder returned by status() (error[E0382] once the other errors are worked around). The generated response enum also has no way for the implementation to choose the concrete status within the range.
openapi-generator version
master (7.27.0-SNAPSHOT, commit 30f13393)
OpenAPI declaration file content or url
openapi: 3.0.3
info:
title: Range responses
version: 1.0.0
paths:
/pets/{petId}:
get:
operationId: getPet
parameters:
- name: petId
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: The pet
content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
"4XX":
description: Client error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"5XX":
description: Server error
components:
schemas:
Pet:
type: object
properties:
name:
type: string
Error:
type: object
properties:
message:
type: string
Generation Details
java -jar openapi-generator-cli.jar generate -g rust-axum -i spec.yaml -o out
Steps to reproduce
- Generate the server with the spec above.
- Run
cargo checkinout. - Compilation fails with E0609 (
no field 'code' on type 'models::Error') for the4XXarm and E0425 (cannot find value 'body') for the5XXarm.
Related issues/PRs
None found.
Suggest a fix
Have range responses carry the status code: generate them as struct variants with a status: u16 field (plus body and headers as usual), e.g. Status4XX_ClientError { status: u16, body: models::Error }. The server then sets response.status(status), so the implementation picks the concrete code within the range.
- Dominant language
- Java
- Stars
- 26.9k
- Forks
- 7.8k
- Avg merge
- 2d 23m
- Merged PRs (30d)
- 177
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from OpenAPITools/openapi-generator
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OpenAPITools/openapi-generator#25768 ·
Maintainers usually reply within 1 day
-
Enhancement: Feature
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OpenAPITools/openapi-generator#25753 ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
OpenAPITools/openapi-generator#25724 · 1 comment ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
OpenAPITools/openapi-generator#25723 · 1 comment ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
OpenAPITools/openapi-generator#25719 · 1 comment ·
Maintainers usually reply within 1 day
All issues in OpenAPITools/openapi-generator
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
eclipse-tradista/tradista#371 ·
Maintainers usually reply within 1 day
-
critical
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
mars-sim/mars-sim#2199 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
primefaces/primefaces#15568 ·
Maintainers usually reply within 1 day
-
崩溃日志只按 CRLF 分行Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
PCL-Community/PCL-CE#3872 ·
Maintainers usually reply within 1 day