swagger-api / swagger-api/swagger-codegen
Docs: Installation and Getting Started sections in README are conflicting.
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
Expected that the installation section would provide me with everything needed to get started.
Actually, the download of the jar file is insufficient to run codegen for some languages (typescript-angular) and "git clone" should be done instead to get mustache templates.
Swagger-codegen version
3.0.0-rc1
Swagger declaration file content or url
Command line used for generation
java -jar swagger-codegen-cli.jar generate -i http://localhost:8080/openapi.json -l typescript-angular -o typescript-client
Steps to reproduce
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
Review the README's Installation and Getting Started sections alongside the documented java -jar generation command for typescript-angular. Clarify whether downloading the JAR is sufficient or whether git clone is required for the Mustache templates, then make both sections consistent and verify that the resulting instructions cover the reported workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, java, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100