@octokit/openapi 6.6.1 → 6.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.
- package/generated/api.github.com.deref.json +294 -11
- package/generated/api.github.com.json +123 -13
- 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 +40 -6
- package/generated/ghes-3.2.json +46 -4
- package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +39 -5
- package/generated/ghes-3.3-diff-to-ghes-3.4.json +45 -3
- package/generated/ghes-3.3.deref.json +40 -6
- package/generated/ghes-3.3.json +46 -4
- 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 +46 -9
- package/generated/ghes-3.4.json +50 -11
- package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +1 -0
- package/generated/ghes-3.5-diff-to-api.github.com.deref.json +3 -3
- package/generated/ghes-3.5-diff-to-api.github.com.json +3 -3
- package/generated/ghes-3.5.deref.json +62 -11
- package/generated/ghes-3.5.json +66 -13
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +1 -0
- package/generated/github.ae-diff-to-api.github.com.deref.json +1 -1
- package/generated/github.ae-diff-to-api.github.com.json +1 -1
- package/generated/github.ae.deref.json +16 -2
- package/generated/github.ae.json +16 -2
- 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.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
|
|
@@ -13191,6 +13191,18 @@
|
|
|
13191
13191
|
"type": "string"
|
|
13192
13192
|
}
|
|
13193
13193
|
}
|
|
13194
|
+
},
|
|
13195
|
+
"examples": {
|
|
13196
|
+
"default": {
|
|
13197
|
+
"summary": "Create an authorization",
|
|
13198
|
+
"value": {
|
|
13199
|
+
"scopes": ["public_repo"],
|
|
13200
|
+
"note": "optional note",
|
|
13201
|
+
"note_url": "http://optional/note/url",
|
|
13202
|
+
"client_id": "abcde12345fghij67890",
|
|
13203
|
+
"client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f"
|
|
13204
|
+
}
|
|
13205
|
+
}
|
|
13194
13206
|
}
|
|
13195
13207
|
}
|
|
13196
13208
|
}
|
|
@@ -13819,9 +13831,9 @@
|
|
|
13819
13831
|
"name": "client_id",
|
|
13820
13832
|
"in": "path",
|
|
13821
13833
|
"required": true,
|
|
13822
|
-
"description": "The client ID of the
|
|
13834
|
+
"description": "The client ID of the OAuth app.",
|
|
13823
13835
|
"schema": { "type": "string" },
|
|
13824
|
-
"examples": { "default": { "value": "
|
|
13836
|
+
"examples": { "default": { "value": "abcde12345fghij67890" } }
|
|
13825
13837
|
}
|
|
13826
13838
|
],
|
|
13827
13839
|
"requestBody": {
|
|
@@ -13858,6 +13870,17 @@
|
|
|
13858
13870
|
},
|
|
13859
13871
|
"required": ["client_secret"],
|
|
13860
13872
|
"type": "object"
|
|
13873
|
+
},
|
|
13874
|
+
"examples": {
|
|
13875
|
+
"default": {
|
|
13876
|
+
"summary": "Create an authorization for an app",
|
|
13877
|
+
"value": {
|
|
13878
|
+
"client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
|
|
13879
|
+
"scopes": ["public_repo"],
|
|
13880
|
+
"note": "optional note",
|
|
13881
|
+
"note_url": "http://optional/note/url"
|
|
13882
|
+
}
|
|
13883
|
+
}
|
|
13861
13884
|
}
|
|
13862
13885
|
}
|
|
13863
13886
|
}
|
|
@@ -14966,9 +14989,9 @@
|
|
|
14966
14989
|
"name": "client_id",
|
|
14967
14990
|
"in": "path",
|
|
14968
14991
|
"required": true,
|
|
14969
|
-
"description": "The client ID of the
|
|
14992
|
+
"description": "The client ID of the OAuth app.",
|
|
14970
14993
|
"schema": { "type": "string" },
|
|
14971
|
-
"examples": { "default": { "value": "
|
|
14994
|
+
"examples": { "default": { "value": "abcde12345fghij67890" } }
|
|
14972
14995
|
},
|
|
14973
14996
|
{
|
|
14974
14997
|
"name": "fingerprint",
|
|
@@ -15007,6 +15030,17 @@
|
|
|
15007
15030
|
},
|
|
15008
15031
|
"required": ["client_secret"],
|
|
15009
15032
|
"type": "object"
|
|
15033
|
+
},
|
|
15034
|
+
"examples": {
|
|
15035
|
+
"default": {
|
|
15036
|
+
"summary": "Create an authorization for an app and fingerprint",
|
|
15037
|
+
"value": {
|
|
15038
|
+
"client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
|
|
15039
|
+
"scopes": ["public_repo"],
|
|
15040
|
+
"note": "optional note",
|
|
15041
|
+
"note_url": "http://optional/note/url"
|
|
15042
|
+
}
|
|
15043
|
+
}
|
|
15010
15044
|
}
|
|
15011
15045
|
}
|
|
15012
15046
|
}
|
|
@@ -25913,7 +25947,7 @@
|
|
|
25913
25947
|
"/enterprises/{enterprise}/settings/billing/advanced-security": {
|
|
25914
25948
|
"get": {
|
|
25915
25949
|
"summary": "Get GitHub Advanced Security active committers for an enterprise",
|
|
25916
|
-
"description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.",
|
|
25950
|
+
"description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
|
|
25917
25951
|
"tags": ["billing"],
|
|
25918
25952
|
"operationId": "billing/get-github-advanced-security-billing-ghe",
|
|
25919
25953
|
"externalDocs": {
|
|
@@ -77242,7 +77276,7 @@
|
|
|
77242
77276
|
"/orgs/{org}/settings/billing/advanced-security": {
|
|
77243
77277
|
"get": {
|
|
77244
77278
|
"summary": "Get GitHub Advanced Security active committers for an organization",
|
|
77245
|
-
"description": "Gets the GitHub Advanced Security active committers for an organization per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.\nIf this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.",
|
|
77279
|
+
"description": "Gets the GitHub Advanced Security active committers for an organization per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.\n\nIf this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
|
|
77246
77280
|
"tags": ["billing"],
|
|
77247
77281
|
"operationId": "billing/get-github-advanced-security-billing-org",
|
|
77248
77282
|
"externalDocs": {
|
|
@@ -166703,10 +166737,13 @@
|
|
|
166703
166737
|
"content": {
|
|
166704
166738
|
"application/json": {
|
|
166705
166739
|
"schema": {
|
|
166740
|
+
"title": "Empty Object",
|
|
166741
|
+
"description": "An object without any properties.",
|
|
166706
166742
|
"type": "object",
|
|
166707
166743
|
"properties": {},
|
|
166708
166744
|
"additionalProperties": false
|
|
166709
|
-
}
|
|
166745
|
+
},
|
|
166746
|
+
"examples": { "default": { "value": null } }
|
|
166710
166747
|
}
|
|
166711
166748
|
}
|
|
166712
166749
|
},
|
|
@@ -255693,7 +255730,7 @@
|
|
|
255693
255730
|
"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
|
|
255694
255731
|
"get": {
|
|
255695
255732
|
"summary": "List requested reviewers for a pull request",
|
|
255696
|
-
"description": "",
|
|
255733
|
+
"description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.4/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
|
|
255697
255734
|
"tags": ["pulls"],
|
|
255698
255735
|
"operationId": "pulls/list-requested-reviewers",
|
|
255699
255736
|
"externalDocs": {
|
package/generated/ghes-3.4.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
4
|
+
"version": "6.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
|
|
@@ -2941,6 +2941,18 @@
|
|
|
2941
2941
|
"type": "string"
|
|
2942
2942
|
}
|
|
2943
2943
|
}
|
|
2944
|
+
},
|
|
2945
|
+
"examples": {
|
|
2946
|
+
"default": {
|
|
2947
|
+
"summary": "Create an authorization",
|
|
2948
|
+
"value": {
|
|
2949
|
+
"scopes": ["public_repo"],
|
|
2950
|
+
"note": "optional note",
|
|
2951
|
+
"note_url": "http://optional/note/url",
|
|
2952
|
+
"client_id": "abcde12345fghij67890",
|
|
2953
|
+
"client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f"
|
|
2954
|
+
}
|
|
2955
|
+
}
|
|
2944
2956
|
}
|
|
2945
2957
|
}
|
|
2946
2958
|
}
|
|
@@ -2991,7 +3003,7 @@
|
|
|
2991
3003
|
"description": "API method documentation",
|
|
2992
3004
|
"url": "https://docs.github.com/enterprise-server@3.4/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app"
|
|
2993
3005
|
},
|
|
2994
|
-
"parameters": [{ "$ref": "#/components/parameters/client-id" }],
|
|
3006
|
+
"parameters": [{ "$ref": "#/components/parameters/oauth-client-id" }],
|
|
2995
3007
|
"requestBody": {
|
|
2996
3008
|
"required": true,
|
|
2997
3009
|
"content": {
|
|
@@ -3026,6 +3038,17 @@
|
|
|
3026
3038
|
},
|
|
3027
3039
|
"required": ["client_secret"],
|
|
3028
3040
|
"type": "object"
|
|
3041
|
+
},
|
|
3042
|
+
"examples": {
|
|
3043
|
+
"default": {
|
|
3044
|
+
"summary": "Create an authorization for an app",
|
|
3045
|
+
"value": {
|
|
3046
|
+
"client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
|
|
3047
|
+
"scopes": ["public_repo"],
|
|
3048
|
+
"note": "optional note",
|
|
3049
|
+
"note_url": "http://optional/note/url"
|
|
3050
|
+
}
|
|
3051
|
+
}
|
|
3029
3052
|
}
|
|
3030
3053
|
}
|
|
3031
3054
|
}
|
|
@@ -3095,7 +3118,7 @@
|
|
|
3095
3118
|
"url": "https://docs.github.com/enterprise-server@3.4/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint"
|
|
3096
3119
|
},
|
|
3097
3120
|
"parameters": [
|
|
3098
|
-
{ "$ref": "#/components/parameters/client-id" },
|
|
3121
|
+
{ "$ref": "#/components/parameters/oauth-client-id" },
|
|
3099
3122
|
{
|
|
3100
3123
|
"name": "fingerprint",
|
|
3101
3124
|
"in": "path",
|
|
@@ -3133,6 +3156,17 @@
|
|
|
3133
3156
|
},
|
|
3134
3157
|
"required": ["client_secret"],
|
|
3135
3158
|
"type": "object"
|
|
3159
|
+
},
|
|
3160
|
+
"examples": {
|
|
3161
|
+
"default": {
|
|
3162
|
+
"summary": "Create an authorization for an app and fingerprint",
|
|
3163
|
+
"value": {
|
|
3164
|
+
"client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
|
|
3165
|
+
"scopes": ["public_repo"],
|
|
3166
|
+
"note": "optional note",
|
|
3167
|
+
"note_url": "http://optional/note/url"
|
|
3168
|
+
}
|
|
3169
|
+
}
|
|
3136
3170
|
}
|
|
3137
3171
|
}
|
|
3138
3172
|
}
|
|
@@ -5270,7 +5304,7 @@
|
|
|
5270
5304
|
"/enterprises/{enterprise}/settings/billing/advanced-security": {
|
|
5271
5305
|
"get": {
|
|
5272
5306
|
"summary": "Get GitHub Advanced Security active committers for an enterprise",
|
|
5273
|
-
"description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.",
|
|
5307
|
+
"description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
|
|
5274
5308
|
"tags": ["billing"],
|
|
5275
5309
|
"operationId": "billing/get-github-advanced-security-billing-ghe",
|
|
5276
5310
|
"externalDocs": {
|
|
@@ -11674,7 +11708,7 @@
|
|
|
11674
11708
|
"/orgs/{org}/settings/billing/advanced-security": {
|
|
11675
11709
|
"get": {
|
|
11676
11710
|
"summary": "Get GitHub Advanced Security active committers for an organization",
|
|
11677
|
-
"description": "Gets the GitHub Advanced Security active committers for an organization per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.\nIf this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.",
|
|
11711
|
+
"description": "Gets the GitHub Advanced Security active committers for an organization per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.\n\nIf this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
|
|
11678
11712
|
"tags": ["billing"],
|
|
11679
11713
|
"operationId": "billing/get-github-advanced-security-billing-org",
|
|
11680
11714
|
"externalDocs": {
|
|
@@ -22247,11 +22281,8 @@
|
|
|
22247
22281
|
"description": "Response when creating a secret",
|
|
22248
22282
|
"content": {
|
|
22249
22283
|
"application/json": {
|
|
22250
|
-
"schema": {
|
|
22251
|
-
|
|
22252
|
-
"properties": {},
|
|
22253
|
-
"additionalProperties": false
|
|
22254
|
-
}
|
|
22284
|
+
"schema": { "$ref": "#/components/schemas/empty-object" },
|
|
22285
|
+
"examples": { "default": { "value": null } }
|
|
22255
22286
|
}
|
|
22256
22287
|
}
|
|
22257
22288
|
},
|
|
@@ -29444,7 +29475,7 @@
|
|
|
29444
29475
|
"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
|
|
29445
29476
|
"get": {
|
|
29446
29477
|
"summary": "List requested reviewers for a pull request",
|
|
29447
|
-
"description": "",
|
|
29478
|
+
"description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.4/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
|
|
29448
29479
|
"tags": ["pulls"],
|
|
29449
29480
|
"operationId": "pulls/list-requested-reviewers",
|
|
29450
29481
|
"externalDocs": {
|
|
@@ -75744,6 +75775,14 @@
|
|
|
75744
75775
|
"required": true,
|
|
75745
75776
|
"schema": { "type": "string" }
|
|
75746
75777
|
},
|
|
75778
|
+
"oauth-client-id": {
|
|
75779
|
+
"name": "client_id",
|
|
75780
|
+
"in": "path",
|
|
75781
|
+
"required": true,
|
|
75782
|
+
"description": "The client ID of the OAuth app.",
|
|
75783
|
+
"schema": { "type": "string" },
|
|
75784
|
+
"examples": { "default": { "value": "abcde12345fghij67890" } }
|
|
75785
|
+
},
|
|
75747
75786
|
"authorization-id": {
|
|
75748
75787
|
"name": "authorization_id",
|
|
75749
75788
|
"description": "The unique identifier of the authorization.",
|
|
@@ -12598,6 +12598,7 @@
|
|
|
12598
12598
|
"/repos/{owner}/{repo}/codespaces": ["get", "post"],
|
|
12599
12599
|
"/repos/{owner}/{repo}/codespaces/devcontainers": ["get"],
|
|
12600
12600
|
"/repos/{owner}/{repo}/codespaces/machines": ["get"],
|
|
12601
|
+
"/repos/{owner}/{repo}/codespaces/new": ["get"],
|
|
12601
12602
|
"/repos/{owner}/{repo}/codespaces/secrets": ["get"],
|
|
12602
12603
|
"/repos/{owner}/{repo}/codespaces/secrets/public-key": ["get"],
|
|
12603
12604
|
"/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": [
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
4
|
+
"version": "6.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
|
|
@@ -28967,7 +28967,7 @@
|
|
|
28967
28967
|
"/orgs/{org}/code-scanning/alerts": {
|
|
28968
28968
|
"get": {
|
|
28969
28969
|
"summary": "List code scanning alerts for an organization",
|
|
28970
|
-
"description": "Lists
|
|
28970
|
+
"description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.",
|
|
28971
28971
|
"tags": ["code-scanning"],
|
|
28972
28972
|
"operationId": "code-scanning/list-alerts-for-org",
|
|
28973
28973
|
"externalDocs": {
|
|
@@ -29042,7 +29042,7 @@
|
|
|
29042
29042
|
},
|
|
29043
29043
|
{
|
|
29044
29044
|
"name": "state",
|
|
29045
|
-
"description": "
|
|
29045
|
+
"description": "If specified, only code scanning alerts with this state will be returned.",
|
|
29046
29046
|
"in": "query",
|
|
29047
29047
|
"required": false,
|
|
29048
29048
|
"schema": {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
4
|
+
"version": "6.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
|
|
@@ -3589,7 +3589,7 @@
|
|
|
3589
3589
|
"/orgs/{org}/code-scanning/alerts": {
|
|
3590
3590
|
"get": {
|
|
3591
3591
|
"summary": "List code scanning alerts for an organization",
|
|
3592
|
-
"description": "Lists
|
|
3592
|
+
"description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.",
|
|
3593
3593
|
"tags": ["code-scanning"],
|
|
3594
3594
|
"operationId": "code-scanning/list-alerts-for-org",
|
|
3595
3595
|
"externalDocs": {
|
|
@@ -3607,7 +3607,7 @@
|
|
|
3607
3607
|
{ "$ref": "#/components/parameters/direction" },
|
|
3608
3608
|
{
|
|
3609
3609
|
"name": "state",
|
|
3610
|
-
"description": "
|
|
3610
|
+
"description": "If specified, only code scanning alerts with this state will be returned.",
|
|
3611
3611
|
"in": "query",
|
|
3612
3612
|
"required": false,
|
|
3613
3613
|
"schema": {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
4
|
+
"version": "6.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
|
|
@@ -13191,6 +13191,18 @@
|
|
|
13191
13191
|
"type": "string"
|
|
13192
13192
|
}
|
|
13193
13193
|
}
|
|
13194
|
+
},
|
|
13195
|
+
"examples": {
|
|
13196
|
+
"default": {
|
|
13197
|
+
"summary": "Create an authorization",
|
|
13198
|
+
"value": {
|
|
13199
|
+
"scopes": ["public_repo"],
|
|
13200
|
+
"note": "optional note",
|
|
13201
|
+
"note_url": "http://optional/note/url",
|
|
13202
|
+
"client_id": "abcde12345fghij67890",
|
|
13203
|
+
"client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f"
|
|
13204
|
+
}
|
|
13205
|
+
}
|
|
13194
13206
|
}
|
|
13195
13207
|
}
|
|
13196
13208
|
}
|
|
@@ -13819,9 +13831,9 @@
|
|
|
13819
13831
|
"name": "client_id",
|
|
13820
13832
|
"in": "path",
|
|
13821
13833
|
"required": true,
|
|
13822
|
-
"description": "The client ID of the
|
|
13834
|
+
"description": "The client ID of the OAuth app.",
|
|
13823
13835
|
"schema": { "type": "string" },
|
|
13824
|
-
"examples": { "default": { "value": "
|
|
13836
|
+
"examples": { "default": { "value": "abcde12345fghij67890" } }
|
|
13825
13837
|
}
|
|
13826
13838
|
],
|
|
13827
13839
|
"requestBody": {
|
|
@@ -13858,6 +13870,17 @@
|
|
|
13858
13870
|
},
|
|
13859
13871
|
"required": ["client_secret"],
|
|
13860
13872
|
"type": "object"
|
|
13873
|
+
},
|
|
13874
|
+
"examples": {
|
|
13875
|
+
"default": {
|
|
13876
|
+
"summary": "Create an authorization for an app",
|
|
13877
|
+
"value": {
|
|
13878
|
+
"client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
|
|
13879
|
+
"scopes": ["public_repo"],
|
|
13880
|
+
"note": "optional note",
|
|
13881
|
+
"note_url": "http://optional/note/url"
|
|
13882
|
+
}
|
|
13883
|
+
}
|
|
13861
13884
|
}
|
|
13862
13885
|
}
|
|
13863
13886
|
}
|
|
@@ -14966,9 +14989,9 @@
|
|
|
14966
14989
|
"name": "client_id",
|
|
14967
14990
|
"in": "path",
|
|
14968
14991
|
"required": true,
|
|
14969
|
-
"description": "The client ID of the
|
|
14992
|
+
"description": "The client ID of the OAuth app.",
|
|
14970
14993
|
"schema": { "type": "string" },
|
|
14971
|
-
"examples": { "default": { "value": "
|
|
14994
|
+
"examples": { "default": { "value": "abcde12345fghij67890" } }
|
|
14972
14995
|
},
|
|
14973
14996
|
{
|
|
14974
14997
|
"name": "fingerprint",
|
|
@@ -15007,6 +15030,17 @@
|
|
|
15007
15030
|
},
|
|
15008
15031
|
"required": ["client_secret"],
|
|
15009
15032
|
"type": "object"
|
|
15033
|
+
},
|
|
15034
|
+
"examples": {
|
|
15035
|
+
"default": {
|
|
15036
|
+
"summary": "Create an authorization for an app and fingerprint",
|
|
15037
|
+
"value": {
|
|
15038
|
+
"client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
|
|
15039
|
+
"scopes": ["public_repo"],
|
|
15040
|
+
"note": "optional note",
|
|
15041
|
+
"note_url": "http://optional/note/url"
|
|
15042
|
+
}
|
|
15043
|
+
}
|
|
15010
15044
|
}
|
|
15011
15045
|
}
|
|
15012
15046
|
}
|
|
@@ -26244,7 +26278,7 @@
|
|
|
26244
26278
|
"/enterprises/{enterprise}/settings/billing/advanced-security": {
|
|
26245
26279
|
"get": {
|
|
26246
26280
|
"summary": "Get GitHub Advanced Security active committers for an enterprise",
|
|
26247
|
-
"description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.",
|
|
26281
|
+
"description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
|
|
26248
26282
|
"tags": ["billing"],
|
|
26249
26283
|
"operationId": "billing/get-github-advanced-security-billing-ghe",
|
|
26250
26284
|
"externalDocs": {
|
|
@@ -57885,7 +57919,7 @@
|
|
|
57885
57919
|
"/orgs/{org}/code-scanning/alerts": {
|
|
57886
57920
|
"get": {
|
|
57887
57921
|
"summary": "List code scanning alerts for an organization",
|
|
57888
|
-
"description": "Lists
|
|
57922
|
+
"description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.",
|
|
57889
57923
|
"tags": ["code-scanning"],
|
|
57890
57924
|
"operationId": "code-scanning/list-alerts-for-org",
|
|
57891
57925
|
"externalDocs": {
|
|
@@ -57960,7 +57994,7 @@
|
|
|
57960
57994
|
},
|
|
57961
57995
|
{
|
|
57962
57996
|
"name": "state",
|
|
57963
|
-
"description": "
|
|
57997
|
+
"description": "If specified, only code scanning alerts with this state will be returned.",
|
|
57964
57998
|
"in": "query",
|
|
57965
57999
|
"required": false,
|
|
57966
58000
|
"schema": {
|
|
@@ -79142,7 +79176,7 @@
|
|
|
79142
79176
|
"/orgs/{org}/settings/billing/advanced-security": {
|
|
79143
79177
|
"get": {
|
|
79144
79178
|
"summary": "Get GitHub Advanced Security active committers for an organization",
|
|
79145
|
-
"description": "Gets the GitHub Advanced Security active committers for an organization per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.\nIf this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.",
|
|
79179
|
+
"description": "Gets the GitHub Advanced Security active committers for an organization per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.\n\nIf this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
|
|
79146
79180
|
"tags": ["billing"],
|
|
79147
79181
|
"operationId": "billing/get-github-advanced-security-billing-org",
|
|
79148
79182
|
"externalDocs": {
|
|
@@ -173701,10 +173735,13 @@
|
|
|
173701
173735
|
"content": {
|
|
173702
173736
|
"application/json": {
|
|
173703
173737
|
"schema": {
|
|
173738
|
+
"title": "Empty Object",
|
|
173739
|
+
"description": "An object without any properties.",
|
|
173704
173740
|
"type": "object",
|
|
173705
173741
|
"properties": {},
|
|
173706
173742
|
"additionalProperties": false
|
|
173707
|
-
}
|
|
173743
|
+
},
|
|
173744
|
+
"examples": { "default": { "value": null } }
|
|
173708
173745
|
}
|
|
173709
173746
|
}
|
|
173710
173747
|
},
|
|
@@ -262695,7 +262732,7 @@
|
|
|
262695
262732
|
"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
|
|
262696
262733
|
"get": {
|
|
262697
262734
|
"summary": "List requested reviewers for a pull request",
|
|
262698
|
-
"description": "",
|
|
262735
|
+
"description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.5/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
|
|
262699
262736
|
"tags": ["pulls"],
|
|
262700
262737
|
"operationId": "pulls/list-requested-reviewers",
|
|
262701
262738
|
"externalDocs": {
|
|
@@ -351601,6 +351638,20 @@
|
|
|
351601
351638
|
"responses": { "501": { "description": "Not Implemented" } }
|
|
351602
351639
|
}
|
|
351603
351640
|
},
|
|
351641
|
+
"/repos/{owner}/{repo}/codespaces/new": {
|
|
351642
|
+
"get": {
|
|
351643
|
+
"summary": "Get default attributes for a codespace",
|
|
351644
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.5. It was added in api.github.com",
|
|
351645
|
+
"tags": ["codespaces"],
|
|
351646
|
+
"operationId": "codespaces/pre-flight-with-repo-for-authenticated-user",
|
|
351647
|
+
"externalDocs": {
|
|
351648
|
+
"description": "API method documentation",
|
|
351649
|
+
"url": "https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace"
|
|
351650
|
+
},
|
|
351651
|
+
"x-octokit": { "api.github.com": "removed" },
|
|
351652
|
+
"responses": { "501": { "description": "Not Implemented" } }
|
|
351653
|
+
}
|
|
351654
|
+
},
|
|
351604
351655
|
"/repos/{owner}/{repo}/codespaces/secrets": {
|
|
351605
351656
|
"get": {
|
|
351606
351657
|
"summary": "List repository secrets",
|