swagger-api/swagger-codegen

[Javascript] No documentation on <operation>WithHttpInfo methods created by usePromises

Open

#5,555 opened on May 4, 2017

View on GitHub
 (6 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Feature: DocumentationGeneral: Suggestionhelp wanted

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

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with swagger codegenJavaScriptdocumentation practices
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the swagger codegen repository, specifically the JavaScript client generation templates (e.g., modules/swagger codegen/src/main/resources/Javascript/). Look for how usePromises option generates WithHttpInfo methods. Check if any existing documentation covers these methods. Consider contributing a section to the generated client documentation or a README note. Also review issue comments for maintainer guidance on desired documentation format.