OpenAPI 3.1 exploded query parameter validation fails
まだ誰も着手していません。
評価
調査の方向性
Start by reading ParameterValidator and trace how it handles array schemas for OpenAPI 3.1, where the issue says schemas are parsed as JSONSchema. Reproduce the failure with the shown sort parameter and a request such as sort=field or sort=field,DESC. Done means exploded query array values validate without being parsed as a single JSON value.
索引モデルが issue の本文から書いたものです。
説明
In attempting to write a swagger.yml for an API that uses spring pagination (page, size & sort) I created the following for the sort param:
components:
parameters:
sort:
name: sort
in: query
description: The sort order(s) (`property[,direction=ASC]`) for the page to retrieve.
required: false
style: form
explode: true
schema:
description: The sort order(s) for pagination
type: array
items:
type: string
description: A sort order definition (`property[,direction=ASC]`).
minLength: 1
maxLength: 1024
pattern: '^[A-Za-z0-9_.-]+(?i:,(ASC|DESC))?$'
This however fails to validate a request containing e.g. sort=field or sort=field,DESC, etc. as it attempts to parse the value (in this case field or field,DESC) as JSON.
This appears to be because although ParameterValidator has special cases for when the schema is instanceof ArraySchema, for OpenAPI 3.1 the schema is always parsed as a JSONSchema with getTypes().equals(Set.of("array")), meaning it attempts to validate it as a single value which fails.
- 主要言語
- Java
- スター
- 17
- フォーク
- 6
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
atlassian/openapi-request-validator のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 3/5 半日 初心者へのやさしさ 55/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 62/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
-
Message context not populated when validating response headers対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
atlassian/openapi-request-validator の issue をすべて見る
似ている issue
-
[Bug]: REST API URL starting with "http" but no scheme (e.g. httpbin.org/get) is not given an http:// prefix対応中かも @ItsDeadlyProgrammer が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
appsmithorg/appsmith#42471 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
code-maintenance
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
メンテナーはふだん 1 日以内に返信
-
bug priority: medium Review effort [1-5]: 3 status: needs-triage type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
carlos-emr/carlos#5258 ·
メンテナーはふだん 1 日以内に返信
-
bug: author create/update with an unknown avatarId returns 404 instead of 400 UNKNOWN_REFERENCE対応中かも @Vinu2111 が今日担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
atomityhq/blog-cms#59 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信