OpenAPITools / OpenAPITools/openapi-generator
[REQ] Cookie parameters are not annotated as such in typescript
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
I'm not sure if I'm missing some kind of config, but currently, when I generate an axios typescript sdk, it shows cookie parameters as if they were no different from the rest. Because of that, when using the SDK I have to go back to the original docs to figure out which ones were cookies (it's not always obvious from the name).
Describe the solution you'd like
I'd like the generated docstrings to contain a "cookie" annotation for each cookie parameter.
Describe alternatives you've considered
Naming all cookies as something_cookie, but it doesn't work if the cookie is already named in some other context by an external tool, and makes the names unnecessarily verbose.
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
No files or tests are identified in the issue. Start by tracing the axios TypeScript SDK generator's handling of cookie parameters and its generated docstrings; then add coverage for a cookie parameter and verify that the generated documentation distinguishes it from other parameters.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100