Validate `required` + `default` properties

オープン
#345 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
javascript, openapi
領域
api

調査の方向性

リンクされている petstore.yaml の例と required_param_has_default 設定から始め、次にドキュメントに対して lint-openapi を実行します。パラメーターに対する既存のエラーと、94 行付近の required プロパティに対するエラーが欠落していることを比較します。完了の条件は、デフォルト値も持つ required プロパティが設定によって一貫して報告されることです。

索引モデルが issue の本文から書いたものです。

説明

using petstore.yaml
and the "required_param_has_default": "error" config option

adding default: some_string here on a parameter and running lint-openapi does correctly return an error

however setting default: some_string here on a property does not return a error

the config option "required_param_has_default": "error" refers to param so I guess this excludes request body objects etc (?)
if so, I was wondering if this is something that makes sense to add (because it seems equally incorrect on a param and request body object's prop)?

(I'm using version 0.51.3)

主要言語
JavaScript
スター
635
フォーク
98
平均マージ
1日 5時間
マージ済み PR(30日)
8

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

IBM/openapi-validator のほかの issue

IBM/openapi-validator の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。