説明
OpenAPI 2.0の in: body パラメーターには、リクエスト本文の型と構造を定義する schema が必要です。このフィールドがないと、本文の形式が明確になりません。
想定される影響
クライアントが誤った本文を送信したり、コード生成や仕様の検証に失敗したりする可能性があります。
対処方法
実際のリクエスト本文に合う schema を追加してください。型と必要なフィールドを定義し、共通のモデルには再利用可能な定義への参照を使えます。
例
次のパラメーターの例では、整数のリクエスト本文を表す schema を追加しています。
変更前
json
{
"name": "limit",
"in": "body",
"description": "max records to return",
"required": true
}
変更後
json
{
"name": "limit",
"in": "body",
"description": "max records to return",
"required": true,
"schema": {
"type": "integer"
}
}