[Schema Inaccuracy] head.label and head.user can be null in pull-request schema
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 68/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- github, openapi
- 領域
- api, documentation
調査の方向性
#/components/schemas/pull-request から開始し、head.label と head.user の定義を調査します。報告された pull request 51976 に対する curl のレスポンスを失敗例として使用してください。両方のプロパティを nullable としてマークし、null 許容となる条件を文書化する一方で、head.repo の既存の処理は維持してください。生成されたスキーマにこれらの変更が反映されていることを確認してください。
索引モデルが issue の本文から書いたものです。
説明
Schema Inaccuracy
The current schema for #/components/schemas/pull-request defines head.label and head.user as required.
Expected
head.label and head.user should have nullable: true with the nullability conditions documented (from what I understand, if the user's account was deleted for some reason: all the cases I can see are for "ghost" users)
Reproduction Steps
❯ curl -s https://api.github.com/repos/odoo/odoo/pulls/51976 | jq .head
{
"label": null,
"ref": "12.0",
"sha": "3cf7aba2e293417c6e8a6a4785624c8315ccbb7a",
"user": null,
"repo": null
}
Side-note
The same issue was fixed for head.repo as reported in https://github.com/github/rest-api-description/issues/161 and https://github.com/github/rest-api-description/issues/424, would be nice to also add a description to that property explaining the conditions under which it can be null.
- 主要言語
- 言語のデータがありません
- スター
- 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
-
dead_air_detection fails on m4a/AAC audio ("Could not decode audio: Format not recognised") for uploads, base64 and own-bucket recordings対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
future-agi/future-agi#3317 ·
メンテナーはふだん 1 日以内に返信
-
task
難易度 2/5 半日 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
ehmpathy/rhachet-roles-bhrain#576 ·
メンテナーはふだん 1 日以内に返信
-
comp/tools P2 platform/telegram sweeper:risk-message-delivery type/bug
難易度 2/5 1〜3時間 初心者へのやさしさ 61/100
NousResearch/hermes-agent#133164 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
apache/rocketmq-dashboard#5594 ·
メンテナーはふだん 3 日以内に返信