diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 76ff584a3..8cd182839 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "2.23.1", + "version": "2.24.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -488,6 +488,112 @@ "x-octokit": {} } }, + "/app/hook/deliveries": { + "get": { + "summary": "List deliveries for an app webhook", + "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/cursor" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/hook-delivery-item" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery-items" + } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/app/hook/deliveries/{delivery_id}": { + "get": { + "summary": "Get a delivery for an app webhook", + "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#get-a-delivery-for-an-app-webhook" + }, + "parameters": [{ "$ref": "#/components/parameters/delivery-id" }], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hook-delivery" }, + "examples": { + "default": { "$ref": "#/components/examples/hook-delivery" } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/app/hook/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for an app webhook", + "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/redeliver-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook" + }, + "parameters": [{ "$ref": "#/components/parameters/delivery-id" }], + "responses": { + "202": { "$ref": "#/components/responses/accepted" }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, "/app/installations": { "get": { "summary": "List installations for the authenticated app", @@ -7696,6 +7802,122 @@ "x-octokit": {} } }, + "/orgs/{org}/hooks/{hook_id}/deliveries": { + "get": { + "summary": "List deliveries for an organization webhook", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "tags": ["orgs"], + "operationId": "orgs/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-deliveries-for-an-organization-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/cursor" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/hook-delivery-item" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery-items" + } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a webhook delivery for an organization webhook", + "description": "Returns a delivery for a webhook configured in an organization.", + "tags": ["orgs"], + "operationId": "orgs/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/delivery-id" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hook-delivery" }, + "examples": { + "default": { "$ref": "#/components/examples/hook-delivery" } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for an organization webhook", + "description": "Redeliver a delivery for a webhook configured in an organization.", + "tags": ["orgs"], + "operationId": "orgs/redeliver-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#redeliver-a-delivery-for-an-organization-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/delivery-id" } + ], + "responses": { + "202": { "$ref": "#/components/responses/accepted" }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", @@ -14120,7 +14342,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { "post": { "summary": "Approve a workflow run for a fork pull request", - "description": "**Note:** This endpoint is currently in beta and is subject to change.\n\nApproves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": ["actions"], "operationId": "actions/approve-workflow-run", "externalDocs": { @@ -22690,6 +22912,125 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + "get": { + "summary": "List deliveries for a repository webhook", + "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", + "tags": ["repos"], + "operationId": "repos/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-deliveries-for-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/cursor" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/hook-delivery-item" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery-items" + } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a delivery for a repository webhook", + "description": "Returns a delivery for a webhook configured in a repository.", + "tags": ["repos"], + "operationId": "repos/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-delivery-for-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/delivery-id" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hook-delivery" }, + "examples": { + "default": { "$ref": "#/components/examples/hook-delivery" } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for a repository webhook", + "description": "Redeliver a webhook delivery for a webhook configured in a repository.", + "tags": ["repos"], + "operationId": "repos/redeliver-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#redeliver-a-delivery-for-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/delivery-id" } + ], + "responses": { + "202": { "$ref": "#/components/responses/accepted" }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { "post": { "summary": "Ping a repository webhook", @@ -39477,6 +39818,250 @@ } } }, + "hook-delivery-item": { + "title": "Simple webhook delivery", + "description": "Delivery made by a webhook, without request and response information.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the webhook delivery.", + "type": "integer", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id" + ] + }, + "scim-error": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { "type": "string", "nullable": true }, + "documentation_url": { "type": "string", "nullable": true }, + "detail": { "type": "string", "nullable": true }, + "status": { "type": "integer" }, + "scimType": { "type": "string", "nullable": true }, + "schemas": { "type": "array", "items": { "type": "string" } } + } + }, + "validation-error": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": ["message", "documentation_url"], + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": ["code"], + "properties": { + "resource": { "type": "string" }, + "field": { "type": "string" }, + "message": { "type": "string" }, + "code": { "type": "string" }, + "index": { "type": "integer" }, + "value": { + "oneOf": [ + { "type": "string", "nullable": true }, + { "type": "integer", "nullable": true }, + { + "type": "array", + "nullable": true, + "items": { "type": "string" } + } + ] + } + } + } + } + } + }, + "hook-delivery": { + "title": "Webhook delivery", + "description": "Delivery made by a webhook.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the delivery.", + "type": "integer", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the delivery was delivered.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Description of the status of the attempted delivery", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The webhook payload.", + "type": "object", + "nullable": true, + "additionalProperties": true + } + }, + "required": ["headers", "payload"] + }, + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The response payload received.", + "type": "string", + "nullable": true, + "additionalProperties": true + } + }, + "required": ["headers", "payload"] + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id", + "request", + "response" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise account", @@ -40401,41 +40986,6 @@ }, "required": ["token", "expires_at"] }, - "validation-error": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": ["message", "documentation_url"], - "properties": { - "message": { "type": "string" }, - "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": ["code"], - "properties": { - "resource": { "type": "string" }, - "field": { "type": "string" }, - "message": { "type": "string" }, - "code": { "type": "string" }, - "index": { "type": "integer" }, - "value": { - "oneOf": [ - { "type": "string", "nullable": true }, - { "type": "integer", "nullable": true }, - { - "type": "array", - "nullable": true, - "items": { "type": "string" } - } - ] - } - } - } - } - } - }, "application-grant": { "title": "Application Grant", "description": "The authorization associated with an OAuth Access.", @@ -43132,6 +43682,11 @@ "format": "uri", "example": "https://api.github.com/orgs/octocat/hooks/1/pings" }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + }, "name": { "type": "string", "example": "web" }, "events": { "type": "array", @@ -47357,19 +47912,6 @@ }, "required": ["next_analysis_url", "confirm_delete_url"] }, - "scim-error": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { "type": "string", "nullable": true }, - "documentation_url": { "type": "string", "nullable": true }, - "detail": { "type": "string", "nullable": true }, - "status": { "type": "integer" }, - "scimType": { "type": "string", "nullable": true }, - "schemas": { "type": "array", "items": { "type": "string" } } - } - }, "code-scanning-analysis-sarif-file": { "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).\"", "type": "string" @@ -49221,6 +49763,11 @@ "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + }, "last_response": { "$ref": "#/components/schemas/hook-response" } }, "required": [ @@ -53933,6 +54480,74 @@ "url": "https://example.com/webhook" } }, + "hook-delivery-items": { + "value": [ + { + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456 + }, + { + "id": 123456789, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-04T00:57:16Z", + "redelivery": true, + "duration": 0.28, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456 + } + ] + }, + "hook-delivery": { + "value": { + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "request": { + "headers": { + "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "Accept": "*/*", + "X-GitHub-Hook-ID": "42", + "User-Agent": "GitHub-Hookshot/b8c71d8", + "X-GitHub-Event": "issues", + "X-GitHub-Hook-Installation-Target-ID": "123", + "X-GitHub-Hook-Installation-Target-Type": "repository", + "content-type": "application/json", + "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" + }, + "payload": { + "action": "opened", + "issue": { "body": "foo" }, + "repository": { "id": 123 } + } + }, + "response": { + "headers": { "Content-Type": "text/html;charset=utf-8" }, + "payload": "ok" + } + } + }, "base-installation-items": { "value": [ { @@ -56523,6 +57138,7 @@ "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": ["push", "pull_request"], "active": true, @@ -56538,6 +57154,7 @@ "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": ["push", "pull_request"], "active": true, @@ -56552,6 +57169,7 @@ "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "name": "web", "events": ["pull_request"], "active": true, @@ -65017,6 +65635,7 @@ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", @@ -65042,6 +65661,7 @@ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } } }, @@ -72342,6 +72962,29 @@ } } }, + "bad_request": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + }, + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + } + } + }, + "validation_failed": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/validation-error" } + } + } + }, + "accepted": { + "description": "Accepted", + "content": { "application/json": { "schema": { "type": "object" } } } + }, "preview_header_missing": { "description": "Preview header missing", "content": { @@ -72373,14 +73016,6 @@ } } }, - "validation_failed": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/validation-error" } - } - } - }, "not_modified": { "description": "Not modified" }, "gone": { "description": "Gone", @@ -72467,17 +73102,6 @@ } } }, - "bad_request": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/basic-error" } - }, - "application/scim+json": { - "schema": { "$ref": "#/components/schemas/scim-error" } - } - } - }, "internal_error": { "description": "Internal Error", "content": { @@ -72487,10 +73111,6 @@ } }, "found": { "description": "Found" }, - "accepted": { - "description": "Accepted", - "content": { "application/json": { "schema": { "type": "object" } } } - }, "no_content": { "description": "A header with no content is returned." }, "scim_not_found": { "description": "Resource not found", @@ -72555,6 +73175,19 @@ "in": "query", "schema": { "type": "integer", "default": 30 } }, + "cursor": { + "name": "cursor", + "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "delivery-id": { + "name": "delivery_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, "page": { "name": "page", "description": "Page number of the results to fetch.", diff --git a/cache/ghes-2.22.json b/cache/ghes-2.22.json index 9ad475b4d..fe41833cc 100644 --- a/cache/ghes-2.22.json +++ b/cache/ghes-2.22.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "2.23.1", + "version": "2.24.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -29148,7 +29148,7 @@ }, "post": { "summary": "Enable or disable maintenance mode", - "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).", + "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).", "operationId": "enterprise-admin/enable-or-disable-maintenance-mode", "tags": ["enterprise-admin"], "externalDocs": { @@ -29172,16 +29172,19 @@ }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "maintenance": { "type": "string", - "description": "A JSON string with the attributes `enabled` and `when`." + "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)." } }, "required": ["maintenance"] + }, + "example": { + "maintenance": "{\"enabled\":true, \"when\":\"now\"}" } } } @@ -29234,7 +29237,7 @@ }, "put": { "summary": "Set settings", - "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings).", + "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/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).", "operationId": "enterprise-admin/set-settings", "tags": ["enterprise-admin"], "externalDocs": { @@ -29244,16 +29247,19 @@ "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "settings": { "type": "string", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify." + "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/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings)." } }, "required": ["settings"] + }, + "example": { + "settings": "{ \"enterprise\": { \"public_pages\": true }}" } } } @@ -29305,7 +29311,7 @@ }, "post": { "summary": "Add an authorized SSH key", - "description": "", + "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).", "operationId": "enterprise-admin/add-authorized-ssh-key", "tags": ["enterprise-admin"], "externalDocs": { @@ -29330,16 +29336,19 @@ }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "authorized_key": { "type": "string", - "description": "The path to the public SSH key." + "description": "The public SSH key." } }, "required": ["authorized_key"] + }, + "example": { + "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" } } } @@ -29355,7 +29364,7 @@ }, "delete": { "summary": "Remove an authorized SSH key", - "description": "", + "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).", "operationId": "enterprise-admin/remove-authorized-ssh-key", "tags": ["enterprise-admin"], "externalDocs": { @@ -29380,16 +29389,19 @@ }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "authorized_key": { "type": "string", - "description": "The path to the public SSH key." + "description": "The public SSH key." } }, "required": ["authorized_key"] + }, + "example": { + "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" } } } @@ -29407,7 +29419,7 @@ "/setup/api/start": { "post": { "summary": "Create a GitHub license", - "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/enterprise-server@2.22/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/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings).", + "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/enterprise-server@2.22/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).", "operationId": "enterprise-admin/create-enterprise-server-license", "tags": ["enterprise-admin"], "externalDocs": { @@ -29417,7 +29429,7 @@ "responses": { "202": { "description": "Response" } }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { @@ -29431,7 +29443,7 @@ }, "settings": { "type": "string", - "description": "An optional JSON string containing the installation settings." + "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/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings)." } }, "required": ["license"] @@ -29452,7 +29464,7 @@ "/setup/api/upgrade": { "post": { "summary": "Upgrade a license", - "description": "This API upgrades your license and also triggers the configuration process:", + "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).", "operationId": "enterprise-admin/upgrade-license", "tags": ["enterprise-admin"], "externalDocs": { @@ -29462,7 +29474,7 @@ "responses": { "202": { "description": "Response" } }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { diff --git a/cache/ghes-3.0.json b/cache/ghes-3.0.json index 8f1a03c97..360177721 100644 --- a/cache/ghes-3.0.json +++ b/cache/ghes-3.0.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "2.23.1", + "version": "2.24.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -30308,7 +30308,7 @@ }, "post": { "summary": "Enable or disable maintenance mode", - "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).", + "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).", "operationId": "enterprise-admin/enable-or-disable-maintenance-mode", "tags": ["enterprise-admin"], "externalDocs": { @@ -30332,16 +30332,19 @@ }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "maintenance": { "type": "string", - "description": "A JSON string with the attributes `enabled` and `when`." + "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)." } }, "required": ["maintenance"] + }, + "example": { + "maintenance": "{\"enabled\":true, \"when\":\"now\"}" } } } @@ -30394,7 +30397,7 @@ }, "put": { "summary": "Set settings", - "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings).", + "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/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).", "operationId": "enterprise-admin/set-settings", "tags": ["enterprise-admin"], "externalDocs": { @@ -30404,16 +30407,19 @@ "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "settings": { "type": "string", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify." + "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/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings)." } }, "required": ["settings"] + }, + "example": { + "settings": "{ \"enterprise\": { \"public_pages\": true }}" } } } @@ -30465,7 +30471,7 @@ }, "post": { "summary": "Add an authorized SSH key", - "description": "", + "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).", "operationId": "enterprise-admin/add-authorized-ssh-key", "tags": ["enterprise-admin"], "externalDocs": { @@ -30490,16 +30496,19 @@ }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "authorized_key": { "type": "string", - "description": "The path to the public SSH key." + "description": "The public SSH key." } }, "required": ["authorized_key"] + }, + "example": { + "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" } } } @@ -30515,7 +30524,7 @@ }, "delete": { "summary": "Remove an authorized SSH key", - "description": "", + "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).", "operationId": "enterprise-admin/remove-authorized-ssh-key", "tags": ["enterprise-admin"], "externalDocs": { @@ -30540,16 +30549,19 @@ }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "authorized_key": { "type": "string", - "description": "The path to the public SSH key." + "description": "The public SSH key." } }, "required": ["authorized_key"] + }, + "example": { + "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" } } } @@ -30567,7 +30579,7 @@ "/setup/api/start": { "post": { "summary": "Create a GitHub license", - "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/enterprise-server@3.0/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/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings).", + "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/enterprise-server@3.0/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).", "operationId": "enterprise-admin/create-enterprise-server-license", "tags": ["enterprise-admin"], "externalDocs": { @@ -30577,7 +30589,7 @@ "responses": { "202": { "description": "Response" } }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { @@ -30591,7 +30603,7 @@ }, "settings": { "type": "string", - "description": "An optional JSON string containing the installation settings." + "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/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings)." } }, "required": ["license"] @@ -30612,7 +30624,7 @@ "/setup/api/upgrade": { "post": { "summary": "Upgrade a license", - "description": "This API upgrades your license and also triggers the configuration process:", + "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).", "operationId": "enterprise-admin/upgrade-license", "tags": ["enterprise-admin"], "externalDocs": { @@ -30622,7 +30634,7 @@ "responses": { "202": { "description": "Response" } }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { diff --git a/cache/ghes-3.1.json b/cache/ghes-3.1.json index a0e6330a7..4c65087aa 100644 --- a/cache/ghes-3.1.json +++ b/cache/ghes-3.1.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "2.23.1", + "version": "2.24.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -30752,7 +30752,7 @@ }, "post": { "summary": "Enable or disable maintenance mode", - "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).", + "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).", "operationId": "enterprise-admin/enable-or-disable-maintenance-mode", "tags": ["enterprise-admin"], "externalDocs": { @@ -30776,16 +30776,19 @@ }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "maintenance": { "type": "string", - "description": "A JSON string with the attributes `enabled` and `when`." + "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)." } }, "required": ["maintenance"] + }, + "example": { + "maintenance": "{\"enabled\":true, \"when\":\"now\"}" } } } @@ -30838,7 +30841,7 @@ }, "put": { "summary": "Set settings", - "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings).", + "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.1/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).", "operationId": "enterprise-admin/set-settings", "tags": ["enterprise-admin"], "externalDocs": { @@ -30848,16 +30851,19 @@ "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "settings": { "type": "string", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify." + "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/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings)." } }, "required": ["settings"] + }, + "example": { + "settings": "{ \"enterprise\": { \"public_pages\": true }}" } } } @@ -30909,7 +30915,7 @@ }, "post": { "summary": "Add an authorized SSH key", - "description": "", + "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).", "operationId": "enterprise-admin/add-authorized-ssh-key", "tags": ["enterprise-admin"], "externalDocs": { @@ -30934,16 +30940,19 @@ }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "authorized_key": { "type": "string", - "description": "The path to the public SSH key." + "description": "The public SSH key." } }, "required": ["authorized_key"] + }, + "example": { + "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" } } } @@ -30959,7 +30968,7 @@ }, "delete": { "summary": "Remove an authorized SSH key", - "description": "", + "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).", "operationId": "enterprise-admin/remove-authorized-ssh-key", "tags": ["enterprise-admin"], "externalDocs": { @@ -30984,16 +30993,19 @@ }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "authorized_key": { "type": "string", - "description": "The path to the public SSH key." + "description": "The public SSH key." } }, "required": ["authorized_key"] + }, + "example": { + "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" } } } @@ -31011,7 +31023,7 @@ "/setup/api/start": { "post": { "summary": "Create a GitHub license", - "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/enterprise-server@3.1/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/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings).", + "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/enterprise-server@3.1/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).", "operationId": "enterprise-admin/create-enterprise-server-license", "tags": ["enterprise-admin"], "externalDocs": { @@ -31021,7 +31033,7 @@ "responses": { "202": { "description": "Response" } }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { @@ -31035,7 +31047,7 @@ }, "settings": { "type": "string", - "description": "An optional JSON string containing the installation settings." + "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/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings)." } }, "required": ["license"] @@ -31056,7 +31068,7 @@ "/setup/api/upgrade": { "post": { "summary": "Upgrade a license", - "description": "This API upgrades your license and also triggers the configuration process:", + "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).", "operationId": "enterprise-admin/upgrade-license", "tags": ["enterprise-admin"], "externalDocs": { @@ -31066,7 +31078,7 @@ "responses": { "202": { "description": "Response" } }, "requestBody": { "content": { - "application/json": { + "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { diff --git a/cache/github.ae.json b/cache/github.ae.json index 5f6d2452c..95e0f95ae 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "2.23.1", + "version": "2.24.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -1731,6 +1731,112 @@ "x-octokit": {} } }, + "/app/hook/deliveries": { + "get": { + "summary": "List deliveries for an app webhook", + "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#list-deliveries-for-an-app-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/cursor" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/hook-delivery-item" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery-items" + } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/app/hook/deliveries/{delivery_id}": { + "get": { + "summary": "Get a delivery for an app webhook", + "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#get-a-delivery-for-an-app-webhook" + }, + "parameters": [{ "$ref": "#/components/parameters/delivery-id" }], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hook-delivery" }, + "examples": { + "default": { "$ref": "#/components/examples/hook-delivery" } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/app/hook/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for an app webhook", + "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/redeliver-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook" + }, + "parameters": [{ "$ref": "#/components/parameters/delivery-id" }], + "responses": { + "202": { "$ref": "#/components/responses/accepted" }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, "/app/installations": { "get": { "summary": "List installations for the authenticated app", @@ -6986,6 +7092,76 @@ "x-octokit": {} } }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a webhook delivery for an organization webhook", + "description": "Returns a delivery for a webhook configured in an organization.", + "tags": ["orgs"], + "operationId": "orgs/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/delivery-id" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hook-delivery" }, + "examples": { + "default": { "$ref": "#/components/examples/hook-delivery" } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for an organization webhook", + "description": "Redeliver a delivery for a webhook configured in an organization.", + "tags": ["orgs"], + "operationId": "orgs/redeliver-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#redeliver-a-delivery-for-an-organization-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/delivery-id" } + ], + "responses": { + "202": { "$ref": "#/components/responses/accepted" }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", @@ -19707,6 +19883,125 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + "get": { + "summary": "List deliveries for a repository webhook", + "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", + "tags": ["repos"], + "operationId": "repos/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#list-deliveries-for-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/cursor" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/hook-delivery-item" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery-items" + } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a delivery for a repository webhook", + "description": "Returns a delivery for a webhook configured in a repository.", + "tags": ["repos"], + "operationId": "repos/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-delivery-for-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/delivery-id" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hook-delivery" }, + "examples": { + "default": { "$ref": "#/components/examples/hook-delivery" } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for a repository webhook", + "description": "Redeliver a webhook delivery for a webhook configured in a repository.", + "tags": ["repos"], + "operationId": "repos/redeliver-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#redeliver-a-delivery-for-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" }, + { "$ref": "#/components/parameters/delivery-id" } + ], + "responses": { + "202": { "$ref": "#/components/responses/accepted" }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { "post": { "summary": "Ping a repository webhook", @@ -32394,6 +32689,19 @@ "in": "query", "schema": { "type": "integer", "default": 30 } }, + "cursor": { + "name": "cursor", + "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "delivery-id": { + "name": "delivery_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, "since": { "name": "since", "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -33565,6 +33873,250 @@ } } }, + "hook-delivery-item": { + "title": "Simple webhook delivery", + "description": "Delivery made by a webhook, without request and response information.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the webhook delivery.", + "type": "integer", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id" + ] + }, + "scim-error": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { "type": "string", "nullable": true }, + "documentation_url": { "type": "string", "nullable": true }, + "detail": { "type": "string", "nullable": true }, + "status": { "type": "integer" }, + "scimType": { "type": "string", "nullable": true }, + "schemas": { "type": "array", "items": { "type": "string" } } + } + }, + "validation-error": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": ["message", "documentation_url"], + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": ["code"], + "properties": { + "resource": { "type": "string" }, + "field": { "type": "string" }, + "message": { "type": "string" }, + "code": { "type": "string" }, + "index": { "type": "integer" }, + "value": { + "oneOf": [ + { "type": "string", "nullable": true }, + { "type": "integer", "nullable": true }, + { + "type": "array", + "nullable": true, + "items": { "type": "string" } + } + ] + } + } + } + } + } + }, + "hook-delivery": { + "title": "Webhook delivery", + "description": "Delivery made by a webhook.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the delivery.", + "type": "integer", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the delivery was delivered.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Description of the status of the attempted delivery", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The webhook payload.", + "type": "object", + "nullable": true, + "additionalProperties": true + } + }, + "required": ["headers", "payload"] + }, + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The response payload received.", + "type": "string", + "nullable": true, + "additionalProperties": true + } + }, + "required": ["headers", "payload"] + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id", + "request", + "response" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise account", @@ -34321,41 +34873,6 @@ }, "required": ["token", "expires_at"] }, - "validation-error": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": ["message", "documentation_url"], - "properties": { - "message": { "type": "string" }, - "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": ["code"], - "properties": { - "resource": { "type": "string" }, - "field": { "type": "string" }, - "message": { "type": "string" }, - "code": { "type": "string" }, - "index": { "type": "integer" }, - "value": { - "oneOf": [ - { "type": "string", "nullable": true }, - { "type": "integer", "nullable": true }, - { - "type": "array", - "nullable": true, - "items": { "type": "string" } - } - ] - } - } - } - } - } - }, "code-of-conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", @@ -36292,6 +36809,11 @@ "format": "uri", "example": "https://api.github.com/orgs/octocat/hooks/1/pings" }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + }, "name": { "type": "string", "example": "web" }, "events": { "type": "array", @@ -40193,19 +40715,6 @@ "updated_at" ] }, - "scim-error": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { "type": "string", "nullable": true }, - "documentation_url": { "type": "string", "nullable": true }, - "detail": { "type": "string", "nullable": true }, - "status": { "type": "integer" }, - "scimType": { "type": "string", "nullable": true }, - "schemas": { "type": "array", "items": { "type": "string" } } - } - }, "branch-short": { "title": "Branch Short", "description": "Branch Short", @@ -42012,6 +42521,11 @@ "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + }, "last_response": { "$ref": "#/components/schemas/hook-response" } }, "required": [ @@ -46289,6 +46803,73 @@ "url": "https://example.com/webhook" } }, + "hook-delivery-items": { + "value": [ + { + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456 + }, + { + "id": 123456789, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-04T00:57:16Z", + "redelivery": true, + "duration": 0.28, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456 + } + ] + }, + "hook-delivery": { + "value": { + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "request": { + "headers": { + "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "Accept": "*/*", + "X-GitHub-Hook-ID": "42", + "User-Agent": "GitHub-Hookshot/b8c71d8", + "X-GitHub-Event": "issues", + "X-GitHub-Hook-Installation-Target-ID": "123", + "X-GitHub-Hook-Installation-Target-Type": "repository", + "content-type": "application/json" + }, + "payload": { + "action": "opened", + "issue": { "body": "foo" }, + "repository": { "id": 123 } + } + }, + "response": { + "headers": { "Content-Type": "text/html;charset=utf-8" }, + "payload": "ok" + } + } + }, "base-installation-items": { "value": [ { @@ -48130,6 +48711,7 @@ "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": ["push", "pull_request"], "active": true, @@ -48145,6 +48727,7 @@ "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": ["push", "pull_request"], "active": true, @@ -48159,6 +48742,7 @@ "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "name": "web", "events": ["pull_request"], "active": true, @@ -55647,6 +56231,7 @@ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", @@ -55672,6 +56257,7 @@ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } } }, @@ -61480,6 +62066,29 @@ } } }, + "bad_request": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + }, + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + } + } + }, + "validation_failed": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/validation-error" } + } + } + }, + "accepted": { + "description": "Accepted", + "content": { "application/json": { "schema": { "type": "object" } } } + }, "preview_header_missing": { "description": "Preview header missing", "content": { @@ -61511,14 +62120,6 @@ } } }, - "validation_failed": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/validation-error" } - } - } - }, "not_modified": { "description": "Not modified" }, "forbidden_gist": { "description": "Forbidden Gist", @@ -61613,22 +62214,7 @@ } } }, - "bad_request": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/basic-error" } - }, - "application/scim+json": { - "schema": { "$ref": "#/components/schemas/scim-error" } - } - } - }, "found": { "description": "Found" }, - "accepted": { - "description": "Accepted", - "content": { "application/json": { "schema": { "type": "object" } } } - }, "no_content": { "description": "A header with no content is returned." } } } diff --git a/packages/openapi-types-ghes-2.22/package.json b/packages/openapi-types-ghes-2.22/package.json index a4f34d1d2..fb17cda95 100644 --- a/packages/openapi-types-ghes-2.22/package.json +++ b/packages/openapi-types-ghes-2.22/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "2.23.1" } + "octokit": { "openapi-version": "2.24.0" } } diff --git a/packages/openapi-types-ghes-2.22/types.d.ts b/packages/openapi-types-ghes-2.22/types.d.ts index c24a7a20e..a33391fcc 100644 --- a/packages/openapi-types-ghes-2.22/types.d.ts +++ b/packages/openapi-types-ghes-2.22/types.d.ts @@ -3394,40 +3394,46 @@ export interface paths { "/setup/api/maintenance": { /** Check your installation's maintenance status: */ get: operations["enterprise-admin/get-maintenance-status"]; - /** - * 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. - * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ + /** **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). */ post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; }; "/setup/api/settings": { get: operations["enterprise-admin/get-settings"]; - /** For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings). */ + /** + * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings). + * + * **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). + */ put: operations["enterprise-admin/set-settings"]; }; "/setup/api/settings/authorized-keys": { get: operations["enterprise-admin/get-all-authorized-ssh-keys"]; + /** **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). */ post: operations["enterprise-admin/add-authorized-ssh-key"]; + /** **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). */ delete: operations["enterprise-admin/remove-authorized-ssh-key"]; }; "/setup/api/start": { /** - * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license: + * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. 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. * - * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings). + * **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). */ post: operations["enterprise-admin/create-enterprise-server-license"]; }; "/setup/api/upgrade": { - /** This API upgrades your license and also triggers the configuration process: */ + /** + * This API upgrades your license and also triggers the configuration process. + * + * **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). + */ post: operations["enterprise-admin/upgrade-license"]; }; "/teams/{team_id}": { @@ -24587,11 +24593,7 @@ export interface operations { }; }; }; - /** - * 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. - * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ + /** **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). */ "enterprise-admin/enable-or-disable-maintenance-mode": { responses: { /** Response */ @@ -24603,8 +24605,14 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** A JSON string with the attributes `enabled` and `when`. */ + "application/x-www-form-urlencoded": { + /** + * A JSON string with the attributes `enabled` and `when`. + * + * 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. + * + * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). + */ maintenance: string; }; }; @@ -24620,7 +24628,11 @@ export interface operations { }; }; }; - /** For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings). */ + /** + * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings). + * + * **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). + */ "enterprise-admin/set-settings": { responses: { /** Response */ @@ -24628,8 +24640,8 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. */ + "application/x-www-form-urlencoded": { + /** 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/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings). */ settings: string; }; }; @@ -24645,6 +24657,7 @@ export interface operations { }; }; }; + /** **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). */ "enterprise-admin/add-authorized-ssh-key": { responses: { /** Response */ @@ -24656,13 +24669,14 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** The path to the public SSH key. */ + "application/x-www-form-urlencoded": { + /** The public SSH key. */ authorized_key: string; }; }; }; }; + /** **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). */ "enterprise-admin/remove-authorized-ssh-key": { responses: { /** Response */ @@ -24674,24 +24688,24 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** The path to the public SSH key. */ + "application/x-www-form-urlencoded": { + /** The public SSH key. */ authorized_key: string; }; }; }; }; /** - * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license: + * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. 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. * - * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings). + * **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). */ "enterprise-admin/create-enterprise-server-license": { responses: { @@ -24700,18 +24714,22 @@ export interface operations { }; requestBody: { content: { - "application/json": { + "application/x-www-form-urlencoded": { /** The content of your _.ghl_ license file. */ license: string; /** You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter. */ password?: string; - /** An optional JSON string containing the installation settings. */ + /** An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.22/rest/reference/enterprise-admin#get-settings). */ settings?: string; }; }; }; }; - /** This API upgrades your license and also triggers the configuration process: */ + /** + * This API upgrades your license and also triggers the configuration process. + * + * **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). + */ "enterprise-admin/upgrade-license": { responses: { /** Response */ @@ -24719,7 +24737,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { + "application/x-www-form-urlencoded": { /** The content of your new _.ghl_ license file. */ license?: string; }; diff --git a/packages/openapi-types-ghes-3.0/package.json b/packages/openapi-types-ghes-3.0/package.json index 258eaa729..e3559a1ef 100644 --- a/packages/openapi-types-ghes-3.0/package.json +++ b/packages/openapi-types-ghes-3.0/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "2.23.1" } + "octokit": { "openapi-version": "2.24.0" } } diff --git a/packages/openapi-types-ghes-3.0/types.d.ts b/packages/openapi-types-ghes-3.0/types.d.ts index 469ab29f6..b8fb7b2e1 100644 --- a/packages/openapi-types-ghes-3.0/types.d.ts +++ b/packages/openapi-types-ghes-3.0/types.d.ts @@ -3622,40 +3622,46 @@ export interface paths { "/setup/api/maintenance": { /** Check your installation's maintenance status: */ get: operations["enterprise-admin/get-maintenance-status"]; - /** - * 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. - * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ + /** **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). */ post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; }; "/setup/api/settings": { get: operations["enterprise-admin/get-settings"]; - /** For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings). */ + /** + * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings). + * + * **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). + */ put: operations["enterprise-admin/set-settings"]; }; "/setup/api/settings/authorized-keys": { get: operations["enterprise-admin/get-all-authorized-ssh-keys"]; + /** **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). */ post: operations["enterprise-admin/add-authorized-ssh-key"]; + /** **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). */ delete: operations["enterprise-admin/remove-authorized-ssh-key"]; }; "/setup/api/start": { /** - * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license: + * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. 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. * - * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings). + * **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). */ post: operations["enterprise-admin/create-enterprise-server-license"]; }; "/setup/api/upgrade": { - /** This API upgrades your license and also triggers the configuration process: */ + /** + * This API upgrades your license and also triggers the configuration process. + * + * **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). + */ post: operations["enterprise-admin/upgrade-license"]; }; "/teams/{team_id}": { @@ -25611,11 +25617,7 @@ export interface operations { }; }; }; - /** - * 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. - * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ + /** **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). */ "enterprise-admin/enable-or-disable-maintenance-mode": { responses: { /** Response */ @@ -25627,8 +25629,14 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** A JSON string with the attributes `enabled` and `when`. */ + "application/x-www-form-urlencoded": { + /** + * A JSON string with the attributes `enabled` and `when`. + * + * 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. + * + * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). + */ maintenance: string; }; }; @@ -25644,7 +25652,11 @@ export interface operations { }; }; }; - /** For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings). */ + /** + * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings). + * + * **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). + */ "enterprise-admin/set-settings": { responses: { /** Response */ @@ -25652,8 +25664,8 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. */ + "application/x-www-form-urlencoded": { + /** 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/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings). */ settings: string; }; }; @@ -25669,6 +25681,7 @@ export interface operations { }; }; }; + /** **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). */ "enterprise-admin/add-authorized-ssh-key": { responses: { /** Response */ @@ -25680,13 +25693,14 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** The path to the public SSH key. */ + "application/x-www-form-urlencoded": { + /** The public SSH key. */ authorized_key: string; }; }; }; }; + /** **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). */ "enterprise-admin/remove-authorized-ssh-key": { responses: { /** Response */ @@ -25698,24 +25712,24 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** The path to the public SSH key. */ + "application/x-www-form-urlencoded": { + /** The public SSH key. */ authorized_key: string; }; }; }; }; /** - * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license: + * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. 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. * - * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings). + * **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). */ "enterprise-admin/create-enterprise-server-license": { responses: { @@ -25724,18 +25738,22 @@ export interface operations { }; requestBody: { content: { - "application/json": { + "application/x-www-form-urlencoded": { /** The content of your _.ghl_ license file. */ license: string; /** You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter. */ password?: string; - /** An optional JSON string containing the installation settings. */ + /** An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings). */ settings?: string; }; }; }; }; - /** This API upgrades your license and also triggers the configuration process: */ + /** + * This API upgrades your license and also triggers the configuration process. + * + * **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). + */ "enterprise-admin/upgrade-license": { responses: { /** Response */ @@ -25743,7 +25761,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { + "application/x-www-form-urlencoded": { /** The content of your new _.ghl_ license file. */ license?: string; }; diff --git a/packages/openapi-types-ghes-3.1/package.json b/packages/openapi-types-ghes-3.1/package.json index 13042fcef..02ccd40af 100644 --- a/packages/openapi-types-ghes-3.1/package.json +++ b/packages/openapi-types-ghes-3.1/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "2.23.1" } + "octokit": { "openapi-version": "2.24.0" } } diff --git a/packages/openapi-types-ghes-3.1/types.d.ts b/packages/openapi-types-ghes-3.1/types.d.ts index 654620e5a..e367fbd0b 100644 --- a/packages/openapi-types-ghes-3.1/types.d.ts +++ b/packages/openapi-types-ghes-3.1/types.d.ts @@ -3774,40 +3774,46 @@ export interface paths { "/setup/api/maintenance": { /** Check your installation's maintenance status: */ get: operations["enterprise-admin/get-maintenance-status"]; - /** - * 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. - * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ + /** **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). */ post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; }; "/setup/api/settings": { get: operations["enterprise-admin/get-settings"]; - /** For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings). */ + /** + * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings). + * + * **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). + */ put: operations["enterprise-admin/set-settings"]; }; "/setup/api/settings/authorized-keys": { get: operations["enterprise-admin/get-all-authorized-ssh-keys"]; + /** **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). */ post: operations["enterprise-admin/add-authorized-ssh-key"]; + /** **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). */ delete: operations["enterprise-admin/remove-authorized-ssh-key"]; }; "/setup/api/start": { /** - * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license: + * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. 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. * - * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings). + * **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). */ post: operations["enterprise-admin/create-enterprise-server-license"]; }; "/setup/api/upgrade": { - /** This API upgrades your license and also triggers the configuration process: */ + /** + * This API upgrades your license and also triggers the configuration process. + * + * **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). + */ post: operations["enterprise-admin/upgrade-license"]; }; "/teams/{team_id}": { @@ -26242,11 +26248,7 @@ export interface operations { }; }; }; - /** - * 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. - * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ + /** **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). */ "enterprise-admin/enable-or-disable-maintenance-mode": { responses: { /** Response */ @@ -26258,8 +26260,14 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** A JSON string with the attributes `enabled` and `when`. */ + "application/x-www-form-urlencoded": { + /** + * A JSON string with the attributes `enabled` and `when`. + * + * 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. + * + * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). + */ maintenance: string; }; }; @@ -26275,7 +26283,11 @@ export interface operations { }; }; }; - /** For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings). */ + /** + * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings). + * + * **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). + */ "enterprise-admin/set-settings": { responses: { /** Response */ @@ -26283,8 +26295,8 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. */ + "application/x-www-form-urlencoded": { + /** 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/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings). */ settings: string; }; }; @@ -26300,6 +26312,7 @@ export interface operations { }; }; }; + /** **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). */ "enterprise-admin/add-authorized-ssh-key": { responses: { /** Response */ @@ -26311,13 +26324,14 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** The path to the public SSH key. */ + "application/x-www-form-urlencoded": { + /** The public SSH key. */ authorized_key: string; }; }; }; }; + /** **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). */ "enterprise-admin/remove-authorized-ssh-key": { responses: { /** Response */ @@ -26329,24 +26343,24 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** The path to the public SSH key. */ + "application/x-www-form-urlencoded": { + /** The public SSH key. */ authorized_key: string; }; }; }; }; /** - * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license: + * When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. 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. * - * For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings). + * **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). */ "enterprise-admin/create-enterprise-server-license": { responses: { @@ -26355,18 +26369,22 @@ export interface operations { }; requestBody: { content: { - "application/json": { + "application/x-www-form-urlencoded": { /** The content of your _.ghl_ license file. */ license: string; /** You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter. */ password?: string; - /** An optional JSON string containing the installation settings. */ + /** An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings). */ settings?: string; }; }; }; }; - /** This API upgrades your license and also triggers the configuration process: */ + /** + * This API upgrades your license and also triggers the configuration process. + * + * **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). + */ "enterprise-admin/upgrade-license": { responses: { /** Response */ @@ -26374,7 +26392,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { + "application/x-www-form-urlencoded": { /** The content of your new _.ghl_ license file. */ license?: string; }; diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index 0c83b32b5..decda8676 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "2.23.1" } + "octokit": { "openapi-version": "2.24.0" } } diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index 14e71d609..287a2b205 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -116,6 +116,30 @@ export interface paths { */ patch: operations["apps/update-webhook-config-for-app"]; }; + "/app/hook/deliveries": { + /** + * Returns a list of webhook deliveries for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + get: operations["apps/list-webhook-deliveries"]; + }; + "/app/hook/deliveries/{delivery_id}": { + /** + * Returns a delivery for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + get: operations["apps/get-webhook-delivery"]; + }; + "/app/hook/deliveries/{delivery_id}/attempts": { + /** + * Redeliver a delivery for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + post: operations["apps/redeliver-webhook-delivery"]; + }; "/app/installations": { /** * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. @@ -824,6 +848,14 @@ export interface paths { */ patch: operations["orgs/update-webhook-config-for-org"]; }; + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + /** Returns a delivery for a webhook configured in an organization. */ + get: operations["orgs/get-webhook-delivery"]; + }; + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + /** Redeliver a delivery for a webhook configured in an organization. */ + post: operations["orgs/redeliver-webhook-delivery"]; + }; "/orgs/{org}/hooks/{hook_id}/pings": { /** This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook. */ post: operations["orgs/ping-webhook"]; @@ -2561,6 +2593,18 @@ export interface paths { */ patch: operations["repos/update-webhook-config-for-repo"]; }; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + /** Returns a list of webhook deliveries for a webhook configured in a repository. */ + get: operations["repos/list-webhook-deliveries"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + /** Returns a delivery for a webhook configured in a repository. */ + get: operations["repos/get-webhook-delivery"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + /** Redeliver a webhook delivery for a webhook configured in a repository. */ + post: operations["repos/redeliver-webhook-delivery"]; + }; "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { /** This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; @@ -4136,6 +4180,90 @@ export interface components { secret?: components["schemas"]["webhook-config-secret"]; insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; }; + /** Delivery made by a webhook, without request and response information. */ + "hook-delivery-item": { + /** Unique identifier of the webhook delivery. */ + id: number; + /** Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). */ + guid: string; + /** Time when the webhook delivery occurred. */ + delivered_at: string; + /** Whether the webhook delivery is a redelivery. */ + redelivery: boolean; + /** Time spent delivering. */ + duration: number; + /** Describes the response returned after attempting the delivery. */ + status: string; + /** Status code received when delivery was made. */ + status_code: number; + /** The event that triggered the delivery. */ + event: string; + /** The type of activity for the event that triggered the delivery. */ + action: string | null; + /** The id of the GitHub App installation associated with this event. */ + installation_id: number | null; + /** The id of the repository associated with this event. */ + repository_id: number | null; + }; + /** Scim Error */ + "scim-error": { + message?: string | null; + documentation_url?: string | null; + detail?: string | null; + status?: number; + scimType?: string | null; + schemas?: string[]; + }; + /** Validation Error */ + "validation-error": { + message: string; + documentation_url: string; + errors?: { + resource?: string; + field?: string; + message?: string; + code: string; + index?: number; + value?: (string | null) | (number | null) | (string[] | null); + }[]; + }; + /** Delivery made by a webhook. */ + "hook-delivery": { + /** Unique identifier of the delivery. */ + id: number; + /** Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). */ + guid: string; + /** Time when the delivery was delivered. */ + delivered_at: string; + /** Whether the delivery is a redelivery. */ + redelivery: boolean; + /** Time spent delivering. */ + duration: number; + /** Description of the status of the attempted delivery */ + status: string; + /** Status code received when delivery was made. */ + status_code: number; + /** The event that triggered the delivery. */ + event: string; + /** The type of activity for the event that triggered the delivery. */ + action: string | null; + /** The id of the GitHub App installation associated with this event. */ + installation_id: number | null; + /** The id of the repository associated with this event. */ + repository_id: number | null; + request: { + /** The request headers sent with the webhook delivery. */ + headers: { [key: string]: any } | null; + /** The webhook payload. */ + payload: { [key: string]: any } | null; + }; + response: { + /** The response headers received when the delivery was made. */ + headers: { [key: string]: any } | null; + /** The response payload received. */ + payload: string | null; + }; + }; /** An enterprise account */ enterprise: { /** A short description of the enterprise. */ @@ -4420,19 +4548,6 @@ export interface components { has_multiple_single_files?: boolean; single_file_paths?: string[]; }; - /** Validation Error */ - "validation-error": { - message: string; - documentation_url: string; - errors?: { - resource?: string; - field?: string; - message?: string; - code: string; - index?: number; - value?: (string | null) | (number | null) | (string[] | null); - }[]; - }; /** Code Of Conduct */ "code-of-conduct": { key: string; @@ -5155,6 +5270,7 @@ export interface components { id: number; url: string; ping_url: string; + deliveries_url?: string; name: string; events: string[]; active: boolean; @@ -6475,15 +6591,6 @@ export interface components { author_association: components["schemas"]["author_association"]; reactions?: components["schemas"]["reaction-rollup"]; }; - /** Scim Error */ - "scim-error": { - message?: string | null; - documentation_url?: string | null; - detail?: string | null; - status?: number; - scimType?: string | null; - schemas?: string[]; - }; /** Branch Short */ "branch-short": { name: string; @@ -7146,6 +7253,7 @@ export interface components { url: string; test_url: string; ping_url: string; + deliveries_url?: string; last_response: components["schemas"]["hook-response"]; }; /** Issue Event Label */ @@ -8757,6 +8865,25 @@ export interface components { "application/json": components["schemas"]["validation-error-simple"]; }; }; + /** Bad Request */ + bad_request: { + content: { + "application/json": components["schemas"]["basic-error"]; + "application/scim+json": components["schemas"]["scim-error"]; + }; + }; + /** Validation failed */ + validation_failed: { + content: { + "application/json": components["schemas"]["validation-error"]; + }; + }; + /** Accepted */ + accepted: { + content: { + "application/json": { [key: string]: any }; + }; + }; /** Preview header missing */ preview_header_missing: { content: { @@ -8778,12 +8905,6 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Validation failed */ - validation_failed: { - content: { - "application/json": components["schemas"]["validation-error"]; - }; - }; /** Not modified */ not_modified: unknown; /** Forbidden Gist */ @@ -8852,21 +8973,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Bad Request */ - bad_request: { - content: { - "application/json": components["schemas"]["basic-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; /** Found */ found: unknown; - /** Accepted */ - accepted: { - content: { - "application/json": { [key: string]: any }; - }; - }; /** A header with no content is returned. */ no_content: unknown; }; @@ -8885,6 +8993,9 @@ export interface components { username: string; /** Results per page (max 100). */ per_page: number; + /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor: string; + "delivery-id": number; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since: string; /** installation_id parameter */ @@ -9656,6 +9767,70 @@ export interface operations { }; }; }; + /** + * Returns a list of webhook deliveries for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/list-webhook-deliveries": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor?: components["parameters"]["cursor"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Returns a delivery for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/get-webhook-delivery": { + parameters: { + path: { + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Redeliver a delivery for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/redeliver-webhook-delivery": { + parameters: { + path: { + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * @@ -12499,6 +12674,41 @@ export interface operations { }; }; }; + /** Returns a delivery for a webhook configured in an organization. */ + "orgs/get-webhook-delivery": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Redeliver a delivery for a webhook configured in an organization. */ + "orgs/redeliver-webhook-delivery": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook. */ "orgs/ping-webhook": { parameters: { @@ -19590,6 +19800,69 @@ export interface operations { }; }; }; + /** Returns a list of webhook deliveries for a webhook configured in a repository. */ + "repos/list-webhook-deliveries": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor?: components["parameters"]["cursor"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Returns a delivery for a webhook configured in a repository. */ + "repos/get-webhook-delivery": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Redeliver a webhook delivery for a webhook configured in a repository. */ + "repos/redeliver-webhook-delivery": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook. */ "repos/ping-webhook": { parameters: { diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index edd92c964..852fdcc20 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "2.23.1" } + "octokit": { "openapi-version": "2.24.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index 716ef0ad4..4d47558a6 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -34,6 +34,30 @@ export interface paths { */ patch: operations["apps/update-webhook-config-for-app"]; }; + "/app/hook/deliveries": { + /** + * Returns a list of webhook deliveries for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + get: operations["apps/list-webhook-deliveries"]; + }; + "/app/hook/deliveries/{delivery_id}": { + /** + * Returns a delivery for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + get: operations["apps/get-webhook-delivery"]; + }; + "/app/hook/deliveries/{delivery_id}/attempts": { + /** + * Redeliver a delivery for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + post: operations["apps/redeliver-webhook-delivery"]; + }; "/app/installations": { /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. @@ -1125,6 +1149,18 @@ export interface paths { */ patch: operations["orgs/update-webhook-config-for-org"]; }; + "/orgs/{org}/hooks/{hook_id}/deliveries": { + /** Returns a list of webhook deliveries for a webhook configured in an organization. */ + get: operations["orgs/list-webhook-deliveries"]; + }; + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + /** Returns a delivery for a webhook configured in an organization. */ + get: operations["orgs/get-webhook-delivery"]; + }; + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + /** Redeliver a delivery for a webhook configured in an organization. */ + post: operations["orgs/redeliver-webhook-delivery"]; + }; "/orgs/{org}/hooks/{hook_id}/pings": { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ post: operations["orgs/ping-webhook"]; @@ -1922,8 +1958,6 @@ export interface paths { }; "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { /** - * **Note:** This endpoint is currently in beta and is subject to change. - * * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. @@ -3306,6 +3340,18 @@ export interface paths { */ patch: operations["repos/update-webhook-config-for-repo"]; }; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + /** Returns a list of webhook deliveries for a webhook configured in a repository. */ + get: operations["repos/list-webhook-deliveries"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + /** Returns a delivery for a webhook configured in a repository. */ + get: operations["repos/get-webhook-delivery"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + /** Redeliver a webhook delivery for a webhook configured in a repository. */ + post: operations["repos/redeliver-webhook-delivery"]; + }; "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; @@ -5300,6 +5346,90 @@ export interface components { secret?: components["schemas"]["webhook-config-secret"]; insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; }; + /** Delivery made by a webhook, without request and response information. */ + "hook-delivery-item": { + /** Unique identifier of the webhook delivery. */ + id: number; + /** Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). */ + guid: string; + /** Time when the webhook delivery occurred. */ + delivered_at: string; + /** Whether the webhook delivery is a redelivery. */ + redelivery: boolean; + /** Time spent delivering. */ + duration: number; + /** Describes the response returned after attempting the delivery. */ + status: string; + /** Status code received when delivery was made. */ + status_code: number; + /** The event that triggered the delivery. */ + event: string; + /** The type of activity for the event that triggered the delivery. */ + action: string | null; + /** The id of the GitHub App installation associated with this event. */ + installation_id: number | null; + /** The id of the repository associated with this event. */ + repository_id: number | null; + }; + /** Scim Error */ + "scim-error": { + message?: string | null; + documentation_url?: string | null; + detail?: string | null; + status?: number; + scimType?: string | null; + schemas?: string[]; + }; + /** Validation Error */ + "validation-error": { + message: string; + documentation_url: string; + errors?: { + resource?: string; + field?: string; + message?: string; + code: string; + index?: number; + value?: (string | null) | (number | null) | (string[] | null); + }[]; + }; + /** Delivery made by a webhook. */ + "hook-delivery": { + /** Unique identifier of the delivery. */ + id: number; + /** Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). */ + guid: string; + /** Time when the delivery was delivered. */ + delivered_at: string; + /** Whether the delivery is a redelivery. */ + redelivery: boolean; + /** Time spent delivering. */ + duration: number; + /** Description of the status of the attempted delivery */ + status: string; + /** Status code received when delivery was made. */ + status_code: number; + /** The event that triggered the delivery. */ + event: string; + /** The type of activity for the event that triggered the delivery. */ + action: string | null; + /** The id of the GitHub App installation associated with this event. */ + installation_id: number | null; + /** The id of the repository associated with this event. */ + repository_id: number | null; + request: { + /** The request headers sent with the webhook delivery. */ + headers: { [key: string]: any } | null; + /** The webhook payload. */ + payload: { [key: string]: any } | null; + }; + response: { + /** The response headers received when the delivery was made. */ + headers: { [key: string]: any } | null; + /** The response payload received. */ + payload: string | null; + }; + }; /** An enterprise account */ enterprise: { /** A short description of the enterprise. */ @@ -5649,19 +5779,6 @@ export interface components { has_multiple_single_files?: boolean; single_file_paths?: string[]; }; - /** Validation Error */ - "validation-error": { - message: string; - documentation_url: string; - errors?: { - resource?: string; - field?: string; - message?: string; - code: string; - index?: number; - value?: (string | null) | (number | null) | (string[] | null); - }[]; - }; /** The authorization associated with an OAuth Access. */ "application-grant": { id: number; @@ -6662,6 +6779,7 @@ export interface components { id: number; url: string; ping_url: string; + deliveries_url?: string; name: string; events: string[]; active: boolean; @@ -8097,15 +8215,6 @@ export interface components { /** Next deletable analysis in chain, with last analysis deletion confirmation */ confirm_delete_url: string | null; }; - /** Scim Error */ - "scim-error": { - message?: string | null; - documentation_url?: string | null; - detail?: string | null; - status?: number; - scimType?: string | null; - schemas?: string[]; - }; /** A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ "code-scanning-analysis-sarif-file": string; "code-scanning-sarifs-receipt": { @@ -8779,6 +8888,7 @@ export interface components { url: string; test_url: string; ping_url: string; + deliveries_url?: string; last_response: components["schemas"]["hook-response"]; }; /** A repository import from an external source. */ @@ -10704,6 +10814,25 @@ export interface components { "application/json": components["schemas"]["validation-error-simple"]; }; }; + /** Bad Request */ + bad_request: { + content: { + "application/json": components["schemas"]["basic-error"]; + "application/scim+json": components["schemas"]["scim-error"]; + }; + }; + /** Validation failed */ + validation_failed: { + content: { + "application/json": components["schemas"]["validation-error"]; + }; + }; + /** Accepted */ + accepted: { + content: { + "application/json": { [key: string]: any }; + }; + }; /** Preview header missing */ preview_header_missing: { content: { @@ -10725,12 +10854,6 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Validation failed */ - validation_failed: { - content: { - "application/json": components["schemas"]["validation-error"]; - }; - }; /** Not modified */ not_modified: unknown; /** Gone */ @@ -10793,13 +10916,6 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Bad Request */ - bad_request: { - content: { - "application/json": components["schemas"]["basic-error"]; - "application/scim+json": components["schemas"]["scim-error"]; - }; - }; /** Internal Error */ internal_error: { content: { @@ -10808,12 +10924,6 @@ export interface components { }; /** Found */ found: unknown; - /** Accepted */ - accepted: { - content: { - "application/json": { [key: string]: any }; - }; - }; /** A header with no content is returned. */ no_content: unknown; /** Resource not found */ @@ -10855,6 +10965,9 @@ export interface components { parameters: { /** Results per page (max 100). */ per_page: number; + /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor: string; + "delivery-id": number; /** Page number of the results to fetch. */ page: number; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ @@ -11189,6 +11302,70 @@ export interface operations { }; }; }; + /** + * Returns a list of webhook deliveries for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/list-webhook-deliveries": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor?: components["parameters"]["cursor"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Returns a delivery for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/get-webhook-delivery": { + parameters: { + path: { + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Redeliver a delivery for the webhook configured for a GitHub App. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/redeliver-webhook-delivery": { + parameters: { + path: { + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * @@ -15366,6 +15543,66 @@ export interface operations { }; }; }; + /** Returns a list of webhook deliveries for a webhook configured in an organization. */ + "orgs/list-webhook-deliveries": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor?: components["parameters"]["cursor"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Returns a delivery for a webhook configured in an organization. */ + "orgs/get-webhook-delivery": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Redeliver a delivery for a webhook configured in an organization. */ + "orgs/redeliver-webhook-delivery": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ "orgs/ping-webhook": { parameters: { @@ -18921,8 +19158,6 @@ export interface operations { }; }; /** - * **Note:** This endpoint is currently in beta and is subject to change. - * * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. @@ -23823,6 +24058,69 @@ export interface operations { }; }; }; + /** Returns a list of webhook deliveries for a webhook configured in a repository. */ + "repos/list-webhook-deliveries": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor?: components["parameters"]["cursor"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Returns a delivery for a webhook configured in a repository. */ + "repos/get-webhook-delivery": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Redeliver a webhook delivery for a webhook configured in a repository. */ + "repos/redeliver-webhook-delivery": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ "repos/ping-webhook": { parameters: {