[Schema Inaccuracy] Imprecise units in check-run `output.summary` and `output.text` fields

オープン

#5,399 2025年9月24日に作成コメント 0 件リアクション 0 件担当者 0 名 GitHub で見る

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

評価

難易度: 2/5
見積もり時間: 1〜3時間
初心者へのやさしさ: 35/100

issue の種類: ドキュメント
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: github, openapi
領域: api, documentation

調査の方向性

まず、/repos/{owner}/{repo}/check-runs エンドポイントにある check-run 出力のフィールド output.summary と output.text の OpenAPI スキーマおよびレンダリングされた説明を探します。maxLength 65535 がどのように表現されているかを確認し、必要な単位の正確な表現を決定します。スキーマとエンドポイントのドキュメントで上限が曖昧でなくなれば完了です。

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

説明

documentation

Schema Inaccuracy

The /repos/{owner}/{repo}/check-runs's parameter body.output.summary, body.output.text describe a max length of 65535 "characters" in their description.

The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters."

The the encoding of a "character" is not specified, which can lead to confusion, as described in https://github.com/github/docs/issues/35252. Based on that issue, "character" in this case is seemingly referring to a 1-byte ascii making the "character" limit a "byte limit" in practice. However since utf8 is supported and rendered, the character count can be far less in practice, especially for check-runs which use non-latin languages as their output.

This confusion might be considered to be clarified since the schema specifies the field's output.summary.maxLength. However OpenAPI is also unclear about if maxLength refers to bytes, characters of a given encoding, etc, and also the maxLength field is not rendered in the Github API docs.

主要言語: 言語のデータがありません
スター: 1.6k
フォーク: 342
平均マージ: 2時間 23分
マージ済み PR（30日）: 57

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

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

はじめの一歩

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

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

[Schema Inaccuracy] Repository security advisory operations name `repository_advisories:read` / `repository_advisories:write` OAuth scopes that do not exist オープン

feature

難易度 2/5 1〜3時間初心者へのやさしさ 85/100

github/rest-api-description#7220 · 2026年9月22日に作成
[Schema Inaccuracy] Missing Link header from org/security-advisories response description オープン

feature

難易度 2/5 1〜3時間初心者へのやさしさ 82/100

github/rest-api-description#7201 · 2026年9月15日に作成
Runner deprecations: enterprise scope is in the changelog and the 404 handler but not in the description オープン

feature

難易度 2/5 1〜3時間初心者へのやさしさ 72/100

github/rest-api-description#7163 · 2026年9月9日に作成
Runner deprecations: registration_deprecates_at is declared on the response but never returned オープン

feature

難易度 2/5 1〜3時間初心者へのやさしさ 68/100

github/rest-api-description#7162 · 2026年9月9日に作成
configure-pages API endpoint yields anchor that doesn't exist in docs オープン

feature

難易度 2/5 1〜3時間初心者へのやさしさ 68/100

github/rest-api-description#7135 · 2026年9月4日に作成

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

似ている issue

Add full support for Excel and XML exports as email attachment オープン

Area: Excel support

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

orbeon/orbeon-forms#7893 · 2026年9月23日に作成
[essnmx] Fix typo in NXLauetof application definition オープン

essnmx good first issue

難易度 1/5 1時間未満初心者へのやさしさ 95/100

scipp/ess#760 · 2026年9月23日に作成
`IOCExtractor` always fails: `ioc_analyzer.build()` takes 1 argument but the agent dispatcher passes 2 オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

yeti-platform/yeti#1380 · 2026年9月23日に作成
OAuth client scope handling breaks on comma-separated scope strings オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

modelcontextprotocol/python-sdk#3566 · 2026年9月23日に作成
Bedrock: every OpenAI GPT-6 Sol/Luna call fails with 400 because the default temperature is always sent オープン

難易度 2/5 1〜3時間初心者へのやさしさ 70/100

griptape-ai/griptape#2353 · 2026年9月23日に作成

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

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