説明
#/parameters/... で参照する共通パラメーターは、実際の parameters 定義に存在する必要があります。名前の誤りや定義の削除により、必要なリクエストパラメーターを読み込めなくなります。
想定される影響
文書生成や検証に失敗したり、必要なパラメーター情報が欠落したりする可能性があります。
対処方法
参照名を定義に合わせてください。必要な定義は復元し、不要になった参照だけを削除してください。名前を変更する場合は使用箇所も更新してください。
例
次の抜粋では、不要な maxParam への参照を削除し、実在する limitParam を残しています。
変更前
json
{
"paths": {
"/": {
"get": {
"parameters": [
{
"$ref": "#/parameters/maxParam"
},
{
"$ref": "#/parameters/limitParam"
}
]
}
}
},
"parameters": {
"limitParam": {
"name": "limit",
"in": "query",
"required": true,
"type": "integer"
}
}
}
変更後
json
{
"paths": {
"/": {
"get": {
"parameters": [
{
"$ref": "#/parameters/limitParam"
}
]
}
}
},
"parameters": {
"limitParam": {
"name": "limit",
"in": "query",
"required": true,
"type": "integer"
}
}
}