Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

FlavorText documentation is incorrect

オープン
#166 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
javascript
領域
documentation

調査の方向性

src/docs/utility.json の FlavorText レスポンスモデルから始め、そのフィールドを src/docs/contests.json と src/docs/pokemon.json のエンドポイントモデルと比較します。FlavorText から version を削除し、VersionFlavorText を追加して、PokemonSpecies の flavor_text_entries 参照を更新します。ドキュメント化されたスキーマが参照先の API スキーマと一致すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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:

主要言語
JavaScript
スター
159
フォーク
63
平均マージ
7時間 26分
マージ済み PR(30日)
2

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

PokeAPI/pokeapi.co のほかの issue

PokeAPI/pokeapi.co の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。