Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[Possible Schema Inaccuracy] multiple PR fields have odd description

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
openapi
領域
api, documentation

調査の方向性

まず "pull-request" レスポンス/スキーマを見つけ、mergeable、draft、rebaseable、mergeable_state の定義を確認します。それらの optional および nullable の挙動を GraphQL API の MergeStateStatus enum と比較します。スキーマがこれらの挙動を明確に文書化しているか、フィールドと enum 値を正確に表現していれば完了です。

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

説明

feature fundamentals-and-support inaccuracy P4 shield waiting for review

I'm not entirely sure that these are schema inaccuracies but multiple fields of PRs (specifically the "pull-request" response / schema) have an odd definition:

  • mergeable is a nullable boolean field,it is not otherwise documented, it's hard to fathom why a PR would be something other than "mergeable" and "not mergeable". Either the field should be marked required, or the behaviour should be explained (I guess "we don't know if it's mergeable yet" is possible but in that case why not just set it to non-mergeable?).
  • draft is somewhat similarly an optional boolean, it's not clear when it would be absent (possibly projects which don't support / allow draft PRs? still why have that in the response rather than just false?)
  • rebaseable is both nullable and optional, same remarks as above.
  • mergeable_state is completely undocumented aside from knowing it's a string. Looking at the GraphQL API, it the example value ("clean") matches the MergeStateStatus enum. If this is the right conversion, mergeable_state should be defined as an enum with those values provided (and documented as they are in the graphql schema, maybe).
主要言語
言語のデータがありません
スター
1.6k
フォーク
342
平均マージ
2時間 23分
マージ済み PR(30日)
57

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

github/rest-api-description のほかの issue

github/rest-api-description の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

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

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