@octokit/openapi 7.12.0 → 7.13.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 +767 -33
- package/generated/api.github.com.json +312 -24
- 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 +33 -15
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +23 -14
- package/generated/ghes-3.2.deref.json +48 -30
- package/generated/ghes-3.2.json +33 -24
- package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +2 -2
- package/generated/ghes-3.3-diff-to-ghes-3.4.json +2 -2
- package/generated/ghes-3.3.deref.json +49 -31
- package/generated/ghes-3.3.json +33 -24
- package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +8 -8
- package/generated/ghes-3.4-diff-to-ghes-3.5.json +3 -3
- package/generated/ghes-3.4.deref.json +50 -32
- package/generated/ghes-3.4.json +33 -24
- package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +11 -0
- package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
- package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +19 -19
- package/generated/ghes-3.5-diff-to-ghes-3.6.json +14 -14
- package/generated/ghes-3.5.deref.json +166 -33
- package/generated/ghes-3.5.json +139 -24
- package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +6 -11
- package/generated/ghes-3.6-diff-to-api.github.com.deref.json +3 -3
- package/generated/ghes-3.6-diff-to-api.github.com.json +2 -2
- package/generated/ghes-3.6.deref.json +815 -139
- package/generated/ghes-3.6.json +556 -130
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +6 -0
- package/generated/github.ae-diff-to-api.github.com.deref.json +17 -17
- package/generated/github.ae-diff-to-api.github.com.json +14 -14
- package/generated/github.ae.deref.json +102 -31
- package/generated/github.ae.json +77 -24
- package/package.json +1 -1
package/generated/ghes-3.3.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "7.
|
|
4
|
+
"version": "7.13.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": {
|
|
@@ -8237,7 +8237,7 @@
|
|
|
8237
8237
|
},
|
|
8238
8238
|
{
|
|
8239
8239
|
"name": "state",
|
|
8240
|
-
"description": "Indicates the state of the issues to return.
|
|
8240
|
+
"description": "Indicates the state of the issues to return.",
|
|
8241
8241
|
"in": "query",
|
|
8242
8242
|
"required": false,
|
|
8243
8243
|
"schema": {
|
|
@@ -8255,7 +8255,7 @@
|
|
|
8255
8255
|
},
|
|
8256
8256
|
{
|
|
8257
8257
|
"name": "sort",
|
|
8258
|
-
"description": "What to sort results by.
|
|
8258
|
+
"description": "What to sort results by.",
|
|
8259
8259
|
"in": "query",
|
|
8260
8260
|
"required": false,
|
|
8261
8261
|
"schema": {
|
|
@@ -8497,7 +8497,7 @@
|
|
|
8497
8497
|
"type": "string"
|
|
8498
8498
|
},
|
|
8499
8499
|
"mode": {
|
|
8500
|
-
"description": "The rendering mode.
|
|
8500
|
+
"description": "The rendering mode.",
|
|
8501
8501
|
"enum": [
|
|
8502
8502
|
"markdown",
|
|
8503
8503
|
"gfm"
|
|
@@ -12392,7 +12392,7 @@
|
|
|
12392
12392
|
},
|
|
12393
12393
|
{
|
|
12394
12394
|
"name": "state",
|
|
12395
|
-
"description": "Indicates the state of the issues to return.
|
|
12395
|
+
"description": "Indicates the state of the issues to return.",
|
|
12396
12396
|
"in": "query",
|
|
12397
12397
|
"required": false,
|
|
12398
12398
|
"schema": {
|
|
@@ -12410,7 +12410,7 @@
|
|
|
12410
12410
|
},
|
|
12411
12411
|
{
|
|
12412
12412
|
"name": "sort",
|
|
12413
|
-
"description": "What to sort results by.
|
|
12413
|
+
"description": "What to sort results by.",
|
|
12414
12414
|
"in": "query",
|
|
12415
12415
|
"required": false,
|
|
12416
12416
|
"schema": {
|
|
@@ -13278,7 +13278,7 @@
|
|
|
13278
13278
|
},
|
|
13279
13279
|
{
|
|
13280
13280
|
"name": "state",
|
|
13281
|
-
"description": "Indicates the state of the projects to return.
|
|
13281
|
+
"description": "Indicates the state of the projects to return.",
|
|
13282
13282
|
"in": "query",
|
|
13283
13283
|
"required": false,
|
|
13284
13284
|
"schema": {
|
|
@@ -27320,7 +27320,7 @@
|
|
|
27320
27320
|
},
|
|
27321
27321
|
"put": {
|
|
27322
27322
|
"summary": "Create or update file contents",
|
|
27323
|
-
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
|
|
27323
|
+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
|
|
27324
27324
|
"tags": [
|
|
27325
27325
|
"repos"
|
|
27326
27326
|
],
|
|
@@ -27499,7 +27499,7 @@
|
|
|
27499
27499
|
},
|
|
27500
27500
|
"delete": {
|
|
27501
27501
|
"summary": "Delete a file",
|
|
27502
|
-
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
|
|
27502
|
+
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
|
|
27503
27503
|
"tags": [
|
|
27504
27504
|
"repos"
|
|
27505
27505
|
],
|
|
@@ -29048,7 +29048,7 @@
|
|
|
29048
29048
|
},
|
|
29049
29049
|
{
|
|
29050
29050
|
"name": "sort",
|
|
29051
|
-
"description": "The sort order.
|
|
29051
|
+
"description": "The sort order. `stargazers` will sort by star count.",
|
|
29052
29052
|
"in": "query",
|
|
29053
29053
|
"required": false,
|
|
29054
29054
|
"schema": {
|
|
@@ -31363,7 +31363,7 @@
|
|
|
31363
31363
|
},
|
|
31364
31364
|
{
|
|
31365
31365
|
"name": "state",
|
|
31366
|
-
"description": "Indicates the state of the issues to return.
|
|
31366
|
+
"description": "Indicates the state of the issues to return.",
|
|
31367
31367
|
"in": "query",
|
|
31368
31368
|
"required": false,
|
|
31369
31369
|
"schema": {
|
|
@@ -31408,7 +31408,7 @@
|
|
|
31408
31408
|
},
|
|
31409
31409
|
{
|
|
31410
31410
|
"name": "sort",
|
|
31411
|
-
"description": "What to sort results by.
|
|
31411
|
+
"description": "What to sort results by.",
|
|
31412
31412
|
"in": "query",
|
|
31413
31413
|
"required": false,
|
|
31414
31414
|
"schema": {
|
|
@@ -36000,7 +36000,7 @@
|
|
|
36000
36000
|
},
|
|
36001
36001
|
{
|
|
36002
36002
|
"name": "state",
|
|
36003
|
-
"description": "Indicates the state of the projects to return.
|
|
36003
|
+
"description": "Indicates the state of the projects to return.",
|
|
36004
36004
|
"in": "query",
|
|
36005
36005
|
"required": false,
|
|
36006
36006
|
"schema": {
|
|
@@ -36213,7 +36213,7 @@
|
|
|
36213
36213
|
},
|
|
36214
36214
|
{
|
|
36215
36215
|
"name": "sort",
|
|
36216
|
-
"description": "What to sort results by.
|
|
36216
|
+
"description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.",
|
|
36217
36217
|
"in": "query",
|
|
36218
36218
|
"required": false,
|
|
36219
36219
|
"schema": {
|
|
@@ -36229,7 +36229,7 @@
|
|
|
36229
36229
|
},
|
|
36230
36230
|
{
|
|
36231
36231
|
"name": "direction",
|
|
36232
|
-
"description": "The direction of the sort.
|
|
36232
|
+
"description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
|
|
36233
36233
|
"in": "query",
|
|
36234
36234
|
"required": false,
|
|
36235
36235
|
"schema": {
|
|
@@ -36435,7 +36435,7 @@
|
|
|
36435
36435
|
},
|
|
36436
36436
|
{
|
|
36437
36437
|
"name": "direction",
|
|
36438
|
-
"description": "
|
|
36438
|
+
"description": "The direction to sort results. Ignored without `sort` parameter.",
|
|
36439
36439
|
"in": "query",
|
|
36440
36440
|
"required": false,
|
|
36441
36441
|
"schema": {
|
|
@@ -37066,7 +37066,7 @@
|
|
|
37066
37066
|
},
|
|
37067
37067
|
{
|
|
37068
37068
|
"name": "direction",
|
|
37069
|
-
"description": "
|
|
37069
|
+
"description": "The direction to sort results. Ignored without `sort` parameter.",
|
|
37070
37070
|
"in": "query",
|
|
37071
37071
|
"required": false,
|
|
37072
37072
|
"schema": {
|
|
@@ -46515,7 +46515,7 @@
|
|
|
46515
46515
|
},
|
|
46516
46516
|
{
|
|
46517
46517
|
"name": "state",
|
|
46518
|
-
"description": "Indicates the state of the issues to return.
|
|
46518
|
+
"description": "Indicates the state of the issues to return.",
|
|
46519
46519
|
"in": "query",
|
|
46520
46520
|
"required": false,
|
|
46521
46521
|
"schema": {
|
|
@@ -46533,7 +46533,7 @@
|
|
|
46533
46533
|
},
|
|
46534
46534
|
{
|
|
46535
46535
|
"name": "sort",
|
|
46536
|
-
"description": "What to sort results by.
|
|
46536
|
+
"description": "What to sort results by.",
|
|
46537
46537
|
"in": "query",
|
|
46538
46538
|
"required": false,
|
|
46539
46539
|
"schema": {
|
|
@@ -46893,7 +46893,7 @@
|
|
|
46893
46893
|
"parameters": [
|
|
46894
46894
|
{
|
|
46895
46895
|
"name": "state",
|
|
46896
|
-
"description": "Indicates the state of the memberships to return.
|
|
46896
|
+
"description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.",
|
|
46897
46897
|
"in": "query",
|
|
46898
46898
|
"required": false,
|
|
46899
46899
|
"schema": {
|
|
@@ -48987,7 +48987,7 @@
|
|
|
48987
48987
|
},
|
|
48988
48988
|
{
|
|
48989
48989
|
"name": "state",
|
|
48990
|
-
"description": "Indicates the state of the projects to return.
|
|
48990
|
+
"description": "Indicates the state of the projects to return.",
|
|
48991
48991
|
"in": "query",
|
|
48992
48992
|
"required": false,
|
|
48993
48993
|
"schema": {
|
|
@@ -58566,7 +58566,7 @@
|
|
|
58566
58566
|
"readOnly": true
|
|
58567
58567
|
},
|
|
58568
58568
|
"secret-scanning-alert-state": {
|
|
58569
|
-
"description": "Sets the state of the secret scanning alert.
|
|
58569
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
58570
58570
|
"type": "string",
|
|
58571
58571
|
"enum": [
|
|
58572
58572
|
"open",
|
|
@@ -61263,7 +61263,16 @@
|
|
|
61263
61263
|
"description": "The outcome of the job.",
|
|
61264
61264
|
"example": "success",
|
|
61265
61265
|
"type": "string",
|
|
61266
|
-
"nullable": true
|
|
61266
|
+
"nullable": true,
|
|
61267
|
+
"enum": [
|
|
61268
|
+
"success",
|
|
61269
|
+
"failure",
|
|
61270
|
+
"neutral",
|
|
61271
|
+
"cancelled",
|
|
61272
|
+
"skipped",
|
|
61273
|
+
"timed_out",
|
|
61274
|
+
"action_required"
|
|
61275
|
+
]
|
|
61267
61276
|
},
|
|
61268
61277
|
"started_at": {
|
|
61269
61278
|
"description": "The time that the job started, in ISO 8601 format.",
|
|
@@ -96809,7 +96818,7 @@
|
|
|
96809
96818
|
}
|
|
96810
96819
|
},
|
|
96811
96820
|
"code_scanning_forbidden_write": {
|
|
96812
|
-
"description": "Response if the repository is archived or if
|
|
96821
|
+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
|
|
96813
96822
|
"content": {
|
|
96814
96823
|
"application/json": {
|
|
96815
96824
|
"schema": {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "7.
|
|
4
|
+
"version": "7.13.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": {
|
|
@@ -853,7 +853,7 @@
|
|
|
853
853
|
"description": "The REST API URL of the code locations for this alert."
|
|
854
854
|
},
|
|
855
855
|
"state": {
|
|
856
|
-
"description": "Sets the state of the secret scanning alert.
|
|
856
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
857
857
|
"type": "string",
|
|
858
858
|
"enum": [
|
|
859
859
|
"open",
|
|
@@ -13997,7 +13997,7 @@
|
|
|
13997
13997
|
"description": "The REST API URL of the code locations for this alert."
|
|
13998
13998
|
},
|
|
13999
13999
|
"state": {
|
|
14000
|
-
"description": "Sets the state of the secret scanning alert.
|
|
14000
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
14001
14001
|
"type": "string",
|
|
14002
14002
|
"enum": [
|
|
14003
14003
|
"open",
|
|
@@ -47939,7 +47939,7 @@
|
|
|
47939
47939
|
},
|
|
47940
47940
|
{
|
|
47941
47941
|
"name": "sort",
|
|
47942
|
-
"description": "The sort order.
|
|
47942
|
+
"description": "The sort order. `stargazers` will sort by star count.",
|
|
47943
47943
|
"in": "query",
|
|
47944
47944
|
"required": false,
|
|
47945
47945
|
"schema": {
|
|
@@ -56318,7 +56318,7 @@
|
|
|
56318
56318
|
"description": "The REST API URL of the code locations for this alert."
|
|
56319
56319
|
},
|
|
56320
56320
|
"state": {
|
|
56321
|
-
"description": "Sets the state of the secret scanning alert.
|
|
56321
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
56322
56322
|
"type": "string",
|
|
56323
56323
|
"enum": [
|
|
56324
56324
|
"open",
|
|
@@ -56656,7 +56656,7 @@
|
|
|
56656
56656
|
"description": "The REST API URL of the code locations for this alert."
|
|
56657
56657
|
},
|
|
56658
56658
|
"state": {
|
|
56659
|
-
"description": "Sets the state of the secret scanning alert.
|
|
56659
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
56660
56660
|
"type": "string",
|
|
56661
56661
|
"enum": [
|
|
56662
56662
|
"open",
|
|
@@ -56920,7 +56920,7 @@
|
|
|
56920
56920
|
"type": "object",
|
|
56921
56921
|
"properties": {
|
|
56922
56922
|
"state": {
|
|
56923
|
-
"description": "Sets the state of the secret scanning alert.
|
|
56923
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
56924
56924
|
"type": "string",
|
|
56925
56925
|
"enum": [
|
|
56926
56926
|
"open",
|
|
@@ -56998,7 +56998,7 @@
|
|
|
56998
56998
|
"description": "The REST API URL of the code locations for this alert."
|
|
56999
56999
|
},
|
|
57000
57000
|
"state": {
|
|
57001
|
-
"description": "Sets the state of the secret scanning alert.
|
|
57001
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
57002
57002
|
"type": "string",
|
|
57003
57003
|
"enum": [
|
|
57004
57004
|
"open",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "7.
|
|
4
|
+
"version": "7.13.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": {
|
|
@@ -2582,7 +2582,7 @@
|
|
|
2582
2582
|
},
|
|
2583
2583
|
{
|
|
2584
2584
|
"name": "sort",
|
|
2585
|
-
"description": "The sort order.
|
|
2585
|
+
"description": "The sort order. `stargazers` will sort by star count.",
|
|
2586
2586
|
"in": "query",
|
|
2587
2587
|
"required": false,
|
|
2588
2588
|
"schema": {
|
|
@@ -6125,7 +6125,7 @@
|
|
|
6125
6125
|
}
|
|
6126
6126
|
},
|
|
6127
6127
|
"secret-scanning-alert-state": {
|
|
6128
|
-
"description": "Sets the state of the secret scanning alert.
|
|
6128
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
6129
6129
|
"type": "string",
|
|
6130
6130
|
"enum": [
|
|
6131
6131
|
"open",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "7.
|
|
4
|
+
"version": "7.13.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": {
|
|
@@ -32271,7 +32271,7 @@
|
|
|
32271
32271
|
"description": "The REST API URL of the code locations for this alert."
|
|
32272
32272
|
},
|
|
32273
32273
|
"state": {
|
|
32274
|
-
"description": "Sets the state of the secret scanning alert.
|
|
32274
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
32275
32275
|
"type": "string",
|
|
32276
32276
|
"enum": [
|
|
32277
32277
|
"open",
|
|
@@ -48249,7 +48249,7 @@
|
|
|
48249
48249
|
},
|
|
48250
48250
|
{
|
|
48251
48251
|
"name": "state",
|
|
48252
|
-
"description": "Indicates the state of the issues to return.
|
|
48252
|
+
"description": "Indicates the state of the issues to return.",
|
|
48253
48253
|
"in": "query",
|
|
48254
48254
|
"required": false,
|
|
48255
48255
|
"schema": {
|
|
@@ -48273,7 +48273,7 @@
|
|
|
48273
48273
|
},
|
|
48274
48274
|
{
|
|
48275
48275
|
"name": "sort",
|
|
48276
|
-
"description": "What to sort results by.
|
|
48276
|
+
"description": "What to sort results by.",
|
|
48277
48277
|
"in": "query",
|
|
48278
48278
|
"required": false,
|
|
48279
48279
|
"schema": {
|
|
@@ -51499,7 +51499,7 @@
|
|
|
51499
51499
|
"type": "string"
|
|
51500
51500
|
},
|
|
51501
51501
|
"mode": {
|
|
51502
|
-
"description": "The rendering mode.
|
|
51502
|
+
"description": "The rendering mode.",
|
|
51503
51503
|
"enum": [
|
|
51504
51504
|
"markdown",
|
|
51505
51505
|
"gfm"
|
|
@@ -82188,7 +82188,7 @@
|
|
|
82188
82188
|
},
|
|
82189
82189
|
{
|
|
82190
82190
|
"name": "state",
|
|
82191
|
-
"description": "Indicates the state of the issues to return.
|
|
82191
|
+
"description": "Indicates the state of the issues to return.",
|
|
82192
82192
|
"in": "query",
|
|
82193
82193
|
"required": false,
|
|
82194
82194
|
"schema": {
|
|
@@ -82212,7 +82212,7 @@
|
|
|
82212
82212
|
},
|
|
82213
82213
|
{
|
|
82214
82214
|
"name": "sort",
|
|
82215
|
-
"description": "What to sort results by.
|
|
82215
|
+
"description": "What to sort results by.",
|
|
82216
82216
|
"in": "query",
|
|
82217
82217
|
"required": false,
|
|
82218
82218
|
"schema": {
|
|
@@ -92004,7 +92004,7 @@
|
|
|
92004
92004
|
},
|
|
92005
92005
|
{
|
|
92006
92006
|
"name": "state",
|
|
92007
|
-
"description": "Indicates the state of the projects to return.
|
|
92007
|
+
"description": "Indicates the state of the projects to return.",
|
|
92008
92008
|
"in": "query",
|
|
92009
92009
|
"required": false,
|
|
92010
92010
|
"schema": {
|
|
@@ -96749,7 +96749,7 @@
|
|
|
96749
96749
|
"description": "The REST API URL of the code locations for this alert."
|
|
96750
96750
|
},
|
|
96751
96751
|
"state": {
|
|
96752
|
-
"description": "Sets the state of the secret scanning alert.
|
|
96752
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
96753
96753
|
"type": "string",
|
|
96754
96754
|
"enum": [
|
|
96755
96755
|
"open",
|
|
@@ -127576,7 +127576,16 @@
|
|
|
127576
127576
|
"description": "The outcome of the job.",
|
|
127577
127577
|
"example": "success",
|
|
127578
127578
|
"type": "string",
|
|
127579
|
-
"nullable": true
|
|
127579
|
+
"nullable": true,
|
|
127580
|
+
"enum": [
|
|
127581
|
+
"success",
|
|
127582
|
+
"failure",
|
|
127583
|
+
"neutral",
|
|
127584
|
+
"cancelled",
|
|
127585
|
+
"skipped",
|
|
127586
|
+
"timed_out",
|
|
127587
|
+
"action_required"
|
|
127588
|
+
]
|
|
127580
127589
|
},
|
|
127581
127590
|
"started_at": {
|
|
127582
127591
|
"description": "The time that the job started, in ISO 8601 format.",
|
|
@@ -140902,7 +140911,16 @@
|
|
|
140902
140911
|
"description": "The outcome of the job.",
|
|
140903
140912
|
"example": "success",
|
|
140904
140913
|
"type": "string",
|
|
140905
|
-
"nullable": true
|
|
140914
|
+
"nullable": true,
|
|
140915
|
+
"enum": [
|
|
140916
|
+
"success",
|
|
140917
|
+
"failure",
|
|
140918
|
+
"neutral",
|
|
140919
|
+
"cancelled",
|
|
140920
|
+
"skipped",
|
|
140921
|
+
"timed_out",
|
|
140922
|
+
"action_required"
|
|
140923
|
+
]
|
|
140906
140924
|
},
|
|
140907
140925
|
"started_at": {
|
|
140908
140926
|
"description": "The time that the job started, in ISO 8601 format.",
|
|
@@ -184765,7 +184783,7 @@
|
|
|
184765
184783
|
}
|
|
184766
184784
|
},
|
|
184767
184785
|
"403": {
|
|
184768
|
-
"description": "Response if the repository is archived or if
|
|
184786
|
+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
|
|
184769
184787
|
"content": {
|
|
184770
184788
|
"application/json": {
|
|
184771
184789
|
"schema": {
|
|
@@ -185961,7 +185979,7 @@
|
|
|
185961
185979
|
}
|
|
185962
185980
|
},
|
|
185963
185981
|
"403": {
|
|
185964
|
-
"description": "Response if the repository is archived or if
|
|
185982
|
+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
|
|
185965
185983
|
"content": {
|
|
185966
185984
|
"application/json": {
|
|
185967
185985
|
"schema": {
|
|
@@ -186167,7 +186185,7 @@
|
|
|
186167
186185
|
"description": "Bad Request if the sarif field is invalid"
|
|
186168
186186
|
},
|
|
186169
186187
|
"403": {
|
|
186170
|
-
"description": "Response if the repository is archived or if
|
|
186188
|
+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
|
|
186171
186189
|
"content": {
|
|
186172
186190
|
"application/json": {
|
|
186173
186191
|
"schema": {
|
|
@@ -207422,7 +207440,7 @@
|
|
|
207422
207440
|
},
|
|
207423
207441
|
"put": {
|
|
207424
207442
|
"summary": "Create or update file contents",
|
|
207425
|
-
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
|
|
207443
|
+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.4/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
|
|
207426
207444
|
"tags": [
|
|
207427
207445
|
"repos"
|
|
207428
207446
|
],
|
|
@@ -208127,7 +208145,7 @@
|
|
|
208127
208145
|
},
|
|
208128
208146
|
"delete": {
|
|
208129
208147
|
"summary": "Delete a file",
|
|
208130
|
-
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
|
|
208148
|
+
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.4/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
|
|
208131
208149
|
"tags": [
|
|
208132
208150
|
"repos"
|
|
208133
208151
|
],
|
|
@@ -219143,7 +219161,7 @@
|
|
|
219143
219161
|
},
|
|
219144
219162
|
{
|
|
219145
219163
|
"name": "sort",
|
|
219146
|
-
"description": "The sort order.
|
|
219164
|
+
"description": "The sort order. `stargazers` will sort by star count.",
|
|
219147
219165
|
"in": "query",
|
|
219148
219166
|
"required": false,
|
|
219149
219167
|
"schema": {
|
|
@@ -237468,7 +237486,7 @@
|
|
|
237468
237486
|
},
|
|
237469
237487
|
{
|
|
237470
237488
|
"name": "state",
|
|
237471
|
-
"description": "Indicates the state of the issues to return.
|
|
237489
|
+
"description": "Indicates the state of the issues to return.",
|
|
237472
237490
|
"in": "query",
|
|
237473
237491
|
"required": false,
|
|
237474
237492
|
"schema": {
|
|
@@ -237519,7 +237537,7 @@
|
|
|
237519
237537
|
},
|
|
237520
237538
|
{
|
|
237521
237539
|
"name": "sort",
|
|
237522
|
-
"description": "What to sort results by.
|
|
237540
|
+
"description": "What to sort results by.",
|
|
237523
237541
|
"in": "query",
|
|
237524
237542
|
"required": false,
|
|
237525
237543
|
"schema": {
|
|
@@ -297123,7 +297141,7 @@
|
|
|
297123
297141
|
},
|
|
297124
297142
|
{
|
|
297125
297143
|
"name": "state",
|
|
297126
|
-
"description": "Indicates the state of the projects to return.
|
|
297144
|
+
"description": "Indicates the state of the projects to return.",
|
|
297127
297145
|
"in": "query",
|
|
297128
297146
|
"required": false,
|
|
297129
297147
|
"schema": {
|
|
@@ -298103,7 +298121,7 @@
|
|
|
298103
298121
|
},
|
|
298104
298122
|
{
|
|
298105
298123
|
"name": "sort",
|
|
298106
|
-
"description": "What to sort results by.
|
|
298124
|
+
"description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.",
|
|
298107
298125
|
"in": "query",
|
|
298108
298126
|
"required": false,
|
|
298109
298127
|
"schema": {
|
|
@@ -298119,7 +298137,7 @@
|
|
|
298119
298137
|
},
|
|
298120
298138
|
{
|
|
298121
298139
|
"name": "direction",
|
|
298122
|
-
"description": "The direction of the sort.
|
|
298140
|
+
"description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
|
|
298123
298141
|
"in": "query",
|
|
298124
298142
|
"required": false,
|
|
298125
298143
|
"schema": {
|
|
@@ -306099,7 +306117,7 @@
|
|
|
306099
306117
|
},
|
|
306100
306118
|
{
|
|
306101
306119
|
"name": "direction",
|
|
306102
|
-
"description": "
|
|
306120
|
+
"description": "The direction to sort results. Ignored without `sort` parameter.",
|
|
306103
306121
|
"in": "query",
|
|
306104
306122
|
"required": false,
|
|
306105
306123
|
"schema": {
|
|
@@ -315524,7 +315542,7 @@
|
|
|
315524
315542
|
},
|
|
315525
315543
|
{
|
|
315526
315544
|
"name": "direction",
|
|
315527
|
-
"description": "
|
|
315545
|
+
"description": "The direction to sort results. Ignored without `sort` parameter.",
|
|
315528
315546
|
"in": "query",
|
|
315529
315547
|
"required": false,
|
|
315530
315548
|
"schema": {
|
|
@@ -339027,7 +339045,7 @@
|
|
|
339027
339045
|
"description": "The REST API URL of the code locations for this alert."
|
|
339028
339046
|
},
|
|
339029
339047
|
"state": {
|
|
339030
|
-
"description": "Sets the state of the secret scanning alert.
|
|
339048
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
339031
339049
|
"type": "string",
|
|
339032
339050
|
"enum": [
|
|
339033
339051
|
"open",
|
|
@@ -339365,7 +339383,7 @@
|
|
|
339365
339383
|
"description": "The REST API URL of the code locations for this alert."
|
|
339366
339384
|
},
|
|
339367
339385
|
"state": {
|
|
339368
|
-
"description": "Sets the state of the secret scanning alert.
|
|
339386
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
339369
339387
|
"type": "string",
|
|
339370
339388
|
"enum": [
|
|
339371
339389
|
"open",
|
|
@@ -339629,7 +339647,7 @@
|
|
|
339629
339647
|
"type": "object",
|
|
339630
339648
|
"properties": {
|
|
339631
339649
|
"state": {
|
|
339632
|
-
"description": "Sets the state of the secret scanning alert.
|
|
339650
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
339633
339651
|
"type": "string",
|
|
339634
339652
|
"enum": [
|
|
339635
339653
|
"open",
|
|
@@ -339707,7 +339725,7 @@
|
|
|
339707
339725
|
"description": "The REST API URL of the code locations for this alert."
|
|
339708
339726
|
},
|
|
339709
339727
|
"state": {
|
|
339710
|
-
"description": "Sets the state of the secret scanning alert.
|
|
339728
|
+
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
|
|
339711
339729
|
"type": "string",
|
|
339712
339730
|
"enum": [
|
|
339713
339731
|
"open",
|
|
@@ -378418,7 +378436,7 @@
|
|
|
378418
378436
|
},
|
|
378419
378437
|
{
|
|
378420
378438
|
"name": "state",
|
|
378421
|
-
"description": "Indicates the state of the issues to return.
|
|
378439
|
+
"description": "Indicates the state of the issues to return.",
|
|
378422
378440
|
"in": "query",
|
|
378423
378441
|
"required": false,
|
|
378424
378442
|
"schema": {
|
|
@@ -378442,7 +378460,7 @@
|
|
|
378442
378460
|
},
|
|
378443
378461
|
{
|
|
378444
378462
|
"name": "sort",
|
|
378445
|
-
"description": "What to sort results by.
|
|
378463
|
+
"description": "What to sort results by.",
|
|
378446
378464
|
"in": "query",
|
|
378447
378465
|
"required": false,
|
|
378448
378466
|
"schema": {
|
|
@@ -381965,7 +381983,7 @@
|
|
|
381965
381983
|
"parameters": [
|
|
381966
381984
|
{
|
|
381967
381985
|
"name": "state",
|
|
381968
|
-
"description": "Indicates the state of the memberships to return.
|
|
381986
|
+
"description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.",
|
|
381969
381987
|
"in": "query",
|
|
381970
381988
|
"required": false,
|
|
381971
381989
|
"schema": {
|
|
@@ -413397,7 +413415,7 @@
|
|
|
413397
413415
|
},
|
|
413398
413416
|
{
|
|
413399
413417
|
"name": "state",
|
|
413400
|
-
"description": "Indicates the state of the projects to return.
|
|
413418
|
+
"description": "Indicates the state of the projects to return.",
|
|
413401
413419
|
"in": "query",
|
|
413402
413420
|
"required": false,
|
|
413403
413421
|
"schema": {
|