@octokit/openapi 6.2.1 → 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.
- package/generated/api.github.com.deref.json +7628 -7780
- package/generated/api.github.com.json +1267 -1290
- package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
- package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +1 -1
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +1 -1
- package/generated/ghes-3.2.deref.json +15 -5
- package/generated/ghes-3.2.json +28 -26
- package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +23 -0
- package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +96 -1
- package/generated/ghes-3.3-diff-to-ghes-3.4.json +92 -1
- package/generated/ghes-3.3.deref.json +18 -8
- package/generated/ghes-3.3.json +31 -29
- package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
- package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -1
- package/generated/ghes-3.4.deref.json +27 -13
- package/generated/ghes-3.4.json +40 -34
- package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +60 -2
- package/generated/ghes-3.5-diff-to-api.github.com.deref.json +328 -1
- package/generated/ghes-3.5-diff-to-api.github.com.json +206 -10
- package/generated/ghes-3.5.deref.json +44 -45
- package/generated/ghes-3.5.json +65 -68
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +83 -1
- package/generated/github.ae-diff-to-api.github.com.deref.json +423 -1
- package/generated/github.ae-diff-to-api.github.com.json +294 -12
- package/generated/github.ae.deref.json +34 -117
- package/generated/github.ae.json +57 -93
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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": "
|
|
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": [
|
|
53874
|
+
"selected_repository_ids": [1296269, 1296280]
|
|
53875
53875
|
}
|
|
53876
53876
|
}
|
|
53877
53877
|
}
|
|
@@ -196176,7 +196176,7 @@
|
|
|
196176
196176
|
"operationId": "issues/remove-assignees",
|
|
196177
196177
|
"externalDocs": {
|
|
196178
196178
|
"description": "API method documentation",
|
|
196179
|
-
"url": "https://docs.github.com/
|
|
196179
|
+
"url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
|
|
196180
196180
|
},
|
|
196181
196181
|
"parameters": [
|
|
196182
196182
|
{
|
|
@@ -196202,6 +196202,7 @@
|
|
|
196202
196202
|
}
|
|
196203
196203
|
],
|
|
196204
196204
|
"requestBody": {
|
|
196205
|
+
"required": true,
|
|
196205
196206
|
"content": {
|
|
196206
196207
|
"application/json": {
|
|
196207
196208
|
"schema": {
|
|
@@ -196212,7 +196213,8 @@
|
|
|
196212
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._",
|
|
196213
196214
|
"items": { "type": "string" }
|
|
196214
196215
|
}
|
|
196215
|
-
}
|
|
196216
|
+
},
|
|
196217
|
+
"required": ["assignees"]
|
|
196216
196218
|
},
|
|
196217
196219
|
"examples": {
|
|
196218
196220
|
"default": { "value": { "assignees": ["hubot", "other_user"] } }
|
|
@@ -197643,6 +197645,9 @@
|
|
|
197643
197645
|
"allow_auto_merge": { "type": "boolean" },
|
|
197644
197646
|
"delete_branch_on_merge": { "type": "boolean" },
|
|
197645
197647
|
"allow_update_branch": { "type": "boolean" },
|
|
197648
|
+
"use_squash_pr_title_as_default": {
|
|
197649
|
+
"type": "boolean"
|
|
197650
|
+
},
|
|
197646
197651
|
"allow_merge_commit": { "type": "boolean" },
|
|
197647
197652
|
"subscribers_count": { "type": "integer" },
|
|
197648
197653
|
"network_count": { "type": "integer" }
|
|
@@ -197673,6 +197678,11 @@
|
|
|
197673
197678
|
"type": "boolean",
|
|
197674
197679
|
"example": false
|
|
197675
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
|
+
},
|
|
197676
197686
|
"allow_merge_commit": {
|
|
197677
197687
|
"description": "Whether to allow merge commits for pull requests.",
|
|
197678
197688
|
"default": true,
|
package/generated/ghes-3.2.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -8629,7 +8629,7 @@
|
|
|
8629
8629
|
"selected_repository_ids": {
|
|
8630
8630
|
"type": "array",
|
|
8631
8631
|
"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.",
|
|
8632
|
-
"items": { "type": "
|
|
8632
|
+
"items": { "type": "integer" }
|
|
8633
8633
|
}
|
|
8634
8634
|
},
|
|
8635
8635
|
"required": ["visibility"]
|
|
@@ -8640,7 +8640,7 @@
|
|
|
8640
8640
|
"encrypted_value": "c2VjcmV0",
|
|
8641
8641
|
"key_id": "012345678912345678",
|
|
8642
8642
|
"visibility": "selected",
|
|
8643
|
-
"selected_repository_ids": [
|
|
8643
|
+
"selected_repository_ids": [1296269, 1296280]
|
|
8644
8644
|
}
|
|
8645
8645
|
}
|
|
8646
8646
|
}
|
|
@@ -21819,7 +21819,7 @@
|
|
|
21819
21819
|
}
|
|
21820
21820
|
},
|
|
21821
21821
|
"deployment_branch_policy": {
|
|
21822
|
-
"$ref": "#/components/schemas/
|
|
21822
|
+
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
21823
21823
|
}
|
|
21824
21824
|
},
|
|
21825
21825
|
"additionalProperties": false
|
|
@@ -24610,7 +24610,7 @@
|
|
|
24610
24610
|
"operationId": "issues/remove-assignees",
|
|
24611
24611
|
"externalDocs": {
|
|
24612
24612
|
"description": "API method documentation",
|
|
24613
|
-
"url": "https://docs.github.com/
|
|
24613
|
+
"url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
|
|
24614
24614
|
},
|
|
24615
24615
|
"parameters": [
|
|
24616
24616
|
{ "$ref": "#/components/parameters/owner" },
|
|
@@ -24618,6 +24618,7 @@
|
|
|
24618
24618
|
{ "$ref": "#/components/parameters/issue-number" }
|
|
24619
24619
|
],
|
|
24620
24620
|
"requestBody": {
|
|
24621
|
+
"required": true,
|
|
24621
24622
|
"content": {
|
|
24622
24623
|
"application/json": {
|
|
24623
24624
|
"schema": {
|
|
@@ -24628,7 +24629,8 @@
|
|
|
24628
24629
|
"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._",
|
|
24629
24630
|
"items": { "type": "string" }
|
|
24630
24631
|
}
|
|
24631
|
-
}
|
|
24632
|
+
},
|
|
24633
|
+
"required": ["assignees"]
|
|
24632
24634
|
},
|
|
24633
24635
|
"examples": {
|
|
24634
24636
|
"default": { "value": { "assignees": ["hubot", "other_user"] } }
|
|
@@ -40713,7 +40715,7 @@
|
|
|
40713
40715
|
],
|
|
40714
40716
|
"nullable": true
|
|
40715
40717
|
},
|
|
40716
|
-
"
|
|
40718
|
+
"author-association": {
|
|
40717
40719
|
"title": "author_association",
|
|
40718
40720
|
"type": "string",
|
|
40719
40721
|
"example": "OWNER",
|
|
@@ -40879,7 +40881,7 @@
|
|
|
40879
40881
|
"$ref": "#/components/schemas/nullable-integration"
|
|
40880
40882
|
},
|
|
40881
40883
|
"author_association": {
|
|
40882
|
-
"$ref": "#/components/schemas/
|
|
40884
|
+
"$ref": "#/components/schemas/author-association"
|
|
40883
40885
|
},
|
|
40884
40886
|
"reactions": { "$ref": "#/components/schemas/reaction-rollup" }
|
|
40885
40887
|
},
|
|
@@ -40945,7 +40947,7 @@
|
|
|
40945
40947
|
},
|
|
40946
40948
|
"issue_url": { "type": "string", "format": "uri" },
|
|
40947
40949
|
"author_association": {
|
|
40948
|
-
"$ref": "#/components/schemas/
|
|
40950
|
+
"$ref": "#/components/schemas/author-association"
|
|
40949
40951
|
},
|
|
40950
40952
|
"performed_via_github_app": {
|
|
40951
40953
|
"$ref": "#/components/schemas/nullable-integration"
|
|
@@ -41420,7 +41422,7 @@
|
|
|
41420
41422
|
"example": "2011-04-18T23:23:56Z"
|
|
41421
41423
|
},
|
|
41422
41424
|
"author_association": {
|
|
41423
|
-
"$ref": "#/components/schemas/
|
|
41425
|
+
"$ref": "#/components/schemas/author-association"
|
|
41424
41426
|
}
|
|
41425
41427
|
},
|
|
41426
41428
|
"required": [
|
|
@@ -47140,7 +47142,7 @@
|
|
|
47140
47142
|
"created_at": { "type": "string", "format": "date-time" },
|
|
47141
47143
|
"updated_at": { "type": "string", "format": "date-time" },
|
|
47142
47144
|
"author_association": {
|
|
47143
|
-
"$ref": "#/components/schemas/
|
|
47145
|
+
"$ref": "#/components/schemas/author-association"
|
|
47144
47146
|
},
|
|
47145
47147
|
"reactions": { "$ref": "#/components/schemas/reaction-rollup" }
|
|
47146
47148
|
},
|
|
@@ -47185,7 +47187,7 @@
|
|
|
47185
47187
|
"properties": { "href": { "type": "string" } },
|
|
47186
47188
|
"required": ["href"]
|
|
47187
47189
|
},
|
|
47188
|
-
"
|
|
47190
|
+
"auto-merge": {
|
|
47189
47191
|
"title": "Auto merge",
|
|
47190
47192
|
"description": "The status of auto merging a pull request.",
|
|
47191
47193
|
"type": "object",
|
|
@@ -47401,9 +47403,9 @@
|
|
|
47401
47403
|
]
|
|
47402
47404
|
},
|
|
47403
47405
|
"author_association": {
|
|
47404
|
-
"$ref": "#/components/schemas/
|
|
47406
|
+
"$ref": "#/components/schemas/author-association"
|
|
47405
47407
|
},
|
|
47406
|
-
"auto_merge": { "$ref": "#/components/schemas/
|
|
47408
|
+
"auto_merge": { "$ref": "#/components/schemas/auto-merge" },
|
|
47407
47409
|
"draft": {
|
|
47408
47410
|
"description": "Indicates whether or not the pull request is a draft.",
|
|
47409
47411
|
"example": false,
|
|
@@ -48127,7 +48129,7 @@
|
|
|
48127
48129
|
"example": 30,
|
|
48128
48130
|
"description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)."
|
|
48129
48131
|
},
|
|
48130
|
-
"
|
|
48132
|
+
"deployment-branch-policy": {
|
|
48131
48133
|
"type": "object",
|
|
48132
48134
|
"description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.",
|
|
48133
48135
|
"properties": {
|
|
@@ -48248,7 +48250,7 @@
|
|
|
48248
48250
|
}
|
|
48249
48251
|
},
|
|
48250
48252
|
"deployment_branch_policy": {
|
|
48251
|
-
"$ref": "#/components/schemas/
|
|
48253
|
+
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
48252
48254
|
}
|
|
48253
48255
|
},
|
|
48254
48256
|
"required": [
|
|
@@ -48765,7 +48767,7 @@
|
|
|
48765
48767
|
"$ref": "#/components/schemas/nullable-integration"
|
|
48766
48768
|
},
|
|
48767
48769
|
"author_association": {
|
|
48768
|
-
"$ref": "#/components/schemas/
|
|
48770
|
+
"$ref": "#/components/schemas/author-association"
|
|
48769
48771
|
},
|
|
48770
48772
|
"reactions": { "$ref": "#/components/schemas/reaction-rollup" }
|
|
48771
48773
|
},
|
|
@@ -48895,7 +48897,7 @@
|
|
|
48895
48897
|
},
|
|
48896
48898
|
"rename": { "$ref": "#/components/schemas/issue-event-rename" },
|
|
48897
48899
|
"author_association": {
|
|
48898
|
-
"$ref": "#/components/schemas/
|
|
48900
|
+
"$ref": "#/components/schemas/author-association"
|
|
48899
48901
|
},
|
|
48900
48902
|
"lock_reason": { "type": "string", "nullable": true },
|
|
48901
48903
|
"performed_via_github_app": {
|
|
@@ -49598,7 +49600,7 @@
|
|
|
49598
49600
|
},
|
|
49599
49601
|
"issue_url": { "type": "string", "format": "uri" },
|
|
49600
49602
|
"author_association": {
|
|
49601
|
-
"$ref": "#/components/schemas/
|
|
49603
|
+
"$ref": "#/components/schemas/author-association"
|
|
49602
49604
|
},
|
|
49603
49605
|
"performed_via_github_app": {
|
|
49604
49606
|
"$ref": "#/components/schemas/nullable-integration"
|
|
@@ -49813,7 +49815,7 @@
|
|
|
49813
49815
|
"body_html": { "type": "string" },
|
|
49814
49816
|
"body_text": { "type": "string" },
|
|
49815
49817
|
"author_association": {
|
|
49816
|
-
"$ref": "#/components/schemas/
|
|
49818
|
+
"$ref": "#/components/schemas/author-association"
|
|
49817
49819
|
}
|
|
49818
49820
|
},
|
|
49819
49821
|
"required": [
|
|
@@ -49920,7 +49922,7 @@
|
|
|
49920
49922
|
"example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
|
|
49921
49923
|
},
|
|
49922
49924
|
"author_association": {
|
|
49923
|
-
"$ref": "#/components/schemas/
|
|
49925
|
+
"$ref": "#/components/schemas/author-association"
|
|
49924
49926
|
},
|
|
49925
49927
|
"_links": {
|
|
49926
49928
|
"type": "object",
|
|
@@ -51359,9 +51361,9 @@
|
|
|
51359
51361
|
]
|
|
51360
51362
|
},
|
|
51361
51363
|
"author_association": {
|
|
51362
|
-
"$ref": "#/components/schemas/
|
|
51364
|
+
"$ref": "#/components/schemas/author-association"
|
|
51363
51365
|
},
|
|
51364
|
-
"auto_merge": { "$ref": "#/components/schemas/
|
|
51366
|
+
"auto_merge": { "$ref": "#/components/schemas/auto-merge" },
|
|
51365
51367
|
"draft": {
|
|
51366
51368
|
"description": "Indicates whether or not the pull request is a draft.",
|
|
51367
51369
|
"example": false,
|
|
@@ -51516,7 +51518,7 @@
|
|
|
51516
51518
|
"body_html": { "type": "string" },
|
|
51517
51519
|
"body_text": { "type": "string" },
|
|
51518
51520
|
"author_association": {
|
|
51519
|
-
"$ref": "#/components/schemas/
|
|
51521
|
+
"$ref": "#/components/schemas/author-association"
|
|
51520
51522
|
}
|
|
51521
51523
|
},
|
|
51522
51524
|
"required": [
|
|
@@ -51591,7 +51593,7 @@
|
|
|
51591
51593
|
"example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
|
|
51592
51594
|
},
|
|
51593
51595
|
"author_association": {
|
|
51594
|
-
"$ref": "#/components/schemas/
|
|
51596
|
+
"$ref": "#/components/schemas/author-association"
|
|
51595
51597
|
},
|
|
51596
51598
|
"_links": {
|
|
51597
51599
|
"type": "object",
|
|
@@ -52199,7 +52201,7 @@
|
|
|
52199
52201
|
"body": { "type": "string" },
|
|
52200
52202
|
"score": { "type": "number" },
|
|
52201
52203
|
"author_association": {
|
|
52202
|
-
"$ref": "#/components/schemas/
|
|
52204
|
+
"$ref": "#/components/schemas/author-association"
|
|
52203
52205
|
},
|
|
52204
52206
|
"draft": { "type": "boolean" },
|
|
52205
52207
|
"repository": { "$ref": "#/components/schemas/repository" },
|
|
@@ -2577,6 +2577,29 @@
|
|
|
2577
2577
|
}
|
|
2578
2578
|
}
|
|
2579
2579
|
},
|
|
2580
|
+
"/orgs/{org}/actions/secrets/{secret_name}": {
|
|
2581
|
+
"put": {
|
|
2582
|
+
"request_body": {
|
|
2583
|
+
"content_changed": {
|
|
2584
|
+
"changed": {
|
|
2585
|
+
"application/json": {
|
|
2586
|
+
"schema_changed": {
|
|
2587
|
+
"properties_changed": {
|
|
2588
|
+
"changed": {
|
|
2589
|
+
"selected_repository_ids": {
|
|
2590
|
+
"items_changed": {
|
|
2591
|
+
"type_changed": { "to": "integer" }
|
|
2592
|
+
}
|
|
2593
|
+
}
|
|
2594
|
+
}
|
|
2595
|
+
}
|
|
2596
|
+
}
|
|
2597
|
+
}
|
|
2598
|
+
}
|
|
2599
|
+
}
|
|
2600
|
+
}
|
|
2601
|
+
}
|
|
2602
|
+
},
|
|
2580
2603
|
"/orgs/{org}/audit-log": {
|
|
2581
2604
|
"get": {
|
|
2582
2605
|
"parameters": {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -13738,6 +13738,101 @@
|
|
|
13738
13738
|
"x-octokit": { "diff": { "ghes-3.4": { "type": "changed" } } }
|
|
13739
13739
|
}
|
|
13740
13740
|
},
|
|
13741
|
+
"/orgs/{org}/actions/secrets/{secret_name}": {
|
|
13742
|
+
"put": {
|
|
13743
|
+
"summary": "Create or update an organization secret",
|
|
13744
|
+
"description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
|
|
13745
|
+
"tags": ["actions"],
|
|
13746
|
+
"operationId": "actions/create-or-update-org-secret",
|
|
13747
|
+
"externalDocs": {
|
|
13748
|
+
"description": "API method documentation",
|
|
13749
|
+
"url": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-or-update-an-organization-secret"
|
|
13750
|
+
},
|
|
13751
|
+
"parameters": [
|
|
13752
|
+
{
|
|
13753
|
+
"name": "org",
|
|
13754
|
+
"description": "The organization name. The name is not case sensitive.",
|
|
13755
|
+
"in": "path",
|
|
13756
|
+
"required": true,
|
|
13757
|
+
"schema": { "type": "string" }
|
|
13758
|
+
},
|
|
13759
|
+
{
|
|
13760
|
+
"name": "secret_name",
|
|
13761
|
+
"description": "The name of the secret.",
|
|
13762
|
+
"in": "path",
|
|
13763
|
+
"required": true,
|
|
13764
|
+
"schema": { "type": "string" }
|
|
13765
|
+
}
|
|
13766
|
+
],
|
|
13767
|
+
"requestBody": {
|
|
13768
|
+
"required": true,
|
|
13769
|
+
"content": {
|
|
13770
|
+
"application/json": {
|
|
13771
|
+
"schema": {
|
|
13772
|
+
"type": "object",
|
|
13773
|
+
"properties": {
|
|
13774
|
+
"encrypted_value": {
|
|
13775
|
+
"type": "string",
|
|
13776
|
+
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-organization-public-key) endpoint.",
|
|
13777
|
+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
13778
|
+
},
|
|
13779
|
+
"key_id": {
|
|
13780
|
+
"type": "string",
|
|
13781
|
+
"description": "ID of the key you used to encrypt the secret."
|
|
13782
|
+
},
|
|
13783
|
+
"visibility": {
|
|
13784
|
+
"type": "string",
|
|
13785
|
+
"description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.",
|
|
13786
|
+
"enum": ["all", "private", "selected"]
|
|
13787
|
+
},
|
|
13788
|
+
"selected_repository_ids": {
|
|
13789
|
+
"type": "array",
|
|
13790
|
+
"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.3/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/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.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
|
|
13791
|
+
"items": { "type": "integer" }
|
|
13792
|
+
}
|
|
13793
|
+
},
|
|
13794
|
+
"required": ["visibility"]
|
|
13795
|
+
},
|
|
13796
|
+
"examples": {
|
|
13797
|
+
"default": {
|
|
13798
|
+
"value": {
|
|
13799
|
+
"encrypted_value": "c2VjcmV0",
|
|
13800
|
+
"key_id": "012345678912345678",
|
|
13801
|
+
"visibility": "selected",
|
|
13802
|
+
"selected_repository_ids": [1296269, 1296280]
|
|
13803
|
+
}
|
|
13804
|
+
}
|
|
13805
|
+
}
|
|
13806
|
+
}
|
|
13807
|
+
}
|
|
13808
|
+
},
|
|
13809
|
+
"responses": {
|
|
13810
|
+
"201": {
|
|
13811
|
+
"description": "Response when creating a secret",
|
|
13812
|
+
"content": {
|
|
13813
|
+
"application/json": {
|
|
13814
|
+
"schema": {
|
|
13815
|
+
"title": "Empty Object",
|
|
13816
|
+
"description": "An object without any properties.",
|
|
13817
|
+
"type": "object",
|
|
13818
|
+
"properties": {},
|
|
13819
|
+
"additionalProperties": false
|
|
13820
|
+
},
|
|
13821
|
+
"examples": { "default": { "value": null } }
|
|
13822
|
+
}
|
|
13823
|
+
}
|
|
13824
|
+
},
|
|
13825
|
+
"204": { "description": "Response when updating a secret" }
|
|
13826
|
+
},
|
|
13827
|
+
"x-github": {
|
|
13828
|
+
"githubCloudOnly": false,
|
|
13829
|
+
"enabledForGitHubApps": true,
|
|
13830
|
+
"category": "actions",
|
|
13831
|
+
"subcategory": "secrets"
|
|
13832
|
+
},
|
|
13833
|
+
"x-octokit": { "diff": { "ghes-3.4": { "type": "changed" } } }
|
|
13834
|
+
}
|
|
13835
|
+
},
|
|
13741
13836
|
"/orgs/{org}/audit-log": {
|
|
13742
13837
|
"get": {
|
|
13743
13838
|
"summary": "Get the audit log for an organization",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
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" },
|
|
@@ -1442,6 +1442,83 @@
|
|
|
1442
1442
|
"x-octokit": { "diff": { "ghes-3.4.json": { "type": "changed" } } }
|
|
1443
1443
|
}
|
|
1444
1444
|
},
|
|
1445
|
+
"/orgs/{org}/actions/secrets/{secret_name}": {
|
|
1446
|
+
"put": {
|
|
1447
|
+
"summary": "Create or update an organization secret",
|
|
1448
|
+
"description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
|
|
1449
|
+
"tags": ["actions"],
|
|
1450
|
+
"operationId": "actions/create-or-update-org-secret",
|
|
1451
|
+
"externalDocs": {
|
|
1452
|
+
"description": "API method documentation",
|
|
1453
|
+
"url": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-or-update-an-organization-secret"
|
|
1454
|
+
},
|
|
1455
|
+
"parameters": [
|
|
1456
|
+
{ "$ref": "#/components/parameters/org" },
|
|
1457
|
+
{ "$ref": "#/components/parameters/secret-name" }
|
|
1458
|
+
],
|
|
1459
|
+
"requestBody": {
|
|
1460
|
+
"required": true,
|
|
1461
|
+
"content": {
|
|
1462
|
+
"application/json": {
|
|
1463
|
+
"schema": {
|
|
1464
|
+
"type": "object",
|
|
1465
|
+
"properties": {
|
|
1466
|
+
"encrypted_value": {
|
|
1467
|
+
"type": "string",
|
|
1468
|
+
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-organization-public-key) endpoint.",
|
|
1469
|
+
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
|
|
1470
|
+
},
|
|
1471
|
+
"key_id": {
|
|
1472
|
+
"type": "string",
|
|
1473
|
+
"description": "ID of the key you used to encrypt the secret."
|
|
1474
|
+
},
|
|
1475
|
+
"visibility": {
|
|
1476
|
+
"type": "string",
|
|
1477
|
+
"description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.",
|
|
1478
|
+
"enum": ["all", "private", "selected"]
|
|
1479
|
+
},
|
|
1480
|
+
"selected_repository_ids": {
|
|
1481
|
+
"type": "array",
|
|
1482
|
+
"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.3/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/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.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
|
|
1483
|
+
"items": { "type": "integer" }
|
|
1484
|
+
}
|
|
1485
|
+
},
|
|
1486
|
+
"required": ["visibility"]
|
|
1487
|
+
},
|
|
1488
|
+
"examples": {
|
|
1489
|
+
"default": {
|
|
1490
|
+
"value": {
|
|
1491
|
+
"encrypted_value": "c2VjcmV0",
|
|
1492
|
+
"key_id": "012345678912345678",
|
|
1493
|
+
"visibility": "selected",
|
|
1494
|
+
"selected_repository_ids": [1296269, 1296280]
|
|
1495
|
+
}
|
|
1496
|
+
}
|
|
1497
|
+
}
|
|
1498
|
+
}
|
|
1499
|
+
}
|
|
1500
|
+
},
|
|
1501
|
+
"responses": {
|
|
1502
|
+
"201": {
|
|
1503
|
+
"description": "Response when creating a secret",
|
|
1504
|
+
"content": {
|
|
1505
|
+
"application/json": {
|
|
1506
|
+
"schema": { "$ref": "#/components/schemas/empty-object" },
|
|
1507
|
+
"examples": { "default": { "value": null } }
|
|
1508
|
+
}
|
|
1509
|
+
}
|
|
1510
|
+
},
|
|
1511
|
+
"204": { "description": "Response when updating a secret" }
|
|
1512
|
+
},
|
|
1513
|
+
"x-github": {
|
|
1514
|
+
"githubCloudOnly": false,
|
|
1515
|
+
"enabledForGitHubApps": true,
|
|
1516
|
+
"category": "actions",
|
|
1517
|
+
"subcategory": "secrets"
|
|
1518
|
+
},
|
|
1519
|
+
"x-octokit": { "diff": { "ghes-3.4.json": { "type": "changed" } } }
|
|
1520
|
+
}
|
|
1521
|
+
},
|
|
1445
1522
|
"/orgs/{org}/audit-log": {
|
|
1446
1523
|
"get": {
|
|
1447
1524
|
"summary": "Get the audit log for an organization",
|
|
@@ -3321,6 +3398,13 @@
|
|
|
3321
3398
|
"required": true,
|
|
3322
3399
|
"schema": { "type": "string" }
|
|
3323
3400
|
},
|
|
3401
|
+
"secret-name": {
|
|
3402
|
+
"name": "secret_name",
|
|
3403
|
+
"description": "The name of the secret.",
|
|
3404
|
+
"in": "path",
|
|
3405
|
+
"required": true,
|
|
3406
|
+
"schema": { "type": "string" }
|
|
3407
|
+
},
|
|
3324
3408
|
"team-slug": {
|
|
3325
3409
|
"name": "team_slug",
|
|
3326
3410
|
"description": "The slug of the team name.",
|
|
@@ -4111,6 +4195,13 @@
|
|
|
4111
4195
|
"errors": { "type": "array", "items": { "type": "string" } }
|
|
4112
4196
|
}
|
|
4113
4197
|
},
|
|
4198
|
+
"empty-object": {
|
|
4199
|
+
"title": "Empty Object",
|
|
4200
|
+
"description": "An object without any properties.",
|
|
4201
|
+
"type": "object",
|
|
4202
|
+
"properties": {},
|
|
4203
|
+
"additionalProperties": false
|
|
4204
|
+
},
|
|
4114
4205
|
"team-full": {
|
|
4115
4206
|
"title": "Full Team",
|
|
4116
4207
|
"description": "Groups of organization members that gives permissions on specified repositories.",
|