OpenAPITools / OpenAPITools/openapi-generator

[BUG] [Rust Server] yaml headers parameter in responses not match with required flag.

Open
#6,066 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

[BUG] [Rust Server] yaml headers parameter in responses not match with required flag.

openapi-generator version

5.0.x

OpenAPI declaration file content or url

/repos/{repoId}:
parameters:
- in: path
name: repoId
schema:
type: string
required: true
get:
tags: [Repo, Info]
operationId: GetRepoInfo
responses:
"200":
description: OK

  •      headers:
    
  •        X-Cursor:
    
  •          schema:
    
  •            type: string
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StringObject"
    

Generated Rust Server code as following:

pub enum GetRepoInfoResponse {
/// OK
OK

  • (String)
  • {
  •    body: String,
    
  •    x_cursor: String
    
  • }
    }
    //x_cursor is not optional.
Command line used for generation

bin/rust-server-petstore.sh

Steps to reproduce

bin/rust-server-petstore.sh

Related issues/PRs

NA

Suggest a fix

Generate x_cursor as Option<>.

Contributor guide

Open the contributing guide

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.

Research direction

Start with bin/rust-server-petstore.sh and the OpenAPI response-header example, then trace how the Rust server generator represents the X-Cursor header. Compare the generated GetRepoInfoResponse with the header's required setting; done means an optional header is generated as Option<> and the reproduction script produces the corrected output.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.