Rule "ibm-success-response-example" fails for some operations but not others
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 32/100
- issue の種類
- バグ
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- javascript, openapi
調査の方向性
まず、「ibm-success-response-example」ルールの動作を、レスポンススキーマが検証を通る操作と通らない操作で再現し、その後、それらのスキーマを Swagger UI が生成する例と比較します。issue にはファイルやテストが記載されていないため、最初のステップはルールの実装と関連するテストカバレッジを見つけることです。完了とみなすには、不足しているスキーマ要件について明確に説明するか、明確な validator の変更を定義し、異なる操作を対象とするテストでカバーする必要があります。
索引モデルが issue の本文から書いたものです。
説明
I'd like to understand why the above rule complains for some operations, but not others, even if I haven't explicitly defined examples in any of the api responses.
It seems that in some cases the rule accepts that an example can be generated based on the schema of the response, and in other cases the schema is not enough.
Is there a way to tell what's missing from the inadequate schemas?
Also, Swagger UI shows auto generated examples for all my operations, so it's difficult to understand what's missing from some schemas
- 主要言語
- 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 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
IBM/openapi-validator#545 · コメント 1 件 ·
IBM/openapi-validator の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
jonathanong/no-mistakes#3332 ·
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
githubnext/gh-aw-workshop#5674 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 62/100
awesome-dsh-plugin/awesome-dsh-plugin#14970 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
swc-project/swc-ai-issues#653 ·