[BUG][rust-axum] Range response codes (4XX, 5XX) generate code that does not compile

Open
#25,293 0 comments 0 reactions 0 assignees View on GitHub

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
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
tooling

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
  1. Generate the server with the spec above.
  2. Run cargo check in out.
  3. Compilation fails with E0609 (no field 'code' on type 'models::Error') for the 4XX arm and E0425 (cannot find value 'body') for the 5XX arm.
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

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenAPITools/openapi-generator

All issues in OpenAPITools/openapi-generator

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.