Skip to content

Commit 9f7f7f3

Browse files
wolfy1339wolfy1339
authored
feat: new and updated payload examples with resulting schema changes (#813)
* fix: update events for Apps and webhooks * fix: mark `fixed_in` as not required for `repository_vulnerability` events * feat: new `topics` key for `changes` on `repository.edited` event * feat: new auto dismissal of dependabot alerts * feat: new `notification_setting` key on team * feat: new `queued` status for workflow jobs * build: generate types * feat: new `dependabot_alert.created` example payload * chore: update payloads to reflect schema changes * feat: new payload example to demonstrate `queued` steps in a workflow job * build: generate index.json * fix: `id` in nugget package metadata cannot be an object * build: generate types * fix: add missing `additionalProperties: false` * fix: add missing `installation` key to `registry_packag` and `package` events Fixes #812
1 parent 4c7d8fb commit 9f7f7f3

26 files changed

+994
-32
lines changed

‎payload-examples/api.github.com/dependabot_alert/created.payload.json‎

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
{
2+
"action": "created",
3+
"alert": {
4+
"number": 20,
5+
"state": "open",
6+
"dependency": {
7+
"package": { "ecosystem": "npm", "name": "semver" },
8+
"manifest_path": "package-lock.json",
9+
"scope": "runtime"
10+
},
11+
"security_advisory": {
12+
"ghsa_id": "GHSA-c2qf-rxjj-qqgw",
13+
"cve_id": "CVE-2022-25883",
14+
"summary": "semver vulnerable to Regular Expression Denial of Service",
15+
"description": "Versions of the package semver before 7.5.2 are vulnerable to Regular Expression Denial of Service (ReDoS) via the function new Range, when untrusted user data is provided as a range.\n\n\n",
16+
"severity": "medium",
17+
"identifiers": [
18+
{ "value": "GHSA-c2qf-rxjj-qqgw", "type": "GHSA" },
19+
{ "value": "CVE-2022-25883", "type": "CVE" }
20+
],
21+
"references": [
22+
{ "url": "https://nvd.nist.gov/vuln/detail/CVE-2022-25883" },
23+
{ "url": "https://github.com/npm/node-semver/pull/564" },
24+
{
25+
"url": "https://github.com/npm/node-semver/commit/717534ee353682f3bcf33e60a8af4292626d4441"
26+
},
27+
{ "url": "https://security.snyk.io/vuln/SNYK-JS-SEMVER-3247795" },
28+
{
29+
"url": "https://github.com/npm/node-semver/blob/main/classes/range.js#L97-L104"
30+
},
31+
{
32+
"url": "https://github.com/npm/node-semver/blob/main/internal/re.js#L138"
33+
},
34+
{
35+
"url": "https://github.com/npm/node-semver/blob/main/internal/re.js#L160"
36+
},
37+
{ "url": "https://github.com/advisories/GHSA-c2qf-rxjj-qqgw" }
38+
],
39+
"published_at": "2023-06-21T06:30:28Z",
40+
"updated_at": "2023-06-22T16:52:56Z",
41+
"withdrawn_at": null,
42+
"vulnerabilities": [
43+
{
44+
"package": { "ecosystem": "npm", "name": "semver" },
45+
"severity": "medium",
46+
"vulnerable_version_range": "< 7.5.2",
47+
"first_patched_version": { "identifier": "7.5.2" }
48+
}
49+
],
50+
"cvss": {
51+
"vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:L",
52+
"score": 5.3
53+
},
54+
"cwes": [
55+
{
56+
"cwe_id": "CWE-1333",
57+
"name": "Inefficient Regular Expression Complexity"
58+
}
59+
]
60+
},
61+
"security_vulnerability": {
62+
"package": { "ecosystem": "npm", "name": "semver" },
63+
"severity": "medium",
64+
"vulnerable_version_range": "< 7.5.2",
65+
"first_patched_version": { "identifier": "7.5.2" }
66+
},
67+
"url": "https://api.github.com/repos/wolfy1339/pika-pack/dependabot/alerts/20",
68+
"html_url": "https://github.com/wolfy1339/pika-pack/security/dependabot/20",
69+
"created_at": "2023-06-24T13:57:12Z",
70+
"updated_at": "2023-06-24T13:57:12Z",
71+
"dismissed_at": null,
72+
"dismissed_by": null,
73+
"dismissed_reason": null,
74+
"dismissed_comment": null,
75+
"fixed_at": null,
76+
"auto_dismissed_at": null
77+
},
78+
"repository": {
79+
"id": 512875663,
80+
"node_id": "R_kgDOHpHcjw",
81+
"name": "pika-pack",
82+
"full_name": "wolfy1339/pika-pack",
83+
"private": false,
84+
"owner": {
85+
"login": "wolfy1339",
86+
"id": 4595477,
87+
"node_id": "MDQ6VXNlcjQ1OTU0Nzc=",
88+
"avatar_url": "https://avatars.githubusercontent.com/u/4595477?v=4",
89+
"gravatar_id": "",
90+
"url": "https://api.github.com/users/wolfy1339",
91+
"html_url": "https://github.com/wolfy1339",
92+
"followers_url": "https://api.github.com/users/wolfy1339/followers",
93+
"following_url": "https://api.github.com/users/wolfy1339/following{/other_user}",
94+
"gists_url": "https://api.github.com/users/wolfy1339/gists{/gist_id}",
95+
"starred_url": "https://api.github.com/users/wolfy1339/starred{/owner}{/repo}",
96+
"subscriptions_url": "https://api.github.com/users/wolfy1339/subscriptions",
97+
"organizations_url": "https://api.github.com/users/wolfy1339/orgs",
98+
"repos_url": "https://api.github.com/users/wolfy1339/repos",
99+
"events_url": "https://api.github.com/users/wolfy1339/events{/privacy}",
100+
"received_events_url": "https://api.github.com/users/wolfy1339/received_events",
101+
"type": "User",
102+
"site_admin": false
103+
},
104+
"html_url": "https://github.com/wolfy1339/pika-pack",
105+
"description": "📦⚡️ Build your npm package using composable plugins. https://www.pika.dev/blog/introducing-pika-pack/",
106+
"fork": true,
107+
"url": "https://api.github.com/repos/wolfy1339/pika-pack",
108+
"forks_url": "https://api.github.com/repos/wolfy1339/pika-pack/forks",
109+
"keys_url": "https://api.github.com/repos/wolfy1339/pika-pack/keys{/key_id}",
110+
"collaborators_url": "https://api.github.com/repos/wolfy1339/pika-pack/collaborators{/collaborator}",
111+
"teams_url": "https://api.github.com/repos/wolfy1339/pika-pack/teams",
112+
"hooks_url": "https://api.github.com/repos/wolfy1339/pika-pack/hooks",
113+
"issue_events_url": "https://api.github.com/repos/wolfy1339/pika-pack/issues/events{/number}",
114+
"events_url": "https://api.github.com/repos/wolfy1339/pika-pack/events",
115+
"assignees_url": "https://api.github.com/repos/wolfy1339/pika-pack/assignees{/user}",
116+
"branches_url": "https://api.github.com/repos/wolfy1339/pika-pack/branches{/branch}",
117+
"tags_url": "https://api.github.com/repos/wolfy1339/pika-pack/tags",
118+
"blobs_url": "https://api.github.com/repos/wolfy1339/pika-pack/git/blobs{/sha}",
119+
"git_tags_url": "https://api.github.com/repos/wolfy1339/pika-pack/git/tags{/sha}",
120+
"git_refs_url": "https://api.github.com/repos/wolfy1339/pika-pack/git/refs{/sha}",
121+
"trees_url": "https://api.github.com/repos/wolfy1339/pika-pack/git/trees{/sha}",
122+
"statuses_url": "https://api.github.com/repos/wolfy1339/pika-pack/statuses/{sha}",
123+
"languages_url": "https://api.github.com/repos/wolfy1339/pika-pack/languages",
124+
"stargazers_url": "https://api.github.com/repos/wolfy1339/pika-pack/stargazers",
125+
"contributors_url": "https://api.github.com/repos/wolfy1339/pika-pack/contributors",
126+
"subscribers_url": "https://api.github.com/repos/wolfy1339/pika-pack/subscribers",
127+
"subscription_url": "https://api.github.com/repos/wolfy1339/pika-pack/subscription",
128+
"commits_url": "https://api.github.com/repos/wolfy1339/pika-pack/commits{/sha}",
129+
"git_commits_url": "https://api.github.com/repos/wolfy1339/pika-pack/git/commits{/sha}",
130+
"comments_url": "https://api.github.com/repos/wolfy1339/pika-pack/comments{/number}",
131+
"issue_comment_url": "https://api.github.com/repos/wolfy1339/pika-pack/issues/comments{/number}",
132+
"contents_url": "https://api.github.com/repos/wolfy1339/pika-pack/contents/{+path}",
133+
"compare_url": "https://api.github.com/repos/wolfy1339/pika-pack/compare/{base}...{head}",
134+
"merges_url": "https://api.github.com/repos/wolfy1339/pika-pack/merges",
135+
"archive_url": "https://api.github.com/repos/wolfy1339/pika-pack/{archive_format}{/ref}",
136+
"downloads_url": "https://api.github.com/repos/wolfy1339/pika-pack/downloads",
137+
"issues_url": "https://api.github.com/repos/wolfy1339/pika-pack/issues{/number}",
138+
"pulls_url": "https://api.github.com/repos/wolfy1339/pika-pack/pulls{/number}",
139+
"milestones_url": "https://api.github.com/repos/wolfy1339/pika-pack/milestones{/number}",
140+
"notifications_url": "https://api.github.com/repos/wolfy1339/pika-pack/notifications{?since,all,participating}",
141+
"labels_url": "https://api.github.com/repos/wolfy1339/pika-pack/labels{/name}",
142+
"releases_url": "https://api.github.com/repos/wolfy1339/pika-pack/releases{/id}",
143+
"deployments_url": "https://api.github.com/repos/wolfy1339/pika-pack/deployments",
144+
"created_at": "2022-07-11T18:56:02Z",
145+
"updated_at": "2022-07-11T18:58:39Z",
146+
"pushed_at": "2023-06-16T01:37:23Z",
147+
"git_url": "git://github.com/wolfy1339/pika-pack.git",
148+
"ssh_url": "git@github.com:wolfy1339/pika-pack.git",
149+
"clone_url": "https://github.com/wolfy1339/pika-pack.git",
150+
"svn_url": "https://github.com/wolfy1339/pika-pack",
151+
"homepage": "",
152+
"size": 859,
153+
"stargazers_count": 0,
154+
"watchers_count": 0,
155+
"language": "JavaScript",
156+
"has_issues": false,
157+
"has_projects": true,
158+
"has_downloads": true,
159+
"has_wiki": true,
160+
"has_pages": false,
161+
"has_discussions": false,
162+
"forks_count": 0,
163+
"mirror_url": null,
164+
"archived": false,
165+
"disabled": false,
166+
"open_issues_count": 13,
167+
"license": {
168+
"key": "other",
169+
"name": "Other",
170+
"spdx_id": "NOASSERTION",
171+
"url": null,
172+
"node_id": "MDc6TGljZW5zZTA="
173+
},
174+
"allow_forking": true,
175+
"is_template": false,
176+
"web_commit_signoff_required": false,
177+
"topics": [],
178+
"visibility": "public",
179+
"forks": 0,
180+
"open_issues": 13,
181+
"watchers": 0,
182+
"default_branch": "master"
183+
},
184+
"sender": {
185+
"login": "github",
186+
"id": 9919,
187+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
188+
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
189+
"gravatar_id": "",
190+
"url": "https://api.github.com/users/github",
191+
"html_url": "https://github.com/github",
192+
"followers_url": "https://api.github.com/users/github/followers",
193+
"following_url": "https://api.github.com/users/github/following{/other_user}",
194+
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
195+
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
196+
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
197+
"organizations_url": "https://api.github.com/users/github/orgs",
198+
"repos_url": "https://api.github.com/users/github/repos",
199+
"events_url": "https://api.github.com/users/github/events{/privacy}",
200+
"received_events_url": "https://api.github.com/users/github/received_events",
201+
"type": "Organization",
202+
"site_admin": false
203+
},
204+
"installation": {
205+
"id": 13986380,
206+
"node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMTM5ODYzODA="
207+
}
208+
}

0 commit comments

Comments
 (0)