swagger-api / swagger-api/swagger-codegen
[Javascript] No documentation on <operation>WithHttpInfo methods created by usePromises
Open
Nobody has claimed this yet.
Feature: Documentation
General: Suggestion
help wanted
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
It's really great that we now have the WithHttpInfo methods then using usePromises, but this is not documented anywhere. Is there any plans on doing this?
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 by locating the JavaScript generator documentation and the usePromises handling that creates WithHttpInfo methods. Determine where the generated method behavior should be documented, then update the relevant documentation to explain these methods and verify that the usePromises guidance covers them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100