Missing documentation for unnamed API resources
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- api, documentation
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.
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
- Dominant language
- Python
- Stars
- 5.4k
- Forks
- 1.2k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 18
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.
More from PokeAPI/pokeapi
-
Difficulty 2/5 1-2 days Newbie friendliness 76/100
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
UV hardlink files Open
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Ball legality Open
Difficulty 5/5 Over a week Newbie friendliness 35/100
Similar issues
-
bug priority:low
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
CyberAgent/psd2svg#436 ·
-
area/install-update comp/cli comp/desktop P3 sweeper:risk-compatibility type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
NousResearch/hermes-agent#122386 · 1 comment ·
-
ai-generated
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vllm-project/production-stack#1105 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100