path と header の必須パラメータ

path の id と、required: true の header X-Trace、required のない query の q を持つ 1 つのオペレーションの例です。必須になるのは id と X-Trace の 2 つだけであることを確かめます。

入力

OpenAPI の定義(JSON)

{"openapi":"3.1.0","paths":{"/users/{id}":{"get":{"parameters":[{"name":"id","in":"path","required":true},{"name":"q","in":"query"},{"name":"X-Trace","in":"header","required":true}]}}}}

結果

エラー 0 件・警告 0 件・情報 1 件

指摘(エラー・警告・情報)

必須パラメータの一覧

検算(この結果になる理由)

Parameter Object では path は常に必須、required: true のものも必須、required のない query の q は false です。よって GET /users/{id} の必須は id と X-Trace の 2 件で、オペレーションは 1 個になります。

判定の根拠は仕様と根拠に、仕様の出典とともにまとめています。自分の入力で試すにはツールをお使いください。

このツールの制約

• YAML 形式、外部ファイルや URL への参照は読めません。同じファイル内の #/… の参照だけ解決します。
• リクエスト本文(requestBody)の必須や、認証(security)の要件は含めません。パラメータの一覧です。
• OpenAPI 2.0(Swagger)の定義は対象外です。仕様の確認は 3.1.0 で行ったもので、3.0 系の細部の違いまでは確かめていません。
• OpenAPI 全体の文法や、パラメータの schema(型・形式)の正しさは検査しません。

ほかの入力例

• Path Item の共通パラメータを Operation が上書き
• components の定義を $ref で参照
• path なのに required: true がない
• OpenAPI 2.0(Swagger)の定義は読まない