Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation for unnamed API resources #1063

Open
AnActualEmerald opened this issue Apr 2, 2024 · 4 comments
Open

Missing documentation for unnamed API resources #1063

AnActualEmerald opened this issue Apr 2, 2024 · 4 comments

Comments

@AnActualEmerald
Copy link

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

@Naramsim
Copy link
Member

Naramsim commented Apr 2, 2024

Hi, I modified the docs: https://staging.pokeapi.co/docs/v2#resource-listspagination-section Can you check before merging?

Check the Resource Lists/Pagination section

@AnActualEmerald
Copy link
Author

Looks good to me, thanks 👍

@mlemesle
Copy link
Contributor

mlemesle commented Apr 2, 2024

Hey there!

Sorry to intrude in the discussion, but is there a way to be a bit more precise about this? Like flagging or listing which endpoints are named/unamed?
As is, the docs do not tell how to read the data, which can be tedious while deserializing the payload

@Naramsim
Copy link
Member

Naramsim commented Apr 3, 2024

Hi, in the new docs I added the entry:

characteristic, contest-effect, evolution-chain, machine, super-contest-effect endpoints are unnamed, the rest are named.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants