[Schema Inaccuracy] Dependabot Alert "relationship" enum is incomplete
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- openapi
- 領域
- api
調査の方向性
organization Dependabot alerts endpoint のドキュメントと dependabot-alert-with-repository レスポンススキーマから始めます。dependency.relationship enum を見つけ、inconclusive を含む API の取り得る値を確認します。スキーマに有効な値がすべて列挙され、関連するスキーマ検証チェックがすべて成功すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Schema Inaccuracy
The Response Schema for the dependabot alert endpoint (for organizations) defines 3 valid values for relationship. When using this endpoint we sometimes get the value "inconclusive" which is not listed.
"dependabot-alert-with-repository": {
"type": "object",
"description": "A Dependabot alert.",
"properties": {
"number": {
"$ref": "#/components/schemas/alert-number"
},
"state": {
...
},
"dependency": {
"type": "object",
"description": "Details for the vulnerable dependency.",
"readOnly": true,
"properties": {
...
"relationship": {
"type": "string",
"description": "...",
"readOnly": true,
"nullable": true,
"enum": [
"unknown",
"direct",
"transitive"
]
}
}
},
Expected
The schema should include all values
"dependabot-alert-with-repository": {
"type": "object",
"description": "A Dependabot alert.",
"properties": {
"number": {
"$ref": "#/components/schemas/alert-number"
},
"state": {
...
},
"dependency": {
"type": "object",
"description": "Details for the vulnerable dependency.",
"readOnly": true,
"properties": {
...
"relationship": {
"type": "string",
"description": "...",
"readOnly": true,
"nullable": true,
"enum": [
"unknown",
"direct",
"transitive",
"inconclusive"
]
}
}
},
Reproduction Steps
Due to the sensitive nature of alerts I cannot provide an explicit example.
- 主要言語
- 言語のデータがありません
- スター
- 1.6k
- フォーク
- 345
- 平均マージ
- 6時間
- マージ済み PR(30日)
- 82
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/rest-api-description のほかの issue
-
feature
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
github/rest-api-description#7266 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
github/rest-api-description#7246 ·
メンテナーはふだん 1 日以内に返信
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
github/rest-api-description#7220 ·
メンテナーはふだん 1 日以内に返信
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
github/rest-api-description#7201 ·
メンテナーはふだん 1 日以内に返信
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
github/rest-api-description#7163 ·
メンテナーはふだん 1 日以内に返信
github/rest-api-description の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
john-kurkowski/tldextract#382 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
CircuitVerse/CircuitVerse#7967 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
CopilotKit/aimock#491 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
deepset-ai/haystack#13092 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
dani-garcia/vaultwarden#7801 ·
メンテナーはふだん 1 日以内に返信