Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[Schema Inaccuracy] secret-scanning-alert-webhook schema doesn't have state but #4472

Copy link
Copy link
Open
@rahulsom

Description

@rahulsom
Issue body actions

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.

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

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.