FlavorText documentation is incorrect
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- javascript
調査の方向性
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_textlanguageversion
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:
- /src/docs/utility.json
- Remove
versionfield from the FlavorText type response model (link to line) - Add a VersionFlavorText type identical to the current FlavorText type (with
flavor_text,language, andversionfields) (link to line)
- Remove
- /src/docs/contests.json
- Change type of
flavor_text_entriesfield in the PokemonSpecies response model from list of FlavorText to list of VersionFlavorText (link to line)
- Change type of
- 主要言語
- JavaScript
- スター
- 159
- フォーク
- 63
- 平均マージ
- 7時間 26分
- マージ済み PR(30日)
- 2
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
PokeAPI/pokeapi.co のほかの issue
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
PokeAPI/pokeapi.co#171 · コメント 5 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 28/100
PokeAPI/pokeapi.co#162 · コメント 20 件 · リアクション 1 件 ·
-
Edit this page オープン
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
PokeAPI/pokeapi.co#12 · コメント 2 件 · リアクション 1 件 ·
PokeAPI/pokeapi.co の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
area-deployment area-integrations triage:bot-seen
難易度 2/5 半日 初心者へのやさしさ 86/100
-
Issue-Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
sugarlabs/musicblocks#8924 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
ArduPilot/ardupilot_wiki#8088 ·
-
[BUG] createTool tools cannot be registered with Mastra when exactOptionalPropertyTypes is enabled オープンcustomer-eng status: needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100