OpenAPITools / OpenAPITools/openapi-generator
[BUG] Installation doc runs unrelated code with npx
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
Following the instructions at https://openapi-generator.tech/docs/installation, running npx openapi-generator generate -i petstore.yaml -g ruby -o /tmp/test/ will actually run code from
https://www.npmjs.com/package/openapi-generator, not https://www.npmjs.com/package/@openapitools/openapi-generator-cli.
This matches what npm would install with npm install --dry-run openapi-generator.
Suggest a fix
Remove npx from the instructions, or change it to use --package.
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 the installation documentation at https://openapi-generator.tech/docs/installation and reproduce the shown npx command. Check which package npm resolves for openapi-generator versus @openapitools/openapi-generator-cli. Done means the instructions no longer execute the unrelated package, either by removing npx or using the suggested --package form.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, openapi
- Domain
- cli, documentation
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100