Skip to content

Commit 867c6d0

Browse files
github-openapi-botgithub-openapi-bot
committed
Updating OpenAPI descriptions
1 parent 2b294b6 commit 867c6d0

28 files changed

+142
-194
lines changed

‎descriptions/api.github.com/api.github.com.json‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18089,7 +18089,7 @@
1808918089
"/repos/{owner}/{repo}/actions/runs/{run_id}/timing": {
1809018090
"get": {
1809118091
"summary": "Get workflow run usage",
18092-
"description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
18092+
"description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
1809318093
"tags": [
1809418094
"actions"
1809518095
],
@@ -18765,7 +18765,7 @@
1876518765
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": {
1876618766
"get": {
1876718767
"summary": "Get workflow usage",
18768-
"description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
18768+
"description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
1876918769
"tags": [
1877018770
"actions"
1877118771
],
@@ -22846,6 +22846,12 @@
2284622846
},
2284722847
"404": {
2284822848
"description": "Response if `commit_sha` or `ref` cannot be found"
22849+
},
22850+
"400": {
22851+
"description": "Response if the `sarif` field is invalid"
22852+
},
22853+
"413": {
22854+
"description": "Response if the `sarif` field is too large"
2284922855
}
2285022856
},
2285122857
"x-github": {
@@ -27294,7 +27300,7 @@
2729427300
},
2729527301
"digest": {
2729627302
"type": "string",
27297-
"example": "\"md5\""
27303+
"example": "\"sha256\""
2729827304
}
2729927305
},
2730027306
"required": [
@@ -52157,12 +52163,6 @@
5215752163
"ssh_key_fingerprints": {
5215852164
"type": "object",
5215952165
"properties": {
52160-
"MD5_RSA": {
52161-
"type": "string"
52162-
},
52163-
"MD5_DSA": {
52164-
"type": "string"
52165-
},
5216652166
"SHA256_RSA": {
5216752167
"type": "string"
5216852168
},
@@ -60709,7 +60709,7 @@
6070960709
},
6071060710
"digest": {
6071160711
"type": "string",
60712-
"example": "\"md5\""
60712+
"example": "\"sha256\""
6071360713
},
6071460714
"secret": {
6071560715
"$ref": "#/components/schemas/webhook-config-secret"
@@ -68596,8 +68596,6 @@
6859668596
"value": {
6859768597
"verifiable_password_authentication": true,
6859868598
"ssh_key_fingerprints": {
68599-
"MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48",
68600-
"MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c",
6860168599
"SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8",
6860268600
"SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ"
6860368601
},

‎descriptions/api.github.com/api.github.com.yaml‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12907,8 +12907,6 @@ paths:
1290712907
get:
1290812908
summary: Get workflow run usage
1290912909
description: |-
12910-
**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see "[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage)."
12911-
1291212910
Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
1291312911

1291412912
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
@@ -13426,8 +13424,6 @@ paths:
1342613424
get:
1342713425
summary: Get workflow usage
1342813426
description: |-
13429-
**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see "[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage)."
13430-
1343113427
Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
1343213428

1343313429
You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
@@ -16399,6 +16395,10 @@ paths:
1639916395
description: Response if the repository is archived
1640016396
'404':
1640116397
description: Response if `commit_sha` or `ref` cannot be found
16398+
'400':
16399+
description: Response if the `sarif` field is invalid
16400+
'413':
16401+
description: Response if the `sarif` field is too large
1640216402
x-github:
1640316403
enabledForGitHubApps: true
1640416404
githubCloudOnly: false
@@ -19854,7 +19854,7 @@ paths:
1985419854
example: '"abc"'
1985519855
digest:
1985619856
type: string
19857-
example: '"md5"'
19857+
example: '"sha256"'
1985819858
required:
1985919859
- url
1986019860
events:
@@ -37600,10 +37600,6 @@ components:
3760037600
ssh_key_fingerprints:
3760137601
type: object
3760237602
properties:
37603-
MD5_RSA:
37604-
type: string
37605-
MD5_DSA:
37606-
type: string
3760737603
SHA256_RSA:
3760837604
type: string
3760937605
SHA256_DSA:
@@ -43997,7 +43993,7 @@ components:
4399743993
"$ref": "#/components/schemas/webhook-config-content-type"
4399843994
digest:
4399943995
type: string
44000-
example: '"md5"'
43996+
example: '"sha256"'
4400143997
secret:
4400243998
"$ref": "#/components/schemas/webhook-config-secret"
4400343999
token:
@@ -50120,8 +50116,6 @@ components:
5012050116
value:
5012150117
verifiable_password_authentication: true
5012250118
ssh_key_fingerprints:
50123-
MD5_RSA: 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48
50124-
MD5_DSA: ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c
5012550119
SHA256_RSA: nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8
5012650120
SHA256_DSA: br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ
5012750121
hooks:

‎descriptions/api.github.com/dereferenced/api.github.com.deref.json‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -35078,12 +35078,6 @@
3507835078
"ssh_key_fingerprints": {
3507935079
"type": "object",
3508035080
"properties": {
35081-
"MD5_RSA": {
35082-
"type": "string"
35083-
},
35084-
"MD5_DSA": {
35085-
"type": "string"
35086-
},
3508735081
"SHA256_RSA": {
3508835082
"type": "string"
3508935083
},
@@ -35165,8 +35159,6 @@
3516535159
"value": {
3516635160
"verifiable_password_authentication": true,
3516735161
"ssh_key_fingerprints": {
35168-
"MD5_RSA": "16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48",
35169-
"MD5_DSA": "ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c",
3517035162
"SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8",
3517135163
"SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ"
3517235164
},
@@ -102241,7 +102233,7 @@
102241102233
"/repos/{owner}/{repo}/actions/runs/{run_id}/timing": {
102242102234
"get": {
102243102235
"summary": "Get workflow run usage",
102244-
"description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
102236+
"description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
102245102237
"tags": [
102246102238
"actions"
102247102239
],
@@ -105046,7 +105038,7 @@
105046105038
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": {
105047105039
"get": {
105048105040
"summary": "Get workflow usage",
105049-
"description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
105041+
"description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
105050105042
"tags": [
105051105043
"actions"
105052105044
],
@@ -125555,6 +125547,12 @@
125555125547
},
125556125548
"404": {
125557125549
"description": "Response if `commit_sha` or `ref` cannot be found"
125550+
},
125551+
"400": {
125552+
"description": "Response if the `sarif` field is invalid"
125553+
},
125554+
"413": {
125555+
"description": "Response if the `sarif` field is too large"
125558125556
}
125559125557
},
125560125558
"x-github": {
@@ -155709,7 +155707,7 @@
155709155707
},
155710155708
"digest": {
155711155709
"type": "string",
155712-
"example": "\"md5\""
155710+
"example": "\"sha256\""
155713155711
},
155714155712
"secret": {
155715155713
"type": "string",
@@ -155930,7 +155928,7 @@
155930155928
},
155931155929
"digest": {
155932155930
"type": "string",
155933-
"example": "\"md5\""
155931+
"example": "\"sha256\""
155934155932
}
155935155933
},
155936155934
"required": [
@@ -156049,7 +156047,7 @@
156049156047
},
156050156048
"digest": {
156051156049
"type": "string",
156052-
"example": "\"md5\""
156050+
"example": "\"sha256\""
156053156051
},
156054156052
"secret": {
156055156053
"type": "string",
@@ -156401,7 +156399,7 @@
156401156399
},
156402156400
"digest": {
156403156401
"type": "string",
156404-
"example": "\"md5\""
156402+
"example": "\"sha256\""
156405156403
},
156406156404
"secret": {
156407156405
"type": "string",
@@ -156738,7 +156736,7 @@
156738156736
},
156739156737
"digest": {
156740156738
"type": "string",
156741-
"example": "\"md5\""
156739+
"example": "\"sha256\""
156742156740
},
156743156741
"secret": {
156744156742
"type": "string",

0 commit comments

Comments
 (0)