@octokit/openapi 6.2.1 → 6.4.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 +7689 -7772
- package/generated/api.github.com.json +1344 -1295
- 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 +50 -3
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +53 -3
- package/generated/ghes-3.2.deref.json +73 -7
- package/generated/ghes-3.2.json +89 -28
- package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +31 -4
- 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 +76 -10
- package/generated/ghes-3.3.json +92 -31
- 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 +97 -19
- package/generated/ghes-3.4.json +105 -40
- package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +71 -25
- package/generated/ghes-3.5-diff-to-api.github.com.deref.json +328 -574
- package/generated/ghes-3.5-diff-to-api.github.com.json +206 -272
- package/generated/ghes-3.5.deref.json +115 -52
- package/generated/ghes-3.5.json +131 -77
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +97 -4
- 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 +92 -119
- package/generated/github.ae.json +118 -95
- package/package.json +1 -1
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.4.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
|
}
|
|
@@ -19142,7 +19142,6 @@
|
|
|
19142
19142
|
"200": {
|
|
19143
19143
|
"description": "Response",
|
|
19144
19144
|
"content": {
|
|
19145
|
-
"application/json+sarif": { "schema": { "type": "string" } },
|
|
19146
19145
|
"application/json": {
|
|
19147
19146
|
"schema": {
|
|
19148
19147
|
"$ref": "#/components/schemas/code-scanning-analysis"
|
|
@@ -19152,6 +19151,14 @@
|
|
|
19152
19151
|
"$ref": "#/components/examples/code-scanning-analysis-default"
|
|
19153
19152
|
}
|
|
19154
19153
|
}
|
|
19154
|
+
},
|
|
19155
|
+
"application/json+sarif": {
|
|
19156
|
+
"schema": { "type": "object", "additionalProperties": true },
|
|
19157
|
+
"examples": {
|
|
19158
|
+
"response": {
|
|
19159
|
+
"$ref": "#/components/examples/code-scanning-analysis-sarif"
|
|
19160
|
+
}
|
|
19161
|
+
}
|
|
19155
19162
|
}
|
|
19156
19163
|
}
|
|
19157
19164
|
},
|
|
@@ -19271,6 +19278,15 @@
|
|
|
19271
19278
|
}
|
|
19272
19279
|
},
|
|
19273
19280
|
"required": ["commit_sha", "ref", "sarif"]
|
|
19281
|
+
},
|
|
19282
|
+
"examples": {
|
|
19283
|
+
"default": {
|
|
19284
|
+
"value": {
|
|
19285
|
+
"commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da",
|
|
19286
|
+
"ref": "refs/heads/master",
|
|
19287
|
+
"sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA"
|
|
19288
|
+
}
|
|
19289
|
+
}
|
|
19274
19290
|
}
|
|
19275
19291
|
}
|
|
19276
19292
|
}
|
|
@@ -21819,7 +21835,7 @@
|
|
|
21819
21835
|
}
|
|
21820
21836
|
},
|
|
21821
21837
|
"deployment_branch_policy": {
|
|
21822
|
-
"$ref": "#/components/schemas/
|
|
21838
|
+
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
21823
21839
|
}
|
|
21824
21840
|
},
|
|
21825
21841
|
"additionalProperties": false
|
|
@@ -24610,7 +24626,7 @@
|
|
|
24610
24626
|
"operationId": "issues/remove-assignees",
|
|
24611
24627
|
"externalDocs": {
|
|
24612
24628
|
"description": "API method documentation",
|
|
24613
|
-
"url": "https://docs.github.com/
|
|
24629
|
+
"url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
|
|
24614
24630
|
},
|
|
24615
24631
|
"parameters": [
|
|
24616
24632
|
{ "$ref": "#/components/parameters/owner" },
|
|
@@ -24618,6 +24634,7 @@
|
|
|
24618
24634
|
{ "$ref": "#/components/parameters/issue-number" }
|
|
24619
24635
|
],
|
|
24620
24636
|
"requestBody": {
|
|
24637
|
+
"required": true,
|
|
24621
24638
|
"content": {
|
|
24622
24639
|
"application/json": {
|
|
24623
24640
|
"schema": {
|
|
@@ -24628,7 +24645,8 @@
|
|
|
24628
24645
|
"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
24646
|
"items": { "type": "string" }
|
|
24630
24647
|
}
|
|
24631
|
-
}
|
|
24648
|
+
},
|
|
24649
|
+
"required": ["assignees"]
|
|
24632
24650
|
},
|
|
24633
24651
|
"examples": {
|
|
24634
24652
|
"default": { "value": { "assignees": ["hubot", "other_user"] } }
|
|
@@ -40713,7 +40731,7 @@
|
|
|
40713
40731
|
],
|
|
40714
40732
|
"nullable": true
|
|
40715
40733
|
},
|
|
40716
|
-
"
|
|
40734
|
+
"author-association": {
|
|
40717
40735
|
"title": "author_association",
|
|
40718
40736
|
"type": "string",
|
|
40719
40737
|
"example": "OWNER",
|
|
@@ -40879,7 +40897,7 @@
|
|
|
40879
40897
|
"$ref": "#/components/schemas/nullable-integration"
|
|
40880
40898
|
},
|
|
40881
40899
|
"author_association": {
|
|
40882
|
-
"$ref": "#/components/schemas/
|
|
40900
|
+
"$ref": "#/components/schemas/author-association"
|
|
40883
40901
|
},
|
|
40884
40902
|
"reactions": { "$ref": "#/components/schemas/reaction-rollup" }
|
|
40885
40903
|
},
|
|
@@ -40945,7 +40963,7 @@
|
|
|
40945
40963
|
},
|
|
40946
40964
|
"issue_url": { "type": "string", "format": "uri" },
|
|
40947
40965
|
"author_association": {
|
|
40948
|
-
"$ref": "#/components/schemas/
|
|
40966
|
+
"$ref": "#/components/schemas/author-association"
|
|
40949
40967
|
},
|
|
40950
40968
|
"performed_via_github_app": {
|
|
40951
40969
|
"$ref": "#/components/schemas/nullable-integration"
|
|
@@ -41420,7 +41438,7 @@
|
|
|
41420
41438
|
"example": "2011-04-18T23:23:56Z"
|
|
41421
41439
|
},
|
|
41422
41440
|
"author_association": {
|
|
41423
|
-
"$ref": "#/components/schemas/
|
|
41441
|
+
"$ref": "#/components/schemas/author-association"
|
|
41424
41442
|
}
|
|
41425
41443
|
},
|
|
41426
41444
|
"required": [
|
|
@@ -47140,7 +47158,7 @@
|
|
|
47140
47158
|
"created_at": { "type": "string", "format": "date-time" },
|
|
47141
47159
|
"updated_at": { "type": "string", "format": "date-time" },
|
|
47142
47160
|
"author_association": {
|
|
47143
|
-
"$ref": "#/components/schemas/
|
|
47161
|
+
"$ref": "#/components/schemas/author-association"
|
|
47144
47162
|
},
|
|
47145
47163
|
"reactions": { "$ref": "#/components/schemas/reaction-rollup" }
|
|
47146
47164
|
},
|
|
@@ -47185,7 +47203,7 @@
|
|
|
47185
47203
|
"properties": { "href": { "type": "string" } },
|
|
47186
47204
|
"required": ["href"]
|
|
47187
47205
|
},
|
|
47188
|
-
"
|
|
47206
|
+
"auto-merge": {
|
|
47189
47207
|
"title": "Auto merge",
|
|
47190
47208
|
"description": "The status of auto merging a pull request.",
|
|
47191
47209
|
"type": "object",
|
|
@@ -47401,9 +47419,9 @@
|
|
|
47401
47419
|
]
|
|
47402
47420
|
},
|
|
47403
47421
|
"author_association": {
|
|
47404
|
-
"$ref": "#/components/schemas/
|
|
47422
|
+
"$ref": "#/components/schemas/author-association"
|
|
47405
47423
|
},
|
|
47406
|
-
"auto_merge": { "$ref": "#/components/schemas/
|
|
47424
|
+
"auto_merge": { "$ref": "#/components/schemas/auto-merge" },
|
|
47407
47425
|
"draft": {
|
|
47408
47426
|
"description": "Indicates whether or not the pull request is a draft.",
|
|
47409
47427
|
"example": false,
|
|
@@ -48127,7 +48145,7 @@
|
|
|
48127
48145
|
"example": 30,
|
|
48128
48146
|
"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
48147
|
},
|
|
48130
|
-
"
|
|
48148
|
+
"deployment-branch-policy": {
|
|
48131
48149
|
"type": "object",
|
|
48132
48150
|
"description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.",
|
|
48133
48151
|
"properties": {
|
|
@@ -48248,7 +48266,7 @@
|
|
|
48248
48266
|
}
|
|
48249
48267
|
},
|
|
48250
48268
|
"deployment_branch_policy": {
|
|
48251
|
-
"$ref": "#/components/schemas/
|
|
48269
|
+
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
48252
48270
|
}
|
|
48253
48271
|
},
|
|
48254
48272
|
"required": [
|
|
@@ -48765,7 +48783,7 @@
|
|
|
48765
48783
|
"$ref": "#/components/schemas/nullable-integration"
|
|
48766
48784
|
},
|
|
48767
48785
|
"author_association": {
|
|
48768
|
-
"$ref": "#/components/schemas/
|
|
48786
|
+
"$ref": "#/components/schemas/author-association"
|
|
48769
48787
|
},
|
|
48770
48788
|
"reactions": { "$ref": "#/components/schemas/reaction-rollup" }
|
|
48771
48789
|
},
|
|
@@ -48895,7 +48913,7 @@
|
|
|
48895
48913
|
},
|
|
48896
48914
|
"rename": { "$ref": "#/components/schemas/issue-event-rename" },
|
|
48897
48915
|
"author_association": {
|
|
48898
|
-
"$ref": "#/components/schemas/
|
|
48916
|
+
"$ref": "#/components/schemas/author-association"
|
|
48899
48917
|
},
|
|
48900
48918
|
"lock_reason": { "type": "string", "nullable": true },
|
|
48901
48919
|
"performed_via_github_app": {
|
|
@@ -49598,7 +49616,7 @@
|
|
|
49598
49616
|
},
|
|
49599
49617
|
"issue_url": { "type": "string", "format": "uri" },
|
|
49600
49618
|
"author_association": {
|
|
49601
|
-
"$ref": "#/components/schemas/
|
|
49619
|
+
"$ref": "#/components/schemas/author-association"
|
|
49602
49620
|
},
|
|
49603
49621
|
"performed_via_github_app": {
|
|
49604
49622
|
"$ref": "#/components/schemas/nullable-integration"
|
|
@@ -49813,7 +49831,7 @@
|
|
|
49813
49831
|
"body_html": { "type": "string" },
|
|
49814
49832
|
"body_text": { "type": "string" },
|
|
49815
49833
|
"author_association": {
|
|
49816
|
-
"$ref": "#/components/schemas/
|
|
49834
|
+
"$ref": "#/components/schemas/author-association"
|
|
49817
49835
|
}
|
|
49818
49836
|
},
|
|
49819
49837
|
"required": [
|
|
@@ -49920,7 +49938,7 @@
|
|
|
49920
49938
|
"example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
|
|
49921
49939
|
},
|
|
49922
49940
|
"author_association": {
|
|
49923
|
-
"$ref": "#/components/schemas/
|
|
49941
|
+
"$ref": "#/components/schemas/author-association"
|
|
49924
49942
|
},
|
|
49925
49943
|
"_links": {
|
|
49926
49944
|
"type": "object",
|
|
@@ -51359,9 +51377,9 @@
|
|
|
51359
51377
|
]
|
|
51360
51378
|
},
|
|
51361
51379
|
"author_association": {
|
|
51362
|
-
"$ref": "#/components/schemas/
|
|
51380
|
+
"$ref": "#/components/schemas/author-association"
|
|
51363
51381
|
},
|
|
51364
|
-
"auto_merge": { "$ref": "#/components/schemas/
|
|
51382
|
+
"auto_merge": { "$ref": "#/components/schemas/auto-merge" },
|
|
51365
51383
|
"draft": {
|
|
51366
51384
|
"description": "Indicates whether or not the pull request is a draft.",
|
|
51367
51385
|
"example": false,
|
|
@@ -51516,7 +51534,7 @@
|
|
|
51516
51534
|
"body_html": { "type": "string" },
|
|
51517
51535
|
"body_text": { "type": "string" },
|
|
51518
51536
|
"author_association": {
|
|
51519
|
-
"$ref": "#/components/schemas/
|
|
51537
|
+
"$ref": "#/components/schemas/author-association"
|
|
51520
51538
|
}
|
|
51521
51539
|
},
|
|
51522
51540
|
"required": [
|
|
@@ -51591,7 +51609,7 @@
|
|
|
51591
51609
|
"example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
|
|
51592
51610
|
},
|
|
51593
51611
|
"author_association": {
|
|
51594
|
-
"$ref": "#/components/schemas/
|
|
51612
|
+
"$ref": "#/components/schemas/author-association"
|
|
51595
51613
|
},
|
|
51596
51614
|
"_links": {
|
|
51597
51615
|
"type": "object",
|
|
@@ -52199,7 +52217,7 @@
|
|
|
52199
52217
|
"body": { "type": "string" },
|
|
52200
52218
|
"score": { "type": "number" },
|
|
52201
52219
|
"author_association": {
|
|
52202
|
-
"$ref": "#/components/schemas/
|
|
52220
|
+
"$ref": "#/components/schemas/author-association"
|
|
52203
52221
|
},
|
|
52204
52222
|
"draft": { "type": "boolean" },
|
|
52205
52223
|
"repository": { "$ref": "#/components/schemas/repository" },
|
|
@@ -63690,7 +63708,7 @@
|
|
|
63690
63708
|
]
|
|
63691
63709
|
},
|
|
63692
63710
|
"code-scanning-analysis-default": {
|
|
63693
|
-
"summary": "
|
|
63711
|
+
"summary": "application/json response",
|
|
63694
63712
|
"value": {
|
|
63695
63713
|
"ref": "refs/heads/main",
|
|
63696
63714
|
"commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
|
|
@@ -63709,6 +63727,49 @@
|
|
|
63709
63727
|
"warning": ""
|
|
63710
63728
|
}
|
|
63711
63729
|
},
|
|
63730
|
+
"code-scanning-analysis-sarif": {
|
|
63731
|
+
"summary": "application/json+sarif response",
|
|
63732
|
+
"value": {
|
|
63733
|
+
"runs": [
|
|
63734
|
+
{
|
|
63735
|
+
"tool": {
|
|
63736
|
+
"driver": {
|
|
63737
|
+
"name": "CodeQL",
|
|
63738
|
+
"organization": "GitHub",
|
|
63739
|
+
"semanticVersion": "1.0.0",
|
|
63740
|
+
"rules": [
|
|
63741
|
+
{
|
|
63742
|
+
"id": "js/unused-local-variable",
|
|
63743
|
+
"name": "js/unused-local-variable"
|
|
63744
|
+
}
|
|
63745
|
+
]
|
|
63746
|
+
}
|
|
63747
|
+
},
|
|
63748
|
+
"results": [
|
|
63749
|
+
{
|
|
63750
|
+
"guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38",
|
|
63751
|
+
"message": { "text": "Unused variable foo." },
|
|
63752
|
+
"locations": [
|
|
63753
|
+
{
|
|
63754
|
+
"physicalLocation": {
|
|
63755
|
+
"artifactLocation": { "uri": "file1.js" },
|
|
63756
|
+
"region": { "startLine": 1 }
|
|
63757
|
+
}
|
|
63758
|
+
}
|
|
63759
|
+
],
|
|
63760
|
+
"ruleId": "js/unused-local-variable",
|
|
63761
|
+
"properties": [
|
|
63762
|
+
{ "github/alertNumber": 2 },
|
|
63763
|
+
{
|
|
63764
|
+
"github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2"
|
|
63765
|
+
}
|
|
63766
|
+
]
|
|
63767
|
+
}
|
|
63768
|
+
]
|
|
63769
|
+
}
|
|
63770
|
+
]
|
|
63771
|
+
}
|
|
63772
|
+
},
|
|
63712
63773
|
"code-scanning-analysis-deletion": {
|
|
63713
63774
|
"summary": "Default response",
|
|
63714
63775
|
"value": {
|
|
@@ -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": {
|
|
@@ -3097,13 +3120,13 @@
|
|
|
3097
3120
|
"style": "form"
|
|
3098
3121
|
},
|
|
3099
3122
|
{
|
|
3100
|
-
"description": "The property by which to sort the results.",
|
|
3123
|
+
"description": "The property by which to sort the results. `number` is deprecated - we recommend that you use `created` instead.",
|
|
3101
3124
|
"in": "query",
|
|
3102
3125
|
"name": "sort",
|
|
3103
3126
|
"required": false,
|
|
3104
3127
|
"schema": {
|
|
3105
|
-
"default": "
|
|
3106
|
-
"enum": ["created", "
|
|
3128
|
+
"default": "created",
|
|
3129
|
+
"enum": ["created", "number", "updated"],
|
|
3107
3130
|
"type": "string"
|
|
3108
3131
|
},
|
|
3109
3132
|
"style": "form"
|
|
@@ -3124,7 +3147,11 @@
|
|
|
3124
3147
|
"properties_changed": { "removed": ["tags"] }
|
|
3125
3148
|
}
|
|
3126
3149
|
},
|
|
3127
|
-
"removed": [
|
|
3150
|
+
"removed": [
|
|
3151
|
+
"dismissed_comment",
|
|
3152
|
+
"fixed_at",
|
|
3153
|
+
"updated_at"
|
|
3154
|
+
]
|
|
3128
3155
|
}
|
|
3129
3156
|
}
|
|
3130
3157
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
4
|
+
"version": "6.4.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.4.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.",
|