Skip to content

Do installation and installation_repository payloads have the property installation 100% of the times? #516

Closed
@oscard0m

Description

@oscard0m

What article on docs.github.com is affected?

https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads

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

Additional information

{% data reusables.webhooks.installation_properties %}
{% data reusables.webhooks.app_desc %}
{% data reusables.webhooks.sender_desc %}

and

{% data reusables.webhooks.installation_repositories_properties %}
{% data reusables.webhooks.app_desc %}
{% data reusables.webhooks.sender_desc %}

Checking the description of installation property, it denotes it could exist or not:

`installation` | `object` | The {% data variables.product.prodname_github_app %} installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a {% data variables.product.prodname_github_app %}.

but due to the nature of the events, it should always have installation property right?


Context:

@octokit/webhook-definition is working to improve typing of installation property in Payloads so it becomes an optional property (when necessary)

Metadata

Metadata

Assignees

No one assigned

    Labels

    ecosystemThis issue or pull request should be reviewed by the Docs Ecosystem 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