Missing documentation for unnamed API resources
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.4k
- Forks
- 1.2k
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 21
Description
Some paginated endpoints return API resources without a name field, but this behavior isn't mentioned anywhere in the docs.
Steps to Reproduce:
curl "https://pokeapi.co/api/v2/evolution-chain?limit=3" | jq
Results in the output:
{
"count": 541,
"next": "https://pokeapi.co/api/v2/evolution-chain?offset=3&limit=3",
"previous": null,
"results": [
{
"url": "https://pokeapi.co/api/v2/evolution-chain/1/"
},
{
"url": "https://pokeapi.co/api/v2/evolution-chain/2/"
},
{
"url": "https://pokeapi.co/api/v2/evolution-chain/3/"
}
]
}
Where the resources in the results array just have a url and no name
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 paginated evolution-chain request shown in the issue and locate the project documentation describing paginated endpoint results. Document that some resources, including evolution-chain results, may contain only a url and omit name; the work is done when this behavior is clearly stated.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100