@octokit/openapi 7.6.0 → 7.7.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 +1577 -517
  2. package/generated/api.github.com.json +491 -1
  3. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
  5. package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +1 -1
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +1 -1
  7. package/generated/ghes-3.2.deref.json +1 -1
  8. package/generated/ghes-3.2.json +1 -1
  9. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
  11. package/generated/ghes-3.3.deref.json +1 -1
  12. package/generated/ghes-3.3.json +1 -1
  13. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -1
  15. package/generated/ghes-3.4.deref.json +1 -1
  16. package/generated/ghes-3.4.json +1 -1
  17. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  18. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  19. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +1 -1
  20. package/generated/ghes-3.5-diff-to-ghes-3.6.json +1 -1
  21. package/generated/ghes-3.5.deref.json +1 -1
  22. package/generated/ghes-3.5.json +1 -1
  23. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +71 -1
  24. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +391 -1
  25. package/generated/ghes-3.6-diff-to-api.github.com.json +107 -1
  26. package/generated/ghes-3.6.deref.json +136 -2
  27. package/generated/ghes-3.6.json +136 -2
  28. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +14 -0
  29. package/generated/github.ae-diff-to-api.github.com.deref.json +1 -1
  30. package/generated/github.ae-diff-to-api.github.com.json +1 -1
  31. package/generated/github.ae.deref.json +213 -1
  32. package/generated/github.ae.json +183 -1
  33. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.6.0",
4
+ "version": "7.7.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -4707,6 +4707,56 @@
4707
4707
  }
4708
4708
  },
4709
4709
  "/orgs/{org}": {
4710
+ "get": {
4711
+ "summary": "Get an organization",
4712
+ "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"",
4713
+ "tags": [
4714
+ "orgs"
4715
+ ],
4716
+ "operationId": "orgs/get",
4717
+ "externalDocs": {
4718
+ "description": "API method documentation",
4719
+ "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#get-an-organization"
4720
+ },
4721
+ "parameters": [
4722
+ {
4723
+ "$ref": "#/components/parameters/org"
4724
+ }
4725
+ ],
4726
+ "responses": {
4727
+ "200": {
4728
+ "description": "Response",
4729
+ "content": {
4730
+ "application/json": {
4731
+ "schema": {
4732
+ "$ref": "#/components/schemas/organization-full"
4733
+ },
4734
+ "examples": {
4735
+ "default-response": {
4736
+ "$ref": "#/components/examples/organization-full-default-response"
4737
+ }
4738
+ }
4739
+ }
4740
+ }
4741
+ },
4742
+ "404": {
4743
+ "$ref": "#/components/responses/not_found"
4744
+ }
4745
+ },
4746
+ "x-github": {
4747
+ "githubCloudOnly": false,
4748
+ "enabledForGitHubApps": true,
4749
+ "category": "orgs",
4750
+ "subcategory": null
4751
+ },
4752
+ "x-octokit": {
4753
+ "diff": {
4754
+ "api.github.com": {
4755
+ "type": "changed"
4756
+ }
4757
+ }
4758
+ }
4759
+ },
4710
4760
  "patch": {
4711
4761
  "summary": "Update an organization",
4712
4762
  "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.",
@@ -18043,6 +18093,62 @@
18043
18093
  "installed_version": "3.6.0"
18044
18094
  }
18045
18095
  },
18096
+ "organization-full-default-response": {
18097
+ "summary": "Default response",
18098
+ "value": {
18099
+ "login": "github",
18100
+ "id": 1,
18101
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
18102
+ "url": "https://api.github.com/orgs/github",
18103
+ "repos_url": "https://api.github.com/orgs/github/repos",
18104
+ "events_url": "https://api.github.com/orgs/github/events",
18105
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
18106
+ "issues_url": "https://api.github.com/orgs/github/issues",
18107
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
18108
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
18109
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
18110
+ "description": "A great organization",
18111
+ "name": "github",
18112
+ "company": "GitHub",
18113
+ "blog": "https://github.com/blog",
18114
+ "location": "San Francisco",
18115
+ "email": "octocat@github.com",
18116
+ "twitter_username": "github",
18117
+ "is_verified": true,
18118
+ "has_organization_projects": true,
18119
+ "has_repository_projects": true,
18120
+ "public_repos": 2,
18121
+ "public_gists": 1,
18122
+ "followers": 20,
18123
+ "following": 0,
18124
+ "html_url": "https://github.com/octocat",
18125
+ "created_at": "2008-01-14T04:33:35Z",
18126
+ "updated_at": "2014-03-03T18:58:10Z",
18127
+ "type": "Organization",
18128
+ "total_private_repos": 100,
18129
+ "owned_private_repos": 100,
18130
+ "private_gists": 81,
18131
+ "disk_usage": 10000,
18132
+ "collaborators": 8,
18133
+ "billing_email": "mona@github.com",
18134
+ "plan": {
18135
+ "name": "Medium",
18136
+ "space": 400,
18137
+ "private_repos": 20,
18138
+ "filled_seats": 4,
18139
+ "seats": 5
18140
+ },
18141
+ "default_repository_permission": "read",
18142
+ "members_can_create_repositories": true,
18143
+ "two_factor_requirement_enabled": true,
18144
+ "members_allowed_repository_creation_type": "all",
18145
+ "members_can_create_public_repositories": false,
18146
+ "members_can_create_private_repositories": false,
18147
+ "members_can_create_internal_repositories": false,
18148
+ "members_can_create_pages": true,
18149
+ "members_can_fork_private_repositories": false
18150
+ }
18151
+ },
18046
18152
  "organization-full": {
18047
18153
  "value": {
18048
18154
  "login": "github",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.6.0",
4
+ "version": "7.7.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -61954,7 +61954,13 @@
61954
61954
  "category": "orgs",
61955
61955
  "subcategory": null
61956
61956
  },
61957
- "x-octokit": {}
61957
+ "x-octokit": {
61958
+ "diff": {
61959
+ "api.github.com": {
61960
+ "type": "changed"
61961
+ }
61962
+ }
61963
+ }
61958
61964
  },
61959
61965
  "patch": {
61960
61966
  "summary": "Update an organization",
@@ -448019,6 +448025,28 @@
448019
448025
  }
448020
448026
  }
448021
448027
  },
448028
+ "/orgs/{org}/{security_product}/{enablement}": {
448029
+ "post": {
448030
+ "summary": "Enable or disable a security feature for an organization",
448031
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
448032
+ "tags": [
448033
+ "orgs"
448034
+ ],
448035
+ "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
448036
+ "externalDocs": {
448037
+ "description": "API method documentation",
448038
+ "url": "https://docs.github.com/rest/reference/orgs#enable-or-disable-security-product-on-all-org-repos"
448039
+ },
448040
+ "x-octokit": {
448041
+ "api.github.com": "removed"
448042
+ },
448043
+ "responses": {
448044
+ "501": {
448045
+ "description": "Not Implemented"
448046
+ }
448047
+ }
448048
+ }
448049
+ },
448022
448050
  "/repos/{owner}/{repo}/actions/caches": {
448023
448051
  "get": {
448024
448052
  "summary": "List GitHub Actions caches for a repository",
@@ -450202,6 +450230,90 @@
450202
450230
  }
450203
450231
  }
450204
450232
  },
450233
+ "/user/ssh_signing_keys": {
450234
+ "get": {
450235
+ "summary": "List SSH signing keys for the authenticated user",
450236
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
450237
+ "tags": [
450238
+ "users"
450239
+ ],
450240
+ "operationId": "users/list-ssh-signing-keys-for-authenticated-user",
450241
+ "externalDocs": {
450242
+ "description": "API method documentation",
450243
+ "url": "https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user"
450244
+ },
450245
+ "x-octokit": {
450246
+ "api.github.com": "removed"
450247
+ },
450248
+ "responses": {
450249
+ "501": {
450250
+ "description": "Not Implemented"
450251
+ }
450252
+ }
450253
+ },
450254
+ "post": {
450255
+ "summary": "Create a SSH signing key for the authenticated user",
450256
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
450257
+ "operationId": "users/create-ssh-signing-key-for-authenticated-user",
450258
+ "tags": [
450259
+ "users"
450260
+ ],
450261
+ "externalDocs": {
450262
+ "description": "API method documentation",
450263
+ "url": "https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user"
450264
+ },
450265
+ "x-octokit": {
450266
+ "api.github.com": "removed"
450267
+ },
450268
+ "responses": {
450269
+ "501": {
450270
+ "description": "Not Implemented"
450271
+ }
450272
+ }
450273
+ }
450274
+ },
450275
+ "/user/ssh_signing_keys/{ssh_signing_key_id}": {
450276
+ "get": {
450277
+ "summary": "Get an SSH signing key for the authenticated user",
450278
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
450279
+ "tags": [
450280
+ "users"
450281
+ ],
450282
+ "operationId": "users/get-ssh-signing-key-for-authenticated-user",
450283
+ "externalDocs": {
450284
+ "description": "API method documentation",
450285
+ "url": "https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user"
450286
+ },
450287
+ "x-octokit": {
450288
+ "api.github.com": "removed"
450289
+ },
450290
+ "responses": {
450291
+ "501": {
450292
+ "description": "Not Implemented"
450293
+ }
450294
+ }
450295
+ },
450296
+ "delete": {
450297
+ "summary": "Delete an SSH signing key for the authenticated user",
450298
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
450299
+ "tags": [
450300
+ "users"
450301
+ ],
450302
+ "operationId": "users/delete-ssh-signing-key-for-authenticated-user",
450303
+ "externalDocs": {
450304
+ "description": "API method documentation",
450305
+ "url": "https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user"
450306
+ },
450307
+ "x-octokit": {
450308
+ "api.github.com": "removed"
450309
+ },
450310
+ "responses": {
450311
+ "501": {
450312
+ "description": "Not Implemented"
450313
+ }
450314
+ }
450315
+ }
450316
+ },
450205
450317
  "/users/{username}/packages": {
450206
450318
  "get": {
450207
450319
  "summary": "List packages for a user",
@@ -450439,6 +450551,28 @@
450439
450551
  }
450440
450552
  }
450441
450553
  }
450554
+ },
450555
+ "/users/{username}/ssh_signing_keys": {
450556
+ "get": {
450557
+ "summary": "List SSH signing keys for a user",
450558
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
450559
+ "tags": [
450560
+ "users"
450561
+ ],
450562
+ "operationId": "users/list-ssh-signing-keys-for-user",
450563
+ "externalDocs": {
450564
+ "description": "API method documentation",
450565
+ "url": "https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user"
450566
+ },
450567
+ "x-octokit": {
450568
+ "api.github.com": "removed"
450569
+ },
450570
+ "responses": {
450571
+ "501": {
450572
+ "description": "Not Implemented"
450573
+ }
450574
+ }
450575
+ }
450442
450576
  }
450443
450577
  }
450444
450578
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.6.0",
4
+ "version": "7.7.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -10140,7 +10140,13 @@
10140
10140
  "category": "orgs",
10141
10141
  "subcategory": null
10142
10142
  },
10143
- "x-octokit": {}
10143
+ "x-octokit": {
10144
+ "diff": {
10145
+ "api.github.com": {
10146
+ "type": "changed"
10147
+ }
10148
+ }
10149
+ }
10144
10150
  },
10145
10151
  "patch": {
10146
10152
  "summary": "Update an organization",
@@ -55271,6 +55277,28 @@
55271
55277
  }
55272
55278
  }
55273
55279
  },
55280
+ "/orgs/{org}/{security_product}/{enablement}": {
55281
+ "post": {
55282
+ "summary": "Enable or disable a security feature for an organization",
55283
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
55284
+ "tags": [
55285
+ "orgs"
55286
+ ],
55287
+ "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
55288
+ "externalDocs": {
55289
+ "description": "API method documentation",
55290
+ "url": "https://docs.github.com/rest/reference/orgs#enable-or-disable-security-product-on-all-org-repos"
55291
+ },
55292
+ "x-octokit": {
55293
+ "api.github.com": "removed"
55294
+ },
55295
+ "responses": {
55296
+ "501": {
55297
+ "description": "Not Implemented"
55298
+ }
55299
+ }
55300
+ }
55301
+ },
55274
55302
  "/repos/{owner}/{repo}/actions/caches": {
55275
55303
  "get": {
55276
55304
  "summary": "List GitHub Actions caches for a repository",
@@ -57454,6 +57482,90 @@
57454
57482
  }
57455
57483
  }
57456
57484
  },
57485
+ "/user/ssh_signing_keys": {
57486
+ "get": {
57487
+ "summary": "List SSH signing keys for the authenticated user",
57488
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
57489
+ "tags": [
57490
+ "users"
57491
+ ],
57492
+ "operationId": "users/list-ssh-signing-keys-for-authenticated-user",
57493
+ "externalDocs": {
57494
+ "description": "API method documentation",
57495
+ "url": "https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user"
57496
+ },
57497
+ "x-octokit": {
57498
+ "api.github.com": "removed"
57499
+ },
57500
+ "responses": {
57501
+ "501": {
57502
+ "description": "Not Implemented"
57503
+ }
57504
+ }
57505
+ },
57506
+ "post": {
57507
+ "summary": "Create a SSH signing key for the authenticated user",
57508
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
57509
+ "operationId": "users/create-ssh-signing-key-for-authenticated-user",
57510
+ "tags": [
57511
+ "users"
57512
+ ],
57513
+ "externalDocs": {
57514
+ "description": "API method documentation",
57515
+ "url": "https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user"
57516
+ },
57517
+ "x-octokit": {
57518
+ "api.github.com": "removed"
57519
+ },
57520
+ "responses": {
57521
+ "501": {
57522
+ "description": "Not Implemented"
57523
+ }
57524
+ }
57525
+ }
57526
+ },
57527
+ "/user/ssh_signing_keys/{ssh_signing_key_id}": {
57528
+ "get": {
57529
+ "summary": "Get an SSH signing key for the authenticated user",
57530
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
57531
+ "tags": [
57532
+ "users"
57533
+ ],
57534
+ "operationId": "users/get-ssh-signing-key-for-authenticated-user",
57535
+ "externalDocs": {
57536
+ "description": "API method documentation",
57537
+ "url": "https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user"
57538
+ },
57539
+ "x-octokit": {
57540
+ "api.github.com": "removed"
57541
+ },
57542
+ "responses": {
57543
+ "501": {
57544
+ "description": "Not Implemented"
57545
+ }
57546
+ }
57547
+ },
57548
+ "delete": {
57549
+ "summary": "Delete an SSH signing key for the authenticated user",
57550
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
57551
+ "tags": [
57552
+ "users"
57553
+ ],
57554
+ "operationId": "users/delete-ssh-signing-key-for-authenticated-user",
57555
+ "externalDocs": {
57556
+ "description": "API method documentation",
57557
+ "url": "https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user"
57558
+ },
57559
+ "x-octokit": {
57560
+ "api.github.com": "removed"
57561
+ },
57562
+ "responses": {
57563
+ "501": {
57564
+ "description": "Not Implemented"
57565
+ }
57566
+ }
57567
+ }
57568
+ },
57457
57569
  "/users/{username}/packages": {
57458
57570
  "get": {
57459
57571
  "summary": "List packages for a user",
@@ -57691,6 +57803,28 @@
57691
57803
  }
57692
57804
  }
57693
57805
  }
57806
+ },
57807
+ "/users/{username}/ssh_signing_keys": {
57808
+ "get": {
57809
+ "summary": "List SSH signing keys for a user",
57810
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
57811
+ "tags": [
57812
+ "users"
57813
+ ],
57814
+ "operationId": "users/list-ssh-signing-keys-for-user",
57815
+ "externalDocs": {
57816
+ "description": "API method documentation",
57817
+ "url": "https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user"
57818
+ },
57819
+ "x-octokit": {
57820
+ "api.github.com": "removed"
57821
+ },
57822
+ "responses": {
57823
+ "501": {
57824
+ "description": "Not Implemented"
57825
+ }
57826
+ }
57827
+ }
57694
57828
  }
57695
57829
  },
57696
57830
  "components": {
@@ -11942,6 +11942,9 @@
11942
11942
  "get",
11943
11943
  "patch"
11944
11944
  ],
11945
+ "/orgs/{org}/{security_product}/{enablement}": [
11946
+ "post"
11947
+ ],
11945
11948
  "/repos/{owner}/{repo}/actions/cache/usage": [
11946
11949
  "get"
11947
11950
  ],
@@ -12250,6 +12253,14 @@
12250
12253
  "/user/public_emails": [
12251
12254
  "get"
12252
12255
  ],
12256
+ "/user/ssh_signing_keys": [
12257
+ "get",
12258
+ "post"
12259
+ ],
12260
+ "/user/ssh_signing_keys/{ssh_signing_key_id}": [
12261
+ "get",
12262
+ "delete"
12263
+ ],
12253
12264
  "/users/{username}/events/public": [
12254
12265
  "get"
12255
12266
  ],
@@ -12287,6 +12298,9 @@
12287
12298
  ],
12288
12299
  "/users/{username}/settings/billing/shared-storage": [
12289
12300
  "get"
12301
+ ],
12302
+ "/users/{username}/ssh_signing_keys": [
12303
+ "get"
12290
12304
  ]
12291
12305
  }
12292
12306
  },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.6.0",
4
+ "version": "7.7.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.6.0",
4
+ "version": "7.7.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {