swagger-api / swagger-api/swagger-client
Document usage of agent
Open
Nobody has claimed this yet.
cat: documentation
Hacktoberfest
type: enhancement
version: 3.x
- Dominant language
- JavaScript
- Stars
- 2.7k
- Forks
- 765
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 6
Description
More information in this comment. Let's document the fact that our http interface consumes another options from fetch interface in more generic way and add a concrete example about using agent as described in attached comment.
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 linked comment for the required behavior, then locate the HTTP interface and its fetch interface options in the project documentation. Done means the documentation explains the additional options generically and includes a concrete example of using an agent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100