Documentation for the data injected into templates for easier customisation

Open Beginner friendly
#528 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Look at the template files in the project (likely in a templates directory) and the code that injects data into them. Run the generator with a sample OpenAPI spec and log the data passed to templates to understand the structure. Document the available variables and their shapes for each template.

Written by the indexing model from the issue text.

Description

Hi!

Haven't found any docs for that, are there any plans to support such a documentation?
Right now the only way to actually customise generation is to read the source code of the project and/or log the data it injects to templates.

Dominant language
TypeScript
Stars
4.1k
Forks
436
Avg merge
9d 7h
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

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.

More from acacode/swagger-typescript-api

All issues in acacode/swagger-typescript-api

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.