Skip to content

[Schema Inaccuracy] Schema for webhook-check-run-rerequested doesn't match example #4593

Open
@rahulsom

Description

@rahulsom

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    featurefundamentals-and-supportAdded by Howie to auto-add issues to API Platform KTLO project

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions