[Schema Inaccuracy] Repository Vulnerability Alert's webhook create action missing lots of fields for Organization, Repository, and Sender
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- openapi
- Domain
- api
Research direction
Start by comparing the Repository, Organization, and Sender definitions in the OpenAPI spec with those used by other webhook events. Review available webhook payload examples if provided; done means the specification and emitted Repository Vulnerability Alert payload agree on the listed fields, though the issue leaves which side should change unresolved.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
Repository only seems to contain id, node_id, name, full_name, private, owner (also missing a bunch of things), html_url, description, fork, and default_branch. The other actions provide many more things.
Organization only seems to contain login, id, node_id, url, avatar_url, and description. Compared to other events, it's missing repos_url, events_url, hooks_url, issues_url, members_url, and public_members_url.
Sender only seems to contain login, id, node_id, avatar_url, type, and site_admin. Compared to other events, it's missing gravatar_id, url, html_url, followers_url, following_url, gists_url, starred_url, subscriptions_url, organizations_url, repos_url, events_url, received_events_url, and user_view_type.
Expected
The spec has definitions for these, but it's not sent. Either the spec needs to be updated or what sends needs to be updated; I don't really care which.
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
- 2h 23m
- Merged PRs (30d)
- 57
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/rest-api-description
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
github/rest-api-description#7220 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
github/rest-api-description#7201 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/rest-api-description#7163 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7162 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7135 ·
All issues in github/rest-api-description
Similar issues
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
essnmx good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yeti-platform/yeti#1380 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/python-sdk#3566 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
griptape-ai/griptape#2353 ·