@octokit/openapi 6.1.4 → 6.3.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 (29) hide show
  1. package/generated/api.github.com.deref.json +12366 -10615
  2. package/generated/api.github.com.json +3916 -3453
  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 +187 -7
  8. package/generated/ghes-3.2.json +190 -29
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +23 -0
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +96 -1
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +92 -1
  12. package/generated/ghes-3.3.deref.json +371 -1395
  13. package/generated/ghes-3.3.json +491 -315
  14. package/generated/ghes-3.4-anicca-diff-to-ghes-3.5.deref.json +0 -14
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +7801 -10209
  16. package/generated/ghes-3.4-diff-to-ghes-3.5.json +341 -326
  17. package/generated/ghes-3.4.deref.json +1434 -3653
  18. package/generated/ghes-3.4.json +1184 -1001
  19. package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +69 -73
  20. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +28230 -31386
  21. package/generated/ghes-3.5-diff-to-api.github.com.json +813 -744
  22. package/generated/ghes-3.5.deref.json +1692 -4983
  23. package/generated/ghes-3.5.json +2093 -2049
  24. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +92 -0
  25. package/generated/github.ae-diff-to-api.github.com.deref.json +488 -1
  26. package/generated/github.ae-diff-to-api.github.com.json +362 -12
  27. package/generated/github.ae.deref.json +253 -104
  28. package/generated/github.ae.json +263 -81
  29. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.4",
4
+ "version": "6.3.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.4",
4
+ "version": "6.3.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.4",
4
+ "version": "6.3.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.4",
4
+ "version": "6.3.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.1.4",
4
+ "version": "6.3.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -53860,7 +53860,7 @@
53860
53860
  "selected_repository_ids": {
53861
53861
  "type": "array",
53862
53862
  "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
53863
- "items": { "type": "string" }
53863
+ "items": { "type": "integer" }
53864
53864
  }
53865
53865
  },
53866
53866
  "required": ["visibility"]
@@ -53871,7 +53871,7 @@
53871
53871
  "encrypted_value": "c2VjcmV0",
53872
53872
  "key_id": "012345678912345678",
53873
53873
  "visibility": "selected",
53874
- "selected_repository_ids": ["1296269", "1296280"]
53874
+ "selected_repository_ids": [1296269, 1296280]
53875
53875
  }
53876
53876
  }
53877
53877
  }
@@ -53889,7 +53889,8 @@
53889
53889
  "type": "object",
53890
53890
  "properties": {},
53891
53891
  "additionalProperties": false
53892
- }
53892
+ },
53893
+ "examples": { "default": { "value": null } }
53893
53894
  }
53894
53895
  }
53895
53896
  },
@@ -58112,6 +58113,71 @@
58112
58113
  "created_at"
58113
58114
  ]
58114
58115
  }
58116
+ },
58117
+ "examples": {
58118
+ "200-response": {
58119
+ "value": [
58120
+ {
58121
+ "id": "22237752260",
58122
+ "type": "WatchEvent",
58123
+ "actor": {
58124
+ "id": 583231,
58125
+ "login": "octocat",
58126
+ "display_login": "octocat",
58127
+ "gravatar_id": "",
58128
+ "url": "https://api.github.com/users/octocat",
58129
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
58130
+ },
58131
+ "repo": {
58132
+ "id": 1296269,
58133
+ "name": "octo-org/octo-repo",
58134
+ "url": "https://api.github.com/repos/octo-org/octo-repo"
58135
+ },
58136
+ "payload": { "action": "started" },
58137
+ "public": true,
58138
+ "created_at": "2022-06-08T23:29:25Z"
58139
+ },
58140
+ {
58141
+ "id": "22249084964",
58142
+ "type": "PushEvent",
58143
+ "actor": {
58144
+ "id": 583231,
58145
+ "login": "octocat",
58146
+ "display_login": "octocat",
58147
+ "gravatar_id": "",
58148
+ "url": "https://api.github.com/users/octocat",
58149
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
58150
+ },
58151
+ "repo": {
58152
+ "id": 1296269,
58153
+ "name": "octo-org/octo-repo",
58154
+ "url": "https://api.github.com/repos/octo-org/oct-repo"
58155
+ },
58156
+ "payload": {
58157
+ "push_id": 10115855396,
58158
+ "size": 1,
58159
+ "distinct_size": 1,
58160
+ "ref": "refs/heads/master",
58161
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
58162
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
58163
+ "commits": [
58164
+ {
58165
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
58166
+ "author": {
58167
+ "email": "octocat@github.com",
58168
+ "name": "Monalisa Octocat"
58169
+ },
58170
+ "message": "commit",
58171
+ "distinct": true,
58172
+ "url": "https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
58173
+ }
58174
+ ]
58175
+ },
58176
+ "public": true,
58177
+ "created_at": "2022-06-09T12:47:28Z"
58178
+ }
58179
+ ]
58180
+ }
58115
58181
  }
58116
58182
  }
58117
58183
  }
@@ -93069,6 +93135,24 @@
93069
93135
  "schema": { "type": "string" }
93070
93136
  }
93071
93137
  }
93138
+ },
93139
+ "410": {
93140
+ "description": "Gone",
93141
+ "content": {
93142
+ "application/json": {
93143
+ "schema": {
93144
+ "title": "Basic Error",
93145
+ "description": "Basic Error",
93146
+ "type": "object",
93147
+ "properties": {
93148
+ "message": { "type": "string" },
93149
+ "documentation_url": { "type": "string" },
93150
+ "url": { "type": "string" },
93151
+ "status": { "type": "string" }
93152
+ }
93153
+ }
93154
+ }
93155
+ }
93072
93156
  }
93073
93157
  },
93074
93158
  "x-github": {
@@ -162031,6 +162115,71 @@
162031
162115
  "created_at"
162032
162116
  ]
162033
162117
  }
162118
+ },
162119
+ "examples": {
162120
+ "200-response": {
162121
+ "value": [
162122
+ {
162123
+ "id": "22249084964",
162124
+ "type": "PushEvent",
162125
+ "actor": {
162126
+ "id": 583231,
162127
+ "login": "octocat",
162128
+ "display_login": "octocat",
162129
+ "gravatar_id": "",
162130
+ "url": "https://api.github.com/users/octocat",
162131
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
162132
+ },
162133
+ "repo": {
162134
+ "id": 1296269,
162135
+ "name": "octocat/Hello-World",
162136
+ "url": "https://api.github.com/repos/octocat/Hello-World"
162137
+ },
162138
+ "payload": {
162139
+ "push_id": 10115855396,
162140
+ "size": 1,
162141
+ "distinct_size": 1,
162142
+ "ref": "refs/heads/master",
162143
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
162144
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
162145
+ "commits": [
162146
+ {
162147
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
162148
+ "author": {
162149
+ "email": "octocat@github.com",
162150
+ "name": "Monalisa Octocat"
162151
+ },
162152
+ "message": "commit",
162153
+ "distinct": true,
162154
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
162155
+ }
162156
+ ]
162157
+ },
162158
+ "public": true,
162159
+ "created_at": "2022-06-09T12:47:28Z"
162160
+ },
162161
+ {
162162
+ "id": "22237752260",
162163
+ "type": "WatchEvent",
162164
+ "actor": {
162165
+ "id": 583231,
162166
+ "login": "octocat",
162167
+ "display_login": "octocat",
162168
+ "gravatar_id": "",
162169
+ "url": "https://api.github.com/users/octocat",
162170
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
162171
+ },
162172
+ "repo": {
162173
+ "id": 1296269,
162174
+ "name": "octocat/Hello-World",
162175
+ "url": "https://api.github.com/repos/octocat/Hello-World"
162176
+ },
162177
+ "payload": { "action": "started" },
162178
+ "public": true,
162179
+ "created_at": "2022-06-08T23:29:25Z"
162180
+ }
162181
+ ]
162182
+ }
162034
162183
  }
162035
162184
  }
162036
162185
  }
@@ -196027,7 +196176,7 @@
196027
196176
  "operationId": "issues/remove-assignees",
196028
196177
  "externalDocs": {
196029
196178
  "description": "API method documentation",
196030
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#remove-assignees-from-an-issue"
196179
+ "url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
196031
196180
  },
196032
196181
  "parameters": [
196033
196182
  {
@@ -196053,6 +196202,7 @@
196053
196202
  }
196054
196203
  ],
196055
196204
  "requestBody": {
196205
+ "required": true,
196056
196206
  "content": {
196057
196207
  "application/json": {
196058
196208
  "schema": {
@@ -196063,7 +196213,8 @@
196063
196213
  "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._",
196064
196214
  "items": { "type": "string" }
196065
196215
  }
196066
- }
196216
+ },
196217
+ "required": ["assignees"]
196067
196218
  },
196068
196219
  "examples": {
196069
196220
  "default": { "value": { "assignees": ["hubot", "other_user"] } }
@@ -197494,6 +197645,9 @@
197494
197645
  "allow_auto_merge": { "type": "boolean" },
197495
197646
  "delete_branch_on_merge": { "type": "boolean" },
197496
197647
  "allow_update_branch": { "type": "boolean" },
197648
+ "use_squash_pr_title_as_default": {
197649
+ "type": "boolean"
197650
+ },
197497
197651
  "allow_merge_commit": { "type": "boolean" },
197498
197652
  "subscribers_count": { "type": "integer" },
197499
197653
  "network_count": { "type": "integer" }
@@ -197524,6 +197678,11 @@
197524
197678
  "type": "boolean",
197525
197679
  "example": false
197526
197680
  },
197681
+ "use_squash_pr_title_as_default": {
197682
+ "type": "boolean",
197683
+ "description": "Whether a squash merge commit can use the pull request title as default.",
197684
+ "default": false
197685
+ },
197527
197686
  "allow_merge_commit": {
197528
197687
  "description": "Whether to allow merge commits for pull requests.",
197529
197688
  "default": true,
@@ -266178,7 +266337,8 @@
266178
266337
  "type": "object",
266179
266338
  "properties": {},
266180
266339
  "additionalProperties": false
266181
- }
266340
+ },
266341
+ "examples": { "default": { "value": null } }
266182
266342
  }
266183
266343
  }
266184
266344
  },
@@ -285939,6 +286099,18 @@
285939
286099
  }
285940
286100
  }
285941
286101
  ]
286102
+ },
286103
+ "examples": {
286104
+ "default": {
286105
+ "summary": "Example adding multiple email addresses",
286106
+ "value": {
286107
+ "emails": [
286108
+ "octocat@github.com",
286109
+ "mona@github.com",
286110
+ "octocat@octocat.org"
286111
+ ]
286112
+ }
286113
+ }
285942
286114
  }
285943
286115
  }
285944
286116
  }
@@ -286147,6 +286319,14 @@
286147
286319
  "required": ["emails"]
286148
286320
  }
286149
286321
  ]
286322
+ },
286323
+ "examples": {
286324
+ "default": {
286325
+ "summary": "Example deleting multiple email accounts",
286326
+ "value": {
286327
+ "emails": ["octocat@github.com", "mona@github.com"]
286328
+ }
286329
+ }
286150
286330
  }
286151
286331
  }
286152
286332
  }