GraphQL スキーマ仕様: @deprecated ディレクティブで非推奨のフィールドを示す

GraphQL スキーマ内のある型のフィールドや Enum 値が非推奨になったことを表すには、@deprecated ディレクティブを使用します。 reason 引数で非推奨とされた理由を記述することができるので、その文章中に代替となるフィールド名を記述しておくと親切です。

次の例では、email フィールドが非推奨 (deprecated) になり、代わりに emailAddress フィールドを参照して欲しいことを示しています。

type User {
    emailAddress: String
    email: String @deprecated(reason: "Use 'emailAddress'.")
}

関連記事

• GraphQL クエリ仕様: ディレクティブによる条件分岐 (@include, @skip)
• GraphQL クエリ仕様: フィールド名にエイリアスを付ける
• GraphQL スキーマ仕様: インタフェース型 (interface type) を定義する
• GraphQL スキーマ仕様: スキーマ定義の基本
• GraphQL スキーマ仕様: 型やフィールドに説明文 (description) を記述する
• Apollo Client の fetchMore を自動で呼び出して GitHub GraphQL の100件制限を乗り越える (useAutoFetchMore)
• Apollo CLI の codegen で GraphQL クエリレスポンスの TypeScript 型を自動生成する