Skip to content

WebHook installation_repositories event schema inconsistency/clarity #43315

@bensgilbert

Description

@bensgilbert

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/webhooks/webhook-events-and-payloads#installation_repositories

What part(s) of the article would you like to see updated?

The installation_repositories event defines two required properties:
repositories_added array of objects
repositories_removed array of objects

Each repository in repositories_added is typed as:
full_name string Required
id integer Required
name string Required
node_id string Required
private boolean Required

Each repository in repositories_removed has the exact same structure yet all the properties are optional. Given that repositories_removed is required, it doesn't make sense that each object in the array can be empty (why make it required if that's the case, there's no point in receiving "[{}, {}, {}]" for example). The docs don't explain when, if at all, the properties will not be sent.

I'd expect that the schema for repositories_added and repositories_removed be the same, with all the properties listed above being required.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions