PokeAPI / PokeAPI/pokeapi.co

FlavorText documentation is incorrect

Open
#166 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
159
Forks
63
Avg merge
7h 26m
Merged PRs (30d)
2

Description

The documentation for the FlavorText type does not match its schema.

All referenced schema are from PokeAPI / api-data in the data/schema/v2 folder.
I have checked that the referenced schemas match the API results (for at least an id of 1).
The examples given in the documentation do match the schemas, so would not need changing.

Issue details

FlavorText is specified as having a version field, when most references to it do not have one.

The FlavorText type is documented as having three fields:

  • flavor_text
  • language
  • version

FlavorText is used in three endpoints (all under the field flavor_text_entries) in the documentation:

In the contest-effect and super-contest-effect endpoints, the value under flavor_text_entries does not have a version field (ie. it only has flavor_text and language fields).

In the pokemon-species endpoint, the value under flavor_text_entries does have a version field, so matches the online documentation.

Suggestion

Making a new VersionFlavorText type for use in the PokemonSpecies endpoint, and changing the FlavorText type to not have the version field.

The naming of this type would match the pattern of VersionGroupFlavorText type (which has the fields text, language, and version_group).

VersionGroupFlavorText is also only used once (in the item endpoint), so it seems reasonable to add VersionFlavorText in the utility section along with it. Alternatively, it could be added in the Pokemon group under the PokemonSpecies endpoint.

This would affect:

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the FlavorText response model in src/docs/utility.json and compare its fields with the endpoint models in src/docs/contests.json and src/docs/pokemon.json. Remove version from FlavorText, add VersionFlavorText, and update the PokemonSpecies flavor_text_entries reference; done when the documented schemas match the referenced API schemas.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.