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] <no definition of display_title> #2966

Copy link
Copy link
Open
@windqin

Description

@windqin
Issue body actions

Schema Inaccuracy

In https://github.com/github/rest-api-description/blob/main/descriptions/ghec/ghec.2022-11-28.json commit 6510f7e,
no definition of display_title under components -> schemas -> webhook-workflow-run-completed -> properties -> workflow_run -> allOf[0] -> properties, but the real payload from GHEC webhook event contains this field.

Expected

display_title defined as:

                                    "display_title": {
                                        "type": "string",
                                        "example": "Simple Workflow",
                                        "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.",
                                        "maxLength": 1024
                                    }

Under components -> schemas -> webhook-workflow-run-completed -> properties -> workflow_run -> allOf[0] -> properties

Reproduction Steps

In GHEC repo settings -> Webhooks -> Manage webhook, setup a webhook with "Workflow runs" selected, run a workflow, then check the "Recent Deliveries" in the webhook setting page, you can see the webhook event workflow_run.completed payload contains display_title.

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.