Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Missing documentation for unnamed API resources

Open
#1,063 4 comments 1 reaction 0 assignees View on GitHub

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PokeAPI/pokeapi

All issues in PokeAPI/pokeapi

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.