@octokit/openapi 13.0.0 → 13.1.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 +4679 -575
- package/generated/api.github.com.json +1752 -87
- package/generated/ghec.deref.json +8161 -705
- package/generated/ghec.json +2645 -556
- package/generated/ghes-3.10.deref.json +83 -82
- package/generated/ghes-3.10.json +73 -54
- package/generated/ghes-3.7.deref.json +67 -63
- package/generated/ghes-3.7.json +57 -36
- package/generated/ghes-3.8.deref.json +78 -74
- package/generated/ghes-3.8.json +68 -47
- package/generated/ghes-3.9.deref.json +81 -77
- package/generated/ghes-3.9.json +71 -50
- package/generated/github.ae.deref.json +258 -72
- package/generated/github.ae.json +162 -36
- package/package.json +1 -1
package/generated/ghes-3.9.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "13.
|
|
4
|
+
"version": "13.1.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": {
|
|
@@ -4431,7 +4431,7 @@
|
|
|
4431
4431
|
},
|
|
4432
4432
|
"post": {
|
|
4433
4433
|
"summary": "Create a new authorization",
|
|
4434
|
-
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed.
|
|
4434
|
+
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.9/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)\" in the GitHub Enterprise Cloud documentation.",
|
|
4435
4435
|
"tags": [
|
|
4436
4436
|
"oauth-authorizations"
|
|
4437
4437
|
],
|
|
@@ -17348,7 +17348,7 @@
|
|
|
17348
17348
|
},
|
|
17349
17349
|
"post": {
|
|
17350
17350
|
"summary": "Start an organization migration",
|
|
17351
|
-
"description": "Initiates the generation of a migration archive.",
|
|
17351
|
+
"description": "Initiates the generation of a migration archive.\n\nBefore you can use this endpoint, you must configure a blob storage provider in the \"Migrations\" section in the Management Console. For more details, see \"[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.9/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage).\"",
|
|
17352
17352
|
"tags": [
|
|
17353
17353
|
"migrations"
|
|
17354
17354
|
],
|
|
@@ -17418,7 +17418,7 @@
|
|
|
17418
17418
|
},
|
|
17419
17419
|
"exclude": {
|
|
17420
17420
|
"type": "array",
|
|
17421
|
-
"description": "Exclude related items from being returned in the response in order to improve performance of the request.
|
|
17421
|
+
"description": "Exclude related items from being returned in the response in order to improve performance of the request.",
|
|
17422
17422
|
"items": {
|
|
17423
17423
|
"type": "string",
|
|
17424
17424
|
"enum": [
|
|
@@ -24566,7 +24566,7 @@
|
|
|
24566
24566
|
"/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
|
|
24567
24567
|
"post": {
|
|
24568
24568
|
"summary": "Re-run a job from a workflow run",
|
|
24569
|
-
"description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
24569
|
+
"description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
|
|
24570
24570
|
"tags": [
|
|
24571
24571
|
"actions"
|
|
24572
24572
|
],
|
|
@@ -24857,7 +24857,7 @@
|
|
|
24857
24857
|
"/repos/{owner}/{repo}/actions/organization-variables": {
|
|
24858
24858
|
"get": {
|
|
24859
24859
|
"summary": "List repository organization variables",
|
|
24860
|
-
"description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
24860
|
+
"description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
24861
24861
|
"tags": [
|
|
24862
24862
|
"actions"
|
|
24863
24863
|
],
|
|
@@ -25330,7 +25330,7 @@
|
|
|
25330
25330
|
"/repos/{owner}/{repo}/actions/runners": {
|
|
25331
25331
|
"get": {
|
|
25332
25332
|
"summary": "List self-hosted runners for a repository",
|
|
25333
|
-
"description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25333
|
+
"description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
25334
25334
|
"tags": [
|
|
25335
25335
|
"actions"
|
|
25336
25336
|
],
|
|
@@ -25402,7 +25402,7 @@
|
|
|
25402
25402
|
"/repos/{owner}/{repo}/actions/runners/downloads": {
|
|
25403
25403
|
"get": {
|
|
25404
25404
|
"summary": "List runner applications for a repository",
|
|
25405
|
-
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25405
|
+
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
25406
25406
|
"tags": [
|
|
25407
25407
|
"actions"
|
|
25408
25408
|
],
|
|
@@ -25451,7 +25451,7 @@
|
|
|
25451
25451
|
"/repos/{owner}/{repo}/actions/runners/registration-token": {
|
|
25452
25452
|
"post": {
|
|
25453
25453
|
"summary": "Create a registration token for a repository",
|
|
25454
|
-
"description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25454
|
+
"description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```",
|
|
25455
25455
|
"tags": [
|
|
25456
25456
|
"actions"
|
|
25457
25457
|
],
|
|
@@ -25497,7 +25497,7 @@
|
|
|
25497
25497
|
"/repos/{owner}/{repo}/actions/runners/remove-token": {
|
|
25498
25498
|
"post": {
|
|
25499
25499
|
"summary": "Create a remove token for a repository",
|
|
25500
|
-
"description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25500
|
+
"description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```",
|
|
25501
25501
|
"tags": [
|
|
25502
25502
|
"actions"
|
|
25503
25503
|
],
|
|
@@ -25543,7 +25543,7 @@
|
|
|
25543
25543
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}": {
|
|
25544
25544
|
"get": {
|
|
25545
25545
|
"summary": "Get a self-hosted runner for a repository",
|
|
25546
|
-
"description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25546
|
+
"description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
25547
25547
|
"tags": [
|
|
25548
25548
|
"actions"
|
|
25549
25549
|
],
|
|
@@ -25590,7 +25590,7 @@
|
|
|
25590
25590
|
},
|
|
25591
25591
|
"delete": {
|
|
25592
25592
|
"summary": "Delete a self-hosted runner from a repository",
|
|
25593
|
-
"description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25593
|
+
"description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
25594
25594
|
"tags": [
|
|
25595
25595
|
"actions"
|
|
25596
25596
|
],
|
|
@@ -25627,7 +25627,7 @@
|
|
|
25627
25627
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
|
|
25628
25628
|
"get": {
|
|
25629
25629
|
"summary": "List labels for a self-hosted runner for a repository",
|
|
25630
|
-
"description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25630
|
+
"description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
25631
25631
|
"tags": [
|
|
25632
25632
|
"actions"
|
|
25633
25633
|
],
|
|
@@ -25665,7 +25665,7 @@
|
|
|
25665
25665
|
},
|
|
25666
25666
|
"post": {
|
|
25667
25667
|
"summary": "Add custom labels to a self-hosted runner for a repository",
|
|
25668
|
-
"description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25668
|
+
"description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
25669
25669
|
"tags": [
|
|
25670
25670
|
"actions"
|
|
25671
25671
|
],
|
|
@@ -25740,7 +25740,7 @@
|
|
|
25740
25740
|
},
|
|
25741
25741
|
"put": {
|
|
25742
25742
|
"summary": "Set custom labels for a self-hosted runner for a repository",
|
|
25743
|
-
"description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25743
|
+
"description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
25744
25744
|
"tags": [
|
|
25745
25745
|
"actions"
|
|
25746
25746
|
],
|
|
@@ -25815,7 +25815,7 @@
|
|
|
25815
25815
|
},
|
|
25816
25816
|
"delete": {
|
|
25817
25817
|
"summary": "Remove all custom labels from a self-hosted runner for a repository",
|
|
25818
|
-
"description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25818
|
+
"description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
25819
25819
|
"tags": [
|
|
25820
25820
|
"actions"
|
|
25821
25821
|
],
|
|
@@ -25855,7 +25855,7 @@
|
|
|
25855
25855
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
|
|
25856
25856
|
"delete": {
|
|
25857
25857
|
"summary": "Remove a custom label from a self-hosted runner for a repository",
|
|
25858
|
-
"description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25858
|
+
"description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
25859
25859
|
"tags": [
|
|
25860
25860
|
"actions"
|
|
25861
25861
|
],
|
|
@@ -26398,7 +26398,7 @@
|
|
|
26398
26398
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
|
|
26399
26399
|
"post": {
|
|
26400
26400
|
"summary": "Cancel a workflow run",
|
|
26401
|
-
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
26401
|
+
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
|
|
26402
26402
|
"tags": [
|
|
26403
26403
|
"actions"
|
|
26404
26404
|
],
|
|
@@ -27206,7 +27206,7 @@
|
|
|
27206
27206
|
"/repos/{owner}/{repo}/actions/variables": {
|
|
27207
27207
|
"get": {
|
|
27208
27208
|
"summary": "List repository variables",
|
|
27209
|
-
"description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
27209
|
+
"description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
27210
27210
|
"tags": [
|
|
27211
27211
|
"actions"
|
|
27212
27212
|
],
|
|
@@ -27276,7 +27276,7 @@
|
|
|
27276
27276
|
},
|
|
27277
27277
|
"post": {
|
|
27278
27278
|
"summary": "Create a repository variable",
|
|
27279
|
-
"description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
27279
|
+
"description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
27280
27280
|
"tags": [
|
|
27281
27281
|
"actions"
|
|
27282
27282
|
],
|
|
@@ -27354,7 +27354,7 @@
|
|
|
27354
27354
|
"/repos/{owner}/{repo}/actions/variables/{name}": {
|
|
27355
27355
|
"get": {
|
|
27356
27356
|
"summary": "Get a repository variable",
|
|
27357
|
-
"description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
27357
|
+
"description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
27358
27358
|
"tags": [
|
|
27359
27359
|
"actions"
|
|
27360
27360
|
],
|
|
@@ -27401,7 +27401,7 @@
|
|
|
27401
27401
|
},
|
|
27402
27402
|
"patch": {
|
|
27403
27403
|
"summary": "Update a repository variable",
|
|
27404
|
-
"description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
27404
|
+
"description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
27405
27405
|
"tags": [
|
|
27406
27406
|
"actions"
|
|
27407
27407
|
],
|
|
@@ -27464,7 +27464,7 @@
|
|
|
27464
27464
|
},
|
|
27465
27465
|
"delete": {
|
|
27466
27466
|
"summary": "Delete a repository variable",
|
|
27467
|
-
"description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
27467
|
+
"description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
27468
27468
|
"tags": [
|
|
27469
27469
|
"actions"
|
|
27470
27470
|
],
|
|
@@ -31392,7 +31392,7 @@
|
|
|
31392
31392
|
},
|
|
31393
31393
|
"patch": {
|
|
31394
31394
|
"summary": "Update a check run",
|
|
31395
|
-
"description": "**Note:** The
|
|
31395
|
+
"description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.",
|
|
31396
31396
|
"tags": [
|
|
31397
31397
|
"checks"
|
|
31398
31398
|
],
|
|
@@ -32065,7 +32065,7 @@
|
|
|
32065
32065
|
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
|
|
32066
32066
|
"get": {
|
|
32067
32067
|
"summary": "List check runs in a check suite",
|
|
32068
|
-
"description": "
|
|
32068
|
+
"description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.",
|
|
32069
32069
|
"tags": [
|
|
32070
32070
|
"checks"
|
|
32071
32071
|
],
|
|
@@ -32924,7 +32924,7 @@
|
|
|
32924
32924
|
}
|
|
32925
32925
|
},
|
|
32926
32926
|
"403": {
|
|
32927
|
-
"$ref": "#/components/responses/
|
|
32927
|
+
"$ref": "#/components/responses/code_scanning_forbidden_write"
|
|
32928
32928
|
},
|
|
32929
32929
|
"404": {
|
|
32930
32930
|
"$ref": "#/components/responses/not_found"
|
|
@@ -34400,7 +34400,7 @@
|
|
|
34400
34400
|
"/repos/{owner}/{repo}/commits/{ref}/check-runs": {
|
|
34401
34401
|
"get": {
|
|
34402
34402
|
"summary": "List check runs for a Git reference",
|
|
34403
|
-
"description": "**Note:** The
|
|
34403
|
+
"description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.",
|
|
34404
34404
|
"tags": [
|
|
34405
34405
|
"checks"
|
|
34406
34406
|
],
|
|
@@ -34503,7 +34503,7 @@
|
|
|
34503
34503
|
"/repos/{owner}/{repo}/commits/{ref}/check-suites": {
|
|
34504
34504
|
"get": {
|
|
34505
34505
|
"summary": "List check suites for a Git reference",
|
|
34506
|
-
"description": "
|
|
34506
|
+
"description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
|
|
34507
34507
|
"tags": [
|
|
34508
34508
|
"checks"
|
|
34509
34509
|
],
|
|
@@ -37111,7 +37111,7 @@
|
|
|
37111
37111
|
"content": {
|
|
37112
37112
|
"application/json": {
|
|
37113
37113
|
"schema": {
|
|
37114
|
-
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
|
|
37114
|
+
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type"
|
|
37115
37115
|
},
|
|
37116
37116
|
"examples": {
|
|
37117
37117
|
"example-wildcard": {
|
|
@@ -37168,7 +37168,7 @@
|
|
|
37168
37168
|
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
37169
37169
|
"get": {
|
|
37170
37170
|
"summary": "Get a deployment branch policy",
|
|
37171
|
-
"description": "Gets a deployment branch policy for an environment.\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 `
|
|
37171
|
+
"description": "Gets a deployment branch policy for an environment.\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 `administration:read` permission for the repository to use this endpoint.",
|
|
37172
37172
|
"tags": [
|
|
37173
37173
|
"repos"
|
|
37174
37174
|
],
|
|
@@ -45223,7 +45223,7 @@
|
|
|
45223
45223
|
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
|
|
45224
45224
|
"get": {
|
|
45225
45225
|
"summary": "List reactions for a pull request review comment",
|
|
45226
|
-
"description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
45226
|
+
"description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
45227
45227
|
"tags": [
|
|
45228
45228
|
"reactions"
|
|
45229
45229
|
],
|
|
@@ -50814,7 +50814,7 @@
|
|
|
50814
50814
|
"/repositories/{repository_id}/environments/{environment_name}/variables": {
|
|
50815
50815
|
"get": {
|
|
50816
50816
|
"summary": "List environment variables",
|
|
50817
|
-
"description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
50817
|
+
"description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
50818
50818
|
"tags": [
|
|
50819
50819
|
"actions"
|
|
50820
50820
|
],
|
|
@@ -50884,7 +50884,7 @@
|
|
|
50884
50884
|
},
|
|
50885
50885
|
"post": {
|
|
50886
50886
|
"summary": "Create an environment variable",
|
|
50887
|
-
"description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
50887
|
+
"description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
50888
50888
|
"tags": [
|
|
50889
50889
|
"actions"
|
|
50890
50890
|
],
|
|
@@ -50962,7 +50962,7 @@
|
|
|
50962
50962
|
"/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
|
|
50963
50963
|
"get": {
|
|
50964
50964
|
"summary": "Get an environment variable",
|
|
50965
|
-
"description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
50965
|
+
"description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
50966
50966
|
"tags": [
|
|
50967
50967
|
"actions"
|
|
50968
50968
|
],
|
|
@@ -51009,7 +51009,7 @@
|
|
|
51009
51009
|
},
|
|
51010
51010
|
"patch": {
|
|
51011
51011
|
"summary": "Update an environment variable",
|
|
51012
|
-
"description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
51012
|
+
"description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
51013
51013
|
"tags": [
|
|
51014
51014
|
"actions"
|
|
51015
51015
|
],
|
|
@@ -51072,7 +51072,7 @@
|
|
|
51072
51072
|
},
|
|
51073
51073
|
"delete": {
|
|
51074
51074
|
"summary": "Delete an environment variable",
|
|
51075
|
-
"description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
51075
|
+
"description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
51076
51076
|
"tags": [
|
|
51077
51077
|
"actions"
|
|
51078
51078
|
],
|
|
@@ -84857,7 +84857,7 @@
|
|
|
84857
84857
|
}
|
|
84858
84858
|
},
|
|
84859
84859
|
"x-github": {
|
|
84860
|
-
"githubCloudOnly":
|
|
84860
|
+
"githubCloudOnly": true,
|
|
84861
84861
|
"category": "webhooks",
|
|
84862
84862
|
"subcategory": "user",
|
|
84863
84863
|
"supported-webhook-types": [
|
|
@@ -84964,7 +84964,7 @@
|
|
|
84964
84964
|
}
|
|
84965
84965
|
},
|
|
84966
84966
|
"x-github": {
|
|
84967
|
-
"githubCloudOnly":
|
|
84967
|
+
"githubCloudOnly": true,
|
|
84968
84968
|
"category": "webhooks",
|
|
84969
84969
|
"subcategory": "user",
|
|
84970
84970
|
"supported-webhook-types": [
|
|
@@ -99094,7 +99094,6 @@
|
|
|
99094
99094
|
"forks",
|
|
99095
99095
|
"forks_count",
|
|
99096
99096
|
"git_url",
|
|
99097
|
-
"has_downloads",
|
|
99098
99097
|
"has_issues",
|
|
99099
99098
|
"has_projects",
|
|
99100
99099
|
"has_wiki",
|
|
@@ -102466,7 +102465,7 @@
|
|
|
102466
102465
|
]
|
|
102467
102466
|
},
|
|
102468
102467
|
"languages": {
|
|
102469
|
-
"description": "Languages to be
|
|
102468
|
+
"description": "Languages to be analyzed.",
|
|
102470
102469
|
"type": "array",
|
|
102471
102470
|
"items": {
|
|
102472
102471
|
"type": "string",
|
|
@@ -105329,6 +105328,20 @@
|
|
|
105329
105328
|
}
|
|
105330
105329
|
}
|
|
105331
105330
|
},
|
|
105331
|
+
"deployment-branch-policy-name-pattern-with-type": {
|
|
105332
|
+
"title": "Deployment branch and tag policy name pattern",
|
|
105333
|
+
"type": "object",
|
|
105334
|
+
"properties": {
|
|
105335
|
+
"name": {
|
|
105336
|
+
"description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
|
|
105337
|
+
"type": "string",
|
|
105338
|
+
"example": "release/*"
|
|
105339
|
+
}
|
|
105340
|
+
},
|
|
105341
|
+
"required": [
|
|
105342
|
+
"name"
|
|
105343
|
+
]
|
|
105344
|
+
},
|
|
105332
105345
|
"deployment-branch-policy-name-pattern": {
|
|
105333
105346
|
"title": "Deployment branch policy name pattern",
|
|
105334
105347
|
"type": "object",
|
|
@@ -118771,7 +118784,7 @@
|
|
|
118771
118784
|
"format": "uri"
|
|
118772
118785
|
},
|
|
118773
118786
|
"conclusion": {
|
|
118774
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
118787
|
+
"description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.",
|
|
118775
118788
|
"type": "string",
|
|
118776
118789
|
"nullable": true,
|
|
118777
118790
|
"enum": [
|
|
@@ -119552,7 +119565,7 @@
|
|
|
119552
119565
|
"format": "uri"
|
|
119553
119566
|
},
|
|
119554
119567
|
"conclusion": {
|
|
119555
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
119568
|
+
"description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.",
|
|
119556
119569
|
"type": "string",
|
|
119557
119570
|
"nullable": true,
|
|
119558
119571
|
"enum": [
|
|
@@ -120326,7 +120339,7 @@
|
|
|
120326
120339
|
"format": "uri"
|
|
120327
120340
|
},
|
|
120328
120341
|
"conclusion": {
|
|
120329
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
120342
|
+
"description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.",
|
|
120330
120343
|
"type": "string",
|
|
120331
120344
|
"nullable": true,
|
|
120332
120345
|
"enum": [
|
|
@@ -120731,7 +120744,7 @@
|
|
|
120731
120744
|
]
|
|
120732
120745
|
},
|
|
120733
120746
|
"dismissed_reason": {
|
|
120734
|
-
"description": "The reason for dismissing or closing the alert.
|
|
120747
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
120735
120748
|
"type": "string",
|
|
120736
120749
|
"nullable": true,
|
|
120737
120750
|
"enum": [
|
|
@@ -121050,7 +121063,7 @@
|
|
|
121050
121063
|
]
|
|
121051
121064
|
},
|
|
121052
121065
|
"dismissed_reason": {
|
|
121053
|
-
"description": "The reason for dismissing or closing the alert.
|
|
121066
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
121054
121067
|
"type": "string",
|
|
121055
121068
|
"nullable": true,
|
|
121056
121069
|
"enum": [
|
|
@@ -121657,7 +121670,7 @@
|
|
|
121657
121670
|
]
|
|
121658
121671
|
},
|
|
121659
121672
|
"dismissed_reason": {
|
|
121660
|
-
"description": "The reason for dismissing or closing the alert.
|
|
121673
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
121661
121674
|
"type": "string",
|
|
121662
121675
|
"nullable": true,
|
|
121663
121676
|
"enum": [
|
|
@@ -128032,7 +128045,7 @@
|
|
|
128032
128045
|
"format": "date-time"
|
|
128033
128046
|
},
|
|
128034
128047
|
"conclusion": {
|
|
128035
|
-
"description": "The result of the completed check run.
|
|
128048
|
+
"description": "The result of the completed check run. This value will be `null` until the check run has completed.",
|
|
128036
128049
|
"type": "string",
|
|
128037
128050
|
"nullable": true,
|
|
128038
128051
|
"enum": [
|
|
@@ -152861,6 +152874,10 @@
|
|
|
152861
152874
|
"type": "string",
|
|
152862
152875
|
"format": "uri"
|
|
152863
152876
|
},
|
|
152877
|
+
"has_discussions": {
|
|
152878
|
+
"description": "Whether the repository has discussions enabled.",
|
|
152879
|
+
"type": "boolean"
|
|
152880
|
+
},
|
|
152864
152881
|
"has_downloads": {
|
|
152865
152882
|
"description": "Whether downloads are enabled.",
|
|
152866
152883
|
"type": "boolean",
|
|
@@ -153217,6 +153234,10 @@
|
|
|
153217
153234
|
},
|
|
153218
153235
|
"watchers_count": {
|
|
153219
153236
|
"type": "integer"
|
|
153237
|
+
},
|
|
153238
|
+
"web_commit_signoff_required": {
|
|
153239
|
+
"description": "Whether to require commit signoff.",
|
|
153240
|
+
"type": "boolean"
|
|
153220
153241
|
}
|
|
153221
153242
|
},
|
|
153222
153243
|
"required": [
|
|
@@ -275930,7 +275951,7 @@
|
|
|
275930
275951
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
275931
275952
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
275932
275953
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
275933
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
275954
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
275934
275955
|
"status": "completed",
|
|
275935
275956
|
"conclusion": "success",
|
|
275936
275957
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -276604,7 +276625,7 @@
|
|
|
276604
276625
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
276605
276626
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
276606
276627
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
276607
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
276628
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
276608
276629
|
"status": "completed",
|
|
276609
276630
|
"conclusion": "success",
|
|
276610
276631
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -292151,7 +292172,7 @@
|
|
|
292151
292172
|
},
|
|
292152
292173
|
"hook-id": {
|
|
292153
292174
|
"name": "hook_id",
|
|
292154
|
-
"description": "The unique identifier of the hook.",
|
|
292175
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
292155
292176
|
"in": "path",
|
|
292156
292177
|
"required": true,
|
|
292157
292178
|
"schema": {
|