-
Notifications
You must be signed in to change notification settings - Fork 286
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 github/docs#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.