Incorrect validation occuring due to property using "enum" as a property name
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- javascript
調査の方向性
まず、参照されている openapi.yaml と PropertyPrototype の例を使って警告を再現し、プロパティ名が "enum" になっているパスに焦点を当てます。validator がそのパスをどのように解釈するかを追跡し、例をカバーする回帰ケースを追加します。完了の条件は、そのドキュメントで誤った enum 警告が発生しなくなり、正しい enum の検証は引き続き機能することです。
索引モデルが issue の本文から書いたものです。
説明
Version: [email protected]
The validator comes back with a warning for the content of some of our example responses:
Message : Enum value "option1" must be "single_select".
Path : paths./tekton_pipelines/{pipeline_id}/properties.post.requestBody.content.application/json.examples.single_select_env_properties.value.enum.0
Line : 1119
This is arising in 9 places in our API yaml. The full yaml file can be seen here
This is one example:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PropertyPrototype'
examples:
single_select_env_properties:
value:
name: "enums"
type: "single_select"
enum: ["option1","option2","option3"]
value: "option1"
Schema for the enum:
enum:
description: Options for `single_select` property type
type: array
minItems: 0
maxItems: 1024
items:
$ref: '#/components/schemas/GeneralString'
It seems like the fact we are using the term enum for one of the properties in our API schema is confusing the validator
- 主要言語
- JavaScript
- スター
- 635
- フォーク
- 98
- 平均マージ
- 1日 5時間
- マージ済み PR（30日）
- 8
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
IBM/openapi-validator のほかの issue
-
security
難易度 2/5 1〜3時間 初心者へのやさしさ 52/100
IBM/openapi-validator#875 · コメント 1 件 ·
-
`Provided ruleset is not an object` error after upgrading from 1.37.12 to 1.37.13再び着手できるかも @diatrcz が 123 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
IBM/openapi-validator#809 · コメント 5 件 · リアクション 2 件 · 担当者 1 名 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
IBM/openapi-validator#748 · コメント 4 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 42/100
IBM/openapi-validator#747 · コメント 2 件 · リアクション 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 32/100
IBM/openapi-validator#643 · コメント 3 件 ·
IBM/openapi-validator の issue をすべて見る
似ている issue
-
对信息编解码工具建议オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 79/100
メンテナーはふだん 1 日以内に返信
-
good first issue tests
難易度 1/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
bug role: dev-lead
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
briangwalker/TrussExplorer#424 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
eliasstravik/herdr-projects#1032 ·