Skip to content

check_run webhook: check-run-with-simple-check-suite.status is missing "waiting" and "requested" enum values #7003

Description

@rahulsom

Description

The check-run schema (used for REST API responses, e.g. GET /repos/{owner}/{repo}/check-runs/{check_run_id}) lists status as one of:

queued, in_progress, completed, waiting, requested, pending

But the check-run-with-simple-check-suite schema — used for the check_run webhook payload (components.schemas.check-run-with-simple-check-suite.properties.status) — only lists:

queued, in_progress, completed, pending

In practice, GitHub emits check_run webhook deliveries with status: "waiting" (and presumably "requested", matching the REST schema). Clients that generate strict enums from the webhook schema (e.g. OpenAPI codegen tools) fail to deserialize these real payloads with an "unrecognized enum value" error.

Expected

check-run-with-simple-check-suite.status should list the same enum values as check-run.status: queued, in_progress, completed, waiting, requested, pending.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions