swagger-api / swagger-api/swagger-codegen
[Ruby] OpenAPI spec version is not being updated in spec/* files
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
Calling swagger-codegen for the ruby client does not update the OpenAPI spec version in the comments of the spec files.
Swagger-codegen version
> swagger-codegen version
3.0.52
Swagger declaration file content or url
OpenAPI yaml spec:
https://gist.github.com/pijng/b3d09581c4f7bbf81bac4778dc8516f2
Command line used for generation
swagger-codegen generate -i ./openapi.yaml -l ruby -o /Projects/swagger-codegen-ruby/ --additional-properties gemName=moonlogs-ruby gemVersion=0.3.10
Steps to reproduce
- Create an empty directory
- Populate it with generated ruby client for version 0.3.10 using
openapi.yamlspec from gist by calling:
swagger-codegen generate -i ./openapi.yaml -l ruby -o <path-to-directory> --additional-properties gemName=moonlogs-ruby gemVersion=0.3.10
- Change the
info.versionto 0.3.11 inopenapi.yaml - Call swagger-codegen against the updated
openapi.yamlwith relevant version ingemVersion:
swagger-codegen generate -i ./openapi.yaml -l ruby -o <path-to-same-directory> --additional-properties gemName=moonlogs-ruby gemVersion=0.3.11
As the result, all references to version 0.3.10 will be replaced by 0.3.11, except for files in the spec/ directory.
Demonstrating the difference between versions at a single point in time:
Related issues/PRs
Suggest a fix/enhancement
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
Reproduce the issue with the linked OpenAPI YAML and the two swagger-codegen generate commands, comparing generated files under spec/ before and after changing info.version and gemVersion. Trace the Ruby generator's handling of spec/* files and verify that rerunning generation updates their version comments from 0.3.10 to 0.3.11.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, ruby
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100