Skip to content

[Schema Inaccuracy] <wrong spec in webhook-workflow-job-completed -> workflow_job -> allOf[1]> #2971

Open
@windqin

Description

@windqin

Schema Inaccuracy

In https://github.com/github/rest-api-description/blob/main/descriptions/ghec/ghec.2022-11-28.json head revision commit 35b5cecdbe953ee7bedce405a786d108ccf6af03, the definition of webhook-workflow-job-completed -> workflow_job -> allOf[1] is nearly the same as allOf[0], but the steps definition under it is wrong:

                  "steps": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "nullable": true
                    }
                  },

And the required field in allOf[1]:

                "required": [
                  "conclusion"
                ]

Looks not very make sense.

What's the purpose of define allOf[1]?

Expected

Not use allOf for webhook-workflow-job-completed -> workflow_job, but just let webhook-workflow-job-completed -> workflow_job equals the definition of webhook-workflow-job-completed -> workflow_job -> allOf[0]

Reproduction Steps

In GHEC repo settings -> Webhooks -> Manage webhook, setup a webhook with "Workflow jobs" selected, run a workflow, then check the "Recent Deliveries" in the webhook setting page, you can see the webhook event workflow_job.completed payload the "workflow_job" field matches the spec webhook-workflow-job-completed -> workflow_job -> allOf[0]

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