説明
コールバックの $ref は、有効なコールバックオブジェクトを参照する必要があります。パスや名前に誤りがあると、APIが後から送るコールバックリクエストの定義を読み込めません。
想定される影響
文書やクライアントコードの生成に失敗したり、コールバックの連携に必要な情報が欠落したりする可能性があります。
対処方法
共通コールバックは #/components/callbacks/... の実在する定義を参照してください。外部ファイルの有効なコールバックオブジェクトも利用できます。パスと参照先の名前を確認してください。
例
次の抜粋では、POST 操作のコールバック参照にある callbaccgcks を callbacks に修正しています。コールバックURLを渡す元のリクエスト本文の定義は省略しています。
変更前
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"post": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "Success"
}
},
"callbacks": {
"myEvent": {
"$ref": "#/components/callbaccgcks/inProgress"
}
}
}
}
},
"components": {
"callbacks": {
"inProgress": {
"{$request.body#/inProgressUrl}": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}
}
}
変更後
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"post": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "Success"
}
},
"callbacks": {
"myEvent": {
"$ref": "#/components/callbacks/inProgress"
}
}
}
}
},
"components": {
"callbacks": {
"inProgress": {
"{$request.body#/inProgressUrl}": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}
}
}