[Schema Inaccuracy] Imprecise units in check-run `output.summary` and `output.text` fields
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- github, openapi
- Domain
- api, documentation
Research direction
Start by locating the OpenAPI schema and rendered description for the check-run output.summary and output.text fields under the /repos/{owner}/{repo}/check-runs endpoint. Confirm how the 65535 maxLength is represented and determine the precise unit wording needed; done means the schema and endpoint documentation no longer leave the limit ambiguous.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- No language data
- Stars
- 1.6k
- Forks
- 342
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 57
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/rest-api-description
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
github/rest-api-description#7220 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
github/rest-api-description#7201 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/rest-api-description#7163 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7162 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7135 ·
All issues in github/rest-api-description
Similar issues
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
essnmx good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yeti-platform/yeti#1380 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/python-sdk#3566 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
griptape-ai/griptape#2353 ·