Schema Inaccuracy
Three schemas type their review state property as a plain string rather than an enum, even though the value is constrained to a documented set.
REST (uppercase values):
components/schemas/pull-request-review.state — { "type": "string", "example": "CHANGES_REQUESTED" }. Used by GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews and every other endpoint returning a review.
Event records (lowercase values):
components/schemas/timeline-reviewed-event.state — { "type": "string", "example": "CHANGES_REQUESTED" }. Returned by GET /repos/{owner}/{repo}/issues/{issue_number}/timeline. The example value here is uppercase, but the live API returns lowercase for this surface (see Reproduction below).
components/schemas/webhooks_review.state — { "type": "string" }, $ref'd from webhook-pull-request-review-submitted.review and -edited.review. Webhook payloads deliver lowercase.
The canonical value list is GitHub's own GraphQL PullRequestReviewState enum: APPROVED, CHANGES_REQUESTED, COMMENTED, DISMISSED, PENDING. Prior precedent for citing the GraphQL enum as the source of truth: #74 (author_association), which was resolved by introducing a shared author-association component schema with the enum drawn from the GraphQL CommentAuthorAssociation enum.
Expected
pull-request-review.state (REST) should enumerate the uppercase values the API returns:
"state": {
"type": "string",
"enum": ["APPROVED", "CHANGES_REQUESTED", "COMMENTED", "DISMISSED", "PENDING"],
"example": "CHANGES_REQUESTED"
}
timeline-reviewed-event.state and webhooks_review.state should enumerate the lowercase values these surfaces actually deliver (pending is omitted because reviews don't reach event records or webhook payloads until submitted):
"state": {
"type": "string",
"enum": ["approved", "changes_requested", "commented", "dismissed"]
}
The inline webhook-pull-request-review-dismissed.review.state already declares the enum ["dismissed", "approved", "changes_requested"] directly — precedent for the same fix on webhooks_review.state.
Reproduction Steps
REST pull-request-review.state returns uppercase:
$ curl -s -H "Accept: application/vnd.github+json" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/kubernetes/kubernetes/pulls/90000/reviews \
| jq '[.[].state] | unique'
[
"APPROVED",
"CHANGES_REQUESTED",
"COMMENTED"
]
timeline-reviewed-event.state returns lowercase from the same PR (despite the spec's uppercase example: "CHANGES_REQUESTED"):
$ curl -s -H "Accept: application/vnd.github+json" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/kubernetes/kubernetes/issues/90000/timeline \
| jq -r '[.[] | select(.event == "reviewed") | .state] | unique'
[
"approved",
"changes_requested",
"commented"
]
Schema Inaccuracy
Three schemas type their review
stateproperty as a plainstringrather than anenum, even though the value is constrained to a documented set.REST (uppercase values):
components/schemas/pull-request-review.state—{ "type": "string", "example": "CHANGES_REQUESTED" }. Used byGET /repos/{owner}/{repo}/pulls/{pull_number}/reviewsand every other endpoint returning a review.Event records (lowercase values):
components/schemas/timeline-reviewed-event.state—{ "type": "string", "example": "CHANGES_REQUESTED" }. Returned byGET /repos/{owner}/{repo}/issues/{issue_number}/timeline. Theexamplevalue here is uppercase, but the live API returns lowercase for this surface (see Reproduction below).components/schemas/webhooks_review.state—{ "type": "string" },$ref'd fromwebhook-pull-request-review-submitted.reviewand-edited.review. Webhook payloads deliver lowercase.The canonical value list is GitHub's own GraphQL
PullRequestReviewStateenum:APPROVED,CHANGES_REQUESTED,COMMENTED,DISMISSED,PENDING. Prior precedent for citing the GraphQL enum as the source of truth: #74 (author_association), which was resolved by introducing a sharedauthor-associationcomponent schema with the enum drawn from the GraphQLCommentAuthorAssociationenum.Expected
pull-request-review.state(REST) should enumerate the uppercase values the API returns:timeline-reviewed-event.stateandwebhooks_review.stateshould enumerate the lowercase values these surfaces actually deliver (pendingis omitted because reviews don't reach event records or webhook payloads until submitted):The inline
webhook-pull-request-review-dismissed.review.statealready declares the enum["dismissed", "approved", "changes_requested"]directly — precedent for the same fix onwebhooks_review.state.Reproduction Steps
REST
pull-request-review.statereturns uppercase:timeline-reviewed-event.statereturns lowercase from the same PR (despite the spec's uppercaseexample: "CHANGES_REQUESTED"):