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] secret-scanning-alert-webhook schema doesn't have state but #4472

Open
rahulsom opened this issue Jan 26, 2025 · 14 comments

Comments

@rahulsom
Copy link

rahulsom commented Jan 26, 2025

Schema Inaccuracy

The example is at

#/webhooks/secret-scanning-alert-location-created/post/requestBody/content/application~1json/examples

That points to

#/components/examples/secret-scanning-alert-location-created

A snippet of the example

    6:     "updated_at" : "2020-11-06T18:18:30Z",
    7:     "url" : "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42",
    8:     "html_url" : "https://github.com/octocat-repo/hello-world/security/secret-scanning/42",
    9:     "locations_url" : "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations",
>  10:     "state" : "open",
   11:     "secret_type" : "mailchimp_api_key",
   12:     "secret" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2"
   13:   },
   14:   "location" : {

The schema is at

#/components/schemas/webhook-secret-scanning-alert-location-created/properties/alert

That points to

#/components/schemas/secret-scanning-alert-webhook

This lacks state

Expected

The schema and example match

Reproduction Steps

This is from

https://github.com/github/rest-api-description/raw/main/descriptions-next/ghes-3.13/ghes-3.13.json

I've checked for this in 3.10, 3.11, 3.12, 3.13, 3.14.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

5 similar comments
@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@Jasonradford51

This comment has been minimized.

@shiftkey
Copy link
Member

shiftkey commented Feb 3, 2025

Thanks for the report @rahulsom! I've forwarded this to the team that maintains this part of the webhooks API, and they'll reach out if they have any further questions...

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