フィールドの非推奨化
GraphQLスキーマのバージョン管理では、フィールドを非推奨にすること、つまりそのフィールドをもはや使用すべきでないことをユーザーに伝え、代わりに使用するフィールドを示すことが必要です。
コードによるフィールドの非推奨化に加え、Gato GraphQL はどのフィールドをどのように非推奨にするかを設定するためのユーザーインターフェイスを提供しています。
設定はフィールド非推奨リストを通じて作成され、スキーマ設定を介してカスタムエンドポイントとパーシステッドクエリに提供されます。
すべてのフィールド非推奨リストへのアクセス
プラグインのメニューにある「Field Deprecation Lists」をクリックすると、作成済みのすべてのフィールド非推奨リストが表示されます。
新しいフィールド非推奨リストの作成
「Add New Field Deprecation List」ボタンをクリックして、WordPressエディターを開きます。
フィールド非推奨リストにタイトルを付け、フィールドのエントリを追加し、非推奨メッセージを設定します。準備ができたら、Publish ボタンをクリックします。これにより、新しいフィールド非推奨リストがスキーマ設定で利用可能になります。
フィールドはスキーマ内で非推奨としてマークされ、さらに、非推奨フィールドをクエリしたときにレスポンスに非推奨メッセージが表示されます（モジュール Deprecation Notifier が有効な場合）。
フィールド非推奨エントリ
各 Field Deprecation List には1つまたは複数のエントリが含まれており、それぞれ次の要素を持っています。
- 非推奨にするフィールド
- 非推奨メッセージ
インターフェイスからのフィールドの選択
タイプのフィールドに加え、インターフェイスからもフィールドを選択できます。この場合、そのインターフェイスを実装するすべてのタイプのフィールドに対して非推奨化が実行されます。
フィールド非推奨リストの説明
Document settings パネルの「Excerpt」フィールドを使用して、フィールド非推奨リストに説明を追加します。
詳細はガイド APIへの説明の追加 を参照してください。
フィールド非推奨リストの使用
フィールド非推奨リストを作成したら、対応するスキーマ設定を編集することで、カスタムエンドポイントまたはパーシステッドクエリにそれを使用させ、「Field Deprecation Lists」ブロック下のリストから ACL を選択できます。
設定をカスタマイズしない場合、「Field Deprecation」タブの設定ページで定義されたデフォルトの Field Deprecation Lists が使用されます。
