@octokit/openapi 9.0.0 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/generated/api.github.com.deref.json +1 -1
  2. package/generated/api.github.com.json +1 -1
  3. package/generated/ghec-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghec-diff-to-api.github.com.json +1 -1
  5. package/generated/ghec.deref.json +1 -1
  6. package/generated/ghec.json +1 -1
  7. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
  8. package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -1
  9. package/generated/ghes-3.4.deref.json +1 -1
  10. package/generated/ghes-3.4.json +1 -1
  11. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +1 -1
  12. package/generated/ghes-3.5-diff-to-ghes-3.6.json +1 -1
  13. package/generated/ghes-3.5.deref.json +1 -1
  14. package/generated/ghes-3.5.json +1 -1
  15. package/generated/ghes-3.6-diff-to-ghes-3.7.deref.json +1 -1
  16. package/generated/ghes-3.6-diff-to-ghes-3.7.json +1 -1
  17. package/generated/ghes-3.6.deref.json +1 -1
  18. package/generated/ghes-3.6.json +1 -1
  19. package/generated/ghes-3.7-diff-to-api.github.com.deref.json +1 -1
  20. package/generated/ghes-3.7-diff-to-api.github.com.json +1 -1
  21. package/generated/ghes-3.7.deref.json +1 -1
  22. package/generated/ghes-3.7.json +1 -1
  23. package/generated/github.ae-diff-to-api.github.com.deref.json +1 -1
  24. package/generated/github.ae-diff-to-api.github.com.json +1 -1
  25. package/generated/github.ae.deref.json +1 -1
  26. package/generated/github.ae.json +1 -1
  27. package/index.js +0 -2
  28. package/package.json +1 -1
  29. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +0 -4320
  30. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +0 -40339
  31. package/generated/ghes-3.3-diff-to-ghes-3.4.json +0 -11582
  32. package/generated/ghes-3.3.deref.json +0 -376144
  33. package/generated/ghes-3.3.json +0 -97701
@@ -1,4320 +0,0 @@
1
- {
2
- "info": {
3
- "contact": null,
4
- "description": null,
5
- "extensions": {
6
- "changed": {
7
- "x-github-release": {
8
- "from": 3.4,
9
- "to": 3.3
10
- }
11
- }
12
- },
13
- "license": null,
14
- "terms_of_service": null,
15
- "title": null,
16
- "version": null
17
- },
18
- "paths": {
19
- "added": {
20
- "/applications/{client_id}/grants/{access_token}": {
21
- "delete": {
22
- "deprecated": true,
23
- "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server](https://github.com/settings/applications#authorized).",
24
- "externalDocs": {
25
- "description": "API method documentation",
26
- "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-a-grant-for-an-application"
27
- },
28
- "operationId": "apps/revoke-grant-for-application",
29
- "parameters": [
30
- {
31
- "description": "The client ID of the GitHub app.",
32
- "examples": {
33
- "default": {
34
- "value": "Iv1.8a61f9b3a7aba766"
35
- }
36
- },
37
- "in": "path",
38
- "name": "client_id",
39
- "required": true,
40
- "schema": {
41
- "type": "string"
42
- },
43
- "style": "simple"
44
- },
45
- {
46
- "in": "path",
47
- "name": "access_token",
48
- "required": true,
49
- "schema": {
50
- "type": "string"
51
- },
52
- "style": "simple"
53
- }
54
- ],
55
- "responses": {
56
- "204": {
57
- "description": "Response"
58
- }
59
- },
60
- "summary": "Revoke a grant for an application",
61
- "tags": [
62
- "apps"
63
- ],
64
- "x-github": {
65
- "category": "apps",
66
- "deprecationDate": "2020-02-14",
67
- "enabledForGitHubApps": false,
68
- "githubCloudOnly": false,
69
- "removalDate": "2021-05-05",
70
- "subcategory": "oauth-applications"
71
- }
72
- }
73
- },
74
- "/applications/{client_id}/tokens/{access_token}": {
75
- "delete": {
76
- "deprecated": true,
77
- "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.",
78
- "externalDocs": {
79
- "description": "API method documentation",
80
- "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-an-authorization-for-an-application"
81
- },
82
- "operationId": "apps/revoke-authorization-for-application",
83
- "parameters": [
84
- {
85
- "description": "The client ID of the GitHub app.",
86
- "examples": {
87
- "default": {
88
- "value": "Iv1.8a61f9b3a7aba766"
89
- }
90
- },
91
- "in": "path",
92
- "name": "client_id",
93
- "required": true,
94
- "schema": {
95
- "type": "string"
96
- },
97
- "style": "simple"
98
- },
99
- {
100
- "in": "path",
101
- "name": "access_token",
102
- "required": true,
103
- "schema": {
104
- "type": "string"
105
- },
106
- "style": "simple"
107
- }
108
- ],
109
- "responses": {
110
- "204": {
111
- "description": "Response"
112
- }
113
- },
114
- "summary": "Revoke an authorization for an application",
115
- "tags": [
116
- "apps"
117
- ],
118
- "x-github": {
119
- "category": "apps",
120
- "deprecationDate": "2020-02-14",
121
- "enabledForGitHubApps": false,
122
- "githubCloudOnly": false,
123
- "removalDate": "2021-05-05",
124
- "subcategory": "oauth-applications"
125
- }
126
- },
127
- "get": {
128
- "deprecated": true,
129
- "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
130
- "externalDocs": {
131
- "description": "API method documentation",
132
- "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#check-an-authorization"
133
- },
134
- "operationId": "apps/check-authorization",
135
- "parameters": [
136
- {
137
- "description": "The client ID of the GitHub app.",
138
- "examples": {
139
- "default": {
140
- "value": "Iv1.8a61f9b3a7aba766"
141
- }
142
- },
143
- "in": "path",
144
- "name": "client_id",
145
- "required": true,
146
- "schema": {
147
- "type": "string"
148
- },
149
- "style": "simple"
150
- },
151
- {
152
- "in": "path",
153
- "name": "access_token",
154
- "required": true,
155
- "schema": {
156
- "type": "string"
157
- },
158
- "style": "simple"
159
- }
160
- ],
161
- "responses": {
162
- "200": {
163
- "content": {
164
- "application/json": {
165
- "examples": {
166
- "default": {
167
- "value": {
168
- "app": {
169
- "client_id": "Iv1.8a61f9b3a7aba766",
170
- "name": "my github app",
171
- "url": "http://my-github-app.com"
172
- },
173
- "created_at": "2011-09-06T17:26:27Z",
174
- "expires_at": "2011-09-08T17:26:27Z",
175
- "fingerprint": "jklmnop12345678",
176
- "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
177
- "id": 1,
178
- "note": "optional note",
179
- "note_url": "http://optional/note/url",
180
- "scopes": [
181
- "public_repo",
182
- "user"
183
- ],
184
- "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
185
- "token_last_eight": "Ae178B4a",
186
- "updated_at": "2011-09-06T20:39:23Z",
187
- "url": "https://api.github.com/authorizations/1",
188
- "user": {
189
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
190
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
191
- "followers_url": "https://api.github.com/users/octocat/followers",
192
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
193
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
194
- "html_url": "https://github.com/octocat",
195
- "id": 1,
196
- "login": "octocat",
197
- "node_id": "MDQ6VXNlcjE=",
198
- "organizations_url": "https://api.github.com/users/octocat/orgs",
199
- "received_events_url": "https://api.github.com/users/octocat/received_events",
200
- "repos_url": "https://api.github.com/users/octocat/repos",
201
- "site_admin": false,
202
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
203
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
204
- "type": "User",
205
- "url": "https://api.github.com/users/octocat"
206
- }
207
- }
208
- }
209
- },
210
- "schema": {
211
- "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.",
212
- "nullable": true,
213
- "properties": {
214
- "app": {
215
- "properties": {
216
- "client_id": {
217
- "type": "string"
218
- },
219
- "name": {
220
- "type": "string"
221
- },
222
- "url": {
223
- "format": "uri",
224
- "type": "string"
225
- }
226
- },
227
- "required": [
228
- "client_id",
229
- "name",
230
- "url"
231
- ],
232
- "type": "object"
233
- },
234
- "created_at": {
235
- "format": "date-time",
236
- "type": "string"
237
- },
238
- "expires_at": {
239
- "format": "date-time",
240
- "nullable": true,
241
- "type": "string"
242
- },
243
- "fingerprint": {
244
- "nullable": true,
245
- "type": "string"
246
- },
247
- "hashed_token": {
248
- "nullable": true,
249
- "type": "string"
250
- },
251
- "id": {
252
- "type": "integer"
253
- },
254
- "installation": {
255
- "nullable": true,
256
- "properties": {
257
- "account": {
258
- "description": "A GitHub user.",
259
- "properties": {
260
- "avatar_url": {
261
- "example": "https://github.com/images/error/octocat_happy.gif",
262
- "format": "uri",
263
- "type": "string"
264
- },
265
- "email": {
266
- "nullable": true,
267
- "type": "string"
268
- },
269
- "events_url": {
270
- "example": "https://api.github.com/users/octocat/events{/privacy}",
271
- "type": "string"
272
- },
273
- "followers_url": {
274
- "example": "https://api.github.com/users/octocat/followers",
275
- "format": "uri",
276
- "type": "string"
277
- },
278
- "following_url": {
279
- "example": "https://api.github.com/users/octocat/following{/other_user}",
280
- "type": "string"
281
- },
282
- "gists_url": {
283
- "example": "https://api.github.com/users/octocat/gists{/gist_id}",
284
- "type": "string"
285
- },
286
- "gravatar_id": {
287
- "example": "41d064eb2195891e12d0413f63227ea7",
288
- "nullable": true,
289
- "type": "string"
290
- },
291
- "html_url": {
292
- "example": "https://github.com/octocat",
293
- "format": "uri",
294
- "type": "string"
295
- },
296
- "id": {
297
- "example": 1,
298
- "type": "integer"
299
- },
300
- "login": {
301
- "example": "octocat",
302
- "type": "string"
303
- },
304
- "name": {
305
- "nullable": true,
306
- "type": "string"
307
- },
308
- "node_id": {
309
- "example": "MDQ6VXNlcjE=",
310
- "type": "string"
311
- },
312
- "organizations_url": {
313
- "example": "https://api.github.com/users/octocat/orgs",
314
- "format": "uri",
315
- "type": "string"
316
- },
317
- "received_events_url": {
318
- "example": "https://api.github.com/users/octocat/received_events",
319
- "format": "uri",
320
- "type": "string"
321
- },
322
- "repos_url": {
323
- "example": "https://api.github.com/users/octocat/repos",
324
- "format": "uri",
325
- "type": "string"
326
- },
327
- "site_admin": {
328
- "type": "boolean"
329
- },
330
- "starred_at": {
331
- "example": "\"2020-07-09T00:17:55Z\"",
332
- "type": "string"
333
- },
334
- "starred_url": {
335
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
336
- "type": "string"
337
- },
338
- "subscriptions_url": {
339
- "example": "https://api.github.com/users/octocat/subscriptions",
340
- "format": "uri",
341
- "type": "string"
342
- },
343
- "type": {
344
- "example": "User",
345
- "type": "string"
346
- },
347
- "url": {
348
- "example": "https://api.github.com/users/octocat",
349
- "format": "uri",
350
- "type": "string"
351
- }
352
- },
353
- "required": [
354
- "avatar_url",
355
- "events_url",
356
- "followers_url",
357
- "following_url",
358
- "gists_url",
359
- "gravatar_id",
360
- "html_url",
361
- "id",
362
- "node_id",
363
- "login",
364
- "organizations_url",
365
- "received_events_url",
366
- "repos_url",
367
- "site_admin",
368
- "starred_url",
369
- "subscriptions_url",
370
- "type",
371
- "url"
372
- ],
373
- "title": "Simple User",
374
- "type": "object"
375
- },
376
- "has_multiple_single_files": {
377
- "example": true,
378
- "type": "boolean"
379
- },
380
- "permissions": {
381
- "description": "The permissions granted to the user-to-server access token.",
382
- "example": {
383
- "contents": "read",
384
- "deployments": "write",
385
- "issues": "read",
386
- "single_file": "read"
387
- },
388
- "properties": {
389
- "actions": {
390
- "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.",
391
- "enum": [
392
- "read",
393
- "write"
394
- ],
395
- "type": "string"
396
- },
397
- "administration": {
398
- "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.",
399
- "enum": [
400
- "read",
401
- "write"
402
- ],
403
- "type": "string"
404
- },
405
- "checks": {
406
- "description": "The level of permission to grant the access token for checks on code.",
407
- "enum": [
408
- "read",
409
- "write"
410
- ],
411
- "type": "string"
412
- },
413
- "content_references": {
414
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
415
- "enum": [
416
- "read",
417
- "write"
418
- ],
419
- "type": "string"
420
- },
421
- "contents": {
422
- "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.",
423
- "enum": [
424
- "read",
425
- "write"
426
- ],
427
- "type": "string"
428
- },
429
- "deployments": {
430
- "description": "The level of permission to grant the access token for deployments and deployment statuses.",
431
- "enum": [
432
- "read",
433
- "write"
434
- ],
435
- "type": "string"
436
- },
437
- "environments": {
438
- "description": "The level of permission to grant the access token for managing repository environments.",
439
- "enum": [
440
- "read",
441
- "write"
442
- ],
443
- "type": "string"
444
- },
445
- "issues": {
446
- "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.",
447
- "enum": [
448
- "read",
449
- "write"
450
- ],
451
- "type": "string"
452
- },
453
- "members": {
454
- "description": "The level of permission to grant the access token for organization teams and members.",
455
- "enum": [
456
- "read",
457
- "write"
458
- ],
459
- "type": "string"
460
- },
461
- "metadata": {
462
- "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.",
463
- "enum": [
464
- "read",
465
- "write"
466
- ],
467
- "type": "string"
468
- },
469
- "organization_administration": {
470
- "description": "The level of permission to grant the access token to manage access to an organization.",
471
- "enum": [
472
- "read",
473
- "write"
474
- ],
475
- "type": "string"
476
- },
477
- "organization_hooks": {
478
- "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
479
- "enum": [
480
- "read",
481
- "write"
482
- ],
483
- "type": "string"
484
- },
485
- "organization_packages": {
486
- "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.",
487
- "enum": [
488
- "read",
489
- "write"
490
- ],
491
- "type": "string"
492
- },
493
- "organization_plan": {
494
- "description": "The level of permission to grant the access token for viewing an organization's plan.",
495
- "enum": [
496
- "read"
497
- ],
498
- "type": "string"
499
- },
500
- "organization_projects": {
501
- "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).",
502
- "enum": [
503
- "read",
504
- "write",
505
- "admin"
506
- ],
507
- "type": "string"
508
- },
509
- "organization_secrets": {
510
- "description": "The level of permission to grant the access token to manage organization secrets.",
511
- "enum": [
512
- "read",
513
- "write"
514
- ],
515
- "type": "string"
516
- },
517
- "organization_self_hosted_runners": {
518
- "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.",
519
- "enum": [
520
- "read",
521
- "write"
522
- ],
523
- "type": "string"
524
- },
525
- "organization_user_blocking": {
526
- "description": "The level of permission to grant the access token to view and manage users blocked by the organization.",
527
- "enum": [
528
- "read",
529
- "write"
530
- ],
531
- "type": "string"
532
- },
533
- "packages": {
534
- "description": "The level of permission to grant the access token for packages published to GitHub Packages.",
535
- "enum": [
536
- "read",
537
- "write"
538
- ],
539
- "type": "string"
540
- },
541
- "pages": {
542
- "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.",
543
- "enum": [
544
- "read",
545
- "write"
546
- ],
547
- "type": "string"
548
- },
549
- "pull_requests": {
550
- "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.",
551
- "enum": [
552
- "read",
553
- "write"
554
- ],
555
- "type": "string"
556
- },
557
- "repository_hooks": {
558
- "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
559
- "enum": [
560
- "read",
561
- "write"
562
- ],
563
- "type": "string"
564
- },
565
- "repository_projects": {
566
- "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.",
567
- "enum": [
568
- "read",
569
- "write",
570
- "admin"
571
- ],
572
- "type": "string"
573
- },
574
- "secret_scanning_alerts": {
575
- "description": "The level of permission to grant the access token to view and manage secret scanning alerts.",
576
- "enum": [
577
- "read",
578
- "write"
579
- ],
580
- "type": "string"
581
- },
582
- "secrets": {
583
- "description": "The level of permission to grant the access token to manage repository secrets.",
584
- "enum": [
585
- "read",
586
- "write"
587
- ],
588
- "type": "string"
589
- },
590
- "security_events": {
591
- "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.",
592
- "enum": [
593
- "read",
594
- "write"
595
- ],
596
- "type": "string"
597
- },
598
- "single_file": {
599
- "description": "The level of permission to grant the access token to manage just a single file.",
600
- "enum": [
601
- "read",
602
- "write"
603
- ],
604
- "type": "string"
605
- },
606
- "statuses": {
607
- "description": "The level of permission to grant the access token for commit statuses.",
608
- "enum": [
609
- "read",
610
- "write"
611
- ],
612
- "type": "string"
613
- },
614
- "team_discussions": {
615
- "description": "The level of permission to grant the access token to manage team discussions and related comments.",
616
- "enum": [
617
- "read",
618
- "write"
619
- ],
620
- "type": "string"
621
- },
622
- "vulnerability_alerts": {
623
- "description": "The level of permission to grant the access token to manage Dependabot alerts.",
624
- "enum": [
625
- "read",
626
- "write"
627
- ],
628
- "type": "string"
629
- },
630
- "workflows": {
631
- "description": "The level of permission to grant the access token to update GitHub Actions workflow files.",
632
- "enum": [
633
- "write"
634
- ],
635
- "type": "string"
636
- }
637
- },
638
- "title": "App Permissions",
639
- "type": "object"
640
- },
641
- "repositories_url": {
642
- "example": "https://api.github.com/users/octocat/repos",
643
- "format": "uri",
644
- "type": "string"
645
- },
646
- "repository_selection": {
647
- "description": "Describe whether all repositories have been selected or there's a selection involved",
648
- "enum": [
649
- "all",
650
- "selected"
651
- ],
652
- "type": "string"
653
- },
654
- "single_file_name": {
655
- "example": "config.yaml",
656
- "nullable": true,
657
- "type": "string"
658
- },
659
- "single_file_paths": {
660
- "example": [
661
- "config.yml",
662
- ".github/issue_TEMPLATE.md"
663
- ],
664
- "items": {
665
- "type": "string"
666
- },
667
- "type": "array"
668
- }
669
- },
670
- "required": [
671
- "permissions",
672
- "repository_selection",
673
- "single_file_name",
674
- "repositories_url",
675
- "account"
676
- ],
677
- "title": "Scoped Installation",
678
- "type": "object"
679
- },
680
- "note": {
681
- "nullable": true,
682
- "type": "string"
683
- },
684
- "note_url": {
685
- "format": "uri",
686
- "nullable": true,
687
- "type": "string"
688
- },
689
- "scopes": {
690
- "description": "A list of scopes that this authorization is in.",
691
- "items": {
692
- "type": "string"
693
- },
694
- "nullable": true,
695
- "type": "array"
696
- },
697
- "token": {
698
- "type": "string"
699
- },
700
- "token_last_eight": {
701
- "nullable": true,
702
- "type": "string"
703
- },
704
- "updated_at": {
705
- "format": "date-time",
706
- "type": "string"
707
- },
708
- "url": {
709
- "format": "uri",
710
- "type": "string"
711
- },
712
- "user": {
713
- "description": "A GitHub user.",
714
- "nullable": true,
715
- "properties": {
716
- "avatar_url": {
717
- "example": "https://github.com/images/error/octocat_happy.gif",
718
- "format": "uri",
719
- "type": "string"
720
- },
721
- "email": {
722
- "nullable": true,
723
- "type": "string"
724
- },
725
- "events_url": {
726
- "example": "https://api.github.com/users/octocat/events{/privacy}",
727
- "type": "string"
728
- },
729
- "followers_url": {
730
- "example": "https://api.github.com/users/octocat/followers",
731
- "format": "uri",
732
- "type": "string"
733
- },
734
- "following_url": {
735
- "example": "https://api.github.com/users/octocat/following{/other_user}",
736
- "type": "string"
737
- },
738
- "gists_url": {
739
- "example": "https://api.github.com/users/octocat/gists{/gist_id}",
740
- "type": "string"
741
- },
742
- "gravatar_id": {
743
- "example": "41d064eb2195891e12d0413f63227ea7",
744
- "nullable": true,
745
- "type": "string"
746
- },
747
- "html_url": {
748
- "example": "https://github.com/octocat",
749
- "format": "uri",
750
- "type": "string"
751
- },
752
- "id": {
753
- "example": 1,
754
- "type": "integer"
755
- },
756
- "login": {
757
- "example": "octocat",
758
- "type": "string"
759
- },
760
- "name": {
761
- "nullable": true,
762
- "type": "string"
763
- },
764
- "node_id": {
765
- "example": "MDQ6VXNlcjE=",
766
- "type": "string"
767
- },
768
- "organizations_url": {
769
- "example": "https://api.github.com/users/octocat/orgs",
770
- "format": "uri",
771
- "type": "string"
772
- },
773
- "received_events_url": {
774
- "example": "https://api.github.com/users/octocat/received_events",
775
- "format": "uri",
776
- "type": "string"
777
- },
778
- "repos_url": {
779
- "example": "https://api.github.com/users/octocat/repos",
780
- "format": "uri",
781
- "type": "string"
782
- },
783
- "site_admin": {
784
- "type": "boolean"
785
- },
786
- "starred_at": {
787
- "example": "\"2020-07-09T00:17:55Z\"",
788
- "type": "string"
789
- },
790
- "starred_url": {
791
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
792
- "type": "string"
793
- },
794
- "subscriptions_url": {
795
- "example": "https://api.github.com/users/octocat/subscriptions",
796
- "format": "uri",
797
- "type": "string"
798
- },
799
- "type": {
800
- "example": "User",
801
- "type": "string"
802
- },
803
- "url": {
804
- "example": "https://api.github.com/users/octocat",
805
- "format": "uri",
806
- "type": "string"
807
- }
808
- },
809
- "required": [
810
- "avatar_url",
811
- "events_url",
812
- "followers_url",
813
- "following_url",
814
- "gists_url",
815
- "gravatar_id",
816
- "html_url",
817
- "id",
818
- "node_id",
819
- "login",
820
- "organizations_url",
821
- "received_events_url",
822
- "repos_url",
823
- "site_admin",
824
- "starred_url",
825
- "subscriptions_url",
826
- "type",
827
- "url"
828
- ],
829
- "title": "Simple User",
830
- "type": "object"
831
- }
832
- },
833
- "required": [
834
- "app",
835
- "id",
836
- "note",
837
- "note_url",
838
- "scopes",
839
- "token",
840
- "hashed_token",
841
- "token_last_eight",
842
- "fingerprint",
843
- "url",
844
- "created_at",
845
- "updated_at",
846
- "expires_at"
847
- ],
848
- "title": "Authorization",
849
- "type": "object"
850
- }
851
- }
852
- },
853
- "description": "Response"
854
- },
855
- "404": {
856
- "content": {
857
- "application/json": {
858
- "schema": {
859
- "description": "Basic Error",
860
- "properties": {
861
- "documentation_url": {
862
- "type": "string"
863
- },
864
- "message": {
865
- "type": "string"
866
- },
867
- "status": {
868
- "type": "string"
869
- },
870
- "url": {
871
- "type": "string"
872
- }
873
- },
874
- "title": "Basic Error",
875
- "type": "object"
876
- }
877
- }
878
- },
879
- "description": "Resource not found"
880
- }
881
- },
882
- "summary": "Check an authorization",
883
- "tags": [
884
- "apps"
885
- ],
886
- "x-github": {
887
- "category": "apps",
888
- "deprecationDate": "2020-02-14",
889
- "enabledForGitHubApps": false,
890
- "githubCloudOnly": false,
891
- "removalDate": "2021-05-05",
892
- "subcategory": "oauth-applications"
893
- }
894
- },
895
- "post": {
896
- "deprecated": true,
897
- "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
898
- "externalDocs": {
899
- "description": "API method documentation",
900
- "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#reset-an-authorization"
901
- },
902
- "operationId": "apps/reset-authorization",
903
- "parameters": [
904
- {
905
- "description": "The client ID of the GitHub app.",
906
- "examples": {
907
- "default": {
908
- "value": "Iv1.8a61f9b3a7aba766"
909
- }
910
- },
911
- "in": "path",
912
- "name": "client_id",
913
- "required": true,
914
- "schema": {
915
- "type": "string"
916
- },
917
- "style": "simple"
918
- },
919
- {
920
- "in": "path",
921
- "name": "access_token",
922
- "required": true,
923
- "schema": {
924
- "type": "string"
925
- },
926
- "style": "simple"
927
- }
928
- ],
929
- "responses": {
930
- "200": {
931
- "content": {
932
- "application/json": {
933
- "examples": {
934
- "default": {
935
- "value": {
936
- "app": {
937
- "client_id": "Iv1.8a61f9b3a7aba766",
938
- "name": "my github app",
939
- "url": "http://my-github-app.com"
940
- },
941
- "created_at": "2011-09-06T17:26:27Z",
942
- "expires_at": "2011-09-08T17:26:27Z",
943
- "fingerprint": "jklmnop12345678",
944
- "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
945
- "id": 1,
946
- "note": "optional note",
947
- "note_url": "http://optional/note/url",
948
- "scopes": [
949
- "public_repo",
950
- "user"
951
- ],
952
- "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
953
- "token_last_eight": "Ae178B4a",
954
- "updated_at": "2011-09-06T20:39:23Z",
955
- "url": "https://api.github.com/authorizations/1",
956
- "user": {
957
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
958
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
959
- "followers_url": "https://api.github.com/users/octocat/followers",
960
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
961
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
962
- "html_url": "https://github.com/octocat",
963
- "id": 1,
964
- "login": "octocat",
965
- "node_id": "MDQ6VXNlcjE=",
966
- "organizations_url": "https://api.github.com/users/octocat/orgs",
967
- "received_events_url": "https://api.github.com/users/octocat/received_events",
968
- "repos_url": "https://api.github.com/users/octocat/repos",
969
- "site_admin": false,
970
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
971
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
972
- "type": "User",
973
- "url": "https://api.github.com/users/octocat"
974
- }
975
- }
976
- }
977
- },
978
- "schema": {
979
- "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.",
980
- "properties": {
981
- "app": {
982
- "properties": {
983
- "client_id": {
984
- "type": "string"
985
- },
986
- "name": {
987
- "type": "string"
988
- },
989
- "url": {
990
- "format": "uri",
991
- "type": "string"
992
- }
993
- },
994
- "required": [
995
- "client_id",
996
- "name",
997
- "url"
998
- ],
999
- "type": "object"
1000
- },
1001
- "created_at": {
1002
- "format": "date-time",
1003
- "type": "string"
1004
- },
1005
- "expires_at": {
1006
- "format": "date-time",
1007
- "nullable": true,
1008
- "type": "string"
1009
- },
1010
- "fingerprint": {
1011
- "nullable": true,
1012
- "type": "string"
1013
- },
1014
- "hashed_token": {
1015
- "nullable": true,
1016
- "type": "string"
1017
- },
1018
- "id": {
1019
- "type": "integer"
1020
- },
1021
- "installation": {
1022
- "nullable": true,
1023
- "properties": {
1024
- "account": {
1025
- "description": "A GitHub user.",
1026
- "properties": {
1027
- "avatar_url": {
1028
- "example": "https://github.com/images/error/octocat_happy.gif",
1029
- "format": "uri",
1030
- "type": "string"
1031
- },
1032
- "email": {
1033
- "nullable": true,
1034
- "type": "string"
1035
- },
1036
- "events_url": {
1037
- "example": "https://api.github.com/users/octocat/events{/privacy}",
1038
- "type": "string"
1039
- },
1040
- "followers_url": {
1041
- "example": "https://api.github.com/users/octocat/followers",
1042
- "format": "uri",
1043
- "type": "string"
1044
- },
1045
- "following_url": {
1046
- "example": "https://api.github.com/users/octocat/following{/other_user}",
1047
- "type": "string"
1048
- },
1049
- "gists_url": {
1050
- "example": "https://api.github.com/users/octocat/gists{/gist_id}",
1051
- "type": "string"
1052
- },
1053
- "gravatar_id": {
1054
- "example": "41d064eb2195891e12d0413f63227ea7",
1055
- "nullable": true,
1056
- "type": "string"
1057
- },
1058
- "html_url": {
1059
- "example": "https://github.com/octocat",
1060
- "format": "uri",
1061
- "type": "string"
1062
- },
1063
- "id": {
1064
- "example": 1,
1065
- "type": "integer"
1066
- },
1067
- "login": {
1068
- "example": "octocat",
1069
- "type": "string"
1070
- },
1071
- "name": {
1072
- "nullable": true,
1073
- "type": "string"
1074
- },
1075
- "node_id": {
1076
- "example": "MDQ6VXNlcjE=",
1077
- "type": "string"
1078
- },
1079
- "organizations_url": {
1080
- "example": "https://api.github.com/users/octocat/orgs",
1081
- "format": "uri",
1082
- "type": "string"
1083
- },
1084
- "received_events_url": {
1085
- "example": "https://api.github.com/users/octocat/received_events",
1086
- "format": "uri",
1087
- "type": "string"
1088
- },
1089
- "repos_url": {
1090
- "example": "https://api.github.com/users/octocat/repos",
1091
- "format": "uri",
1092
- "type": "string"
1093
- },
1094
- "site_admin": {
1095
- "type": "boolean"
1096
- },
1097
- "starred_at": {
1098
- "example": "\"2020-07-09T00:17:55Z\"",
1099
- "type": "string"
1100
- },
1101
- "starred_url": {
1102
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
1103
- "type": "string"
1104
- },
1105
- "subscriptions_url": {
1106
- "example": "https://api.github.com/users/octocat/subscriptions",
1107
- "format": "uri",
1108
- "type": "string"
1109
- },
1110
- "type": {
1111
- "example": "User",
1112
- "type": "string"
1113
- },
1114
- "url": {
1115
- "example": "https://api.github.com/users/octocat",
1116
- "format": "uri",
1117
- "type": "string"
1118
- }
1119
- },
1120
- "required": [
1121
- "avatar_url",
1122
- "events_url",
1123
- "followers_url",
1124
- "following_url",
1125
- "gists_url",
1126
- "gravatar_id",
1127
- "html_url",
1128
- "id",
1129
- "node_id",
1130
- "login",
1131
- "organizations_url",
1132
- "received_events_url",
1133
- "repos_url",
1134
- "site_admin",
1135
- "starred_url",
1136
- "subscriptions_url",
1137
- "type",
1138
- "url"
1139
- ],
1140
- "title": "Simple User",
1141
- "type": "object"
1142
- },
1143
- "has_multiple_single_files": {
1144
- "example": true,
1145
- "type": "boolean"
1146
- },
1147
- "permissions": {
1148
- "description": "The permissions granted to the user-to-server access token.",
1149
- "example": {
1150
- "contents": "read",
1151
- "deployments": "write",
1152
- "issues": "read",
1153
- "single_file": "read"
1154
- },
1155
- "properties": {
1156
- "actions": {
1157
- "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.",
1158
- "enum": [
1159
- "read",
1160
- "write"
1161
- ],
1162
- "type": "string"
1163
- },
1164
- "administration": {
1165
- "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.",
1166
- "enum": [
1167
- "read",
1168
- "write"
1169
- ],
1170
- "type": "string"
1171
- },
1172
- "checks": {
1173
- "description": "The level of permission to grant the access token for checks on code.",
1174
- "enum": [
1175
- "read",
1176
- "write"
1177
- ],
1178
- "type": "string"
1179
- },
1180
- "content_references": {
1181
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
1182
- "enum": [
1183
- "read",
1184
- "write"
1185
- ],
1186
- "type": "string"
1187
- },
1188
- "contents": {
1189
- "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.",
1190
- "enum": [
1191
- "read",
1192
- "write"
1193
- ],
1194
- "type": "string"
1195
- },
1196
- "deployments": {
1197
- "description": "The level of permission to grant the access token for deployments and deployment statuses.",
1198
- "enum": [
1199
- "read",
1200
- "write"
1201
- ],
1202
- "type": "string"
1203
- },
1204
- "environments": {
1205
- "description": "The level of permission to grant the access token for managing repository environments.",
1206
- "enum": [
1207
- "read",
1208
- "write"
1209
- ],
1210
- "type": "string"
1211
- },
1212
- "issues": {
1213
- "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.",
1214
- "enum": [
1215
- "read",
1216
- "write"
1217
- ],
1218
- "type": "string"
1219
- },
1220
- "members": {
1221
- "description": "The level of permission to grant the access token for organization teams and members.",
1222
- "enum": [
1223
- "read",
1224
- "write"
1225
- ],
1226
- "type": "string"
1227
- },
1228
- "metadata": {
1229
- "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.",
1230
- "enum": [
1231
- "read",
1232
- "write"
1233
- ],
1234
- "type": "string"
1235
- },
1236
- "organization_administration": {
1237
- "description": "The level of permission to grant the access token to manage access to an organization.",
1238
- "enum": [
1239
- "read",
1240
- "write"
1241
- ],
1242
- "type": "string"
1243
- },
1244
- "organization_hooks": {
1245
- "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
1246
- "enum": [
1247
- "read",
1248
- "write"
1249
- ],
1250
- "type": "string"
1251
- },
1252
- "organization_packages": {
1253
- "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.",
1254
- "enum": [
1255
- "read",
1256
- "write"
1257
- ],
1258
- "type": "string"
1259
- },
1260
- "organization_plan": {
1261
- "description": "The level of permission to grant the access token for viewing an organization's plan.",
1262
- "enum": [
1263
- "read"
1264
- ],
1265
- "type": "string"
1266
- },
1267
- "organization_projects": {
1268
- "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).",
1269
- "enum": [
1270
- "read",
1271
- "write",
1272
- "admin"
1273
- ],
1274
- "type": "string"
1275
- },
1276
- "organization_secrets": {
1277
- "description": "The level of permission to grant the access token to manage organization secrets.",
1278
- "enum": [
1279
- "read",
1280
- "write"
1281
- ],
1282
- "type": "string"
1283
- },
1284
- "organization_self_hosted_runners": {
1285
- "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.",
1286
- "enum": [
1287
- "read",
1288
- "write"
1289
- ],
1290
- "type": "string"
1291
- },
1292
- "organization_user_blocking": {
1293
- "description": "The level of permission to grant the access token to view and manage users blocked by the organization.",
1294
- "enum": [
1295
- "read",
1296
- "write"
1297
- ],
1298
- "type": "string"
1299
- },
1300
- "packages": {
1301
- "description": "The level of permission to grant the access token for packages published to GitHub Packages.",
1302
- "enum": [
1303
- "read",
1304
- "write"
1305
- ],
1306
- "type": "string"
1307
- },
1308
- "pages": {
1309
- "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.",
1310
- "enum": [
1311
- "read",
1312
- "write"
1313
- ],
1314
- "type": "string"
1315
- },
1316
- "pull_requests": {
1317
- "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.",
1318
- "enum": [
1319
- "read",
1320
- "write"
1321
- ],
1322
- "type": "string"
1323
- },
1324
- "repository_hooks": {
1325
- "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
1326
- "enum": [
1327
- "read",
1328
- "write"
1329
- ],
1330
- "type": "string"
1331
- },
1332
- "repository_projects": {
1333
- "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.",
1334
- "enum": [
1335
- "read",
1336
- "write",
1337
- "admin"
1338
- ],
1339
- "type": "string"
1340
- },
1341
- "secret_scanning_alerts": {
1342
- "description": "The level of permission to grant the access token to view and manage secret scanning alerts.",
1343
- "enum": [
1344
- "read",
1345
- "write"
1346
- ],
1347
- "type": "string"
1348
- },
1349
- "secrets": {
1350
- "description": "The level of permission to grant the access token to manage repository secrets.",
1351
- "enum": [
1352
- "read",
1353
- "write"
1354
- ],
1355
- "type": "string"
1356
- },
1357
- "security_events": {
1358
- "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.",
1359
- "enum": [
1360
- "read",
1361
- "write"
1362
- ],
1363
- "type": "string"
1364
- },
1365
- "single_file": {
1366
- "description": "The level of permission to grant the access token to manage just a single file.",
1367
- "enum": [
1368
- "read",
1369
- "write"
1370
- ],
1371
- "type": "string"
1372
- },
1373
- "statuses": {
1374
- "description": "The level of permission to grant the access token for commit statuses.",
1375
- "enum": [
1376
- "read",
1377
- "write"
1378
- ],
1379
- "type": "string"
1380
- },
1381
- "team_discussions": {
1382
- "description": "The level of permission to grant the access token to manage team discussions and related comments.",
1383
- "enum": [
1384
- "read",
1385
- "write"
1386
- ],
1387
- "type": "string"
1388
- },
1389
- "vulnerability_alerts": {
1390
- "description": "The level of permission to grant the access token to manage Dependabot alerts.",
1391
- "enum": [
1392
- "read",
1393
- "write"
1394
- ],
1395
- "type": "string"
1396
- },
1397
- "workflows": {
1398
- "description": "The level of permission to grant the access token to update GitHub Actions workflow files.",
1399
- "enum": [
1400
- "write"
1401
- ],
1402
- "type": "string"
1403
- }
1404
- },
1405
- "title": "App Permissions",
1406
- "type": "object"
1407
- },
1408
- "repositories_url": {
1409
- "example": "https://api.github.com/users/octocat/repos",
1410
- "format": "uri",
1411
- "type": "string"
1412
- },
1413
- "repository_selection": {
1414
- "description": "Describe whether all repositories have been selected or there's a selection involved",
1415
- "enum": [
1416
- "all",
1417
- "selected"
1418
- ],
1419
- "type": "string"
1420
- },
1421
- "single_file_name": {
1422
- "example": "config.yaml",
1423
- "nullable": true,
1424
- "type": "string"
1425
- },
1426
- "single_file_paths": {
1427
- "example": [
1428
- "config.yml",
1429
- ".github/issue_TEMPLATE.md"
1430
- ],
1431
- "items": {
1432
- "type": "string"
1433
- },
1434
- "type": "array"
1435
- }
1436
- },
1437
- "required": [
1438
- "permissions",
1439
- "repository_selection",
1440
- "single_file_name",
1441
- "repositories_url",
1442
- "account"
1443
- ],
1444
- "title": "Scoped Installation",
1445
- "type": "object"
1446
- },
1447
- "note": {
1448
- "nullable": true,
1449
- "type": "string"
1450
- },
1451
- "note_url": {
1452
- "format": "uri",
1453
- "nullable": true,
1454
- "type": "string"
1455
- },
1456
- "scopes": {
1457
- "description": "A list of scopes that this authorization is in.",
1458
- "items": {
1459
- "type": "string"
1460
- },
1461
- "nullable": true,
1462
- "type": "array"
1463
- },
1464
- "token": {
1465
- "type": "string"
1466
- },
1467
- "token_last_eight": {
1468
- "nullable": true,
1469
- "type": "string"
1470
- },
1471
- "updated_at": {
1472
- "format": "date-time",
1473
- "type": "string"
1474
- },
1475
- "url": {
1476
- "format": "uri",
1477
- "type": "string"
1478
- },
1479
- "user": {
1480
- "description": "A GitHub user.",
1481
- "nullable": true,
1482
- "properties": {
1483
- "avatar_url": {
1484
- "example": "https://github.com/images/error/octocat_happy.gif",
1485
- "format": "uri",
1486
- "type": "string"
1487
- },
1488
- "email": {
1489
- "nullable": true,
1490
- "type": "string"
1491
- },
1492
- "events_url": {
1493
- "example": "https://api.github.com/users/octocat/events{/privacy}",
1494
- "type": "string"
1495
- },
1496
- "followers_url": {
1497
- "example": "https://api.github.com/users/octocat/followers",
1498
- "format": "uri",
1499
- "type": "string"
1500
- },
1501
- "following_url": {
1502
- "example": "https://api.github.com/users/octocat/following{/other_user}",
1503
- "type": "string"
1504
- },
1505
- "gists_url": {
1506
- "example": "https://api.github.com/users/octocat/gists{/gist_id}",
1507
- "type": "string"
1508
- },
1509
- "gravatar_id": {
1510
- "example": "41d064eb2195891e12d0413f63227ea7",
1511
- "nullable": true,
1512
- "type": "string"
1513
- },
1514
- "html_url": {
1515
- "example": "https://github.com/octocat",
1516
- "format": "uri",
1517
- "type": "string"
1518
- },
1519
- "id": {
1520
- "example": 1,
1521
- "type": "integer"
1522
- },
1523
- "login": {
1524
- "example": "octocat",
1525
- "type": "string"
1526
- },
1527
- "name": {
1528
- "nullable": true,
1529
- "type": "string"
1530
- },
1531
- "node_id": {
1532
- "example": "MDQ6VXNlcjE=",
1533
- "type": "string"
1534
- },
1535
- "organizations_url": {
1536
- "example": "https://api.github.com/users/octocat/orgs",
1537
- "format": "uri",
1538
- "type": "string"
1539
- },
1540
- "received_events_url": {
1541
- "example": "https://api.github.com/users/octocat/received_events",
1542
- "format": "uri",
1543
- "type": "string"
1544
- },
1545
- "repos_url": {
1546
- "example": "https://api.github.com/users/octocat/repos",
1547
- "format": "uri",
1548
- "type": "string"
1549
- },
1550
- "site_admin": {
1551
- "type": "boolean"
1552
- },
1553
- "starred_at": {
1554
- "example": "\"2020-07-09T00:17:55Z\"",
1555
- "type": "string"
1556
- },
1557
- "starred_url": {
1558
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
1559
- "type": "string"
1560
- },
1561
- "subscriptions_url": {
1562
- "example": "https://api.github.com/users/octocat/subscriptions",
1563
- "format": "uri",
1564
- "type": "string"
1565
- },
1566
- "type": {
1567
- "example": "User",
1568
- "type": "string"
1569
- },
1570
- "url": {
1571
- "example": "https://api.github.com/users/octocat",
1572
- "format": "uri",
1573
- "type": "string"
1574
- }
1575
- },
1576
- "required": [
1577
- "avatar_url",
1578
- "events_url",
1579
- "followers_url",
1580
- "following_url",
1581
- "gists_url",
1582
- "gravatar_id",
1583
- "html_url",
1584
- "id",
1585
- "node_id",
1586
- "login",
1587
- "organizations_url",
1588
- "received_events_url",
1589
- "repos_url",
1590
- "site_admin",
1591
- "starred_url",
1592
- "subscriptions_url",
1593
- "type",
1594
- "url"
1595
- ],
1596
- "title": "Simple User",
1597
- "type": "object"
1598
- }
1599
- },
1600
- "required": [
1601
- "app",
1602
- "id",
1603
- "note",
1604
- "note_url",
1605
- "scopes",
1606
- "token",
1607
- "hashed_token",
1608
- "token_last_eight",
1609
- "fingerprint",
1610
- "url",
1611
- "created_at",
1612
- "updated_at",
1613
- "expires_at"
1614
- ],
1615
- "title": "Authorization",
1616
- "type": "object"
1617
- }
1618
- }
1619
- },
1620
- "description": "Response"
1621
- }
1622
- },
1623
- "summary": "Reset an authorization",
1624
- "tags": [
1625
- "apps"
1626
- ],
1627
- "x-github": {
1628
- "category": "apps",
1629
- "deprecationDate": "2020-02-14",
1630
- "enabledForGitHubApps": false,
1631
- "githubCloudOnly": false,
1632
- "removalDate": "2021-05-05",
1633
- "subcategory": "oauth-applications"
1634
- }
1635
- }
1636
- },
1637
- "/content_references/{content_reference_id}/attachments": {
1638
- "post": {
1639
- "deprecated": null,
1640
- "description": "**Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
1641
- "externalDocs": {
1642
- "description": "API method documentation",
1643
- "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment"
1644
- },
1645
- "operationId": "apps/create-content-attachment",
1646
- "parameters": [
1647
- {
1648
- "in": "path",
1649
- "name": "content_reference_id",
1650
- "required": true,
1651
- "schema": {
1652
- "type": "integer"
1653
- },
1654
- "style": "simple"
1655
- }
1656
- ],
1657
- "requestBody": {
1658
- "content": {
1659
- "application/json": {
1660
- "schema": {
1661
- "properties": {
1662
- "body": {
1663
- "description": "The body of the attachment",
1664
- "example": "Body of the attachment",
1665
- "maxLength": 262144,
1666
- "type": "string"
1667
- },
1668
- "title": {
1669
- "description": "The title of the attachment",
1670
- "example": "Title of the attachment",
1671
- "maxLength": 1024,
1672
- "type": "string"
1673
- }
1674
- },
1675
- "required": [
1676
- "title",
1677
- "body"
1678
- ],
1679
- "type": "object"
1680
- }
1681
- }
1682
- },
1683
- "required": null
1684
- },
1685
- "responses": {
1686
- "200": {
1687
- "content": {
1688
- "application/json": {
1689
- "examples": {
1690
- "default": {
1691
- "value": {
1692
- "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()",
1693
- "id": 101,
1694
- "title": "[A-1234] Error found in core/models.py file'"
1695
- }
1696
- }
1697
- },
1698
- "schema": {
1699
- "description": "Content Reference attachments allow you to provide context around URLs posted in comments",
1700
- "properties": {
1701
- "body": {
1702
- "description": "The body of the attachment",
1703
- "example": "Body of the attachment",
1704
- "maxLength": 262144,
1705
- "type": "string"
1706
- },
1707
- "id": {
1708
- "description": "The ID of the attachment",
1709
- "example": 21,
1710
- "type": "integer"
1711
- },
1712
- "node_id": {
1713
- "description": "The node_id of the content attachment",
1714
- "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=",
1715
- "type": "string"
1716
- },
1717
- "title": {
1718
- "description": "The title of the attachment",
1719
- "example": "Title of the attachment",
1720
- "maxLength": 1024,
1721
- "type": "string"
1722
- }
1723
- },
1724
- "required": [
1725
- "id",
1726
- "title",
1727
- "body"
1728
- ],
1729
- "title": "ContentReferenceAttachment",
1730
- "type": "object"
1731
- }
1732
- }
1733
- },
1734
- "description": "Response"
1735
- },
1736
- "304": {
1737
- "description": "Not modified"
1738
- },
1739
- "403": {
1740
- "content": {
1741
- "application/json": {
1742
- "schema": {
1743
- "description": "Basic Error",
1744
- "properties": {
1745
- "documentation_url": {
1746
- "type": "string"
1747
- },
1748
- "message": {
1749
- "type": "string"
1750
- },
1751
- "status": {
1752
- "type": "string"
1753
- },
1754
- "url": {
1755
- "type": "string"
1756
- }
1757
- },
1758
- "title": "Basic Error",
1759
- "type": "object"
1760
- }
1761
- }
1762
- },
1763
- "description": "Forbidden"
1764
- },
1765
- "404": {
1766
- "content": {
1767
- "application/json": {
1768
- "schema": {
1769
- "description": "Basic Error",
1770
- "properties": {
1771
- "documentation_url": {
1772
- "type": "string"
1773
- },
1774
- "message": {
1775
- "type": "string"
1776
- },
1777
- "status": {
1778
- "type": "string"
1779
- },
1780
- "url": {
1781
- "type": "string"
1782
- }
1783
- },
1784
- "title": "Basic Error",
1785
- "type": "object"
1786
- }
1787
- }
1788
- },
1789
- "description": "Resource not found"
1790
- },
1791
- "410": {
1792
- "content": {
1793
- "application/json": {
1794
- "schema": {
1795
- "description": "Basic Error",
1796
- "properties": {
1797
- "documentation_url": {
1798
- "type": "string"
1799
- },
1800
- "message": {
1801
- "type": "string"
1802
- },
1803
- "status": {
1804
- "type": "string"
1805
- },
1806
- "url": {
1807
- "type": "string"
1808
- }
1809
- },
1810
- "title": "Basic Error",
1811
- "type": "object"
1812
- }
1813
- }
1814
- },
1815
- "description": "Gone"
1816
- },
1817
- "415": {
1818
- "content": {
1819
- "application/json": {
1820
- "schema": {
1821
- "properties": {
1822
- "documentation_url": {
1823
- "type": "string"
1824
- },
1825
- "message": {
1826
- "type": "string"
1827
- }
1828
- },
1829
- "required": [
1830
- "message",
1831
- "documentation_url"
1832
- ],
1833
- "type": "object"
1834
- }
1835
- }
1836
- },
1837
- "description": "Preview header missing"
1838
- },
1839
- "422": {
1840
- "content": {
1841
- "application/json": {
1842
- "schema": {
1843
- "description": "Validation Error",
1844
- "properties": {
1845
- "documentation_url": {
1846
- "type": "string"
1847
- },
1848
- "errors": {
1849
- "items": {
1850
- "properties": {
1851
- "code": {
1852
- "type": "string"
1853
- },
1854
- "field": {
1855
- "type": "string"
1856
- },
1857
- "index": {
1858
- "type": "integer"
1859
- },
1860
- "message": {
1861
- "type": "string"
1862
- },
1863
- "resource": {
1864
- "type": "string"
1865
- },
1866
- "value": {
1867
- "oneOf": [
1868
- {
1869
- "nullable": true,
1870
- "type": "string"
1871
- },
1872
- {
1873
- "nullable": true,
1874
- "type": "integer"
1875
- },
1876
- {
1877
- "items": {
1878
- "type": "string"
1879
- },
1880
- "nullable": true,
1881
- "type": "array"
1882
- }
1883
- ]
1884
- }
1885
- },
1886
- "required": [
1887
- "code"
1888
- ],
1889
- "type": "object"
1890
- },
1891
- "type": "array"
1892
- },
1893
- "message": {
1894
- "type": "string"
1895
- }
1896
- },
1897
- "required": [
1898
- "message",
1899
- "documentation_url"
1900
- ],
1901
- "title": "Validation Error",
1902
- "type": "object"
1903
- }
1904
- }
1905
- },
1906
- "description": "Validation failed"
1907
- }
1908
- },
1909
- "summary": "Create a content attachment",
1910
- "tags": [
1911
- "apps"
1912
- ],
1913
- "x-github": {
1914
- "category": "apps",
1915
- "enabledForGitHubApps": true,
1916
- "githubCloudOnly": false,
1917
- "previews": [
1918
- {
1919
- "name": "corsair",
1920
- "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```",
1921
- "required": true
1922
- }
1923
- ],
1924
- "subcategory": "installations"
1925
- }
1926
- }
1927
- },
1928
- "/repos/{owner}/{repo}/community/code_of_conduct": {
1929
- "get": {
1930
- "deprecated": true,
1931
- "description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
1932
- "externalDocs": {
1933
- "description": "API method documentation",
1934
- "url": "https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository"
1935
- },
1936
- "operationId": "codes-of-conduct/get-for-repo",
1937
- "parameters": [
1938
- {
1939
- "in": "path",
1940
- "name": "owner",
1941
- "required": true,
1942
- "schema": {
1943
- "type": "string"
1944
- },
1945
- "style": "simple"
1946
- },
1947
- {
1948
- "in": "path",
1949
- "name": "repo",
1950
- "required": true,
1951
- "schema": {
1952
- "type": "string"
1953
- },
1954
- "style": "simple"
1955
- }
1956
- ],
1957
- "responses": {
1958
- "200": {
1959
- "content": {
1960
- "application/json": {
1961
- "examples": {
1962
- "default": {
1963
- "value": {
1964
- "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\nto any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n",
1965
- "html_url": "https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md",
1966
- "key": "contributor_covenant",
1967
- "name": "Contributor Covenant",
1968
- "url": "https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md"
1969
- }
1970
- }
1971
- },
1972
- "schema": {
1973
- "description": "Code Of Conduct",
1974
- "properties": {
1975
- "body": {
1976
- "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n",
1977
- "type": "string"
1978
- },
1979
- "html_url": {
1980
- "format": "uri",
1981
- "nullable": true,
1982
- "type": "string"
1983
- },
1984
- "key": {
1985
- "example": "contributor_covenant",
1986
- "type": "string"
1987
- },
1988
- "name": {
1989
- "example": "Contributor Covenant",
1990
- "type": "string"
1991
- },
1992
- "url": {
1993
- "example": "https://api.github.com/codes_of_conduct/contributor_covenant",
1994
- "format": "uri",
1995
- "type": "string"
1996
- }
1997
- },
1998
- "required": [
1999
- "url",
2000
- "html_url",
2001
- "key",
2002
- "name"
2003
- ],
2004
- "title": "Code Of Conduct",
2005
- "type": "object"
2006
- }
2007
- }
2008
- },
2009
- "description": "Response"
2010
- }
2011
- },
2012
- "summary": "Get the code of conduct for a repository",
2013
- "tags": [
2014
- "codes-of-conduct"
2015
- ],
2016
- "x-github": {
2017
- "category": "codes-of-conduct",
2018
- "deprecationDate": "2021-09-29",
2019
- "enabledForGitHubApps": true,
2020
- "githubCloudOnly": false,
2021
- "previews": [
2022
- {
2023
- "name": "scarlet-witch",
2024
- "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```",
2025
- "required": true
2026
- }
2027
- ],
2028
- "removalDate": "2021-09-29",
2029
- "subcategory": null
2030
- }
2031
- }
2032
- },
2033
- "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": {
2034
- "post": {
2035
- "deprecated": null,
2036
- "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.3/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
2037
- "externalDocs": {
2038
- "description": "API method documentation",
2039
- "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#create-a-content-attachment"
2040
- },
2041
- "operationId": "apps/create-content-attachment-for-repo",
2042
- "parameters": [
2043
- {
2044
- "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.",
2045
- "in": "path",
2046
- "name": "owner",
2047
- "required": true,
2048
- "schema": {
2049
- "type": "string"
2050
- },
2051
- "style": "simple"
2052
- },
2053
- {
2054
- "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.",
2055
- "in": "path",
2056
- "name": "repo",
2057
- "required": true,
2058
- "schema": {
2059
- "type": "string"
2060
- },
2061
- "style": "simple"
2062
- },
2063
- {
2064
- "description": "The `id` of the `content_reference` event.",
2065
- "in": "path",
2066
- "name": "content_reference_id",
2067
- "required": true,
2068
- "schema": {
2069
- "type": "integer"
2070
- },
2071
- "style": "simple"
2072
- }
2073
- ],
2074
- "requestBody": {
2075
- "content": {
2076
- "application/json": {
2077
- "schema": {
2078
- "properties": {
2079
- "body": {
2080
- "description": "The body of the attachment",
2081
- "example": "Body of the attachment",
2082
- "maxLength": 262144,
2083
- "type": "string"
2084
- },
2085
- "title": {
2086
- "description": "The title of the attachment",
2087
- "example": "Title of the attachment",
2088
- "maxLength": 1024,
2089
- "type": "string"
2090
- }
2091
- },
2092
- "required": [
2093
- "title",
2094
- "body"
2095
- ],
2096
- "type": "object"
2097
- }
2098
- }
2099
- },
2100
- "required": true
2101
- },
2102
- "responses": {
2103
- "200": {
2104
- "content": {
2105
- "application/json": {
2106
- "examples": {
2107
- "default": {
2108
- "value": {
2109
- "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()",
2110
- "id": 101,
2111
- "title": "[A-1234] Error found in core/models.py file'"
2112
- }
2113
- }
2114
- },
2115
- "schema": {
2116
- "description": "Content Reference attachments allow you to provide context around URLs posted in comments",
2117
- "properties": {
2118
- "body": {
2119
- "description": "The body of the attachment",
2120
- "example": "Body of the attachment",
2121
- "maxLength": 262144,
2122
- "type": "string"
2123
- },
2124
- "id": {
2125
- "description": "The ID of the attachment",
2126
- "example": 21,
2127
- "type": "integer"
2128
- },
2129
- "node_id": {
2130
- "description": "The node_id of the content attachment",
2131
- "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=",
2132
- "type": "string"
2133
- },
2134
- "title": {
2135
- "description": "The title of the attachment",
2136
- "example": "Title of the attachment",
2137
- "maxLength": 1024,
2138
- "type": "string"
2139
- }
2140
- },
2141
- "required": [
2142
- "id",
2143
- "title",
2144
- "body"
2145
- ],
2146
- "title": "ContentReferenceAttachment",
2147
- "type": "object"
2148
- }
2149
- }
2150
- },
2151
- "description": "Response"
2152
- },
2153
- "304": {
2154
- "description": "Not modified"
2155
- },
2156
- "403": {
2157
- "content": {
2158
- "application/json": {
2159
- "schema": {
2160
- "description": "Basic Error",
2161
- "properties": {
2162
- "documentation_url": {
2163
- "type": "string"
2164
- },
2165
- "message": {
2166
- "type": "string"
2167
- },
2168
- "status": {
2169
- "type": "string"
2170
- },
2171
- "url": {
2172
- "type": "string"
2173
- }
2174
- },
2175
- "title": "Basic Error",
2176
- "type": "object"
2177
- }
2178
- }
2179
- },
2180
- "description": "Forbidden"
2181
- },
2182
- "404": {
2183
- "content": {
2184
- "application/json": {
2185
- "schema": {
2186
- "description": "Basic Error",
2187
- "properties": {
2188
- "documentation_url": {
2189
- "type": "string"
2190
- },
2191
- "message": {
2192
- "type": "string"
2193
- },
2194
- "status": {
2195
- "type": "string"
2196
- },
2197
- "url": {
2198
- "type": "string"
2199
- }
2200
- },
2201
- "title": "Basic Error",
2202
- "type": "object"
2203
- }
2204
- }
2205
- },
2206
- "description": "Resource not found"
2207
- },
2208
- "410": {
2209
- "content": {
2210
- "application/json": {
2211
- "schema": {
2212
- "description": "Basic Error",
2213
- "properties": {
2214
- "documentation_url": {
2215
- "type": "string"
2216
- },
2217
- "message": {
2218
- "type": "string"
2219
- },
2220
- "status": {
2221
- "type": "string"
2222
- },
2223
- "url": {
2224
- "type": "string"
2225
- }
2226
- },
2227
- "title": "Basic Error",
2228
- "type": "object"
2229
- }
2230
- }
2231
- },
2232
- "description": "Gone"
2233
- },
2234
- "415": {
2235
- "content": {
2236
- "application/json": {
2237
- "schema": {
2238
- "properties": {
2239
- "documentation_url": {
2240
- "type": "string"
2241
- },
2242
- "message": {
2243
- "type": "string"
2244
- }
2245
- },
2246
- "required": [
2247
- "message",
2248
- "documentation_url"
2249
- ],
2250
- "type": "object"
2251
- }
2252
- }
2253
- },
2254
- "description": "Preview header missing"
2255
- },
2256
- "422": {
2257
- "content": {
2258
- "application/json": {
2259
- "schema": {
2260
- "description": "Validation Error",
2261
- "properties": {
2262
- "documentation_url": {
2263
- "type": "string"
2264
- },
2265
- "errors": {
2266
- "items": {
2267
- "properties": {
2268
- "code": {
2269
- "type": "string"
2270
- },
2271
- "field": {
2272
- "type": "string"
2273
- },
2274
- "index": {
2275
- "type": "integer"
2276
- },
2277
- "message": {
2278
- "type": "string"
2279
- },
2280
- "resource": {
2281
- "type": "string"
2282
- },
2283
- "value": {
2284
- "oneOf": [
2285
- {
2286
- "nullable": true,
2287
- "type": "string"
2288
- },
2289
- {
2290
- "nullable": true,
2291
- "type": "integer"
2292
- },
2293
- {
2294
- "items": {
2295
- "type": "string"
2296
- },
2297
- "nullable": true,
2298
- "type": "array"
2299
- }
2300
- ]
2301
- }
2302
- },
2303
- "required": [
2304
- "code"
2305
- ],
2306
- "type": "object"
2307
- },
2308
- "type": "array"
2309
- },
2310
- "message": {
2311
- "type": "string"
2312
- }
2313
- },
2314
- "required": [
2315
- "message",
2316
- "documentation_url"
2317
- ],
2318
- "title": "Validation Error",
2319
- "type": "object"
2320
- }
2321
- }
2322
- },
2323
- "description": "Validation failed, or the endpoint has been spammed."
2324
- }
2325
- },
2326
- "summary": "Create a content attachment",
2327
- "tags": [
2328
- "apps"
2329
- ],
2330
- "x-github": {
2331
- "category": "apps",
2332
- "enabledForGitHubApps": true,
2333
- "githubCloudOnly": false,
2334
- "previews": [
2335
- {
2336
- "name": "corsair",
2337
- "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```"
2338
- }
2339
- ],
2340
- "subcategory": "installations"
2341
- }
2342
- }
2343
- }
2344
- },
2345
- "changed": {
2346
- "/admin/tokens": {
2347
- "get": {
2348
- "responses": {
2349
- "changed": {
2350
- "200": {
2351
- "content": {
2352
- "changed": {
2353
- "application/json": {
2354
- "schema_changed": {
2355
- "items_changed": {
2356
- "properties_changed": {
2357
- "changed": {
2358
- "installation": {
2359
- "properties_changed": {
2360
- "changed": {
2361
- "permissions": {
2362
- "properties_changed": {
2363
- "added": [
2364
- [
2365
- "content_references",
2366
- {
2367
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2368
- "enum": [
2369
- "read",
2370
- "write"
2371
- ],
2372
- "type": "string"
2373
- }
2374
- ]
2375
- ]
2376
- }
2377
- }
2378
- }
2379
- }
2380
- }
2381
- }
2382
- }
2383
- }
2384
- }
2385
- }
2386
- }
2387
- }
2388
- }
2389
- }
2390
- }
2391
- }
2392
- },
2393
- "/admin/users/{username}/authorizations": {
2394
- "post": {
2395
- "responses": {
2396
- "changed": {
2397
- "200": {
2398
- "content": {
2399
- "changed": {
2400
- "application/json": {
2401
- "schema_changed": {
2402
- "properties_changed": {
2403
- "changed": {
2404
- "installation": {
2405
- "properties_changed": {
2406
- "changed": {
2407
- "permissions": {
2408
- "properties_changed": {
2409
- "added": [
2410
- [
2411
- "content_references",
2412
- {
2413
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2414
- "enum": [
2415
- "read",
2416
- "write"
2417
- ],
2418
- "type": "string"
2419
- }
2420
- ]
2421
- ]
2422
- }
2423
- }
2424
- }
2425
- }
2426
- }
2427
- }
2428
- }
2429
- }
2430
- }
2431
- }
2432
- }
2433
- },
2434
- "201": {
2435
- "content": {
2436
- "changed": {
2437
- "application/json": {
2438
- "schema_changed": {
2439
- "properties_changed": {
2440
- "changed": {
2441
- "installation": {
2442
- "properties_changed": {
2443
- "changed": {
2444
- "permissions": {
2445
- "properties_changed": {
2446
- "added": [
2447
- [
2448
- "content_references",
2449
- {
2450
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2451
- "enum": [
2452
- "read",
2453
- "write"
2454
- ],
2455
- "type": "string"
2456
- }
2457
- ]
2458
- ]
2459
- }
2460
- }
2461
- }
2462
- }
2463
- }
2464
- }
2465
- }
2466
- }
2467
- }
2468
- }
2469
- }
2470
- }
2471
- }
2472
- }
2473
- }
2474
- },
2475
- "/app/installations": {
2476
- "get": {
2477
- "responses": {
2478
- "changed": {
2479
- "200": {
2480
- "content": {
2481
- "changed": {
2482
- "application/json": {
2483
- "schema_changed": {
2484
- "items_changed": {
2485
- "properties_changed": {
2486
- "changed": {
2487
- "permissions": {
2488
- "properties_changed": {
2489
- "added": [
2490
- [
2491
- "content_references",
2492
- {
2493
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2494
- "enum": [
2495
- "read",
2496
- "write"
2497
- ],
2498
- "type": "string"
2499
- }
2500
- ]
2501
- ]
2502
- }
2503
- }
2504
- }
2505
- }
2506
- }
2507
- }
2508
- }
2509
- }
2510
- }
2511
- }
2512
- }
2513
- }
2514
- }
2515
- },
2516
- "/app/installations/{installation_id}": {
2517
- "get": {
2518
- "responses": {
2519
- "changed": {
2520
- "200": {
2521
- "content": {
2522
- "changed": {
2523
- "application/json": {
2524
- "schema_changed": {
2525
- "properties_changed": {
2526
- "changed": {
2527
- "permissions": {
2528
- "properties_changed": {
2529
- "added": [
2530
- [
2531
- "content_references",
2532
- {
2533
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2534
- "enum": [
2535
- "read",
2536
- "write"
2537
- ],
2538
- "type": "string"
2539
- }
2540
- ]
2541
- ]
2542
- }
2543
- }
2544
- }
2545
- }
2546
- }
2547
- }
2548
- }
2549
- }
2550
- }
2551
- }
2552
- }
2553
- }
2554
- },
2555
- "/app/installations/{installation_id}/access_tokens": {
2556
- "post": {
2557
- "request_body": {
2558
- "content_changed": {
2559
- "changed": {
2560
- "application/json": {
2561
- "schema_changed": {
2562
- "properties_changed": {
2563
- "changed": {
2564
- "permissions": {
2565
- "properties_changed": {
2566
- "added": [
2567
- [
2568
- "content_references",
2569
- {
2570
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2571
- "enum": [
2572
- "read",
2573
- "write"
2574
- ],
2575
- "type": "string"
2576
- }
2577
- ]
2578
- ]
2579
- }
2580
- }
2581
- }
2582
- }
2583
- }
2584
- }
2585
- }
2586
- }
2587
- },
2588
- "responses": {
2589
- "changed": {
2590
- "201": {
2591
- "content": {
2592
- "changed": {
2593
- "application/json": {
2594
- "schema_changed": {
2595
- "properties_changed": {
2596
- "changed": {
2597
- "permissions": {
2598
- "properties_changed": {
2599
- "added": [
2600
- [
2601
- "content_references",
2602
- {
2603
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2604
- "enum": [
2605
- "read",
2606
- "write"
2607
- ],
2608
- "type": "string"
2609
- }
2610
- ]
2611
- ]
2612
- }
2613
- }
2614
- }
2615
- }
2616
- }
2617
- }
2618
- }
2619
- }
2620
- }
2621
- }
2622
- }
2623
- }
2624
- },
2625
- "/applications/{client_id}/token": {
2626
- "patch": {
2627
- "responses": {
2628
- "changed": {
2629
- "200": {
2630
- "content": {
2631
- "changed": {
2632
- "application/json": {
2633
- "schema_changed": {
2634
- "properties_changed": {
2635
- "changed": {
2636
- "installation": {
2637
- "properties_changed": {
2638
- "changed": {
2639
- "permissions": {
2640
- "properties_changed": {
2641
- "added": [
2642
- [
2643
- "content_references",
2644
- {
2645
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2646
- "enum": [
2647
- "read",
2648
- "write"
2649
- ],
2650
- "type": "string"
2651
- }
2652
- ]
2653
- ]
2654
- }
2655
- }
2656
- }
2657
- }
2658
- }
2659
- }
2660
- }
2661
- }
2662
- }
2663
- }
2664
- }
2665
- }
2666
- }
2667
- }
2668
- },
2669
- "post": {
2670
- "responses": {
2671
- "changed": {
2672
- "200": {
2673
- "content": {
2674
- "changed": {
2675
- "application/json": {
2676
- "schema_changed": {
2677
- "properties_changed": {
2678
- "changed": {
2679
- "installation": {
2680
- "properties_changed": {
2681
- "changed": {
2682
- "permissions": {
2683
- "properties_changed": {
2684
- "added": [
2685
- [
2686
- "content_references",
2687
- {
2688
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2689
- "enum": [
2690
- "read",
2691
- "write"
2692
- ],
2693
- "type": "string"
2694
- }
2695
- ]
2696
- ]
2697
- }
2698
- }
2699
- }
2700
- }
2701
- }
2702
- }
2703
- }
2704
- }
2705
- }
2706
- }
2707
- }
2708
- }
2709
- }
2710
- }
2711
- }
2712
- },
2713
- "/applications/{client_id}/token/scoped": {
2714
- "post": {
2715
- "request_body": {
2716
- "content_changed": {
2717
- "changed": {
2718
- "application/json": {
2719
- "schema_changed": {
2720
- "properties_changed": {
2721
- "changed": {
2722
- "permissions": {
2723
- "properties_changed": {
2724
- "added": [
2725
- [
2726
- "content_references",
2727
- {
2728
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2729
- "enum": [
2730
- "read",
2731
- "write"
2732
- ],
2733
- "type": "string"
2734
- }
2735
- ]
2736
- ]
2737
- }
2738
- }
2739
- }
2740
- }
2741
- }
2742
- }
2743
- }
2744
- }
2745
- },
2746
- "responses": {
2747
- "changed": {
2748
- "200": {
2749
- "content": {
2750
- "changed": {
2751
- "application/json": {
2752
- "schema_changed": {
2753
- "properties_changed": {
2754
- "changed": {
2755
- "installation": {
2756
- "properties_changed": {
2757
- "changed": {
2758
- "permissions": {
2759
- "properties_changed": {
2760
- "added": [
2761
- [
2762
- "content_references",
2763
- {
2764
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2765
- "enum": [
2766
- "read",
2767
- "write"
2768
- ],
2769
- "type": "string"
2770
- }
2771
- ]
2772
- ]
2773
- }
2774
- }
2775
- }
2776
- }
2777
- }
2778
- }
2779
- }
2780
- }
2781
- }
2782
- }
2783
- }
2784
- }
2785
- }
2786
- }
2787
- }
2788
- },
2789
- "/authorizations": {
2790
- "get": {
2791
- "responses": {
2792
- "changed": {
2793
- "200": {
2794
- "content": {
2795
- "changed": {
2796
- "application/json": {
2797
- "schema_changed": {
2798
- "items_changed": {
2799
- "properties_changed": {
2800
- "changed": {
2801
- "installation": {
2802
- "properties_changed": {
2803
- "changed": {
2804
- "permissions": {
2805
- "properties_changed": {
2806
- "added": [
2807
- [
2808
- "content_references",
2809
- {
2810
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2811
- "enum": [
2812
- "read",
2813
- "write"
2814
- ],
2815
- "type": "string"
2816
- }
2817
- ]
2818
- ]
2819
- }
2820
- }
2821
- }
2822
- }
2823
- }
2824
- }
2825
- }
2826
- }
2827
- }
2828
- }
2829
- }
2830
- }
2831
- }
2832
- }
2833
- }
2834
- },
2835
- "post": {
2836
- "responses": {
2837
- "changed": {
2838
- "201": {
2839
- "content": {
2840
- "changed": {
2841
- "application/json": {
2842
- "schema_changed": {
2843
- "properties_changed": {
2844
- "changed": {
2845
- "installation": {
2846
- "properties_changed": {
2847
- "changed": {
2848
- "permissions": {
2849
- "properties_changed": {
2850
- "added": [
2851
- [
2852
- "content_references",
2853
- {
2854
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2855
- "enum": [
2856
- "read",
2857
- "write"
2858
- ],
2859
- "type": "string"
2860
- }
2861
- ]
2862
- ]
2863
- }
2864
- }
2865
- }
2866
- }
2867
- }
2868
- }
2869
- }
2870
- }
2871
- }
2872
- }
2873
- }
2874
- }
2875
- }
2876
- }
2877
- }
2878
- },
2879
- "/authorizations/clients/{client_id}": {
2880
- "put": {
2881
- "responses": {
2882
- "changed": {
2883
- "200": {
2884
- "content": {
2885
- "changed": {
2886
- "application/json": {
2887
- "schema_changed": {
2888
- "properties_changed": {
2889
- "changed": {
2890
- "installation": {
2891
- "properties_changed": {
2892
- "changed": {
2893
- "permissions": {
2894
- "properties_changed": {
2895
- "added": [
2896
- [
2897
- "content_references",
2898
- {
2899
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2900
- "enum": [
2901
- "read",
2902
- "write"
2903
- ],
2904
- "type": "string"
2905
- }
2906
- ]
2907
- ]
2908
- }
2909
- }
2910
- }
2911
- }
2912
- }
2913
- }
2914
- }
2915
- }
2916
- }
2917
- }
2918
- }
2919
- },
2920
- "201": {
2921
- "content": {
2922
- "changed": {
2923
- "application/json": {
2924
- "schema_changed": {
2925
- "properties_changed": {
2926
- "changed": {
2927
- "installation": {
2928
- "properties_changed": {
2929
- "changed": {
2930
- "permissions": {
2931
- "properties_changed": {
2932
- "added": [
2933
- [
2934
- "content_references",
2935
- {
2936
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2937
- "enum": [
2938
- "read",
2939
- "write"
2940
- ],
2941
- "type": "string"
2942
- }
2943
- ]
2944
- ]
2945
- }
2946
- }
2947
- }
2948
- }
2949
- }
2950
- }
2951
- }
2952
- }
2953
- }
2954
- }
2955
- }
2956
- }
2957
- }
2958
- }
2959
- }
2960
- },
2961
- "/authorizations/clients/{client_id}/{fingerprint}": {
2962
- "put": {
2963
- "responses": {
2964
- "changed": {
2965
- "200": {
2966
- "content": {
2967
- "changed": {
2968
- "application/json": {
2969
- "schema_changed": {
2970
- "properties_changed": {
2971
- "changed": {
2972
- "installation": {
2973
- "properties_changed": {
2974
- "changed": {
2975
- "permissions": {
2976
- "properties_changed": {
2977
- "added": [
2978
- [
2979
- "content_references",
2980
- {
2981
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
2982
- "enum": [
2983
- "read",
2984
- "write"
2985
- ],
2986
- "type": "string"
2987
- }
2988
- ]
2989
- ]
2990
- }
2991
- }
2992
- }
2993
- }
2994
- }
2995
- }
2996
- }
2997
- }
2998
- }
2999
- }
3000
- }
3001
- },
3002
- "201": {
3003
- "content": {
3004
- "changed": {
3005
- "application/json": {
3006
- "schema_changed": {
3007
- "properties_changed": {
3008
- "changed": {
3009
- "installation": {
3010
- "properties_changed": {
3011
- "changed": {
3012
- "permissions": {
3013
- "properties_changed": {
3014
- "added": [
3015
- [
3016
- "content_references",
3017
- {
3018
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
3019
- "enum": [
3020
- "read",
3021
- "write"
3022
- ],
3023
- "type": "string"
3024
- }
3025
- ]
3026
- ]
3027
- }
3028
- }
3029
- }
3030
- }
3031
- }
3032
- }
3033
- }
3034
- }
3035
- }
3036
- }
3037
- }
3038
- }
3039
- }
3040
- }
3041
- }
3042
- },
3043
- "/authorizations/{authorization_id}": {
3044
- "get": {
3045
- "responses": {
3046
- "changed": {
3047
- "200": {
3048
- "content": {
3049
- "changed": {
3050
- "application/json": {
3051
- "schema_changed": {
3052
- "properties_changed": {
3053
- "changed": {
3054
- "installation": {
3055
- "properties_changed": {
3056
- "changed": {
3057
- "permissions": {
3058
- "properties_changed": {
3059
- "added": [
3060
- [
3061
- "content_references",
3062
- {
3063
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
3064
- "enum": [
3065
- "read",
3066
- "write"
3067
- ],
3068
- "type": "string"
3069
- }
3070
- ]
3071
- ]
3072
- }
3073
- }
3074
- }
3075
- }
3076
- }
3077
- }
3078
- }
3079
- }
3080
- }
3081
- }
3082
- }
3083
- }
3084
- }
3085
- }
3086
- },
3087
- "patch": {
3088
- "responses": {
3089
- "changed": {
3090
- "200": {
3091
- "content": {
3092
- "changed": {
3093
- "application/json": {
3094
- "schema_changed": {
3095
- "properties_changed": {
3096
- "changed": {
3097
- "installation": {
3098
- "properties_changed": {
3099
- "changed": {
3100
- "permissions": {
3101
- "properties_changed": {
3102
- "added": [
3103
- [
3104
- "content_references",
3105
- {
3106
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
3107
- "enum": [
3108
- "read",
3109
- "write"
3110
- ],
3111
- "type": "string"
3112
- }
3113
- ]
3114
- ]
3115
- }
3116
- }
3117
- }
3118
- }
3119
- }
3120
- }
3121
- }
3122
- }
3123
- }
3124
- }
3125
- }
3126
- }
3127
- }
3128
- }
3129
- }
3130
- },
3131
- "/enterprises/{enterprise}/audit-log": {
3132
- "get": {
3133
- "parameters": {
3134
- "removed": [
3135
- {
3136
- "description": "The event types to include:\n\n- `web` - returns web (non-Git) events.\n- `git` - returns Git events.\n- `all` - returns both web and Git events.\n\nThe default is `web`.",
3137
- "in": "query",
3138
- "name": "include",
3139
- "required": false,
3140
- "schema": {
3141
- "enum": [
3142
- "web",
3143
- "git",
3144
- "all"
3145
- ],
3146
- "type": "string"
3147
- },
3148
- "style": "form"
3149
- }
3150
- ]
3151
- }
3152
- }
3153
- },
3154
- "/orgs/{org}": {
3155
- "get": {
3156
- "responses": {
3157
- "changed": {
3158
- "200": {
3159
- "content": {
3160
- "changed": {
3161
- "application/json": {
3162
- "schema_changed": {
3163
- "properties_changed": {
3164
- "removed": [
3165
- "members_can_fork_private_repositories"
3166
- ]
3167
- }
3168
- }
3169
- }
3170
- }
3171
- }
3172
- }
3173
- }
3174
- }
3175
- },
3176
- "patch": {
3177
- "request_body": {
3178
- "content_changed": {
3179
- "changed": {
3180
- "application/json": {
3181
- "schema_changed": {
3182
- "properties_changed": {
3183
- "removed": [
3184
- "members_can_fork_private_repositories"
3185
- ]
3186
- }
3187
- }
3188
- }
3189
- }
3190
- }
3191
- },
3192
- "responses": {
3193
- "changed": {
3194
- "200": {
3195
- "content": {
3196
- "changed": {
3197
- "application/json": {
3198
- "schema_changed": {
3199
- "properties_changed": {
3200
- "removed": [
3201
- "members_can_fork_private_repositories"
3202
- ]
3203
- }
3204
- }
3205
- }
3206
- }
3207
- }
3208
- }
3209
- }
3210
- }
3211
- }
3212
- },
3213
- "/orgs/{org}/actions/secrets/{secret_name}": {
3214
- "put": {
3215
- "request_body": {
3216
- "content_changed": {
3217
- "changed": {
3218
- "application/json": {
3219
- "schema_changed": {
3220
- "properties_changed": {
3221
- "changed": {
3222
- "selected_repository_ids": {
3223
- "items_changed": {
3224
- "type_changed": {
3225
- "to": "integer"
3226
- }
3227
- }
3228
- }
3229
- }
3230
- }
3231
- }
3232
- }
3233
- }
3234
- }
3235
- }
3236
- }
3237
- },
3238
- "/orgs/{org}/audit-log": {
3239
- "get": {
3240
- "parameters": {
3241
- "removed": [
3242
- {
3243
- "description": "The event types to include:\n\n- `web` - returns web (non-Git) events.\n- `git` - returns Git events.\n- `all` - returns both web and Git events.\n\nThe default is `web`.",
3244
- "in": "query",
3245
- "name": "include",
3246
- "required": false,
3247
- "schema": {
3248
- "enum": [
3249
- "web",
3250
- "git",
3251
- "all"
3252
- ],
3253
- "type": "string"
3254
- },
3255
- "style": "form"
3256
- }
3257
- ]
3258
- }
3259
- }
3260
- },
3261
- "/orgs/{org}/installation": {
3262
- "get": {
3263
- "responses": {
3264
- "changed": {
3265
- "200": {
3266
- "content": {
3267
- "changed": {
3268
- "application/json": {
3269
- "schema_changed": {
3270
- "properties_changed": {
3271
- "changed": {
3272
- "permissions": {
3273
- "properties_changed": {
3274
- "added": [
3275
- [
3276
- "content_references",
3277
- {
3278
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
3279
- "enum": [
3280
- "read",
3281
- "write"
3282
- ],
3283
- "type": "string"
3284
- }
3285
- ]
3286
- ]
3287
- }
3288
- }
3289
- }
3290
- }
3291
- }
3292
- }
3293
- }
3294
- }
3295
- }
3296
- }
3297
- }
3298
- }
3299
- },
3300
- "/orgs/{org}/installations": {
3301
- "get": {
3302
- "responses": {
3303
- "changed": {
3304
- "200": {
3305
- "content": {
3306
- "changed": {
3307
- "application/json": {
3308
- "schema_changed": {
3309
- "properties_changed": {
3310
- "changed": {
3311
- "installations": {
3312
- "items_changed": {
3313
- "properties_changed": {
3314
- "changed": {
3315
- "permissions": {
3316
- "properties_changed": {
3317
- "added": [
3318
- [
3319
- "content_references",
3320
- {
3321
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
3322
- "enum": [
3323
- "read",
3324
- "write"
3325
- ],
3326
- "type": "string"
3327
- }
3328
- ]
3329
- ]
3330
- }
3331
- }
3332
- }
3333
- }
3334
- }
3335
- }
3336
- }
3337
- }
3338
- }
3339
- }
3340
- }
3341
- }
3342
- }
3343
- }
3344
- }
3345
- }
3346
- },
3347
- "/orgs/{org}/teams": {
3348
- "post": {
3349
- "responses": {
3350
- "changed": {
3351
- "201": {
3352
- "content": {
3353
- "changed": {
3354
- "application/json": {
3355
- "schema_changed": {
3356
- "properties_changed": {
3357
- "changed": {
3358
- "organization": {
3359
- "properties_changed": {
3360
- "removed": [
3361
- "members_can_fork_private_repositories"
3362
- ]
3363
- }
3364
- }
3365
- }
3366
- }
3367
- }
3368
- }
3369
- }
3370
- }
3371
- }
3372
- }
3373
- }
3374
- }
3375
- },
3376
- "/orgs/{org}/teams/{team_slug}": {
3377
- "get": {
3378
- "responses": {
3379
- "changed": {
3380
- "200": {
3381
- "content": {
3382
- "changed": {
3383
- "application/json": {
3384
- "schema_changed": {
3385
- "properties_changed": {
3386
- "changed": {
3387
- "organization": {
3388
- "properties_changed": {
3389
- "removed": [
3390
- "members_can_fork_private_repositories"
3391
- ]
3392
- }
3393
- }
3394
- }
3395
- }
3396
- }
3397
- }
3398
- }
3399
- }
3400
- }
3401
- }
3402
- }
3403
- },
3404
- "patch": {
3405
- "responses": {
3406
- "changed": {
3407
- "200": {
3408
- "content": {
3409
- "changed": {
3410
- "application/json": {
3411
- "schema_changed": {
3412
- "properties_changed": {
3413
- "changed": {
3414
- "organization": {
3415
- "properties_changed": {
3416
- "removed": [
3417
- "members_can_fork_private_repositories"
3418
- ]
3419
- }
3420
- }
3421
- }
3422
- }
3423
- }
3424
- }
3425
- }
3426
- }
3427
- },
3428
- "201": {
3429
- "content": {
3430
- "changed": {
3431
- "application/json": {
3432
- "schema_changed": {
3433
- "properties_changed": {
3434
- "changed": {
3435
- "organization": {
3436
- "properties_changed": {
3437
- "removed": [
3438
- "members_can_fork_private_repositories"
3439
- ]
3440
- }
3441
- }
3442
- }
3443
- }
3444
- }
3445
- }
3446
- }
3447
- }
3448
- }
3449
- }
3450
- }
3451
- }
3452
- },
3453
- "/repos/{owner}/{repo}/branches": {
3454
- "get": {
3455
- "responses": {
3456
- "changed": {
3457
- "200": {
3458
- "content": {
3459
- "changed": {
3460
- "application/json": {
3461
- "schema_changed": {
3462
- "items_changed": {
3463
- "properties_changed": {
3464
- "changed": {
3465
- "protection": {
3466
- "properties_changed": {
3467
- "changed": {
3468
- "required_pull_request_reviews": {
3469
- "properties_changed": {
3470
- "removed": [
3471
- "bypass_pull_request_allowances"
3472
- ]
3473
- }
3474
- },
3475
- "required_status_checks": {
3476
- "properties_changed": {
3477
- "removed": [
3478
- "checks"
3479
- ]
3480
- },
3481
- "required_changed": {
3482
- "removed": [
3483
- "checks"
3484
- ]
3485
- }
3486
- }
3487
- }
3488
- }
3489
- }
3490
- }
3491
- }
3492
- }
3493
- }
3494
- }
3495
- }
3496
- }
3497
- }
3498
- }
3499
- }
3500
- }
3501
- },
3502
- "/repos/{owner}/{repo}/branches/{branch}": {
3503
- "get": {
3504
- "responses": {
3505
- "changed": {
3506
- "200": {
3507
- "content": {
3508
- "changed": {
3509
- "application/json": {
3510
- "schema_changed": {
3511
- "properties_changed": {
3512
- "changed": {
3513
- "protection": {
3514
- "properties_changed": {
3515
- "changed": {
3516
- "required_pull_request_reviews": {
3517
- "properties_changed": {
3518
- "removed": [
3519
- "bypass_pull_request_allowances"
3520
- ]
3521
- }
3522
- },
3523
- "required_status_checks": {
3524
- "properties_changed": {
3525
- "removed": [
3526
- "checks"
3527
- ]
3528
- },
3529
- "required_changed": {
3530
- "removed": [
3531
- "checks"
3532
- ]
3533
- }
3534
- }
3535
- }
3536
- }
3537
- }
3538
- }
3539
- }
3540
- }
3541
- }
3542
- }
3543
- }
3544
- }
3545
- }
3546
- }
3547
- }
3548
- },
3549
- "/repos/{owner}/{repo}/branches/{branch}/protection": {
3550
- "get": {
3551
- "responses": {
3552
- "changed": {
3553
- "200": {
3554
- "content": {
3555
- "changed": {
3556
- "application/json": {
3557
- "schema_changed": {
3558
- "properties_changed": {
3559
- "changed": {
3560
- "required_pull_request_reviews": {
3561
- "properties_changed": {
3562
- "removed": [
3563
- "bypass_pull_request_allowances"
3564
- ]
3565
- }
3566
- },
3567
- "required_status_checks": {
3568
- "properties_changed": {
3569
- "removed": [
3570
- "checks"
3571
- ]
3572
- },
3573
- "required_changed": {
3574
- "removed": [
3575
- "checks"
3576
- ]
3577
- }
3578
- }
3579
- }
3580
- }
3581
- }
3582
- }
3583
- }
3584
- }
3585
- }
3586
- }
3587
- }
3588
- },
3589
- "put": {
3590
- "request_body": {
3591
- "content_changed": {
3592
- "changed": {
3593
- "application/json": {
3594
- "schema_changed": {
3595
- "properties_changed": {
3596
- "added": [
3597
- [
3598
- "contexts",
3599
- {
3600
- "description": "The list of status checks to require in order to merge into this branch.",
3601
- "items": {
3602
- "type": "string"
3603
- },
3604
- "type": "array"
3605
- }
3606
- ]
3607
- ],
3608
- "changed": {
3609
- "required_pull_request_reviews": {
3610
- "properties_changed": {
3611
- "removed": [
3612
- "bypass_pull_request_allowances"
3613
- ]
3614
- }
3615
- }
3616
- }
3617
- }
3618
- }
3619
- }
3620
- }
3621
- }
3622
- },
3623
- "responses": {
3624
- "changed": {
3625
- "200": {
3626
- "content": {
3627
- "changed": {
3628
- "application/json": {
3629
- "schema_changed": {
3630
- "properties_changed": {
3631
- "changed": {
3632
- "required_pull_request_reviews": {
3633
- "properties_changed": {
3634
- "removed": [
3635
- "bypass_pull_request_allowances"
3636
- ]
3637
- }
3638
- },
3639
- "required_status_checks": {
3640
- "properties_changed": {
3641
- "removed": [
3642
- "checks"
3643
- ]
3644
- },
3645
- "required_changed": {
3646
- "removed": [
3647
- "checks"
3648
- ]
3649
- }
3650
- }
3651
- }
3652
- }
3653
- }
3654
- }
3655
- }
3656
- }
3657
- }
3658
- }
3659
- }
3660
- }
3661
- },
3662
- "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": {
3663
- "get": {
3664
- "responses": {
3665
- "changed": {
3666
- "200": {
3667
- "content": {
3668
- "changed": {
3669
- "application/json": {
3670
- "schema_changed": {
3671
- "properties_changed": {
3672
- "removed": [
3673
- "bypass_pull_request_allowances"
3674
- ]
3675
- }
3676
- }
3677
- }
3678
- }
3679
- }
3680
- }
3681
- }
3682
- }
3683
- },
3684
- "patch": {
3685
- "request_body": {
3686
- "content_changed": {
3687
- "changed": {
3688
- "application/json": {
3689
- "schema_changed": {
3690
- "properties_changed": {
3691
- "removed": [
3692
- "bypass_pull_request_allowances"
3693
- ]
3694
- }
3695
- }
3696
- }
3697
- }
3698
- }
3699
- },
3700
- "responses": {
3701
- "changed": {
3702
- "200": {
3703
- "content": {
3704
- "changed": {
3705
- "application/json": {
3706
- "schema_changed": {
3707
- "properties_changed": {
3708
- "removed": [
3709
- "bypass_pull_request_allowances"
3710
- ]
3711
- }
3712
- }
3713
- }
3714
- }
3715
- }
3716
- }
3717
- }
3718
- }
3719
- }
3720
- },
3721
- "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": {
3722
- "get": {
3723
- "responses": {
3724
- "changed": {
3725
- "200": {
3726
- "content": {
3727
- "changed": {
3728
- "application/json": {
3729
- "schema_changed": {
3730
- "properties_changed": {
3731
- "removed": [
3732
- "checks"
3733
- ]
3734
- },
3735
- "required_changed": {
3736
- "removed": [
3737
- "checks"
3738
- ]
3739
- }
3740
- }
3741
- }
3742
- }
3743
- }
3744
- }
3745
- }
3746
- }
3747
- },
3748
- "patch": {
3749
- "request_body": {
3750
- "content_changed": {
3751
- "changed": {
3752
- "application/json": {
3753
- "schema_changed": {
3754
- "properties_changed": {
3755
- "removed": [
3756
- "checks"
3757
- ]
3758
- }
3759
- }
3760
- }
3761
- }
3762
- }
3763
- },
3764
- "responses": {
3765
- "changed": {
3766
- "200": {
3767
- "content": {
3768
- "changed": {
3769
- "application/json": {
3770
- "schema_changed": {
3771
- "properties_changed": {
3772
- "removed": [
3773
- "checks"
3774
- ]
3775
- },
3776
- "required_changed": {
3777
- "removed": [
3778
- "checks"
3779
- ]
3780
- }
3781
- }
3782
- }
3783
- }
3784
- }
3785
- }
3786
- }
3787
- }
3788
- }
3789
- },
3790
- "/repos/{owner}/{repo}/branches/{branch}/rename": {
3791
- "post": {
3792
- "responses": {
3793
- "changed": {
3794
- "201": {
3795
- "content": {
3796
- "changed": {
3797
- "application/json": {
3798
- "schema_changed": {
3799
- "properties_changed": {
3800
- "changed": {
3801
- "protection": {
3802
- "properties_changed": {
3803
- "changed": {
3804
- "required_pull_request_reviews": {
3805
- "properties_changed": {
3806
- "removed": [
3807
- "bypass_pull_request_allowances"
3808
- ]
3809
- }
3810
- },
3811
- "required_status_checks": {
3812
- "properties_changed": {
3813
- "removed": [
3814
- "checks"
3815
- ]
3816
- },
3817
- "required_changed": {
3818
- "removed": [
3819
- "checks"
3820
- ]
3821
- }
3822
- }
3823
- }
3824
- }
3825
- }
3826
- }
3827
- }
3828
- }
3829
- }
3830
- }
3831
- }
3832
- }
3833
- }
3834
- }
3835
- }
3836
- },
3837
- "/repos/{owner}/{repo}/code-scanning/alerts": {
3838
- "get": {
3839
- "parameters": {
3840
- "removed": [
3841
- {
3842
- "description": "The direction to sort the results by.",
3843
- "in": "query",
3844
- "name": "direction",
3845
- "required": false,
3846
- "schema": {
3847
- "default": "desc",
3848
- "enum": [
3849
- "asc",
3850
- "desc"
3851
- ],
3852
- "type": "string"
3853
- },
3854
- "style": "form"
3855
- },
3856
- {
3857
- "description": "The property by which to sort the results. `number` is deprecated - we recommend that you use `created` instead.",
3858
- "in": "query",
3859
- "name": "sort",
3860
- "required": false,
3861
- "schema": {
3862
- "default": "created",
3863
- "enum": [
3864
- "created",
3865
- "number",
3866
- "updated"
3867
- ],
3868
- "type": "string"
3869
- },
3870
- "style": "form"
3871
- }
3872
- ]
3873
- },
3874
- "responses": {
3875
- "changed": {
3876
- "200": {
3877
- "content": {
3878
- "changed": {
3879
- "application/json": {
3880
- "schema_changed": {
3881
- "items_changed": {
3882
- "properties_changed": {
3883
- "changed": {
3884
- "rule": {
3885
- "properties_changed": {
3886
- "removed": [
3887
- "tags"
3888
- ]
3889
- }
3890
- }
3891
- },
3892
- "removed": [
3893
- "dismissed_comment",
3894
- "fixed_at",
3895
- "updated_at"
3896
- ]
3897
- }
3898
- }
3899
- }
3900
- }
3901
- }
3902
- }
3903
- }
3904
- },
3905
- "removed": [
3906
- "304"
3907
- ]
3908
- }
3909
- }
3910
- },
3911
- "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": {
3912
- "get": {
3913
- "responses": {
3914
- "changed": {
3915
- "200": {
3916
- "content": {
3917
- "changed": {
3918
- "application/json": {
3919
- "schema_changed": {
3920
- "properties_changed": {
3921
- "removed": [
3922
- "fixed_at",
3923
- "updated_at"
3924
- ]
3925
- }
3926
- }
3927
- }
3928
- }
3929
- }
3930
- }
3931
- },
3932
- "removed": [
3933
- "304"
3934
- ]
3935
- }
3936
- },
3937
- "patch": {
3938
- "responses": {
3939
- "changed": {
3940
- "200": {
3941
- "content": {
3942
- "changed": {
3943
- "application/json": {
3944
- "schema_changed": {
3945
- "properties_changed": {
3946
- "removed": [
3947
- "fixed_at",
3948
- "updated_at"
3949
- ]
3950
- }
3951
- }
3952
- }
3953
- }
3954
- }
3955
- }
3956
- }
3957
- }
3958
- }
3959
- },
3960
- "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": {
3961
- "get": {
3962
- "responses": {
3963
- "changed": {
3964
- "200": {
3965
- "content": {
3966
- "changed": {
3967
- "application/json": {
3968
- "schema_changed": {
3969
- "properties_changed": {
3970
- "changed": {
3971
- "processing_status": {
3972
- "enum_changed": {
3973
- "added": false,
3974
- "removed": false,
3975
- "values_removed": [
3976
- "failed"
3977
- ]
3978
- }
3979
- }
3980
- },
3981
- "removed": [
3982
- "errors"
3983
- ]
3984
- }
3985
- }
3986
- }
3987
- }
3988
- }
3989
- }
3990
- }
3991
- }
3992
- }
3993
- },
3994
- "/repos/{owner}/{repo}/installation": {
3995
- "get": {
3996
- "responses": {
3997
- "changed": {
3998
- "200": {
3999
- "content": {
4000
- "changed": {
4001
- "application/json": {
4002
- "schema_changed": {
4003
- "properties_changed": {
4004
- "changed": {
4005
- "permissions": {
4006
- "properties_changed": {
4007
- "added": [
4008
- [
4009
- "content_references",
4010
- {
4011
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
4012
- "enum": [
4013
- "read",
4014
- "write"
4015
- ],
4016
- "type": "string"
4017
- }
4018
- ]
4019
- ]
4020
- }
4021
- }
4022
- }
4023
- }
4024
- }
4025
- }
4026
- }
4027
- }
4028
- }
4029
- }
4030
- }
4031
- }
4032
- },
4033
- "/teams/{team_id}": {
4034
- "get": {
4035
- "responses": {
4036
- "changed": {
4037
- "200": {
4038
- "content": {
4039
- "changed": {
4040
- "application/json": {
4041
- "schema_changed": {
4042
- "properties_changed": {
4043
- "changed": {
4044
- "organization": {
4045
- "properties_changed": {
4046
- "removed": [
4047
- "members_can_fork_private_repositories"
4048
- ]
4049
- }
4050
- }
4051
- }
4052
- }
4053
- }
4054
- }
4055
- }
4056
- }
4057
- }
4058
- }
4059
- }
4060
- },
4061
- "patch": {
4062
- "responses": {
4063
- "changed": {
4064
- "200": {
4065
- "content": {
4066
- "changed": {
4067
- "application/json": {
4068
- "schema_changed": {
4069
- "properties_changed": {
4070
- "changed": {
4071
- "organization": {
4072
- "properties_changed": {
4073
- "removed": [
4074
- "members_can_fork_private_repositories"
4075
- ]
4076
- }
4077
- }
4078
- }
4079
- }
4080
- }
4081
- }
4082
- }
4083
- }
4084
- },
4085
- "201": {
4086
- "content": {
4087
- "changed": {
4088
- "application/json": {
4089
- "schema_changed": {
4090
- "properties_changed": {
4091
- "changed": {
4092
- "organization": {
4093
- "properties_changed": {
4094
- "removed": [
4095
- "members_can_fork_private_repositories"
4096
- ]
4097
- }
4098
- }
4099
- }
4100
- }
4101
- }
4102
- }
4103
- }
4104
- }
4105
- }
4106
- }
4107
- }
4108
- }
4109
- },
4110
- "/user/installations": {
4111
- "get": {
4112
- "responses": {
4113
- "changed": {
4114
- "200": {
4115
- "content": {
4116
- "changed": {
4117
- "application/json": {
4118
- "schema_changed": {
4119
- "properties_changed": {
4120
- "changed": {
4121
- "installations": {
4122
- "items_changed": {
4123
- "properties_changed": {
4124
- "changed": {
4125
- "permissions": {
4126
- "properties_changed": {
4127
- "added": [
4128
- [
4129
- "content_references",
4130
- {
4131
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
4132
- "enum": [
4133
- "read",
4134
- "write"
4135
- ],
4136
- "type": "string"
4137
- }
4138
- ]
4139
- ]
4140
- }
4141
- }
4142
- }
4143
- }
4144
- }
4145
- }
4146
- }
4147
- }
4148
- }
4149
- }
4150
- }
4151
- }
4152
- }
4153
- }
4154
- }
4155
- }
4156
- },
4157
- "/user/teams": {
4158
- "get": {
4159
- "responses": {
4160
- "changed": {
4161
- "200": {
4162
- "content": {
4163
- "changed": {
4164
- "application/json": {
4165
- "schema_changed": {
4166
- "items_changed": {
4167
- "properties_changed": {
4168
- "changed": {
4169
- "organization": {
4170
- "properties_changed": {
4171
- "removed": [
4172
- "members_can_fork_private_repositories"
4173
- ]
4174
- }
4175
- }
4176
- }
4177
- }
4178
- }
4179
- }
4180
- }
4181
- }
4182
- }
4183
- }
4184
- }
4185
- }
4186
- }
4187
- },
4188
- "/users/{username}/installation": {
4189
- "get": {
4190
- "responses": {
4191
- "changed": {
4192
- "200": {
4193
- "content": {
4194
- "changed": {
4195
- "application/json": {
4196
- "schema_changed": {
4197
- "properties_changed": {
4198
- "changed": {
4199
- "permissions": {
4200
- "properties_changed": {
4201
- "added": [
4202
- [
4203
- "content_references",
4204
- {
4205
- "description": "The level of permission to grant the access token for notification of content references and creation content attachments.",
4206
- "enum": [
4207
- "read",
4208
- "write"
4209
- ],
4210
- "type": "string"
4211
- }
4212
- ]
4213
- ]
4214
- }
4215
- }
4216
- }
4217
- }
4218
- }
4219
- }
4220
- }
4221
- }
4222
- }
4223
- }
4224
- }
4225
- }
4226
- }
4227
- },
4228
- "removed": {
4229
- "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": [
4230
- "get",
4231
- "put",
4232
- "post",
4233
- "delete"
4234
- ],
4235
- "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": [
4236
- "delete"
4237
- ],
4238
- "/enterprises/{enterprise}/secret-scanning/alerts": [
4239
- "get"
4240
- ],
4241
- "/enterprises/{enterprise}/settings/billing/advanced-security": [
4242
- "get"
4243
- ],
4244
- "/organizations/{organization_id}/custom_roles": [
4245
- "get"
4246
- ],
4247
- "/orgs/{org}/actions/runners/{runner_id}/labels": [
4248
- "get",
4249
- "put",
4250
- "post",
4251
- "delete"
4252
- ],
4253
- "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": [
4254
- "delete"
4255
- ],
4256
- "/orgs/{org}/dependabot/secrets": [
4257
- "get"
4258
- ],
4259
- "/orgs/{org}/dependabot/secrets/public-key": [
4260
- "get"
4261
- ],
4262
- "/orgs/{org}/dependabot/secrets/{secret_name}": [
4263
- "get",
4264
- "put",
4265
- "delete"
4266
- ],
4267
- "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": [
4268
- "get",
4269
- "put"
4270
- ],
4271
- "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": [
4272
- "put",
4273
- "delete"
4274
- ],
4275
- "/orgs/{org}/migrations": [
4276
- "get",
4277
- "post"
4278
- ],
4279
- "/orgs/{org}/migrations/{migration_id}": [
4280
- "get"
4281
- ],
4282
- "/orgs/{org}/settings/billing/advanced-security": [
4283
- "get"
4284
- ],
4285
- "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": [
4286
- "get",
4287
- "put",
4288
- "post",
4289
- "delete"
4290
- ],
4291
- "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": [
4292
- "delete"
4293
- ],
4294
- "/repos/{owner}/{repo}/dependabot/secrets": [
4295
- "get"
4296
- ],
4297
- "/repos/{owner}/{repo}/dependabot/secrets/public-key": [
4298
- "get"
4299
- ],
4300
- "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": [
4301
- "get",
4302
- "put",
4303
- "delete"
4304
- ],
4305
- "/repos/{owner}/{repo}/replicas/caches": [
4306
- "get"
4307
- ],
4308
- "/user/migrations": [
4309
- "get",
4310
- "post"
4311
- ],
4312
- "/user/migrations/{migration_id}/archive": [
4313
- "get"
4314
- ],
4315
- "/user/migrations/{migration_id}/repositories": [
4316
- "get"
4317
- ]
4318
- }
4319
- }
4320
- }