@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.7.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": {
|
|
@@ -4427,7 +4427,7 @@
|
|
|
4427
4427
|
},
|
|
4428
4428
|
"post": {
|
|
4429
4429
|
"summary": "Create a new authorization",
|
|
4430
|
-
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/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.7/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/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.7/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.7/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.7/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.7/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed.
|
|
4430
|
+
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/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.7/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/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.7/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.7/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.7/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.7/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.7/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.",
|
|
4431
4431
|
"tags": [
|
|
4432
4432
|
"oauth-authorizations"
|
|
4433
4433
|
],
|
|
@@ -15794,7 +15794,7 @@
|
|
|
15794
15794
|
},
|
|
15795
15795
|
"exclude": {
|
|
15796
15796
|
"type": "array",
|
|
15797
|
-
"description": "Exclude related items from being returned in the response in order to improve performance of the request.
|
|
15797
|
+
"description": "Exclude related items from being returned in the response in order to improve performance of the request.",
|
|
15798
15798
|
"items": {
|
|
15799
15799
|
"type": "string",
|
|
15800
15800
|
"enum": [
|
|
@@ -22399,7 +22399,7 @@
|
|
|
22399
22399
|
"/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
|
|
22400
22400
|
"post": {
|
|
22401
22401
|
"summary": "Re-run a job from a workflow run",
|
|
22402
|
-
"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.\
|
|
22402
|
+
"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.",
|
|
22403
22403
|
"tags": [
|
|
22404
22404
|
"actions"
|
|
22405
22405
|
],
|
|
@@ -23008,7 +23008,7 @@
|
|
|
23008
23008
|
"/repos/{owner}/{repo}/actions/runners": {
|
|
23009
23009
|
"get": {
|
|
23010
23010
|
"summary": "List self-hosted runners for a repository",
|
|
23011
|
-
"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.\
|
|
23011
|
+
"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.",
|
|
23012
23012
|
"tags": [
|
|
23013
23013
|
"actions"
|
|
23014
23014
|
],
|
|
@@ -23080,7 +23080,7 @@
|
|
|
23080
23080
|
"/repos/{owner}/{repo}/actions/runners/downloads": {
|
|
23081
23081
|
"get": {
|
|
23082
23082
|
"summary": "List runner applications for a repository",
|
|
23083
|
-
"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.\
|
|
23083
|
+
"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.",
|
|
23084
23084
|
"tags": [
|
|
23085
23085
|
"actions"
|
|
23086
23086
|
],
|
|
@@ -23129,7 +23129,7 @@
|
|
|
23129
23129
|
"/repos/{owner}/{repo}/actions/runners/registration-token": {
|
|
23130
23130
|
"post": {
|
|
23131
23131
|
"summary": "Create a registration token for a repository",
|
|
23132
|
-
"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.\
|
|
23132
|
+
"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```",
|
|
23133
23133
|
"tags": [
|
|
23134
23134
|
"actions"
|
|
23135
23135
|
],
|
|
@@ -23175,7 +23175,7 @@
|
|
|
23175
23175
|
"/repos/{owner}/{repo}/actions/runners/remove-token": {
|
|
23176
23176
|
"post": {
|
|
23177
23177
|
"summary": "Create a remove token for a repository",
|
|
23178
|
-
"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.\
|
|
23178
|
+
"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```",
|
|
23179
23179
|
"tags": [
|
|
23180
23180
|
"actions"
|
|
23181
23181
|
],
|
|
@@ -23221,7 +23221,7 @@
|
|
|
23221
23221
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}": {
|
|
23222
23222
|
"get": {
|
|
23223
23223
|
"summary": "Get a self-hosted runner for a repository",
|
|
23224
|
-
"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.\
|
|
23224
|
+
"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.",
|
|
23225
23225
|
"tags": [
|
|
23226
23226
|
"actions"
|
|
23227
23227
|
],
|
|
@@ -23268,7 +23268,7 @@
|
|
|
23268
23268
|
},
|
|
23269
23269
|
"delete": {
|
|
23270
23270
|
"summary": "Delete a self-hosted runner from a repository",
|
|
23271
|
-
"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.\
|
|
23271
|
+
"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.",
|
|
23272
23272
|
"tags": [
|
|
23273
23273
|
"actions"
|
|
23274
23274
|
],
|
|
@@ -23305,7 +23305,7 @@
|
|
|
23305
23305
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
|
|
23306
23306
|
"get": {
|
|
23307
23307
|
"summary": "List labels for a self-hosted runner for a repository",
|
|
23308
|
-
"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.\
|
|
23308
|
+
"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.",
|
|
23309
23309
|
"tags": [
|
|
23310
23310
|
"actions"
|
|
23311
23311
|
],
|
|
@@ -23343,7 +23343,7 @@
|
|
|
23343
23343
|
},
|
|
23344
23344
|
"post": {
|
|
23345
23345
|
"summary": "Add custom labels to a self-hosted runner for a repository",
|
|
23346
|
-
"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.\
|
|
23346
|
+
"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.",
|
|
23347
23347
|
"tags": [
|
|
23348
23348
|
"actions"
|
|
23349
23349
|
],
|
|
@@ -23418,7 +23418,7 @@
|
|
|
23418
23418
|
},
|
|
23419
23419
|
"put": {
|
|
23420
23420
|
"summary": "Set custom labels for a self-hosted runner for a repository",
|
|
23421
|
-
"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.\
|
|
23421
|
+
"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.",
|
|
23422
23422
|
"tags": [
|
|
23423
23423
|
"actions"
|
|
23424
23424
|
],
|
|
@@ -23493,7 +23493,7 @@
|
|
|
23493
23493
|
},
|
|
23494
23494
|
"delete": {
|
|
23495
23495
|
"summary": "Remove all custom labels from a self-hosted runner for a repository",
|
|
23496
|
-
"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.\
|
|
23496
|
+
"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.",
|
|
23497
23497
|
"tags": [
|
|
23498
23498
|
"actions"
|
|
23499
23499
|
],
|
|
@@ -23533,7 +23533,7 @@
|
|
|
23533
23533
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
|
|
23534
23534
|
"delete": {
|
|
23535
23535
|
"summary": "Remove a custom label from a self-hosted runner for a repository",
|
|
23536
|
-
"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.\
|
|
23536
|
+
"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.",
|
|
23537
23537
|
"tags": [
|
|
23538
23538
|
"actions"
|
|
23539
23539
|
],
|
|
@@ -24076,7 +24076,7 @@
|
|
|
24076
24076
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
|
|
24077
24077
|
"post": {
|
|
24078
24078
|
"summary": "Cancel a workflow run",
|
|
24079
|
-
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
24079
|
+
"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.",
|
|
24080
24080
|
"tags": [
|
|
24081
24081
|
"actions"
|
|
24082
24082
|
],
|
|
@@ -28770,7 +28770,7 @@
|
|
|
28770
28770
|
},
|
|
28771
28771
|
"patch": {
|
|
28772
28772
|
"summary": "Update a check run",
|
|
28773
|
-
"description": "**Note:** The
|
|
28773
|
+
"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.",
|
|
28774
28774
|
"tags": [
|
|
28775
28775
|
"checks"
|
|
28776
28776
|
],
|
|
@@ -29443,7 +29443,7 @@
|
|
|
29443
29443
|
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
|
|
29444
29444
|
"get": {
|
|
29445
29445
|
"summary": "List check runs in a check suite",
|
|
29446
|
-
"description": "
|
|
29446
|
+
"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.",
|
|
29447
29447
|
"tags": [
|
|
29448
29448
|
"checks"
|
|
29449
29449
|
],
|
|
@@ -31621,7 +31621,7 @@
|
|
|
31621
31621
|
"/repos/{owner}/{repo}/commits/{ref}/check-runs": {
|
|
31622
31622
|
"get": {
|
|
31623
31623
|
"summary": "List check runs for a Git reference",
|
|
31624
|
-
"description": "**Note:** The
|
|
31624
|
+
"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.7/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.7/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.",
|
|
31625
31625
|
"tags": [
|
|
31626
31626
|
"checks"
|
|
31627
31627
|
],
|
|
@@ -31724,7 +31724,7 @@
|
|
|
31724
31724
|
"/repos/{owner}/{repo}/commits/{ref}/check-suites": {
|
|
31725
31725
|
"get": {
|
|
31726
31726
|
"summary": "List check suites for a Git reference",
|
|
31727
|
-
"description": "
|
|
31727
|
+
"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`.",
|
|
31728
31728
|
"tags": [
|
|
31729
31729
|
"checks"
|
|
31730
31730
|
],
|
|
@@ -33984,7 +33984,7 @@
|
|
|
33984
33984
|
"content": {
|
|
33985
33985
|
"application/json": {
|
|
33986
33986
|
"schema": {
|
|
33987
|
-
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
|
|
33987
|
+
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type"
|
|
33988
33988
|
},
|
|
33989
33989
|
"examples": {
|
|
33990
33990
|
"example-wildcard": {
|
|
@@ -34041,7 +34041,7 @@
|
|
|
34041
34041
|
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
34042
34042
|
"get": {
|
|
34043
34043
|
"summary": "Get a deployment branch policy",
|
|
34044
|
-
"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 `
|
|
34044
|
+
"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.",
|
|
34045
34045
|
"tags": [
|
|
34046
34046
|
"repos"
|
|
34047
34047
|
],
|
|
@@ -42090,7 +42090,7 @@
|
|
|
42090
42090
|
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
|
|
42091
42091
|
"get": {
|
|
42092
42092
|
"summary": "List reactions for a pull request review comment",
|
|
42093
|
-
"description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
42093
|
+
"description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
42094
42094
|
"tags": [
|
|
42095
42095
|
"reactions"
|
|
42096
42096
|
],
|
|
@@ -79267,7 +79267,7 @@
|
|
|
79267
79267
|
}
|
|
79268
79268
|
},
|
|
79269
79269
|
"x-github": {
|
|
79270
|
-
"githubCloudOnly":
|
|
79270
|
+
"githubCloudOnly": true,
|
|
79271
79271
|
"category": "webhooks",
|
|
79272
79272
|
"subcategory": "user",
|
|
79273
79273
|
"supported-webhook-types": [
|
|
@@ -79374,7 +79374,7 @@
|
|
|
79374
79374
|
}
|
|
79375
79375
|
},
|
|
79376
79376
|
"x-github": {
|
|
79377
|
-
"githubCloudOnly":
|
|
79377
|
+
"githubCloudOnly": true,
|
|
79378
79378
|
"category": "webhooks",
|
|
79379
79379
|
"subcategory": "user",
|
|
79380
79380
|
"supported-webhook-types": [
|
|
@@ -91963,7 +91963,6 @@
|
|
|
91963
91963
|
"forks",
|
|
91964
91964
|
"forks_count",
|
|
91965
91965
|
"git_url",
|
|
91966
|
-
"has_downloads",
|
|
91967
91966
|
"has_issues",
|
|
91968
91967
|
"has_projects",
|
|
91969
91968
|
"has_wiki",
|
|
@@ -97713,6 +97712,20 @@
|
|
|
97713
97712
|
}
|
|
97714
97713
|
}
|
|
97715
97714
|
},
|
|
97715
|
+
"deployment-branch-policy-name-pattern-with-type": {
|
|
97716
|
+
"title": "Deployment branch and tag policy name pattern",
|
|
97717
|
+
"type": "object",
|
|
97718
|
+
"properties": {
|
|
97719
|
+
"name": {
|
|
97720
|
+
"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).",
|
|
97721
|
+
"type": "string",
|
|
97722
|
+
"example": "release/*"
|
|
97723
|
+
}
|
|
97724
|
+
},
|
|
97725
|
+
"required": [
|
|
97726
|
+
"name"
|
|
97727
|
+
]
|
|
97728
|
+
},
|
|
97716
97729
|
"deployment-branch-policy-name-pattern": {
|
|
97717
97730
|
"title": "Deployment branch policy name pattern",
|
|
97718
97731
|
"type": "object",
|
|
@@ -111364,7 +111377,7 @@
|
|
|
111364
111377
|
"format": "uri"
|
|
111365
111378
|
},
|
|
111366
111379
|
"conclusion": {
|
|
111367
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
111380
|
+
"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`.",
|
|
111368
111381
|
"type": "string",
|
|
111369
111382
|
"nullable": true,
|
|
111370
111383
|
"enum": [
|
|
@@ -112145,7 +112158,7 @@
|
|
|
112145
112158
|
"format": "uri"
|
|
112146
112159
|
},
|
|
112147
112160
|
"conclusion": {
|
|
112148
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
112161
|
+
"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.",
|
|
112149
112162
|
"type": "string",
|
|
112150
112163
|
"nullable": true,
|
|
112151
112164
|
"enum": [
|
|
@@ -112919,7 +112932,7 @@
|
|
|
112919
112932
|
"format": "uri"
|
|
112920
112933
|
},
|
|
112921
112934
|
"conclusion": {
|
|
112922
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
112935
|
+
"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.",
|
|
112923
112936
|
"type": "string",
|
|
112924
112937
|
"nullable": true,
|
|
112925
112938
|
"enum": [
|
|
@@ -113324,7 +113337,7 @@
|
|
|
113324
113337
|
]
|
|
113325
113338
|
},
|
|
113326
113339
|
"dismissed_reason": {
|
|
113327
|
-
"description": "The reason for dismissing or closing the alert.
|
|
113340
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
113328
113341
|
"type": "string",
|
|
113329
113342
|
"nullable": true,
|
|
113330
113343
|
"enum": [
|
|
@@ -113643,7 +113656,7 @@
|
|
|
113643
113656
|
]
|
|
113644
113657
|
},
|
|
113645
113658
|
"dismissed_reason": {
|
|
113646
|
-
"description": "The reason for dismissing or closing the alert.
|
|
113659
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
113647
113660
|
"type": "string",
|
|
113648
113661
|
"nullable": true,
|
|
113649
113662
|
"enum": [
|
|
@@ -114250,7 +114263,7 @@
|
|
|
114250
114263
|
]
|
|
114251
114264
|
},
|
|
114252
114265
|
"dismissed_reason": {
|
|
114253
|
-
"description": "The reason for dismissing or closing the alert.
|
|
114266
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
114254
114267
|
"type": "string",
|
|
114255
114268
|
"nullable": true,
|
|
114256
114269
|
"enum": [
|
|
@@ -120625,7 +120638,7 @@
|
|
|
120625
120638
|
"format": "date-time"
|
|
120626
120639
|
},
|
|
120627
120640
|
"conclusion": {
|
|
120628
|
-
"description": "The result of the completed check run.
|
|
120641
|
+
"description": "The result of the completed check run. This value will be `null` until the check run has completed.",
|
|
120629
120642
|
"type": "string",
|
|
120630
120643
|
"nullable": true,
|
|
120631
120644
|
"enum": [
|
|
@@ -145382,6 +145395,10 @@
|
|
|
145382
145395
|
"type": "string",
|
|
145383
145396
|
"format": "uri"
|
|
145384
145397
|
},
|
|
145398
|
+
"has_discussions": {
|
|
145399
|
+
"description": "Whether the repository has discussions enabled.",
|
|
145400
|
+
"type": "boolean"
|
|
145401
|
+
},
|
|
145385
145402
|
"has_downloads": {
|
|
145386
145403
|
"description": "Whether downloads are enabled.",
|
|
145387
145404
|
"type": "boolean",
|
|
@@ -145738,6 +145755,10 @@
|
|
|
145738
145755
|
},
|
|
145739
145756
|
"watchers_count": {
|
|
145740
145757
|
"type": "integer"
|
|
145758
|
+
},
|
|
145759
|
+
"web_commit_signoff_required": {
|
|
145760
|
+
"description": "Whether to require commit signoff.",
|
|
145761
|
+
"type": "boolean"
|
|
145741
145762
|
}
|
|
145742
145763
|
},
|
|
145743
145764
|
"required": [
|
|
@@ -267241,7 +267262,7 @@
|
|
|
267241
267262
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
267242
267263
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
267243
267264
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
267244
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
267265
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
267245
267266
|
"status": "completed",
|
|
267246
267267
|
"conclusion": "success",
|
|
267247
267268
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -267874,7 +267895,7 @@
|
|
|
267874
267895
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
267875
267896
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
267876
267897
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
267877
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
267898
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
267878
267899
|
"status": "completed",
|
|
267879
267900
|
"conclusion": "success",
|
|
267880
267901
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -282601,7 +282622,7 @@
|
|
|
282601
282622
|
},
|
|
282602
282623
|
"hook-id": {
|
|
282603
282624
|
"name": "hook_id",
|
|
282604
|
-
"description": "The unique identifier of the hook.",
|
|
282625
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
282605
282626
|
"in": "path",
|
|
282606
282627
|
"required": true,
|
|
282607
282628
|
"schema": {
|