swagger-api / swagger-api/swagger-codegen

swagger-codegen README.md section "Modifying the client library format" references old location for templates

Open
#9,658 1 comment 0 reactions 1 assignee View on GitHub

@HugoMario is already working on this.

Since May 8, 2020.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

I found it really hard to find the handlebars templates, as the README.md referenced the location for swagger-codegen 2.4.7:
https://github.com/swagger-api/swagger-codegen/tree/v3.0.10#modifying-the-client-library-format
"You can look at modules/swagger-codegen/src/main/resources/${your-language} for examples."

Swagger-codegen version

swagger-codegen v3.0.10

Swagger declaration file content or url

N/A - this is a documentation fix.

Command line used for generation

N/A - this is a documentation fix.

Steps to reproduce

N/A - this is a documentation fix.

Related issues/PRs

Not sure... I could not find any related issues.

Suggest a fix/enhancement

Modify README.md to reference the new location swagger-codegen-generators/tree/master/src/main/resources/handlebars/${your-language}:
https://github.com/swagger-api/swagger-codegen/tree/v3.0.10#modifying-the-client-library-format
You can look at modules/swagger-codegen-generators/src/main/resources/handlebars/${your-language} for examples.

Making this a link would be more helpful too:
https://github.com/swagger-api/swagger-codegen-generators/tree/master/src/main/resources/handlebars

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.