Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Schema Inaccuracy] webhooks events not available to api.github.com are documented #1966

Open
wolfy1339 opened this issue Dec 11, 2022 · 3 comments

Comments

@wolfy1339
Copy link

Schema Inaccuracy

The security_and_analysis webhook is included in the api.github.com OpenAPI spec, it shouldn't be as it's not available for GitHub.com (Free,Pro, Team).

Before webhooks were included in the OpenAPI spec, this event was documented on the docs, and I filed an issue and it was subsquently removed and confirmed to not be available for GitHub.com (Free,Pro, Team)

See github/docs#18668 (comment)

Expected

For the event definition to not exist in the scope of GitHub.com (Free,Pro, Team) specs

Reproduction Steps

N/A

@wolfy1339 wolfy1339 changed the title [Schema Inaccuracy] security_and_analysis webhook should not be documented in api.github.com [Schema Inaccuracy] webhooks event not available to api.github.com are documented Dec 11, 2022
@wolfy1339 wolfy1339 changed the title [Schema Inaccuracy] webhooks event not available to api.github.com are documented [Schema Inaccuracy] webhooks events not available to api.github.com are documented Dec 11, 2022
@wolfy1339
Copy link
Author

I just also found the user event, that also shouldn't be documented.

In it's description it says:

This event occurs when there is activity relating to user accounts in an enterprise.

@nikpivkin
Copy link

Hi @wolfy1339 !

It seems the security_and_analysis webhook has already been added: https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads#security_and_analysis

@wolfy1339
Copy link
Author

I am aware of that. This issue is about how the event is not available to GitHub.com users and is documented anyway for that version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants