@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
|
@@ -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": {
|
|
@@ -741,7 +741,7 @@
|
|
|
741
741
|
"parameters": [
|
|
742
742
|
{
|
|
743
743
|
"name": "hook_id",
|
|
744
|
-
"description": "The unique identifier of the hook.",
|
|
744
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
745
745
|
"in": "path",
|
|
746
746
|
"required": true,
|
|
747
747
|
"schema": {
|
|
@@ -856,7 +856,7 @@
|
|
|
856
856
|
"parameters": [
|
|
857
857
|
{
|
|
858
858
|
"name": "hook_id",
|
|
859
|
-
"description": "The unique identifier of the hook.",
|
|
859
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
860
860
|
"in": "path",
|
|
861
861
|
"required": true,
|
|
862
862
|
"schema": {
|
|
@@ -1027,7 +1027,7 @@
|
|
|
1027
1027
|
"parameters": [
|
|
1028
1028
|
{
|
|
1029
1029
|
"name": "hook_id",
|
|
1030
|
-
"description": "The unique identifier of the hook.",
|
|
1030
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
1031
1031
|
"in": "path",
|
|
1032
1032
|
"required": true,
|
|
1033
1033
|
"schema": {
|
|
@@ -1064,7 +1064,7 @@
|
|
|
1064
1064
|
"parameters": [
|
|
1065
1065
|
{
|
|
1066
1066
|
"name": "hook_id",
|
|
1067
|
-
"description": "The unique identifier of the hook.",
|
|
1067
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
1068
1068
|
"in": "path",
|
|
1069
1069
|
"required": true,
|
|
1070
1070
|
"schema": {
|
|
@@ -18016,7 +18016,7 @@
|
|
|
18016
18016
|
},
|
|
18017
18017
|
"post": {
|
|
18018
18018
|
"summary": "Create a new authorization",
|
|
18019
|
-
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/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.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/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.10/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.10/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.10/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.10/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed.
|
|
18019
|
+
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/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.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/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.10/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.10/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.10/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.10/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.10/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.",
|
|
18020
18020
|
"tags": [
|
|
18021
18021
|
"oauth-authorizations"
|
|
18022
18022
|
],
|
|
@@ -90169,7 +90169,7 @@
|
|
|
90169
90169
|
},
|
|
90170
90170
|
{
|
|
90171
90171
|
"name": "hook_id",
|
|
90172
|
-
"description": "The unique identifier of the hook.",
|
|
90172
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
90173
90173
|
"in": "path",
|
|
90174
90174
|
"required": true,
|
|
90175
90175
|
"schema": {
|
|
@@ -90356,7 +90356,7 @@
|
|
|
90356
90356
|
},
|
|
90357
90357
|
{
|
|
90358
90358
|
"name": "hook_id",
|
|
90359
|
-
"description": "The unique identifier of the hook.",
|
|
90359
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
90360
90360
|
"in": "path",
|
|
90361
90361
|
"required": true,
|
|
90362
90362
|
"schema": {
|
|
@@ -90689,7 +90689,7 @@
|
|
|
90689
90689
|
},
|
|
90690
90690
|
{
|
|
90691
90691
|
"name": "hook_id",
|
|
90692
|
-
"description": "The unique identifier of the hook.",
|
|
90692
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
90693
90693
|
"in": "path",
|
|
90694
90694
|
"required": true,
|
|
90695
90695
|
"schema": {
|
|
@@ -90761,7 +90761,7 @@
|
|
|
90761
90761
|
},
|
|
90762
90762
|
{
|
|
90763
90763
|
"name": "hook_id",
|
|
90764
|
-
"description": "The unique identifier of the hook.",
|
|
90764
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
90765
90765
|
"in": "path",
|
|
90766
90766
|
"required": true,
|
|
90767
90767
|
"schema": {
|
|
@@ -90854,7 +90854,7 @@
|
|
|
90854
90854
|
},
|
|
90855
90855
|
{
|
|
90856
90856
|
"name": "hook_id",
|
|
90857
|
-
"description": "The unique identifier of the hook.",
|
|
90857
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
90858
90858
|
"in": "path",
|
|
90859
90859
|
"required": true,
|
|
90860
90860
|
"schema": {
|
|
@@ -91000,7 +91000,7 @@
|
|
|
91000
91000
|
},
|
|
91001
91001
|
{
|
|
91002
91002
|
"name": "hook_id",
|
|
91003
|
-
"description": "The unique identifier of the hook.",
|
|
91003
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
91004
91004
|
"in": "path",
|
|
91005
91005
|
"required": true,
|
|
91006
91006
|
"schema": {
|
|
@@ -91319,7 +91319,7 @@
|
|
|
91319
91319
|
},
|
|
91320
91320
|
{
|
|
91321
91321
|
"name": "hook_id",
|
|
91322
|
-
"description": "The unique identifier of the hook.",
|
|
91322
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
91323
91323
|
"in": "path",
|
|
91324
91324
|
"required": true,
|
|
91325
91325
|
"schema": {
|
|
@@ -91681,7 +91681,7 @@
|
|
|
91681
91681
|
},
|
|
91682
91682
|
{
|
|
91683
91683
|
"name": "hook_id",
|
|
91684
|
-
"description": "The unique identifier of the hook.",
|
|
91684
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
91685
91685
|
"in": "path",
|
|
91686
91686
|
"required": true,
|
|
91687
91687
|
"schema": {
|
|
@@ -91876,7 +91876,7 @@
|
|
|
91876
91876
|
},
|
|
91877
91877
|
{
|
|
91878
91878
|
"name": "hook_id",
|
|
91879
|
-
"description": "The unique identifier of the hook.",
|
|
91879
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
91880
91880
|
"in": "path",
|
|
91881
91881
|
"required": true,
|
|
91882
91882
|
"schema": {
|
|
@@ -99520,7 +99520,7 @@
|
|
|
99520
99520
|
},
|
|
99521
99521
|
"post": {
|
|
99522
99522
|
"summary": "Start an organization migration",
|
|
99523
|
-
"description": "Initiates the generation of a migration archive.",
|
|
99523
|
+
"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.10/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).\"",
|
|
99524
99524
|
"tags": [
|
|
99525
99525
|
"migrations"
|
|
99526
99526
|
],
|
|
@@ -99596,7 +99596,7 @@
|
|
|
99596
99596
|
},
|
|
99597
99597
|
"exclude": {
|
|
99598
99598
|
"type": "array",
|
|
99599
|
-
"description": "Exclude related items from being returned in the response in order to improve performance of the request.
|
|
99599
|
+
"description": "Exclude related items from being returned in the response in order to improve performance of the request.",
|
|
99600
99600
|
"items": {
|
|
99601
99601
|
"type": "string",
|
|
99602
99602
|
"enum": [
|
|
@@ -140414,7 +140414,6 @@
|
|
|
140414
140414
|
"forks",
|
|
140415
140415
|
"forks_count",
|
|
140416
140416
|
"git_url",
|
|
140417
|
-
"has_downloads",
|
|
140418
140417
|
"has_issues",
|
|
140419
140418
|
"has_projects",
|
|
140420
140419
|
"has_wiki",
|
|
@@ -145763,7 +145762,6 @@
|
|
|
145763
145762
|
"forks",
|
|
145764
145763
|
"forks_count",
|
|
145765
145764
|
"git_url",
|
|
145766
|
-
"has_downloads",
|
|
145767
145765
|
"has_issues",
|
|
145768
145766
|
"has_projects",
|
|
145769
145767
|
"has_wiki",
|
|
@@ -148054,7 +148052,7 @@
|
|
|
148054
148052
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
148055
148053
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
148056
148054
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
148057
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
148055
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
148058
148056
|
"status": "completed",
|
|
148059
148057
|
"conclusion": "success",
|
|
148060
148058
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -148236,7 +148234,7 @@
|
|
|
148236
148234
|
"/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
|
|
148237
148235
|
"post": {
|
|
148238
148236
|
"summary": "Re-run a job from a workflow run",
|
|
148239
|
-
"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.\
|
|
148237
|
+
"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.",
|
|
148240
148238
|
"tags": [
|
|
148241
148239
|
"actions"
|
|
148242
148240
|
],
|
|
@@ -148874,7 +148872,7 @@
|
|
|
148874
148872
|
"/repos/{owner}/{repo}/actions/organization-variables": {
|
|
148875
148873
|
"get": {
|
|
148876
148874
|
"summary": "List repository organization variables",
|
|
148877
|
-
"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.\
|
|
148875
|
+
"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.",
|
|
148878
148876
|
"tags": [
|
|
148879
148877
|
"actions"
|
|
148880
148878
|
],
|
|
@@ -149672,7 +149670,7 @@
|
|
|
149672
149670
|
"/repos/{owner}/{repo}/actions/runners": {
|
|
149673
149671
|
"get": {
|
|
149674
149672
|
"summary": "List self-hosted runners for a repository",
|
|
149675
|
-
"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.\
|
|
149673
|
+
"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.",
|
|
149676
149674
|
"tags": [
|
|
149677
149675
|
"actions"
|
|
149678
149676
|
],
|
|
@@ -149897,7 +149895,7 @@
|
|
|
149897
149895
|
"/repos/{owner}/{repo}/actions/runners/downloads": {
|
|
149898
149896
|
"get": {
|
|
149899
149897
|
"summary": "List runner applications for a repository",
|
|
149900
|
-
"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.\
|
|
149898
|
+
"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.",
|
|
149901
149899
|
"tags": [
|
|
149902
149900
|
"actions"
|
|
149903
149901
|
],
|
|
@@ -150028,7 +150026,7 @@
|
|
|
150028
150026
|
"/repos/{owner}/{repo}/actions/runners/generate-jitconfig": {
|
|
150029
150027
|
"post": {
|
|
150030
150028
|
"summary": "Create configuration for a just-in-time runner for a repository",
|
|
150031
|
-
"description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
150029
|
+
"description": "Generates a configuration that can be passed to the runner application at startup.\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.",
|
|
150032
150030
|
"tags": [
|
|
150033
150031
|
"actions"
|
|
150034
150032
|
],
|
|
@@ -150309,7 +150307,7 @@
|
|
|
150309
150307
|
"/repos/{owner}/{repo}/actions/runners/registration-token": {
|
|
150310
150308
|
"post": {
|
|
150311
150309
|
"summary": "Create a registration token for a repository",
|
|
150312
|
-
"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.\
|
|
150310
|
+
"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```",
|
|
150313
150311
|
"tags": [
|
|
150314
150312
|
"actions"
|
|
150315
150313
|
],
|
|
@@ -151615,7 +151613,7 @@
|
|
|
151615
151613
|
"/repos/{owner}/{repo}/actions/runners/remove-token": {
|
|
151616
151614
|
"post": {
|
|
151617
151615
|
"summary": "Create a remove token for a repository",
|
|
151618
|
-
"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.\
|
|
151616
|
+
"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```",
|
|
151619
151617
|
"tags": [
|
|
151620
151618
|
"actions"
|
|
151621
151619
|
],
|
|
@@ -152921,7 +152919,7 @@
|
|
|
152921
152919
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}": {
|
|
152922
152920
|
"get": {
|
|
152923
152921
|
"summary": "Get a self-hosted runner for a repository",
|
|
152924
|
-
"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.\
|
|
152922
|
+
"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.",
|
|
152925
152923
|
"tags": [
|
|
152926
152924
|
"actions"
|
|
152927
152925
|
],
|
|
@@ -153083,7 +153081,7 @@
|
|
|
153083
153081
|
},
|
|
153084
153082
|
"delete": {
|
|
153085
153083
|
"summary": "Delete a self-hosted runner from a repository",
|
|
153086
|
-
"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.\
|
|
153084
|
+
"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.",
|
|
153087
153085
|
"tags": [
|
|
153088
153086
|
"actions"
|
|
153089
153087
|
],
|
|
@@ -153138,7 +153136,7 @@
|
|
|
153138
153136
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
|
|
153139
153137
|
"get": {
|
|
153140
153138
|
"summary": "List labels for a self-hosted runner for a repository",
|
|
153141
|
-
"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.\
|
|
153139
|
+
"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.",
|
|
153142
153140
|
"tags": [
|
|
153143
153141
|
"actions"
|
|
153144
153142
|
],
|
|
@@ -153291,7 +153289,7 @@
|
|
|
153291
153289
|
},
|
|
153292
153290
|
"post": {
|
|
153293
153291
|
"summary": "Add custom labels to a self-hosted runner for a repository",
|
|
153294
|
-
"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.\
|
|
153292
|
+
"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.",
|
|
153295
153293
|
"tags": [
|
|
153296
153294
|
"actions"
|
|
153297
153295
|
],
|
|
@@ -153508,7 +153506,7 @@
|
|
|
153508
153506
|
},
|
|
153509
153507
|
"put": {
|
|
153510
153508
|
"summary": "Set custom labels for a self-hosted runner for a repository",
|
|
153511
|
-
"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.\
|
|
153509
|
+
"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.",
|
|
153512
153510
|
"tags": [
|
|
153513
153511
|
"actions"
|
|
153514
153512
|
],
|
|
@@ -153725,7 +153723,7 @@
|
|
|
153725
153723
|
},
|
|
153726
153724
|
"delete": {
|
|
153727
153725
|
"summary": "Remove all custom labels from a self-hosted runner for a repository",
|
|
153728
|
-
"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.\
|
|
153726
|
+
"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.",
|
|
153729
153727
|
"tags": [
|
|
153730
153728
|
"actions"
|
|
153731
153729
|
],
|
|
@@ -153875,7 +153873,7 @@
|
|
|
153875
153873
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
|
|
153876
153874
|
"delete": {
|
|
153877
153875
|
"summary": "Remove a custom label from a self-hosted runner for a repository",
|
|
153878
|
-
"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.\
|
|
153876
|
+
"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.",
|
|
153879
153877
|
"tags": [
|
|
153880
153878
|
"actions"
|
|
153881
153879
|
],
|
|
@@ -161654,7 +161652,7 @@
|
|
|
161654
161652
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
161655
161653
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
161656
161654
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
161657
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
161655
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
161658
161656
|
"status": "completed",
|
|
161659
161657
|
"conclusion": "success",
|
|
161660
161658
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -161881,7 +161879,7 @@
|
|
|
161881
161879
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
|
|
161882
161880
|
"post": {
|
|
161883
161881
|
"summary": "Cancel a workflow run",
|
|
161884
|
-
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
161882
|
+
"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.",
|
|
161885
161883
|
"tags": [
|
|
161886
161884
|
"actions"
|
|
161887
161885
|
],
|
|
@@ -162420,7 +162418,7 @@
|
|
|
162420
162418
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
162421
162419
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
162422
162420
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
162423
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
162421
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
162424
162422
|
"status": "completed",
|
|
162425
162423
|
"conclusion": "success",
|
|
162426
162424
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -164506,7 +164504,7 @@
|
|
|
164506
164504
|
"/repos/{owner}/{repo}/actions/variables": {
|
|
164507
164505
|
"get": {
|
|
164508
164506
|
"summary": "List repository variables",
|
|
164509
|
-
"description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
164507
|
+
"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.",
|
|
164510
164508
|
"tags": [
|
|
164511
164509
|
"actions"
|
|
164512
164510
|
],
|
|
@@ -164650,7 +164648,7 @@
|
|
|
164650
164648
|
},
|
|
164651
164649
|
"post": {
|
|
164652
164650
|
"summary": "Create a repository variable",
|
|
164653
|
-
"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.\
|
|
164651
|
+
"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.",
|
|
164654
164652
|
"tags": [
|
|
164655
164653
|
"actions"
|
|
164656
164654
|
],
|
|
@@ -164744,7 +164742,7 @@
|
|
|
164744
164742
|
"/repos/{owner}/{repo}/actions/variables/{name}": {
|
|
164745
164743
|
"get": {
|
|
164746
164744
|
"summary": "Get a repository variable",
|
|
164747
|
-
"description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
164745
|
+
"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.",
|
|
164748
164746
|
"tags": [
|
|
164749
164747
|
"actions"
|
|
164750
164748
|
],
|
|
@@ -164845,7 +164843,7 @@
|
|
|
164845
164843
|
},
|
|
164846
164844
|
"patch": {
|
|
164847
164845
|
"summary": "Update a repository variable",
|
|
164848
|
-
"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.\
|
|
164846
|
+
"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.",
|
|
164849
164847
|
"tags": [
|
|
164850
164848
|
"actions"
|
|
164851
164849
|
],
|
|
@@ -164926,7 +164924,7 @@
|
|
|
164926
164924
|
},
|
|
164927
164925
|
"delete": {
|
|
164928
164926
|
"summary": "Delete a repository variable",
|
|
164929
|
-
"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.\
|
|
164927
|
+
"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.",
|
|
164930
164928
|
"tags": [
|
|
164931
164929
|
"actions"
|
|
164932
164930
|
],
|
|
@@ -191307,7 +191305,7 @@
|
|
|
191307
191305
|
},
|
|
191308
191306
|
"patch": {
|
|
191309
191307
|
"summary": "Update a check run",
|
|
191310
|
-
"description": "**Note:** The
|
|
191308
|
+
"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.",
|
|
191311
191309
|
"tags": [
|
|
191312
191310
|
"checks"
|
|
191313
191311
|
],
|
|
@@ -198394,7 +198392,7 @@
|
|
|
198394
198392
|
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
|
|
198395
198393
|
"get": {
|
|
198396
198394
|
"summary": "List check runs in a check suite",
|
|
198397
|
-
"description": "
|
|
198395
|
+
"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.",
|
|
198398
198396
|
"tags": [
|
|
198399
198397
|
"checks"
|
|
198400
198398
|
],
|
|
@@ -202728,7 +202726,7 @@
|
|
|
202728
202726
|
]
|
|
202729
202727
|
},
|
|
202730
202728
|
"languages": {
|
|
202731
|
-
"description": "Languages to be
|
|
202729
|
+
"description": "Languages to be analyzed.",
|
|
202732
202730
|
"type": "array",
|
|
202733
202731
|
"items": {
|
|
202734
202732
|
"type": "string",
|
|
@@ -202917,7 +202915,7 @@
|
|
|
202917
202915
|
]
|
|
202918
202916
|
},
|
|
202919
202917
|
"languages": {
|
|
202920
|
-
"description": "CodeQL languages to be analyzed.
|
|
202918
|
+
"description": "CodeQL languages to be analyzed.",
|
|
202921
202919
|
"type": "array",
|
|
202922
202920
|
"items": {
|
|
202923
202921
|
"type": "string",
|
|
@@ -202997,7 +202995,7 @@
|
|
|
202997
202995
|
}
|
|
202998
202996
|
},
|
|
202999
202997
|
"403": {
|
|
203000
|
-
"description": "Response if GitHub Advanced Security is not enabled for this repository",
|
|
202998
|
+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
|
|
203001
202999
|
"content": {
|
|
203002
203000
|
"application/json": {
|
|
203003
203001
|
"schema": {
|
|
@@ -214140,7 +214138,7 @@
|
|
|
214140
214138
|
"/repos/{owner}/{repo}/commits/{ref}/check-runs": {
|
|
214141
214139
|
"get": {
|
|
214142
214140
|
"summary": "List check runs for a Git reference",
|
|
214143
|
-
"description": "**Note:** The
|
|
214141
|
+
"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.10/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.10/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.",
|
|
214144
214142
|
"tags": [
|
|
214145
214143
|
"checks"
|
|
214146
214144
|
],
|
|
@@ -215197,7 +215195,7 @@
|
|
|
215197
215195
|
"/repos/{owner}/{repo}/commits/{ref}/check-suites": {
|
|
215198
215196
|
"get": {
|
|
215199
215197
|
"summary": "List check suites for a Git reference",
|
|
215200
|
-
"description": "
|
|
215198
|
+
"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`.",
|
|
215201
215199
|
"tags": [
|
|
215202
215200
|
"checks"
|
|
215203
215201
|
],
|
|
@@ -231390,7 +231388,6 @@
|
|
|
231390
231388
|
"slug": "justice-league",
|
|
231391
231389
|
"description": "A great team.",
|
|
231392
231390
|
"privacy": "closed",
|
|
231393
|
-
"notification_setting": "notifications_enabled",
|
|
231394
231391
|
"permission": "admin",
|
|
231395
231392
|
"members_url": "https://api.github.com/teams/1/members{/member}",
|
|
231396
231393
|
"repositories_url": "https://api.github.com/teams/1/repos",
|
|
@@ -231990,7 +231987,6 @@
|
|
|
231990
231987
|
"slug": "justice-league",
|
|
231991
231988
|
"description": "A great team.",
|
|
231992
231989
|
"privacy": "closed",
|
|
231993
|
-
"notification_setting": "notifications_enabled",
|
|
231994
231990
|
"permission": "admin",
|
|
231995
231991
|
"members_url": "https://api.github.com/teams/1/members{/member}",
|
|
231996
231992
|
"repositories_url": "https://api.github.com/teams/1/repos",
|
|
@@ -232669,7 +232665,6 @@
|
|
|
232669
232665
|
"slug": "justice-league",
|
|
232670
232666
|
"description": "A great team.",
|
|
232671
232667
|
"privacy": "closed",
|
|
232672
|
-
"notification_setting": "notifications_enabled",
|
|
232673
232668
|
"permission": "admin",
|
|
232674
232669
|
"members_url": "https://api.github.com/teams/1/members{/member}",
|
|
232675
232670
|
"repositories_url": "https://api.github.com/teams/1/repos",
|
|
@@ -232961,11 +232956,11 @@
|
|
|
232961
232956
|
"content": {
|
|
232962
232957
|
"application/json": {
|
|
232963
232958
|
"schema": {
|
|
232964
|
-
"title": "Deployment branch policy name pattern",
|
|
232959
|
+
"title": "Deployment branch and tag policy name pattern",
|
|
232965
232960
|
"type": "object",
|
|
232966
232961
|
"properties": {
|
|
232967
232962
|
"name": {
|
|
232968
|
-
"description": "The name pattern that branches 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).",
|
|
232963
|
+
"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).",
|
|
232969
232964
|
"type": "string",
|
|
232970
232965
|
"example": "release/*"
|
|
232971
232966
|
}
|
|
@@ -233055,7 +233050,7 @@
|
|
|
233055
233050
|
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
233056
233051
|
"get": {
|
|
233057
233052
|
"summary": "Get a deployment branch policy",
|
|
233058
|
-
"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 `
|
|
233053
|
+
"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.",
|
|
233059
233054
|
"tags": [
|
|
233060
233055
|
"repos"
|
|
233061
233056
|
],
|
|
@@ -242717,7 +242712,6 @@
|
|
|
242717
242712
|
"forks",
|
|
242718
242713
|
"forks_count",
|
|
242719
242714
|
"git_url",
|
|
242720
|
-
"has_downloads",
|
|
242721
242715
|
"has_issues",
|
|
242722
242716
|
"has_projects",
|
|
242723
242717
|
"has_wiki",
|
|
@@ -247555,7 +247549,7 @@
|
|
|
247555
247549
|
},
|
|
247556
247550
|
{
|
|
247557
247551
|
"name": "hook_id",
|
|
247558
|
-
"description": "The unique identifier of the hook.",
|
|
247552
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
247559
247553
|
"in": "path",
|
|
247560
247554
|
"required": true,
|
|
247561
247555
|
"schema": {
|
|
@@ -247828,7 +247822,7 @@
|
|
|
247828
247822
|
},
|
|
247829
247823
|
{
|
|
247830
247824
|
"name": "hook_id",
|
|
247831
|
-
"description": "The unique identifier of the hook.",
|
|
247825
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
247832
247826
|
"in": "path",
|
|
247833
247827
|
"required": true,
|
|
247834
247828
|
"schema": {
|
|
@@ -248266,7 +248260,7 @@
|
|
|
248266
248260
|
},
|
|
248267
248261
|
{
|
|
248268
248262
|
"name": "hook_id",
|
|
248269
|
-
"description": "The unique identifier of the hook.",
|
|
248263
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
248270
248264
|
"in": "path",
|
|
248271
248265
|
"required": true,
|
|
248272
248266
|
"schema": {
|
|
@@ -248347,7 +248341,7 @@
|
|
|
248347
248341
|
},
|
|
248348
248342
|
{
|
|
248349
248343
|
"name": "hook_id",
|
|
248350
|
-
"description": "The unique identifier of the hook.",
|
|
248344
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
248351
248345
|
"in": "path",
|
|
248352
248346
|
"required": true,
|
|
248353
248347
|
"schema": {
|
|
@@ -248449,7 +248443,7 @@
|
|
|
248449
248443
|
},
|
|
248450
248444
|
{
|
|
248451
248445
|
"name": "hook_id",
|
|
248452
|
-
"description": "The unique identifier of the hook.",
|
|
248446
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
248453
248447
|
"in": "path",
|
|
248454
248448
|
"required": true,
|
|
248455
248449
|
"schema": {
|
|
@@ -248603,7 +248597,7 @@
|
|
|
248603
248597
|
},
|
|
248604
248598
|
{
|
|
248605
248599
|
"name": "hook_id",
|
|
248606
|
-
"description": "The unique identifier of the hook.",
|
|
248600
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
248607
248601
|
"in": "path",
|
|
248608
248602
|
"required": true,
|
|
248609
248603
|
"schema": {
|
|
@@ -248931,7 +248925,7 @@
|
|
|
248931
248925
|
},
|
|
248932
248926
|
{
|
|
248933
248927
|
"name": "hook_id",
|
|
248934
|
-
"description": "The unique identifier of the hook.",
|
|
248928
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
248935
248929
|
"in": "path",
|
|
248936
248930
|
"required": true,
|
|
248937
248931
|
"schema": {
|
|
@@ -249302,7 +249296,7 @@
|
|
|
249302
249296
|
},
|
|
249303
249297
|
{
|
|
249304
249298
|
"name": "hook_id",
|
|
249305
|
-
"description": "The unique identifier of the hook.",
|
|
249299
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
249306
249300
|
"in": "path",
|
|
249307
249301
|
"required": true,
|
|
249308
249302
|
"schema": {
|
|
@@ -249506,7 +249500,7 @@
|
|
|
249506
249500
|
},
|
|
249507
249501
|
{
|
|
249508
249502
|
"name": "hook_id",
|
|
249509
|
-
"description": "The unique identifier of the hook.",
|
|
249503
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
249510
249504
|
"in": "path",
|
|
249511
249505
|
"required": true,
|
|
249512
249506
|
"schema": {
|
|
@@ -249587,7 +249581,7 @@
|
|
|
249587
249581
|
},
|
|
249588
249582
|
{
|
|
249589
249583
|
"name": "hook_id",
|
|
249590
|
-
"description": "The unique identifier of the hook.",
|
|
249584
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
249591
249585
|
"in": "path",
|
|
249592
249586
|
"required": true,
|
|
249593
249587
|
"schema": {
|
|
@@ -323935,7 +323929,7 @@
|
|
|
323935
323929
|
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
|
|
323936
323930
|
"get": {
|
|
323937
323931
|
"summary": "List reactions for a pull request review comment",
|
|
323938
|
-
"description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
323932
|
+
"description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
323939
323933
|
"tags": [
|
|
323940
323934
|
"reactions"
|
|
323941
323935
|
],
|
|
@@ -364585,7 +364579,7 @@
|
|
|
364585
364579
|
"/repositories/{repository_id}/environments/{environment_name}/variables": {
|
|
364586
364580
|
"get": {
|
|
364587
364581
|
"summary": "List environment variables",
|
|
364588
|
-
"description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
364582
|
+
"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.",
|
|
364589
364583
|
"tags": [
|
|
364590
364584
|
"actions"
|
|
364591
364585
|
],
|
|
@@ -364729,7 +364723,7 @@
|
|
|
364729
364723
|
},
|
|
364730
364724
|
"post": {
|
|
364731
364725
|
"summary": "Create an environment variable",
|
|
364732
|
-
"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.\
|
|
364726
|
+
"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.",
|
|
364733
364727
|
"tags": [
|
|
364734
364728
|
"actions"
|
|
364735
364729
|
],
|
|
@@ -364823,7 +364817,7 @@
|
|
|
364823
364817
|
"/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
|
|
364824
364818
|
"get": {
|
|
364825
364819
|
"summary": "Get an environment variable",
|
|
364826
|
-
"description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
364820
|
+
"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.",
|
|
364827
364821
|
"tags": [
|
|
364828
364822
|
"actions"
|
|
364829
364823
|
],
|
|
@@ -364924,7 +364918,7 @@
|
|
|
364924
364918
|
},
|
|
364925
364919
|
"patch": {
|
|
364926
364920
|
"summary": "Update an environment variable",
|
|
364927
|
-
"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.\
|
|
364921
|
+
"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.",
|
|
364928
364922
|
"tags": [
|
|
364929
364923
|
"actions"
|
|
364930
364924
|
],
|
|
@@ -365005,7 +364999,7 @@
|
|
|
365005
364999
|
},
|
|
365006
365000
|
"delete": {
|
|
365007
365001
|
"summary": "Delete an environment variable",
|
|
365008
|
-
"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.\
|
|
365002
|
+
"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.",
|
|
365009
365003
|
"tags": [
|
|
365010
365004
|
"actions"
|
|
365011
365005
|
],
|
|
@@ -477016,7 +477010,7 @@
|
|
|
477016
477010
|
"format": "uri"
|
|
477017
477011
|
},
|
|
477018
477012
|
"conclusion": {
|
|
477019
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
477013
|
+
"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`.",
|
|
477020
477014
|
"type": "string",
|
|
477021
477015
|
"nullable": true,
|
|
477022
477016
|
"enum": [
|
|
@@ -479370,7 +479364,7 @@
|
|
|
479370
479364
|
"format": "uri"
|
|
479371
479365
|
},
|
|
479372
479366
|
"conclusion": {
|
|
479373
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
479367
|
+
"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.",
|
|
479374
479368
|
"type": "string",
|
|
479375
479369
|
"nullable": true,
|
|
479376
479370
|
"enum": [
|
|
@@ -481717,7 +481711,7 @@
|
|
|
481717
481711
|
"format": "uri"
|
|
481718
481712
|
},
|
|
481719
481713
|
"conclusion": {
|
|
481720
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
481714
|
+
"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.",
|
|
481721
481715
|
"type": "string",
|
|
481722
481716
|
"nullable": true,
|
|
481723
481717
|
"enum": [
|
|
@@ -483695,7 +483689,7 @@
|
|
|
483695
483689
|
]
|
|
483696
483690
|
},
|
|
483697
483691
|
"dismissed_reason": {
|
|
483698
|
-
"description": "The reason for dismissing or closing the alert.
|
|
483692
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
483699
483693
|
"type": "string",
|
|
483700
483694
|
"nullable": true,
|
|
483701
483695
|
"enum": [
|
|
@@ -485587,7 +485581,7 @@
|
|
|
485587
485581
|
]
|
|
485588
485582
|
},
|
|
485589
485583
|
"dismissed_reason": {
|
|
485590
|
-
"description": "The reason for dismissing or closing the alert.
|
|
485584
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
485591
485585
|
"type": "string",
|
|
485592
485586
|
"nullable": true,
|
|
485593
485587
|
"enum": [
|
|
@@ -489343,7 +489337,7 @@
|
|
|
489343
489337
|
]
|
|
489344
489338
|
},
|
|
489345
489339
|
"dismissed_reason": {
|
|
489346
|
-
"description": "The reason for dismissing or closing the alert.
|
|
489340
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
489347
489341
|
"type": "string",
|
|
489348
489342
|
"nullable": true,
|
|
489349
489343
|
"enum": [
|
|
@@ -530089,7 +530083,7 @@
|
|
|
530089
530083
|
"format": "date-time"
|
|
530090
530084
|
},
|
|
530091
530085
|
"conclusion": {
|
|
530092
|
-
"description": "The result of the completed check run.
|
|
530086
|
+
"description": "The result of the completed check run. This value will be `null` until the check run has completed.",
|
|
530093
530087
|
"type": "string",
|
|
530094
530088
|
"nullable": true,
|
|
530095
530089
|
"enum": [
|
|
@@ -633591,6 +633585,10 @@
|
|
|
633591
633585
|
"type": "string",
|
|
633592
633586
|
"format": "uri"
|
|
633593
633587
|
},
|
|
633588
|
+
"has_discussions": {
|
|
633589
|
+
"description": "Whether the repository has discussions enabled.",
|
|
633590
|
+
"type": "boolean"
|
|
633591
|
+
},
|
|
633594
633592
|
"has_downloads": {
|
|
633595
633593
|
"description": "Whether downloads are enabled.",
|
|
633596
633594
|
"type": "boolean",
|
|
@@ -633947,6 +633945,10 @@
|
|
|
633947
633945
|
},
|
|
633948
633946
|
"watchers_count": {
|
|
633949
633947
|
"type": "integer"
|
|
633948
|
+
},
|
|
633949
|
+
"web_commit_signoff_required": {
|
|
633950
|
+
"description": "Whether to require commit signoff.",
|
|
633951
|
+
"type": "boolean"
|
|
633950
633952
|
}
|
|
633951
633953
|
},
|
|
633952
633954
|
"required": [
|
|
@@ -935414,7 +935416,6 @@
|
|
|
935414
935416
|
"forks",
|
|
935415
935417
|
"forks_count",
|
|
935416
935418
|
"git_url",
|
|
935417
|
-
"has_downloads",
|
|
935418
935419
|
"has_issues",
|
|
935419
935420
|
"has_projects",
|
|
935420
935421
|
"has_wiki",
|
|
@@ -961730,7 +961731,7 @@
|
|
|
961730
961731
|
}
|
|
961731
961732
|
},
|
|
961732
961733
|
"x-github": {
|
|
961733
|
-
"githubCloudOnly":
|
|
961734
|
+
"githubCloudOnly": true,
|
|
961734
961735
|
"category": "webhooks",
|
|
961735
961736
|
"subcategory": "user",
|
|
961736
961737
|
"supported-webhook-types": [
|
|
@@ -963422,7 +963423,7 @@
|
|
|
963422
963423
|
}
|
|
963423
963424
|
},
|
|
963424
963425
|
"x-github": {
|
|
963425
|
-
"githubCloudOnly":
|
|
963426
|
+
"githubCloudOnly": true,
|
|
963426
963427
|
"category": "webhooks",
|
|
963427
963428
|
"subcategory": "user",
|
|
963428
963429
|
"supported-webhook-types": [
|