Skip to content

Commit

Permalink
fix: description and sample payload updates (#365)
Browse files Browse the repository at this point in the history
  • Loading branch information
@octokitbot
octokitbot authored Oct 25, 2023
1 parent b403c9f commit d14957b
Show file tree
Hide file tree
Showing 21 changed files with 641 additions and 394 deletions.
259 changes: 192 additions & 67 deletions cache/api.github.com.json
View file

Large diffs are not rendered by default.

259 changes: 192 additions & 67 deletions cache/ghec.json
View file

Large diffs are not rendered by default.

94 changes: 44 additions & 50 deletions cache/ghes-3.10.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "13.1.0",
"version": "13.2.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": {
Expand Down Expand Up @@ -40252,7 +40252,7 @@
"operationId": "repos/list-webhooks",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repos#list-repository-webhooks"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#list-repository-webhooks"
},
"parameters": [
{
Expand Down Expand Up @@ -40299,8 +40299,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repos"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
},
Expand All @@ -40313,7 +40313,7 @@
"operationId": "repos/create-webhook",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repos#create-a-repository-webhook"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#create-a-repository-webhook"
},
"parameters": [
{
Expand Down Expand Up @@ -40436,8 +40436,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repos"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
}
Expand All @@ -40452,7 +40452,7 @@
"operationId": "repos/get-webhook",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repos#get-a-repository-webhook"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#get-a-repository-webhook"
},
"parameters": [
{
Expand Down Expand Up @@ -40488,8 +40488,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repos"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
},
Expand All @@ -40502,7 +40502,7 @@
"operationId": "repos/update-webhook",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repos#update-a-repository-webhook"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#update-a-repository-webhook"
},
"parameters": [
{
Expand Down Expand Up @@ -40621,8 +40621,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repos"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
},
Expand All @@ -40635,7 +40635,7 @@
"operationId": "repos/delete-webhook",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repos#delete-a-repository-webhook"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#delete-a-repository-webhook"
},
"parameters": [
{
Expand All @@ -40659,8 +40659,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repos"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
}
Expand All @@ -40675,7 +40675,7 @@
"operationId": "repos/get-webhook-config-for-repo",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository"
},
"parameters": [
{
Expand Down Expand Up @@ -40708,8 +40708,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repo-config"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
},
Expand All @@ -40722,7 +40722,7 @@
"operationId": "repos/update-webhook-config-for-repo",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository"
},
"parameters": [
{
Expand Down Expand Up @@ -40789,8 +40789,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repo-config"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
}
Expand All @@ -40805,7 +40805,7 @@
"operationId": "repos/list-webhook-deliveries",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#list-deliveries-for-a-repository-webhook"
},
"parameters": [
{
Expand Down Expand Up @@ -40861,8 +40861,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repo-deliveries"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
}
Expand All @@ -40877,7 +40877,7 @@
"operationId": "repos/get-webhook-delivery",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook"
},
"parameters": [
{
Expand Down Expand Up @@ -40919,8 +40919,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repo-deliveries"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
}
Expand All @@ -40935,7 +40935,7 @@
"operationId": "repos/redeliver-webhook-delivery",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook"
},
"parameters": [
{
Expand Down Expand Up @@ -40965,8 +40965,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repo-deliveries"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
}
Expand All @@ -40981,7 +40981,7 @@
"operationId": "repos/ping-webhook",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repos#ping-a-repository-webhook"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#ping-a-repository-webhook"
},
"parameters": [
{
Expand All @@ -41005,8 +41005,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repos"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
}
Expand All @@ -41021,7 +41021,7 @@
"operationId": "repos/test-push-webhook",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/[email protected]/rest/webhooks/repos#test-the-push-repository-webhook"
"url": "https://docs.github.com/[email protected]/rest/repos/webhooks#test-the-push-repository-webhook"
},
"parameters": [
{
Expand All @@ -41045,8 +41045,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "webhooks",
"subcategory": "repos"
"category": "repos",
"subcategory": "webhooks"
},
"x-octokit": {}
}
Expand Down Expand Up @@ -44443,6 +44443,9 @@
}
}
}
},
"404": {
"$ref": "#/components/responses/not_found"
}
},
"x-github": {
Expand Down Expand Up @@ -79104,7 +79107,7 @@
"pull-request-edited": {
"post": {
"summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/[email protected]/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/[email protected]/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/[email protected]/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
"description": "The title or body of a pull request was edited.",
"description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.",
"operationId": "pull-request/edited",
"externalDocs": {
"url": "https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#pull_request"
Expand Down Expand Up @@ -101779,7 +101782,8 @@
"enum": [
"queued",
"in_progress",
"completed"
"completed",
"waiting"
]
},
"conclusion": {
Expand Down Expand Up @@ -278162,7 +278166,6 @@
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,
Expand Down Expand Up @@ -278547,7 +278550,6 @@
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": null,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
Expand Down Expand Up @@ -289790,16 +289792,10 @@
"html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
"locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
"state": "open",
"resolution": null,
"resolved_at": null,
"resolved_by": null,
"secret_type": "mailchimp_api_key",
"secret_type_display_name": "Mailchimp API Key",
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
"push_protection_bypassed_by": null,
"push_protection_bypassed": false,
"push_protection_bypassed_at": null,
"resolution_comment": null
"push_protection_bypassed": false
}
},
"secret-scanning-alert-resolved": {
Expand Down Expand Up @@ -289836,8 +289832,6 @@
"secret_type_display_name": "Mailchimp API Key",
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
"push_protection_bypassed": false,
"push_protection_bypassed_by": null,
"push_protection_bypassed_at": null,
"resolution_comment": "Example comment"
}
},
Expand Down
Loading

0 comments on commit d14957b

Please sign in to comment.