OpenAPITools / OpenAPITools/openapi-generator
Documentation for typescript-fetch incorrectly indicates support for API and Model documentation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Description
openapi-generator version
N/A
OpenAPI declaration file content or url
N/A
Command line used for generation
N/A
Steps to reproduce
View "Documentation Feature" table:
https://openapi-generator.tech/docs/generators/typescript-fetch#documentation-feature
Related issues/PRs
N/A
Suggest a fix/enhancement
Indicate in the table that API and Model documentation is not supported, or at least improve the table to indicate that they are only supported as doc comments in the source code and not as standalone documentation files.
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 typescript-fetch Documentation Feature table at the linked generator documentation page. Update its API and Model documentation entries to distinguish source-code doc comments from standalone documentation files; it is done when the table accurately describes that support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100