非推奨
非推奨フィールドの非推奨化

フィールドの非推奨化

Included in the “Power Extensions” bundle

GraphQL スキーマをアップグレードする際、一部のフィールドが不要になることがあります。それらは、より優れた実装のフィールドに置き換えられる場合もあります。そのような場合、廃止されたフィールドを非推奨化し、クライアントで新しいフィールドへ切り替えるよう利用者に促す非推奨の理由を提供できます。

この拡張機能は、フィールドを非推奨化するためのユーザーインターフェースを提供します。

説明

サイトに新しい「フィールド非推奨化リスト」カスタム投稿タイプが追加されます。メニューの「フィールド非推奨化リスト」ページでエントリを閲覧し、「新しいフィールド非推奨化リストを追加」をクリックしてエディターで新しいエントリを追加できます。

フィールド非推奨化リスト
フィールド非推奨化リスト

フィールド非推奨化リストエディター

各フィールド非推奨化リストには、1つまたは複数のエントリが含まれており、それぞれに以下の要素があります。

  • 非推奨化するフィールド
  • 非推奨化の理由(非推奨フィールドがクエリされた際に GraphQL レスポンスに表示されます)

フィールド非推奨化エントリ

フィールド非推奨化リストを作成した後、対応するスキーマ設定を編集し、「フィールド非推奨化リスト」ブロックの下のリストからアイテムを選択することで、カスタムエンドポイントと Persisted Query がそれを使用するように設定できます。

スキーマ設定でフィールド非推奨化リストを選択する