[Schema Inaccuracy] Check Run webhooks 'check_run' actually has nullable 'output'

Open
#5,832 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Inspect the OpenAPI schema for the check_run webhook and locate the output property. Compare its declared nullability with the reported webhook payload behavior, update the schema declaration, and validate the resulting description with the repository's available checks.

Written by the indexing model from the issue text.

Description

feature

Schema Inaccuracy

Check Run webhooks claims output is non-null, but GitHub regularly sends data with this being null.

Expected

'check_run' should have a nullable 'output'

Reproduction Steps

I can get webhook payload examples if needed, but unlike REST API, this is a bit harder to reproduce at will.

Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.