@octokit/openapi 7.1.0 → 7.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 +9058 -8
- package/generated/api.github.com.json +669 -35
- 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 +119 -1
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +111 -1
- package/generated/ghes-3.2.deref.json +354 -1
- package/generated/ghes-3.2.json +151 -10
- package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +16 -0
- package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +209 -1
- package/generated/ghes-3.3-diff-to-ghes-3.4.json +9 -1
- package/generated/ghes-3.3.deref.json +354 -1
- package/generated/ghes-3.3.json +151 -10
- 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 +339 -1
- package/generated/ghes-3.4.json +152 -10
- package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +764 -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 +141 -1
- package/generated/ghes-3.5-diff-to-ghes-3.6.json +132 -4
- package/generated/ghes-3.5.deref.json +349 -1
- package/generated/ghes-3.5.json +162 -10
- package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +94 -0
- package/generated/ghes-3.6-diff-to-api.github.com.deref.json +399 -1
- package/generated/ghes-3.6-diff-to-api.github.com.json +183 -1
- package/generated/ghes-3.6.deref.json +7239 -1
- package/generated/ghes-3.6.json +380 -10
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +739 -3
- package/generated/github.ae-diff-to-api.github.com.deref.json +163 -1
- package/generated/github.ae-diff-to-api.github.com.json +122 -4
- package/generated/github.ae.deref.json +299 -1
- package/generated/github.ae.json +184 -10
- package/package.json +1 -1
package/generated/github.ae.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "7.
|
|
4
|
+
"version": "7.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": {
|
|
@@ -11489,6 +11489,40 @@
|
|
|
11489
11489
|
"type": "boolean",
|
|
11490
11490
|
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
|
|
11491
11491
|
"default": false
|
|
11492
|
+
},
|
|
11493
|
+
"squash_merge_commit_title": {
|
|
11494
|
+
"type": "string",
|
|
11495
|
+
"enum": [
|
|
11496
|
+
"PR_TITLE",
|
|
11497
|
+
"COMMIT_OR_PR_TITLE"
|
|
11498
|
+
],
|
|
11499
|
+
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
|
|
11500
|
+
},
|
|
11501
|
+
"squash_merge_commit_message": {
|
|
11502
|
+
"type": "string",
|
|
11503
|
+
"enum": [
|
|
11504
|
+
"PR_BODY",
|
|
11505
|
+
"COMMIT_MESSAGES",
|
|
11506
|
+
"BLANK"
|
|
11507
|
+
],
|
|
11508
|
+
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
|
|
11509
|
+
},
|
|
11510
|
+
"merge_commit_title": {
|
|
11511
|
+
"type": "string",
|
|
11512
|
+
"enum": [
|
|
11513
|
+
"PR_TITLE",
|
|
11514
|
+
"MERGE_MESSAGE"
|
|
11515
|
+
],
|
|
11516
|
+
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
|
|
11517
|
+
},
|
|
11518
|
+
"merge_commit_message": {
|
|
11519
|
+
"type": "string",
|
|
11520
|
+
"enum": [
|
|
11521
|
+
"PR_BODY",
|
|
11522
|
+
"PR_TITLE",
|
|
11523
|
+
"BLANK"
|
|
11524
|
+
],
|
|
11525
|
+
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
|
|
11492
11526
|
}
|
|
11493
11527
|
},
|
|
11494
11528
|
"required": [
|
|
@@ -15701,6 +15735,40 @@
|
|
|
15701
15735
|
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
|
|
15702
15736
|
"default": false
|
|
15703
15737
|
},
|
|
15738
|
+
"squash_merge_commit_title": {
|
|
15739
|
+
"type": "string",
|
|
15740
|
+
"enum": [
|
|
15741
|
+
"PR_TITLE",
|
|
15742
|
+
"COMMIT_OR_PR_TITLE"
|
|
15743
|
+
],
|
|
15744
|
+
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
|
|
15745
|
+
},
|
|
15746
|
+
"squash_merge_commit_message": {
|
|
15747
|
+
"type": "string",
|
|
15748
|
+
"enum": [
|
|
15749
|
+
"PR_BODY",
|
|
15750
|
+
"COMMIT_MESSAGES",
|
|
15751
|
+
"BLANK"
|
|
15752
|
+
],
|
|
15753
|
+
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
|
|
15754
|
+
},
|
|
15755
|
+
"merge_commit_title": {
|
|
15756
|
+
"type": "string",
|
|
15757
|
+
"enum": [
|
|
15758
|
+
"PR_TITLE",
|
|
15759
|
+
"MERGE_MESSAGE"
|
|
15760
|
+
],
|
|
15761
|
+
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
|
|
15762
|
+
},
|
|
15763
|
+
"merge_commit_message": {
|
|
15764
|
+
"type": "string",
|
|
15765
|
+
"enum": [
|
|
15766
|
+
"PR_BODY",
|
|
15767
|
+
"PR_TITLE",
|
|
15768
|
+
"BLANK"
|
|
15769
|
+
],
|
|
15770
|
+
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
|
|
15771
|
+
},
|
|
15704
15772
|
"archived": {
|
|
15705
15773
|
"type": "boolean",
|
|
15706
15774
|
"description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
|
|
@@ -17142,9 +17210,12 @@
|
|
|
17142
17210
|
"content": {
|
|
17143
17211
|
"application/json": {
|
|
17144
17212
|
"schema": {
|
|
17145
|
-
"
|
|
17146
|
-
|
|
17147
|
-
|
|
17213
|
+
"$ref": "#/components/schemas/empty-object"
|
|
17214
|
+
},
|
|
17215
|
+
"examples": {
|
|
17216
|
+
"default": {
|
|
17217
|
+
"value": null
|
|
17218
|
+
}
|
|
17148
17219
|
}
|
|
17149
17220
|
}
|
|
17150
17221
|
}
|
|
@@ -17367,6 +17438,11 @@
|
|
|
17367
17438
|
"schema": {
|
|
17368
17439
|
"type": "object",
|
|
17369
17440
|
"nullable": true
|
|
17441
|
+
},
|
|
17442
|
+
"examples": {
|
|
17443
|
+
"default": {
|
|
17444
|
+
"value": null
|
|
17445
|
+
}
|
|
17370
17446
|
}
|
|
17371
17447
|
}
|
|
17372
17448
|
}
|
|
@@ -17377,9 +17453,12 @@
|
|
|
17377
17453
|
"content": {
|
|
17378
17454
|
"application/json": {
|
|
17379
17455
|
"schema": {
|
|
17380
|
-
"
|
|
17381
|
-
|
|
17382
|
-
|
|
17456
|
+
"$ref": "#/components/schemas/empty-object"
|
|
17457
|
+
},
|
|
17458
|
+
"examples": {
|
|
17459
|
+
"default": {
|
|
17460
|
+
"value": null
|
|
17461
|
+
}
|
|
17383
17462
|
}
|
|
17384
17463
|
}
|
|
17385
17464
|
}
|
|
@@ -17672,9 +17751,12 @@
|
|
|
17672
17751
|
"content": {
|
|
17673
17752
|
"application/json": {
|
|
17674
17753
|
"schema": {
|
|
17675
|
-
"
|
|
17676
|
-
|
|
17677
|
-
|
|
17754
|
+
"$ref": "#/components/schemas/empty-object"
|
|
17755
|
+
},
|
|
17756
|
+
"examples": {
|
|
17757
|
+
"default": {
|
|
17758
|
+
"value": null
|
|
17759
|
+
}
|
|
17678
17760
|
}
|
|
17679
17761
|
}
|
|
17680
17762
|
}
|
|
@@ -44002,6 +44084,40 @@
|
|
|
44002
44084
|
"type": "boolean",
|
|
44003
44085
|
"example": false
|
|
44004
44086
|
},
|
|
44087
|
+
"squash_merge_commit_title": {
|
|
44088
|
+
"type": "string",
|
|
44089
|
+
"enum": [
|
|
44090
|
+
"PR_TITLE",
|
|
44091
|
+
"COMMIT_OR_PR_TITLE"
|
|
44092
|
+
],
|
|
44093
|
+
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
|
|
44094
|
+
},
|
|
44095
|
+
"squash_merge_commit_message": {
|
|
44096
|
+
"type": "string",
|
|
44097
|
+
"enum": [
|
|
44098
|
+
"PR_BODY",
|
|
44099
|
+
"COMMIT_MESSAGES",
|
|
44100
|
+
"BLANK"
|
|
44101
|
+
],
|
|
44102
|
+
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
|
|
44103
|
+
},
|
|
44104
|
+
"merge_commit_title": {
|
|
44105
|
+
"type": "string",
|
|
44106
|
+
"enum": [
|
|
44107
|
+
"PR_TITLE",
|
|
44108
|
+
"MERGE_MESSAGE"
|
|
44109
|
+
],
|
|
44110
|
+
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
|
|
44111
|
+
},
|
|
44112
|
+
"merge_commit_message": {
|
|
44113
|
+
"type": "string",
|
|
44114
|
+
"enum": [
|
|
44115
|
+
"PR_BODY",
|
|
44116
|
+
"PR_TITLE",
|
|
44117
|
+
"BLANK"
|
|
44118
|
+
],
|
|
44119
|
+
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
|
|
44120
|
+
},
|
|
44005
44121
|
"has_downloads": {
|
|
44006
44122
|
"description": "Whether downloads are enabled.",
|
|
44007
44123
|
"default": true,
|
|
@@ -45802,6 +45918,12 @@
|
|
|
45802
45918
|
"text/plain": {
|
|
45803
45919
|
"schema": {
|
|
45804
45920
|
"type": "string"
|
|
45921
|
+
},
|
|
45922
|
+
"examples": {
|
|
45923
|
+
"default": {
|
|
45924
|
+
"summary": "Example response",
|
|
45925
|
+
"value": "Responsive is better than fast"
|
|
45926
|
+
}
|
|
45805
45927
|
}
|
|
45806
45928
|
}
|
|
45807
45929
|
}
|
|
@@ -46231,6 +46353,50 @@
|
|
|
46231
46353
|
}
|
|
46232
46354
|
}
|
|
46233
46355
|
},
|
|
46356
|
+
"/enterprises/{enterprise}/consumed-licenses": {
|
|
46357
|
+
"get": {
|
|
46358
|
+
"summary": "List enterprise consumed licenses",
|
|
46359
|
+
"description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
|
|
46360
|
+
"tags": [
|
|
46361
|
+
"enterprise-admin"
|
|
46362
|
+
],
|
|
46363
|
+
"operationId": "enterprise-admin/get-consumed-licenses",
|
|
46364
|
+
"externalDocs": {
|
|
46365
|
+
"description": "API method documentation",
|
|
46366
|
+
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-enterprise-consumed-licenses"
|
|
46367
|
+
},
|
|
46368
|
+
"x-octokit": {
|
|
46369
|
+
"api.github.com": "removed"
|
|
46370
|
+
},
|
|
46371
|
+
"responses": {
|
|
46372
|
+
"501": {
|
|
46373
|
+
"description": "Not Implemented"
|
|
46374
|
+
}
|
|
46375
|
+
}
|
|
46376
|
+
}
|
|
46377
|
+
},
|
|
46378
|
+
"/enterprises/{enterprise}/license-sync-status": {
|
|
46379
|
+
"get": {
|
|
46380
|
+
"summary": "Get a license sync status",
|
|
46381
|
+
"description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
|
|
46382
|
+
"tags": [
|
|
46383
|
+
"enterprise-admin"
|
|
46384
|
+
],
|
|
46385
|
+
"operationId": "enterprise-admin/get-license-sync-status",
|
|
46386
|
+
"externalDocs": {
|
|
46387
|
+
"description": "API method documentation",
|
|
46388
|
+
"url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-license-sync-status"
|
|
46389
|
+
},
|
|
46390
|
+
"x-octokit": {
|
|
46391
|
+
"api.github.com": "removed"
|
|
46392
|
+
},
|
|
46393
|
+
"responses": {
|
|
46394
|
+
"501": {
|
|
46395
|
+
"description": "Not Implemented"
|
|
46396
|
+
}
|
|
46397
|
+
}
|
|
46398
|
+
}
|
|
46399
|
+
},
|
|
46234
46400
|
"/enterprises/{enterprise}/secret-scanning/alerts": {
|
|
46235
46401
|
"get": {
|
|
46236
46402
|
"summary": "List secret scanning alerts for an enterprise",
|
|
@@ -51911,6 +52077,14 @@
|
|
|
51911
52077
|
"write"
|
|
51912
52078
|
]
|
|
51913
52079
|
},
|
|
52080
|
+
"organization_custom_roles": {
|
|
52081
|
+
"type": "string",
|
|
52082
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
52083
|
+
"enum": [
|
|
52084
|
+
"read",
|
|
52085
|
+
"write"
|
|
52086
|
+
]
|
|
52087
|
+
},
|
|
51914
52088
|
"deployments": {
|
|
51915
52089
|
"type": "string",
|
|
51916
52090
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|