説明
OpenAPI 2.0の本文パラメーターでは、name、in、description、required、schema を使います。独自の拡張は x- で始める必要があり、desc などの任意のプロパティは標準フィールドではありません。
想定される影響
文書の検証に失敗したり、ツールがプロパティを無視してリクエスト本文の説明を誤って解釈したりする可能性があります。
対処方法
不正なプロパティを削除するか、内容を正しい標準フィールドに移してください。説明には description、本文の構造には schema を使います。拡張が必要な場合は x- を付け、ツールが対応しているか確認してください。
例
次の本文パラメーターの例では、認識されない desc を削除しています。変更後は最大レコード数を整数として定義しています。
変更前
json
{
"name": "limit",
"in": "body",
"description": "max records to return",
"required": true,
"schema": {
"type": "string"
},
"desc": {
"type": "string"
}
}
変更後
json
{
"name": "limit",
"in": "body",
"description": "max records to return",
"required": true,
"schema": {
"type": "integer"
}
}