@octokit/openapi 16.2.0 → 16.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/api.github.com.deref.json +17 -15
- package/generated/api.github.com.json +232 -549
- package/generated/ghec.deref.json +17 -15
- package/generated/ghec.json +232 -549
- package/generated/ghes-3.10.deref.json +13 -13
- package/generated/ghes-3.10.json +181 -502
- package/generated/ghes-3.11.deref.json +17 -15
- package/generated/ghes-3.11.json +232 -549
- package/generated/ghes-3.12.deref.json +371 -15
- package/generated/ghes-3.12.json +586 -549
- package/generated/ghes-3.9.deref.json +13 -13
- package/generated/ghes-3.9.json +177 -490
- package/generated/github.ae.deref.json +1 -1
- package/generated/github.ae.json +1 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "16.
|
|
4
|
+
"version": "16.4.0",
|
|
5
5
|
"title": "GitHub's official OpenAPI spec + Octokit extension",
|
|
6
6
|
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
|
|
7
7
|
"license": {
|
|
@@ -7117,6 +7117,7 @@
|
|
|
7117
7117
|
"description": "The products and respective version ranges affected by the advisory.",
|
|
7118
7118
|
"nullable": true,
|
|
7119
7119
|
"items": {
|
|
7120
|
+
"description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.",
|
|
7120
7121
|
"type": "object",
|
|
7121
7122
|
"properties": {
|
|
7122
7123
|
"package": {
|
|
@@ -7161,7 +7162,7 @@
|
|
|
7161
7162
|
},
|
|
7162
7163
|
"first_patched_version": {
|
|
7163
7164
|
"type": "string",
|
|
7164
|
-
"description": "The package version that
|
|
7165
|
+
"description": "The package version that resolves the vulnerability.",
|
|
7165
7166
|
"nullable": true
|
|
7166
7167
|
},
|
|
7167
7168
|
"vulnerable_functions": {
|
|
@@ -7729,6 +7730,7 @@
|
|
|
7729
7730
|
"description": "The products and respective version ranges affected by the advisory.",
|
|
7730
7731
|
"nullable": true,
|
|
7731
7732
|
"items": {
|
|
7733
|
+
"description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.",
|
|
7732
7734
|
"type": "object",
|
|
7733
7735
|
"properties": {
|
|
7734
7736
|
"package": {
|
|
@@ -7773,7 +7775,7 @@
|
|
|
7773
7775
|
},
|
|
7774
7776
|
"first_patched_version": {
|
|
7775
7777
|
"type": "string",
|
|
7776
|
-
"description": "The package version that
|
|
7778
|
+
"description": "The package version that resolves the vulnerability.",
|
|
7777
7779
|
"nullable": true
|
|
7778
7780
|
},
|
|
7779
7781
|
"vulnerable_functions": {
|
|
@@ -12217,7 +12219,7 @@
|
|
|
12217
12219
|
"/app/installations/{installation_id}/access_tokens": {
|
|
12218
12220
|
"post": {
|
|
12219
12221
|
"summary": "Create an installation access token for an app",
|
|
12220
|
-
"description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access
|
|
12222
|
+
"description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.12/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
|
|
12221
12223
|
"tags": [
|
|
12222
12224
|
"apps"
|
|
12223
12225
|
],
|
|
@@ -58742,6 +58744,360 @@
|
|
|
58742
58744
|
"x-octokit": {}
|
|
58743
58745
|
}
|
|
58744
58746
|
},
|
|
58747
|
+
"/manage/v1/config/apply": {
|
|
58748
|
+
"get": {
|
|
58749
|
+
"summary": "Get the status of a ghe-config-apply run",
|
|
58750
|
+
"description": "Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID.",
|
|
58751
|
+
"operationId": "enterprise-admin/get-manage-settings",
|
|
58752
|
+
"tags": [
|
|
58753
|
+
"enterprise-admin"
|
|
58754
|
+
],
|
|
58755
|
+
"externalDocs": {
|
|
58756
|
+
"description": "API method documentation",
|
|
58757
|
+
"url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-config-apply-status"
|
|
58758
|
+
},
|
|
58759
|
+
"parameters": [
|
|
58760
|
+
{
|
|
58761
|
+
"name": "run_id",
|
|
58762
|
+
"description": "The unique run ID of the `ghe-config-apply` run.",
|
|
58763
|
+
"in": "query",
|
|
58764
|
+
"required": false,
|
|
58765
|
+
"schema": {
|
|
58766
|
+
"type": "string"
|
|
58767
|
+
}
|
|
58768
|
+
}
|
|
58769
|
+
],
|
|
58770
|
+
"servers": [
|
|
58771
|
+
{
|
|
58772
|
+
"url": "{protocol}://{hostname}",
|
|
58773
|
+
"variables": {
|
|
58774
|
+
"hostname": {
|
|
58775
|
+
"default": "HOSTNAME",
|
|
58776
|
+
"description": "Self-hosted Enterprise Server hostname"
|
|
58777
|
+
},
|
|
58778
|
+
"protocol": {
|
|
58779
|
+
"default": "http",
|
|
58780
|
+
"description": "Self-hosted Enterprise Server protocol"
|
|
58781
|
+
}
|
|
58782
|
+
}
|
|
58783
|
+
}
|
|
58784
|
+
],
|
|
58785
|
+
"responses": {
|
|
58786
|
+
"200": {
|
|
58787
|
+
"description": "Response",
|
|
58788
|
+
"content": {
|
|
58789
|
+
"application/json": {
|
|
58790
|
+
"schema": {
|
|
58791
|
+
"type": "object",
|
|
58792
|
+
"properties": {
|
|
58793
|
+
"running": {
|
|
58794
|
+
"type": "boolean",
|
|
58795
|
+
"description": "Whether the ghe-config-apply run is still running in the environment"
|
|
58796
|
+
},
|
|
58797
|
+
"successful": {
|
|
58798
|
+
"type": "boolean",
|
|
58799
|
+
"description": "Whether the ghe-config-apply run was successful in the environment"
|
|
58800
|
+
},
|
|
58801
|
+
"nodes": {
|
|
58802
|
+
"type": "array",
|
|
58803
|
+
"items": {
|
|
58804
|
+
"type": "object",
|
|
58805
|
+
"properties": {
|
|
58806
|
+
"run_id": {
|
|
58807
|
+
"type": "string",
|
|
58808
|
+
"description": "The unique Run ID of the ghe-config-apply run on the host"
|
|
58809
|
+
},
|
|
58810
|
+
"hostname": {
|
|
58811
|
+
"type": "string",
|
|
58812
|
+
"description": "The hostname of the node"
|
|
58813
|
+
},
|
|
58814
|
+
"running": {
|
|
58815
|
+
"type": "boolean",
|
|
58816
|
+
"description": "Whether the ghe-config-apply run is still running on the host"
|
|
58817
|
+
},
|
|
58818
|
+
"successful": {
|
|
58819
|
+
"type": "boolean",
|
|
58820
|
+
"description": "Whether the ghe-config-apply run was successful on the host"
|
|
58821
|
+
}
|
|
58822
|
+
}
|
|
58823
|
+
}
|
|
58824
|
+
}
|
|
58825
|
+
}
|
|
58826
|
+
},
|
|
58827
|
+
"examples": {
|
|
58828
|
+
"default": {
|
|
58829
|
+
"value": {
|
|
58830
|
+
"running": true,
|
|
58831
|
+
"successful": false,
|
|
58832
|
+
"nodes": [
|
|
58833
|
+
{
|
|
58834
|
+
"run_id": "d34db33f",
|
|
58835
|
+
"hostname": "ghes-01.lan",
|
|
58836
|
+
"running": true,
|
|
58837
|
+
"successful": false
|
|
58838
|
+
}
|
|
58839
|
+
]
|
|
58840
|
+
}
|
|
58841
|
+
}
|
|
58842
|
+
}
|
|
58843
|
+
}
|
|
58844
|
+
}
|
|
58845
|
+
},
|
|
58846
|
+
"400": {
|
|
58847
|
+
"description": "Bad request"
|
|
58848
|
+
},
|
|
58849
|
+
"401": {
|
|
58850
|
+
"description": "Unauthorized"
|
|
58851
|
+
}
|
|
58852
|
+
},
|
|
58853
|
+
"x-github": {
|
|
58854
|
+
"githubCloudOnly": false,
|
|
58855
|
+
"enabledForGitHubApps": false,
|
|
58856
|
+
"category": "enterprise-admin",
|
|
58857
|
+
"subcategory": "manage-ghes"
|
|
58858
|
+
},
|
|
58859
|
+
"x-octokit": {}
|
|
58860
|
+
},
|
|
58861
|
+
"post": {
|
|
58862
|
+
"summary": "Trigger a ghe-config-apply run",
|
|
58863
|
+
"description": "Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.",
|
|
58864
|
+
"operationId": "enterprise-admin/get-manage-settings",
|
|
58865
|
+
"tags": [
|
|
58866
|
+
"enterprise-admin"
|
|
58867
|
+
],
|
|
58868
|
+
"externalDocs": {
|
|
58869
|
+
"description": "API method documentation",
|
|
58870
|
+
"url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#run-config-apply"
|
|
58871
|
+
},
|
|
58872
|
+
"requestBody": {
|
|
58873
|
+
"required": false,
|
|
58874
|
+
"content": {
|
|
58875
|
+
"application/json": {
|
|
58876
|
+
"schema": {
|
|
58877
|
+
"type": "object",
|
|
58878
|
+
"properties": {
|
|
58879
|
+
"run_id": {
|
|
58880
|
+
"type": "string",
|
|
58881
|
+
"description": "The run ID to execute `ghe-config-apply` with. If not provided, a run ID will be generated randomly."
|
|
58882
|
+
}
|
|
58883
|
+
}
|
|
58884
|
+
},
|
|
58885
|
+
"examples": {
|
|
58886
|
+
"default": {
|
|
58887
|
+
"value": {
|
|
58888
|
+
"run_id": "d34db33f"
|
|
58889
|
+
}
|
|
58890
|
+
}
|
|
58891
|
+
}
|
|
58892
|
+
}
|
|
58893
|
+
}
|
|
58894
|
+
},
|
|
58895
|
+
"servers": [
|
|
58896
|
+
{
|
|
58897
|
+
"url": "{protocol}://{hostname}",
|
|
58898
|
+
"variables": {
|
|
58899
|
+
"hostname": {
|
|
58900
|
+
"default": "HOSTNAME",
|
|
58901
|
+
"description": "Self-hosted Enterprise Server hostname"
|
|
58902
|
+
},
|
|
58903
|
+
"protocol": {
|
|
58904
|
+
"default": "http",
|
|
58905
|
+
"description": "Self-hosted Enterprise Server protocol"
|
|
58906
|
+
}
|
|
58907
|
+
}
|
|
58908
|
+
}
|
|
58909
|
+
],
|
|
58910
|
+
"responses": {
|
|
58911
|
+
"200": {
|
|
58912
|
+
"description": "Response",
|
|
58913
|
+
"content": {
|
|
58914
|
+
"application/json": {
|
|
58915
|
+
"schema": {
|
|
58916
|
+
"type": "object",
|
|
58917
|
+
"properties": {
|
|
58918
|
+
"run_id": {
|
|
58919
|
+
"type": "string",
|
|
58920
|
+
"description": "Run ID the job was launched with"
|
|
58921
|
+
}
|
|
58922
|
+
}
|
|
58923
|
+
},
|
|
58924
|
+
"examples": {
|
|
58925
|
+
"default": {
|
|
58926
|
+
"value": {
|
|
58927
|
+
"run_id": "d34db33f"
|
|
58928
|
+
}
|
|
58929
|
+
}
|
|
58930
|
+
}
|
|
58931
|
+
}
|
|
58932
|
+
}
|
|
58933
|
+
},
|
|
58934
|
+
"400": {
|
|
58935
|
+
"description": "Bad request"
|
|
58936
|
+
},
|
|
58937
|
+
"401": {
|
|
58938
|
+
"description": "Unauthorized"
|
|
58939
|
+
}
|
|
58940
|
+
},
|
|
58941
|
+
"x-github": {
|
|
58942
|
+
"githubCloudOnly": false,
|
|
58943
|
+
"enabledForGitHubApps": false,
|
|
58944
|
+
"category": "enterprise-admin",
|
|
58945
|
+
"subcategory": "manage-ghes"
|
|
58946
|
+
},
|
|
58947
|
+
"x-octokit": {}
|
|
58948
|
+
}
|
|
58949
|
+
},
|
|
58950
|
+
"/manage/v1/config/apply/events": {
|
|
58951
|
+
"get": {
|
|
58952
|
+
"summary": "List events from ghe-config-apply",
|
|
58953
|
+
"description": "Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance.",
|
|
58954
|
+
"operationId": "enterprise-admin/get-manage-settings",
|
|
58955
|
+
"tags": [
|
|
58956
|
+
"enterprise-admin"
|
|
58957
|
+
],
|
|
58958
|
+
"externalDocs": {
|
|
58959
|
+
"description": "API method documentation",
|
|
58960
|
+
"url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-config-apply-events"
|
|
58961
|
+
},
|
|
58962
|
+
"parameters": [
|
|
58963
|
+
{
|
|
58964
|
+
"name": "last_request_id",
|
|
58965
|
+
"description": "The unique ID of the last response from a host, used for pagination.",
|
|
58966
|
+
"in": "query",
|
|
58967
|
+
"required": false,
|
|
58968
|
+
"schema": {
|
|
58969
|
+
"type": "string"
|
|
58970
|
+
}
|
|
58971
|
+
}
|
|
58972
|
+
],
|
|
58973
|
+
"servers": [
|
|
58974
|
+
{
|
|
58975
|
+
"url": "{protocol}://{hostname}",
|
|
58976
|
+
"variables": {
|
|
58977
|
+
"hostname": {
|
|
58978
|
+
"default": "HOSTNAME",
|
|
58979
|
+
"description": "Self-hosted Enterprise Server hostname"
|
|
58980
|
+
},
|
|
58981
|
+
"protocol": {
|
|
58982
|
+
"default": "http",
|
|
58983
|
+
"description": "Self-hosted Enterprise Server protocol"
|
|
58984
|
+
}
|
|
58985
|
+
}
|
|
58986
|
+
}
|
|
58987
|
+
],
|
|
58988
|
+
"responses": {
|
|
58989
|
+
"200": {
|
|
58990
|
+
"description": "Response",
|
|
58991
|
+
"content": {
|
|
58992
|
+
"application/json": {
|
|
58993
|
+
"schema": {
|
|
58994
|
+
"type": "object",
|
|
58995
|
+
"properties": {
|
|
58996
|
+
"nodes": {
|
|
58997
|
+
"type": "array",
|
|
58998
|
+
"items": {
|
|
58999
|
+
"type": "object",
|
|
59000
|
+
"properties": {
|
|
59001
|
+
"node": {
|
|
59002
|
+
"type": "string",
|
|
59003
|
+
"description": "Hostname of the node"
|
|
59004
|
+
},
|
|
59005
|
+
"last_request_id": {
|
|
59006
|
+
"type": "string",
|
|
59007
|
+
"description": "Unique ID of the last response from a host used for pagination"
|
|
59008
|
+
},
|
|
59009
|
+
"events": {
|
|
59010
|
+
"type": "array",
|
|
59011
|
+
"items": {
|
|
59012
|
+
"type": "object",
|
|
59013
|
+
"properties": {
|
|
59014
|
+
"timestamp": {
|
|
59015
|
+
"type": "string"
|
|
59016
|
+
},
|
|
59017
|
+
"severity_text": {
|
|
59018
|
+
"type": "string"
|
|
59019
|
+
},
|
|
59020
|
+
"body": {
|
|
59021
|
+
"type": "string"
|
|
59022
|
+
},
|
|
59023
|
+
"event_name": {
|
|
59024
|
+
"type": "string"
|
|
59025
|
+
},
|
|
59026
|
+
"topology": {
|
|
59027
|
+
"type": "string"
|
|
59028
|
+
},
|
|
59029
|
+
"hostname": {
|
|
59030
|
+
"type": "string"
|
|
59031
|
+
},
|
|
59032
|
+
"config_run_id": {
|
|
59033
|
+
"type": "string"
|
|
59034
|
+
},
|
|
59035
|
+
"trace_id": {
|
|
59036
|
+
"type": "string"
|
|
59037
|
+
},
|
|
59038
|
+
"span_id": {
|
|
59039
|
+
"type": "string"
|
|
59040
|
+
},
|
|
59041
|
+
"span_parent_id": {
|
|
59042
|
+
"type": "string"
|
|
59043
|
+
},
|
|
59044
|
+
"span_depth": {
|
|
59045
|
+
"type": "integer"
|
|
59046
|
+
}
|
|
59047
|
+
}
|
|
59048
|
+
}
|
|
59049
|
+
}
|
|
59050
|
+
}
|
|
59051
|
+
}
|
|
59052
|
+
}
|
|
59053
|
+
}
|
|
59054
|
+
},
|
|
59055
|
+
"examples": {
|
|
59056
|
+
"default": {
|
|
59057
|
+
"value": {
|
|
59058
|
+
"nodes": [
|
|
59059
|
+
{
|
|
59060
|
+
"node": "ghes-01.lan",
|
|
59061
|
+
"last_request_id": "387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000",
|
|
59062
|
+
"events": [
|
|
59063
|
+
{
|
|
59064
|
+
"timestamp": "2023-01-01T13:00:00+00:00",
|
|
59065
|
+
"severity_text": "INFO",
|
|
59066
|
+
"body": "Validating services",
|
|
59067
|
+
"event_name": "Enterprise::ConfigApply::PhaseValidation#config_phase_validation",
|
|
59068
|
+
"topology": "multinode",
|
|
59069
|
+
"hostname": "ghes-01.lan",
|
|
59070
|
+
"config_run_id": "d34db33f",
|
|
59071
|
+
"trace_id": "387cd628c06d606700e79be368e5e574",
|
|
59072
|
+
"span_id": "0cde553750689c76",
|
|
59073
|
+
"span_parent_id": 0,
|
|
59074
|
+
"span_depth": 0
|
|
59075
|
+
}
|
|
59076
|
+
]
|
|
59077
|
+
}
|
|
59078
|
+
]
|
|
59079
|
+
}
|
|
59080
|
+
}
|
|
59081
|
+
}
|
|
59082
|
+
}
|
|
59083
|
+
}
|
|
59084
|
+
},
|
|
59085
|
+
"400": {
|
|
59086
|
+
"description": "Bad request"
|
|
59087
|
+
},
|
|
59088
|
+
"401": {
|
|
59089
|
+
"description": "Unauthorized"
|
|
59090
|
+
}
|
|
59091
|
+
},
|
|
59092
|
+
"x-github": {
|
|
59093
|
+
"githubCloudOnly": false,
|
|
59094
|
+
"enabledForGitHubApps": false,
|
|
59095
|
+
"category": "enterprise-admin",
|
|
59096
|
+
"subcategory": "manage-ghes"
|
|
59097
|
+
},
|
|
59098
|
+
"x-octokit": {}
|
|
59099
|
+
}
|
|
59100
|
+
},
|
|
58745
59101
|
"/manage/v1/config/init": {
|
|
58746
59102
|
"post": {
|
|
58747
59103
|
"summary": "Initialize instance configuration with license upload",
|
|
@@ -89005,7 +89361,7 @@
|
|
|
89005
89361
|
"/orgs/{org}/hooks": {
|
|
89006
89362
|
"get": {
|
|
89007
89363
|
"summary": "List organization webhooks",
|
|
89008
|
-
"description": "You must be an organization owner to use this endpoint
|
|
89364
|
+
"description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
89009
89365
|
"tags": [
|
|
89010
89366
|
"orgs"
|
|
89011
89367
|
],
|
|
@@ -89214,7 +89570,7 @@
|
|
|
89214
89570
|
},
|
|
89215
89571
|
"post": {
|
|
89216
89572
|
"summary": "Create an organization webhook",
|
|
89217
|
-
"description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint
|
|
89573
|
+
"description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
89218
89574
|
"tags": [
|
|
89219
89575
|
"orgs"
|
|
89220
89576
|
],
|
|
@@ -89567,7 +89923,7 @@
|
|
|
89567
89923
|
"/orgs/{org}/hooks/{hook_id}": {
|
|
89568
89924
|
"get": {
|
|
89569
89925
|
"summary": "Get an organization webhook",
|
|
89570
|
-
"description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)
|
|
89926
|
+
"description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
89571
89927
|
"tags": [
|
|
89572
89928
|
"orgs"
|
|
89573
89929
|
],
|
|
@@ -89754,7 +90110,7 @@
|
|
|
89754
90110
|
},
|
|
89755
90111
|
"patch": {
|
|
89756
90112
|
"summary": "Update an organization webhook",
|
|
89757
|
-
"description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\"
|
|
90113
|
+
"description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
89758
90114
|
"tags": [
|
|
89759
90115
|
"orgs"
|
|
89760
90116
|
],
|
|
@@ -90087,7 +90443,7 @@
|
|
|
90087
90443
|
},
|
|
90088
90444
|
"delete": {
|
|
90089
90445
|
"summary": "Delete an organization webhook",
|
|
90090
|
-
"description": "You must be an organization owner to use this endpoint
|
|
90446
|
+
"description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
90091
90447
|
"tags": [
|
|
90092
90448
|
"orgs"
|
|
90093
90449
|
],
|
|
@@ -90159,7 +90515,7 @@
|
|
|
90159
90515
|
"/orgs/{org}/hooks/{hook_id}/config": {
|
|
90160
90516
|
"get": {
|
|
90161
90517
|
"summary": "Get a webhook configuration for an organization",
|
|
90162
|
-
"description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint
|
|
90518
|
+
"description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
90163
90519
|
"tags": [
|
|
90164
90520
|
"orgs"
|
|
90165
90521
|
],
|
|
@@ -90252,7 +90608,7 @@
|
|
|
90252
90608
|
},
|
|
90253
90609
|
"patch": {
|
|
90254
90610
|
"summary": "Update a webhook configuration for an organization",
|
|
90255
|
-
"description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint
|
|
90611
|
+
"description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
90256
90612
|
"tags": [
|
|
90257
90613
|
"orgs"
|
|
90258
90614
|
],
|
|
@@ -90398,7 +90754,7 @@
|
|
|
90398
90754
|
"/orgs/{org}/hooks/{hook_id}/deliveries": {
|
|
90399
90755
|
"get": {
|
|
90400
90756
|
"summary": "List deliveries for an organization webhook",
|
|
90401
|
-
"description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint
|
|
90757
|
+
"description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
90402
90758
|
"tags": [
|
|
90403
90759
|
"orgs"
|
|
90404
90760
|
],
|
|
@@ -90717,7 +91073,7 @@
|
|
|
90717
91073
|
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
|
|
90718
91074
|
"get": {
|
|
90719
91075
|
"summary": "Get a webhook delivery for an organization webhook",
|
|
90720
|
-
"description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint
|
|
91076
|
+
"description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
90721
91077
|
"tags": [
|
|
90722
91078
|
"orgs"
|
|
90723
91079
|
],
|
|
@@ -91079,7 +91435,7 @@
|
|
|
91079
91435
|
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
|
|
91080
91436
|
"post": {
|
|
91081
91437
|
"summary": "Redeliver a delivery for an organization webhook",
|
|
91082
|
-
"description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint
|
|
91438
|
+
"description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
91083
91439
|
"tags": [
|
|
91084
91440
|
"orgs"
|
|
91085
91441
|
],
|
|
@@ -91274,7 +91630,7 @@
|
|
|
91274
91630
|
"/orgs/{org}/hooks/{hook_id}/pings": {
|
|
91275
91631
|
"post": {
|
|
91276
91632
|
"summary": "Ping an organization webhook",
|
|
91277
|
-
"description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.12/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint
|
|
91633
|
+
"description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.12/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.",
|
|
91278
91634
|
"tags": [
|
|
91279
91635
|
"orgs"
|
|
91280
91636
|
],
|