非推奨
非推奨Deprecation Notifier

Deprecation Notifier

Included in the “Power Extensions” bundle

クエリへのレスポンスで非推奨情報を送信します(introspectionの実行時だけでなく)。送信先はトップレベルエントリ extensions です。

説明

非推奨のフィールドがクエリされるたびに、同じ GraphQL レスポンスのトップレベルエントリ extensions に非推奨メッセージが返されます。

これにより、APIのユーザーはintrospectionクエリに注意を払っていない場合でも、スキーマの使用方法をアップグレードするよう通知されます。

たとえば、フィールド isPublished が非推奨になっている場合、次のクエリを実行すると:

query {
  posts {
    title
    isPublished
  }
}

...次のレスポンスが返されます:

{
  "extensions": {
    "deprecations": [
      {
        "message": "Use 'isStatus(status:published)' instead of 'isPublished'",
        "extensions": {
          ...
        }
      }
    ]
  },
  "data": {
    "posts": [
      ...
    ]
  }
}