You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Schema Inaccuracy] Webhook actions of one event disagree: workflow_run in_progress, review thread resolved/unresolved, review head.label, simple-check-suite deployment #7248
Some webhook schemas in the 2022-11-28 description on main (c6721f3) describe the same object differently from one action to the next, or leave out a field GitHub's own examples carry. All four were the same at 3cef12e.
webhook-workflow-run-in-progress: workflow_run has no display_title, which completed declares and requested requires, and actor, triggering_actor, repository.owner and head_repository.owner have no user_view_type, which both other actions declare. Its conclusion is nullable: true, but the enum has no null, so a validator that follows OAS 3.0.3 rejects conclusion: null, which is what an in-progress run carries. requested lists null in its enum.
webhook-pull-request-review-thread-resolved and -unresolved describe the same payload apart from action, but four fields are nullable only in resolved: pull_request.auto_merge.commit_title, pull_request.head.label, pull_request.head.repo and thread.comments[].original_line. head.repo is null once a fork is deleted, and original_line can be null on outdated comments, so unresolved rejects payloads resolved accepts.
simple-check-suite, which all four check_run webhooks reach through check-run-with-simple-check-suite.check_suite, has no deployment. The description's own check-run-created, check-run-completed and check-run-rerequested examples carry check_run.check_suite.deployment.
Expected
The actions of one event describe the shared objects the same way: display_title, user_view_type and a null conclusion on in_progress; the same nullability on both review-thread actions and on all review actions; and deployment on simple-check-suite.
Activity