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] Schema for webhook-check-run-rerequested doesn't match example #4593

Open
rahulsom opened this issue Mar 6, 2025 · 0 comments

Comments

@rahulsom
Copy link

rahulsom commented Mar 6, 2025

Schema Inaccuracy

Here's the JSONRef

#/components/schemas/webhook-check-run-rerequested

Here's the properties

        "properties": {
          "action": {
            "type": "string",
            "enum": [
              "rerequested"
            ]
          },
          "check_run": {
            "$ref": "#/components/schemas/check-run-with-simple-check-suite"
          },
          "installation": {
            "$ref": "#/components/schemas/simple-installation"
          },
          "organization": {
            "$ref": "#/components/schemas/organization-simple-webhooks"
          },
          "repository": {
            "$ref": "#/components/schemas/repository-webhooks"
          },
          "sender": {
            "$ref": "#/components/schemas/simple-user"
          }
        },

Here's the example at

#/webhooks/check-run-rerequested/post/requestBody/content/application~1json/examples
               52:             "name" : "Hello-World"
               53:           }
               54:         }
               55:       } ],
            >  56:       "deployment" : {
               57:         "url" : "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
               58:         "id" : 326191728,
               59:         "node_id" : "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
               60:         "task" : "deploy",

The field deployment is unexpected.

Expected

The schema and example match each other

Reproduction Steps

I looked at fpt, ghec, ghes-3.12, ghes-3.13, ghes-3.14, ghes-3.15

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

No branches or pull requests

1 participant