Skip to content

[Schema Inaccuracy] Recently added webhook event names branch_protection_configuration, repository_ruleset not consistently reflected in schema #3775

Open
@jmehnle

Description

@jmehnle

Schema Inaccuracy

The recently-added webhook event names branch_protection_configuration, repository_ruleset not consistently reflected in schema. For example, components.schemas.webhook-check-suite-completed.properties.check_suite.properties.app.properties.events.items.enum doesn't list these. However, I'm receiving webhook events from GitHub that contain the following:

{
  "check_suite": {
    ...
    "app": {
      ...
      "events": [
        "branch_protection_configuration",  // <-- Oops!
        "branch_protection_rule",
        "check_run",
        "check_suite",
        "issue_comment",
        "member",
        "membership",
        "merge_group",
        "organization",
        "pull_request",
        "pull_request_review",
        "pull_request_review_comment",
        "pull_request_review_thread",
        "push",
        "repository",
        "repository_ruleset",  // <-- Oops!
        "status",
        "team",
        "team_add",
        "workflow_job",
        "workflow_run"
      ]
    },
    ...

Expected

components.schemas.webhook-check-suite-completed.properties.check_suite.properties.app.properties.events.items.enum and other enums of webhook event names should include branch_protection_configuration, repository_ruleset as generated in GitHub's webhook events.

Reproduction Steps

Just receive GitHub webhook events for check_suite events, and this will happen.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions