5e-bits / 5e-bits/5e-database

Merge Spellcasting, StartingEquipment, and Class Levels into Class objects.

オープン
#251 コメント 4 件 リアクション 2 件 担当者 0 名 GitHub で見る
主要言語
TypeScript
スター
934
フォーク
427
平均マージ
17時間 25分
マージ済み PR(30日)
22

説明

Currently, the 1:1 relationships of Class->Spellcasting and Class->StartingEquipment exist in the schema as URL strings, rather than the data simply being embedded in the Class object. This only serves to reduce the size of the Class endpoint response, but complicates the digestion of the data rather a lot. Having separate endpoints for Spellcasting and StartingEquipment also creates difficulty maintaining consistency in the structure of internal references; where all other references are suited to using the APIResource structure, these are simply incompatible due to the shape of the referenced data.

As for Class Levels, the size cost of including *all* Level data in the class resource is much greater than for Spellcasting or StartingEquipment. It would perhaps be more suitable, however, to provide references to class levels as an array of APIResources, rather than the current method of supplying a URL that returns such a list. This would again simplify the digestion of the API data greatly, including by reducing the number of API calls that have to be made. Additionally, leaving the Levels endpoint intact allows levels to be queried separately from Classes, if desired.

**In summary:**
- Merge Spellcasting and StartingEquipment data directly into Class objects, get rid of corresponding API endpoints
- Provide Class Levels as an array of APIResources in the Class object, keeping Levels endpoint

All of this can be applied to Subclasses, also.

Another one to discuss is class Spell lists. Move them into Spellcasting, or directly onto the Class object, as an array of APIResources, like Levels?

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

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

調査の方向性

Examine the Class, Spellcasting, and StartingEquipment objects in the schema to understand the current 1:1 relationships and URL references. Look at the Levels endpoint and how it's currently referenced. Determine how to embed Spellcasting and StartingEquipment data directly into Class objects and change Levels to an array of APIResources. Consider applying the same changes to Subclasses and decide on handling class Spell lists.

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

評価

技術スタック
typescript
領域
api, database
issue の種類
リファクタリング
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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