Skip to content

Commit e76fb93

Browse files
octokitbotoctokitbot
authored
feat: GET /app/hook/deliveries, GET /app/hook/deliveries/{delivery_id}, POST /app/hook/deliveries/{delivery_id}/attempts, GET /orgs/{org}/hooks/{hook_id}/deliveries, GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}, POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts, GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries, GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}, POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts (#118)
1 parent 7d03512 commit e76fb93

File tree

15 files changed

+2263
-383
lines changed

15 files changed

+2263
-383
lines changed

‎cache/api.github.com.json‎

Lines changed: 706 additions & 73 deletions
Large diffs are not rendered by default.

‎cache/ghes-2.22.json‎

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "2.23.1",
4+
"version": "2.24.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -29148,7 +29148,7 @@
2914829148
},
2914929149
"post": {
2915029150
"summary": "Enable or disable maintenance mode",
29151-
"description": "The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).",
29151+
"description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
2915229152
"operationId": "enterprise-admin/enable-or-disable-maintenance-mode",
2915329153
"tags": ["enterprise-admin"],
2915429154
"externalDocs": {
@@ -29172,16 +29172,19 @@
2917229172
},
2917329173
"requestBody": {
2917429174
"content": {
29175-
"application/json": {
29175+
"application/x-www-form-urlencoded": {
2917629176
"schema": {
2917729177
"type": "object",
2917829178
"properties": {
2917929179
"maintenance": {
2918029180
"type": "string",
29181-
"description": "A JSON string with the attributes `enabled` and `when`."
29181+
"description": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic)."
2918229182
}
2918329183
},
2918429184
"required": ["maintenance"]
29185+
},
29186+
"example": {
29187+
"maintenance": "{\"enabled\":true, \"when\":\"now\"}"
2918529188
}
2918629189
}
2918729190
}
@@ -29234,7 +29237,7 @@
2923429237
},
2923529238
"put": {
2923629239
"summary": "Set settings",
29237-
"description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/[email protected]/rest/reference/enterprise-admin#get-settings).",
29240+
"description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/[email protected]/rest/reference/enterprise-admin#get-settings).\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
2923829241
"operationId": "enterprise-admin/set-settings",
2923929242
"tags": ["enterprise-admin"],
2924029243
"externalDocs": {
@@ -29244,16 +29247,19 @@
2924429247
"responses": { "204": { "description": "Response" } },
2924529248
"requestBody": {
2924629249
"content": {
29247-
"application/json": {
29250+
"application/x-www-form-urlencoded": {
2924829251
"schema": {
2924929252
"type": "object",
2925029253
"properties": {
2925129254
"settings": {
2925229255
"type": "string",
29253-
"description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify."
29256+
"description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/[email protected]/rest/reference/enterprise-admin#get-settings)."
2925429257
}
2925529258
},
2925629259
"required": ["settings"]
29260+
},
29261+
"example": {
29262+
"settings": "{ \"enterprise\": { \"public_pages\": true }}"
2925729263
}
2925829264
}
2925929265
}
@@ -29305,7 +29311,7 @@
2930529311
},
2930629312
"post": {
2930729313
"summary": "Add an authorized SSH key",
29308-
"description": "",
29314+
"description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
2930929315
"operationId": "enterprise-admin/add-authorized-ssh-key",
2931029316
"tags": ["enterprise-admin"],
2931129317
"externalDocs": {
@@ -29330,16 +29336,19 @@
2933029336
},
2933129337
"requestBody": {
2933229338
"content": {
29333-
"application/json": {
29339+
"application/x-www-form-urlencoded": {
2933429340
"schema": {
2933529341
"type": "object",
2933629342
"properties": {
2933729343
"authorized_key": {
2933829344
"type": "string",
29339-
"description": "The path to the public SSH key."
29345+
"description": "The public SSH key."
2934029346
}
2934129347
},
2934229348
"required": ["authorized_key"]
29349+
},
29350+
"example": {
29351+
"authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="
2934329352
}
2934429353
}
2934529354
}
@@ -29355,7 +29364,7 @@
2935529364
},
2935629365
"delete": {
2935729366
"summary": "Remove an authorized SSH key",
29358-
"description": "",
29367+
"description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
2935929368
"operationId": "enterprise-admin/remove-authorized-ssh-key",
2936029369
"tags": ["enterprise-admin"],
2936129370
"externalDocs": {
@@ -29380,16 +29389,19 @@
2938029389
},
2938129390
"requestBody": {
2938229391
"content": {
29383-
"application/json": {
29392+
"application/x-www-form-urlencoded": {
2938429393
"schema": {
2938529394
"type": "object",
2938629395
"properties": {
2938729396
"authorized_key": {
2938829397
"type": "string",
29389-
"description": "The path to the public SSH key."
29398+
"description": "The public SSH key."
2939029399
}
2939129400
},
2939229401
"required": ["authorized_key"]
29402+
},
29403+
"example": {
29404+
"authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="
2939329405
}
2939429406
}
2939529407
}
@@ -29407,7 +29419,7 @@
2940729419
"/setup/api/start": {
2940829420
"post": {
2940929421
"summary": "Create a GitHub license",
29410-
"description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license:\n\nNote that you need to POST to [`/setup/api/configure`](https://docs.github.com/[email protected]/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\nFor a list of the available settings, see the [Get settings endpoint](https://docs.github.com/[email protected]/rest/reference/enterprise-admin#get-settings).",
29422+
"description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/[email protected]/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
2941129423
"operationId": "enterprise-admin/create-enterprise-server-license",
2941229424
"tags": ["enterprise-admin"],
2941329425
"externalDocs": {
@@ -29417,7 +29429,7 @@
2941729429
"responses": { "202": { "description": "Response" } },
2941829430
"requestBody": {
2941929431
"content": {
29420-
"application/json": {
29432+
"application/x-www-form-urlencoded": {
2942129433
"schema": {
2942229434
"type": "object",
2942329435
"properties": {
@@ -29431,7 +29443,7 @@
2943129443
},
2943229444
"settings": {
2943329445
"type": "string",
29434-
"description": "An optional JSON string containing the installation settings."
29446+
"description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/[email protected]/rest/reference/enterprise-admin#get-settings)."
2943529447
}
2943629448
},
2943729449
"required": ["license"]
@@ -29452,7 +29464,7 @@
2945229464
"/setup/api/upgrade": {
2945329465
"post": {
2945429466
"summary": "Upgrade a license",
29455-
"description": "This API upgrades your license and also triggers the configuration process:",
29467+
"description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
2945629468
"operationId": "enterprise-admin/upgrade-license",
2945729469
"tags": ["enterprise-admin"],
2945829470
"externalDocs": {
@@ -29462,7 +29474,7 @@
2946229474
"responses": { "202": { "description": "Response" } },
2946329475
"requestBody": {
2946429476
"content": {
29465-
"application/json": {
29477+
"application/x-www-form-urlencoded": {
2946629478
"schema": {
2946729479
"type": "object",
2946829480
"properties": {

0 commit comments

Comments
 (0)