OpenAPITools / OpenAPITools/openapi-generator
[BUG] [Rust Server] yaml self reference code compile error.
Nobody has claimed this yet.
- 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
Using self reference in yaml, the generated Rust code compile error.
openapi-generator version
3.0.1
OpenAPI declaration file content or url
Error:
type: object
required:
- code
- retryable
- message
properties:
code:
type: integer
retryable:
type: boolean
message:
type: string
example: NotFound
innerError:
$ref: "#/components/schemas/Error"
Command line used for generation
bin/rust-server-petstore.sh
Steps to reproduce
add above yaml code to modules/openapi-generator/src/test/resources/3_0/rust-server/openapi-v3.yaml, then comile the generated code.
Related issues/PRs
NA
Suggest a fix
Add isSelfReference to check self reference var, and If true add Box<>.
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 modules/openapi-generator/src/test/resources/3_0/rust-server/openapi-v3.yaml and the bin/rust-server-petstore.sh reproduction command. Inspect the Rust server generator handling of the Error schema's self-reference, then regenerate the server and compile the generated code. Done means the self-referencing YAML produces compilable Rust code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, rust
- Domain
- api, backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 38/100