OpenAPITools / OpenAPITools/openapi-generator
[REQ] [angular-typescript] Add documentation for `RequestParams` with `useSingleRequestParameter = true`
Open
Nobody has claimed this yet.
Enhancement: Feature
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
When setting
useSingleRequestParameter: true
the documentation strings for the properties are missing, e.g.:
export interface SomeRequestParams {
id: number;
}
I would like to have the documentation strings in the generated interfaces, e.g.:
export interface SomeRequestParams {
/**
* The ID of the entity.
*/
id: number;
}
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
The issue names the angular-typescript generator and the useSingleRequestParameter option; start by locating that generator’s RequestParams generation path and existing property-description handling. Generate a sample client with the option enabled and verify that each interface property receives its OpenAPI description as JSDoc without changing unrelated output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100