説明
ステータスコードごとのレスポンスの $ref は、レスポンスオブジェクトを参照する必要があります。データスキーマだけでは、説明、ヘッダー、本文形式を表すレスポンスオブジェクトの代わりにはなりません。
想定される影響
仕様の検証や文書生成に失敗したり、クライアントがレスポンス形式を誤解したりする可能性があります。
対処方法
共通レスポンスは #/components/responses/... から参照し、本文スキーマはレスポンスの content 内に指定してください。有効な外部のレスポンスオブジェクトも使えます。
例
次の例では、Success の参照パスを schemas から responses に修正しています。
変更前
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"components": {
"responses": {
"Success": {
"description": "200 response",
"content": {
"application/json": {
"examples": {
"foo": {
"value": {
"versions": [
{
"status": "CURRENT",
"updated": "2011-01-21T11:33:21Z",
"id": "v2.0",
"links": [
{
"href": "http://127.0.0.1:8774/v2/",
"rel": "self"
}
]
}
]
}
}
}
}
}
}
}
},
"paths": {
"/": {
"get": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"$ref": "#/components/schemas/Success"
}
}
}
}
}
}
変更後
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"components": {
"responses": {
"Success": {
"description": "200 response",
"content": {
"application/json": {
"examples": {
"foo": {
"value": {
"versions": [
{
"status": "CURRENT",
"updated": "2011-01-21T11:33:21Z",
"id": "v2.0",
"links": [
{
"href": "http://127.0.0.1:8774/v2/",
"rel": "self"
}
]
}
]
}
}
}
}
}
}
}
},
"paths": {
"/": {
"get": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"$ref": "#/components/responses/Success"
}
}
}
}
}
}