Add Curl & PowerShell Examples instead of / as well as httpie examples in the API docs
Open
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 116
- Forks
- 51
- Avg merge
- 1h 25m
- Merged PRs (30d)
- 1
Description
Curl is the defacto standard for any automation of any restful api's and it seems counter intuitive to use example systems for the docs that most devs would be used to. I have wrapped a number of REST API's in PowerShell before but have not seen httpie previously
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 in the API documentation sections that currently show HTTPie examples and identify the examples covered by the request. Add equivalent cURL and PowerShell examples alongside them, then verify that the updated examples are consistent and render correctly in the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100