From 5f26c05dba0f8847979c5c0e7a2d26d3cc3cadc5 Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Wed, 22 Dec 2021 12:58:59 -0800 Subject: [PATCH] fix: update event properties descriptions for changes in github docs URLs (#596) * feat: remove `content_reference` event BREAKING CHANGE: remove `content_reference` event * fix: update description for `key` property in `deployment_key` event * fix: description updates for `deployment` and `deployment_status` events Co-authored-by: wolfy1339 --- .../webhook-events-and-payloads.html | 1139 ++++++------ .../ghes-30/webhook-events-and-payloads.html | 425 +++-- .../ghes-31/webhook-events-and-payloads.html | 433 +++-- .../ghes-32/webhook-events-and-payloads.html | 433 +++-- .../ghes-33/webhook-events-and-payloads.html | 451 +++-- .../webhook-events-and-payloads.html | 1644 +++++++++-------- .../content_reference/created.payload.json | 128 -- payload-examples/api.github.com/index.json | 290 +-- payload-examples/ghes-30/index.json | 20 +- payload-examples/ghes-31/index.json | 20 +- payload-examples/ghes-32/index.json | 20 +- payload-examples/ghes-33/index.json | 20 +- payload-examples/github.ae/index.json | 380 ++-- .../content_reference/created.schema.json | 31 - .../deploy_key/created.schema.json | 2 +- .../deploy_key/deleted.schema.json | 2 +- .../deployment/created.schema.json | 2 +- .../deployment_status/created.schema.json | 2 +- payload-types/schema.d.ts | 23 +- 19 files changed, 2753 insertions(+), 2712 deletions(-) delete mode 100644 payload-examples/api.github.com/content_reference/created.payload.json delete mode 100644 payload-schemas/api.github.com/content_reference/created.schema.json diff --git a/cache/api.github.com/webhook-events-and-payloads.html b/cache/api.github.com/webhook-events-and-payloads.html index d38a8019f..d10106118 100644 --- a/cache/api.github.com/webhook-events-and-payloads.html +++ b/cache/api.github.com/webhook-events-and-payloads.html @@ -30,15 +30,17 @@

Webhook events and payloads

-
    -
  • +
  • -
    - +
    +
    @@ -872,9 +994,9 @@

    Webhook events and payloads

    " >

    - Enterprise accounts are available with GitHub Enterprise Cloud and GitHub - Enterprise Server. For more information, see "About enterprise accounts."

    @@ -2900,6 +3022,7 @@

    "alert": { "number": 10, "created_at": "2020-07-22T14:06:31Z", + "updated_at": "2020-07-22T14:06:31Z", "url": "https://api.github.com/repos/Codertocat/Hello-World/code-scanning/alerts/10", "html_url": "https://github.com/Codertocat/Hello-World/security/code-scanning/10", "instances": [ @@ -2911,13 +3034,19 @@

    } ], "state": "open", + "fixed_at": null, "dismissed_by": null, "dismissed_at": null, "dismissed_reason": null, "rule": { "id": "Style/FrozenStringLiteralComment", "severity": "note", - "description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default." + "description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default.", + "full_description": "Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default.", + "tags": [ + "style" + ], + "help": "Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged\n--- | --- | --- | --- | ---\nEnabled | No | Yes (Unsafe) | 0.36 | 0.79\n\nThis cop is designed to help you transition from mutable string literals\nto frozen string literals.\nIt will add the comment `# frozen_string_literal: true` to the top of\nfiles to enable frozen string literals. Frozen string literals may be\ndefault in future Ruby. The comment will be added below a shebang and\nencoding comment. The frozen string literal comment is only valid in\nRuby 2.3+.\n\nNote that the cop will ignore files where the comment exists but is set\nto `false` instead of `true`.\n\n### Examples\n\n#### EnforcedStyle: always (default)\n\n```ruby\n# The `always` style will always add the frozen string literal comment\n# to a file, regardless of the Ruby version or if `freeze` or `<<` are\n# called on a string literal.\n# bad\nmodule Bar\n # ...\nend\n\n# good\n# frozen_string_literal: true\n\nmodule Bar\n # ...\nend\n\n# good\n# frozen_string_literal: false\n\nmodule Bar\n # ...\nend\n```\n#### EnforcedStyle: never\n\n```ruby\n# The `never` will enforce that the frozen string literal comment does\n# not exist in a file.\n# bad\n# frozen_string_literal: true\n\nmodule Baz\n # ...\nend\n\n# good\nmodule Baz\n # ...\nend\n```\n#### EnforcedStyle: always_true\n\n```ruby\n# The `always_true` style enforces that the frozen string literal\n# comment is set to `true`. This is a stricter option than `always`\n# and forces projects to use frozen string literals.\n# bad\n# frozen_string_literal: false\n\nmodule Baz\n # ...\nend\n\n# bad\nmodule Baz\n # ...\nend\n\n# good\n# frozen_string_literal: true\n\nmodule Bar\n # ...\nend\n```\n\n### Configurable attributes\n\nName | Default value | Configurable values\n--- | --- | ---\nEnforcedStyle | `always` | `always`, `always_true`, `never`\n\n" }, "tool": { "name": "Rubocop", @@ -3167,7 +3296,7 @@

    object The - commit comment resource. @@ -3391,236 +3520,6 @@

    "site_admin": false } } - -

    -

    - - content_reference -

    -

    - A new content reference is created. A new content reference - is created when the body or comment of an issue or pull request includes - a URL that matches a configured content reference domain. For more - information, see "Using content attachments" to learn more about content references and attachments. -

    -

    - Webhook events are triggered based on the specificity of the domain you - register. For example, if you register a subdomain - (https://subdomain.example.com) then only URLs for the - subdomain trigger this event. If you register a domain - (https://example.com) then URLs for domain and all - subdomains trigger this event. See "Create a content attachment" to create a new content attachment. -

    -

    - - Availability -

    -
      -
    • - GitHub Apps with the content_references:write permission -
      • -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "content_reference": {
-    "id": 17,
-    "node_id": "MDE2OkNvbnRlbnRSZWZlcmVuY2UxNjA5",
-    "reference": "https://errors.ai/"
-  },
-  "repository": {
-    "id": 145551601,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNDU1NTE2MDE=",
-    "name": "hello-world",
-    "full_name": "octocoders/hello-world",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 7718702,
-      "node_id": "MDQ6VXNlcjc3MTg3MDI=",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/7718702?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "html_url": "https://github.com/Codertocat/hello-world",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/hello-world",
-    "forks_url": "https://api.github.com/repos/Codertocat/hello-world/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/hello-world/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/hello-world/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/hello-world/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/hello-world/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/hello-world/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/hello-world/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/hello-world/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/hello-world/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/hello-world/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/hello-world/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/hello-world/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/hello-world/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/hello-world/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/hello-world/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/hello-world/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/hello-world/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/hello-world/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/hello-world/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/hello-world/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/hello-world/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/hello-world/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/hello-world/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/hello-world/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/hello-world/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/hello-world/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/hello-world/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/hello-world/deployments",
-    "created_at": "2018-08-21T10:58:58Z",
-    "updated_at": "2018-08-21T10:59:01Z",
-    "pushed_at": "2018-08-21T10:59:00Z",
-    "git_url": "git://github.com/Codertocat/hello-world.git",
-    "ssh_url": "git@github.com:Codertocat/hello-world.git",
-    "clone_url": "https://github.com/Codertocat/hello-world.git",
-    "svn_url": "https://github.com/Codertocat/hello-world",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 7718702,
-    "node_id": "MDQ6VXNlcjc3MTg3MDI=",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/7718702?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  },
-  "installation": {
-    "id": 371641,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzcxNjQx"
-  }
-}

    @@ -3668,12 +3567,12 @@

    when you push more than three tags at once.

-

+

-

+

when you delete more than three tags at once.

-

+

-

+

>Deploy keys" REST API.

-

+

object The - deploy key resource. @@ -4437,12 +4336,12 @@

-

+

A deployment is created. The type of activity is specified in the action property of the payload object. For more information, see the "deployment" REST API.

-

+

object The - deploymentdeployment. @@ -4742,12 +4642,12 @@

-

+

A deployment is created. The type of activity is specified in the action property of the payload object. For more information, see the "deployment statuses" REST API.

-

+

object The - deployment status. @@ -5065,7 +4965,9 @@

object The - deployment + deployment that this status is associated with. @@ -5109,12 +5011,12 @@

-

+

>Using the GraphQL API for discussions."

-

+

-

+

"repository_url": "https://api.github.com/repos/octo-org/octo-repo", "category": { "id": 32784361, + "node_id": "DIC_kwAqGA", "repository_id": 17273051, "emoji": ":speech_balloon:", "name": "General", @@ -5749,12 +5652,12 @@

>Using the GraphQL API for discussions."

-

+

-

+

"repository_url": "https://api.github.com/repos/octo-org/octo-repo", "category": { "id": 32784361, + "node_id": "DIC_kwAqGA", "repository_id": 17273051, "emoji": ":speech_balloon:", "name": "General", @@ -6150,12 +6054,12 @@

>forks" REST API.

-

+

-

+

>Identifying and authorizing users for GitHub Apps."

-

+

-

+

>About wikis".

-

+

-

+

>GitHub App installation" REST API.

-

+

-

+

>GitHub App installation" REST API.

-

+

-

+

>issue comments" REST API.

-

+

-

+

>issues" REST API.

-

+

>labels" REST API.

-

+

-

+

>GitHub Marketplace."

-

+

>collaborators" REST API.

-

+

-

+

>team members" REST API.

-

+

-

+

on. Therefore, it must be selected for each hook that you'd like to receive meta events for.

-

+

-

+

>milestones" REST API.

-

+

-

+

>organizations" REST API.

-

+

-

+

>blocking organization users" REST API.

-

+

-

+

>Managing packages with GitHub Packages" to learn more about GitHub Packages.

-

+

-

+

for project pages, the default branch for user and organization pages) triggers this event.

-

+

object The - List GitHub Pages builds itself. @@ -11331,12 +11235,12 @@

-

+

> endpoint.

-

+

object The - webhook configuration. @@ -11675,12 +11579,12 @@

-

+

>project cards" REST API.

-

+

-

+

>project columns" REST API.

-

+

-

+

information, see the "projects" REST API.

-

+

-

+

When a private repository is made public. Without a doubt: the best GitHub event.

-

+

-

+

>pull requests" REST API.

-

+

-

+

>pull request reviews" REST API.

-

+

-

+

>pull request review comments" REST API.

-

+

-

+

when you push more than three tags at once.

-

+

-

+

>releases" REST API.

-

+

-

+

>Create a repository dispatch event" endpoint.

-

+

this webhook. -

+

information, see the "repositories" REST API.

-

+

-

+

>Source imports API.

-

+

-

+

>About alerts for vulnerable dependencies".

-

+

-

+

>About secret scanning."

-

+

-

+

>security_advisory

- Activity related to a security advisory. A security advisory provides - information about security-related vulnerabilities in software on - GitHub. The security advisory dataset also powers the GitHub security - alerts, see " +

+ The security advisory dataset also powers the GitHub Dependabot alerts. + For more information, see "About alerts for vulnerable dependencies."

-

+

-

+

>Configuring webhooks for events in your sponsored account".

-

+

>starring" REST API.

-

+

-

+

>statuses" REST API.

-

+

-

+

more information, see the "teams" REST API.

-

+

-

+

>repository is added to a team.

-

+

-

+

starred a repository, and the event’s repository is the repository that was starred.

-

+

-

+

>Events that trigger workflows."

-

+

this webhook. -

+

been completed on a repository. The type of activity is specified in the action property of the payload object.

-

+

-

+

>Events that trigger workflows."

-

+

-

+

Webhook events and payloads

    -
  • +
  • -
    - +
    +
    @@ -738,7 +850,7 @@

    Webhook events and payloads

    Enterprise accounts are available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "About enterprise accounts."

    @@ -2794,7 +2906,7 @@

    The commit comment resource. @@ -4086,7 +4198,7 @@

    The deploy key resource. @@ -4305,7 +4417,7 @@

    A deployment is created. The type of activity is specified in the action property of the payload object. For more information, see the "deployment" REST API.

    @@ -4387,7 +4499,7 @@

    The deployment. @@ -4661,7 +4773,7 @@

    A deployment is created. The type of activity is specified in the action property of the payload object. For more information, see the "deployment statuses" REST API.

    @@ -4743,7 +4855,7 @@

    The deployment status. @@ -4774,7 +4886,7 @@

    The deployment that this status is associated with. @@ -9763,7 +9875,7 @@

    The List GitHub Pages builds itself. @@ -10122,7 +10234,7 @@

    The webhook configuration. @@ -15370,10 +15482,13 @@

    >security_advisory

    - Activity related to a security advisory. A security advisory provides - information about security-related vulnerabilities in software on - GitHub. The security advisory dataset also powers the GitHub security - alerts, see " +

    + The security advisory dataset also powers the GitHub Dependabot alerts. + For more information, see "About alerts for vulnerable dependencies." diff --git a/cache/ghes-31/webhook-events-and-payloads.html b/cache/ghes-31/webhook-events-and-payloads.html index c2d871f94..063eb58c6 100644 --- a/cache/ghes-31/webhook-events-and-payloads.html +++ b/cache/ghes-31/webhook-events-and-payloads.html @@ -30,15 +30,17 @@

    Webhook events and payloads

    -

    +

    The commit comment resource. @@ -2806,12 +3272,12 @@

    -

    +

    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } - -

    -

    - - content_reference -

    -

    - A new content reference is created. A new content reference - is created when the body or comment of an issue or pull request includes - a URL that matches a configured content reference domain. For more - information, see "Using content attachments" to learn more about content references and attachments. -

    -

    - Webhook events are triggered based on the specificity of the domain you - register. For example, if you register a subdomain - (https://subdomain.example.com) then only URLs for the - subdomain trigger this event. If you register a domain - (https://example.com) then URLs for domain and all - subdomains trigger this event. See "Create a content attachment" to create a new content attachment. -

    -

    - - Availability -

    -
      -
    • - GitHub Apps with the content_references:write permission -
      • -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "created",
-  "content_reference": {
-    "id": 17,
-    "node_id": "MDE2OkNvbnRlbnRSZWZlcmVuY2UxNjA5",
-    "reference": "https://errors.ai/"
-  },
-  "repository": {
-    "id": 145551601,
-    "node_id": "MDEwOlJlcG9zaXRvcnkxNDU1NTE2MDE=",
-    "name": "hello-world",
-    "full_name": "octocoders/hello-world",
-    "private": true,
-    "owner": {
-      "login": "Codertocat",
-      "id": 7718702,
-      "node_id": "MDQ6VXNlcjc3MTg3MDI=",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/7718702?v=4",
-      "gravatar_id": "",
-      "url": "https://api.github.com/users/Codertocat",
-      "html_url": "https://github.com/Codertocat",
-      "followers_url": "https://api.github.com/users/Codertocat/followers",
-      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-      "repos_url": "https://api.github.com/users/Codertocat/repos",
-      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-      "type": "User",
-      "site_admin": true
-    },
-    "html_url": "https://github.com/Codertocat/hello-world",
-    "description": null,
-    "fork": false,
-    "url": "https://api.github.com/repos/Codertocat/hello-world",
-    "forks_url": "https://api.github.com/repos/Codertocat/hello-world/forks",
-    "keys_url": "https://api.github.com/repos/Codertocat/hello-world/keys{/key_id}",
-    "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world/collaborators{/collaborator}",
-    "teams_url": "https://api.github.com/repos/Codertocat/hello-world/teams",
-    "hooks_url": "https://api.github.com/repos/Codertocat/hello-world/hooks",
-    "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world/issues/events{/number}",
-    "events_url": "https://api.github.com/repos/Codertocat/hello-world/events",
-    "assignees_url": "https://api.github.com/repos/Codertocat/hello-world/assignees{/user}",
-    "branches_url": "https://api.github.com/repos/Codertocat/hello-world/branches{/branch}",
-    "tags_url": "https://api.github.com/repos/Codertocat/hello-world/tags",
-    "blobs_url": "https://api.github.com/repos/Codertocat/hello-world/git/blobs{/sha}",
-    "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world/git/tags{/sha}",
-    "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world/git/refs{/sha}",
-    "trees_url": "https://api.github.com/repos/Codertocat/hello-world/git/trees{/sha}",
-    "statuses_url": "https://api.github.com/repos/Codertocat/hello-world/statuses/{sha}",
-    "languages_url": "https://api.github.com/repos/Codertocat/hello-world/languages",
-    "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world/stargazers",
-    "contributors_url": "https://api.github.com/repos/Codertocat/hello-world/contributors",
-    "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world/subscribers",
-    "subscription_url": "https://api.github.com/repos/Codertocat/hello-world/subscription",
-    "commits_url": "https://api.github.com/repos/Codertocat/hello-world/commits{/sha}",
-    "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world/git/commits{/sha}",
-    "comments_url": "https://api.github.com/repos/Codertocat/hello-world/comments{/number}",
-    "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world/issues/comments{/number}",
-    "contents_url": "https://api.github.com/repos/Codertocat/hello-world/contents/{+path}",
-    "compare_url": "https://api.github.com/repos/Codertocat/hello-world/compare/{base}...{head}",
-    "merges_url": "https://api.github.com/repos/Codertocat/hello-world/merges",
-    "archive_url": "https://api.github.com/repos/Codertocat/hello-world/{archive_format}{/ref}",
-    "downloads_url": "https://api.github.com/repos/Codertocat/hello-world/downloads",
-    "issues_url": "https://api.github.com/repos/Codertocat/hello-world/issues{/number}",
-    "pulls_url": "https://api.github.com/repos/Codertocat/hello-world/pulls{/number}",
-    "milestones_url": "https://api.github.com/repos/Codertocat/hello-world/milestones{/number}",
-    "notifications_url": "https://api.github.com/repos/Codertocat/hello-world/notifications{?since,all,participating}",
-    "labels_url": "https://api.github.com/repos/Codertocat/hello-world/labels{/name}",
-    "releases_url": "https://api.github.com/repos/Codertocat/hello-world/releases{/id}",
-    "deployments_url": "https://api.github.com/repos/Codertocat/hello-world/deployments",
-    "created_at": "2018-08-21T10:58:58Z",
-    "updated_at": "2018-08-21T10:59:01Z",
-    "pushed_at": "2018-08-21T10:59:00Z",
-    "git_url": "git://github.com/Codertocat/hello-world.git",
-    "ssh_url": "git@github.com:Codertocat/hello-world.git",
-    "clone_url": "https://github.com/Codertocat/hello-world.git",
-    "svn_url": "https://github.com/Codertocat/hello-world",
-    "homepage": null,
-    "size": 0,
-    "stargazers_count": 0,
-    "watchers_count": 0,
-    "language": null,
-    "has_issues": true,
-    "has_projects": true,
-    "has_downloads": true,
-    "has_wiki": true,
-    "has_pages": false,
-    "forks_count": 0,
-    "mirror_url": null,
-    "archived": false,
-    "open_issues_count": 2,
-    "license": null,
-    "forks": 0,
-    "open_issues": 2,
-    "watchers": 0,
-    "default_branch": "master"
-  },
-  "sender": {
-    "login": "Codertocat",
-    "id": 7718702,
-    "node_id": "MDQ6VXNlcjc3MTg3MDI=",
-    "avatar_url": "https://avatars1.githubusercontent.com/u/7718702?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Codertocat",
-    "html_url": "https://github.com/Codertocat",
-    "followers_url": "https://api.github.com/users/Codertocat/followers",
-    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
-    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
-    "repos_url": "https://api.github.com/users/Codertocat/repos",
-    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
-    "type": "User",
-    "site_admin": true
-  },
-  "installation": {
-    "id": 371641,
-    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzcxNjQx"
-  }
-}

    @@ -3278,12 +3513,12 @@

    when you push more than three tags at once.

    -

    +

  • Organization webhooks
  • GitHub Apps with the contents permission

-

+

-

+

when you delete more than three tags at once.

-

+

  • Organization webhooks
  • GitHub Apps with the contents permission
    • -

    +

    -

    +

    >Deploy keys" REST API.

    -

    +

  • Repository webhooks
  • Organization webhooks
    • -

    +

    The deploy key resource. @@ -4087,12 +4322,12 @@

    -

    +

    A deployment is created. The type of activity is specified in the action property of the payload object. For more information, see the "deployment" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the deployments permission
    • -

    +

    The deployment. @@ -4396,12 +4631,12 @@

    -

    +

    A deployment is created. The type of activity is specified in the action property of the payload object. For more information, see the "deployment statuses" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the deployments permission
    • -

    +

    The deployment status. @@ -4736,7 +4971,7 @@

    The deployment that this status is associated with. @@ -4784,12 +5019,12 @@

    -

    +

    repositories" for more details. This event is not available in the Events API.

    -

    +

    >." -

    +

    -

    +

    >forks" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the contents permission
    • -

    +

    -

    +

    >Identifying and authorizing users for GitHub Apps."

    -

    +

    • GitHub Apps
    -

    +

    -

    +

    >About wikis".

    -

    +

  • Organization webhooks
  • GitHub Apps with the contents permission
    • -

    +

    -

    +

    >GitHub App installation" REST API.

    -

    +

    • GitHub Apps
    -

    +

    -

    +

    >GitHub App installation" REST API.

    -

    +

    • GitHub Apps
    -

    +

    -

    +

    >issue comments" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the issues permission
    • -

    +

    -

    +

    >issues" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the issues permission
    • -

    +

    >labels" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the metadata permission
    • -

    +

    -

    +

    >collaborators" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the members permission
    • -

    +

    -

    +

    >team members" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the members permission
    • -

    +

    -

    +

    on. Therefore, it must be selected for each hook that you'd like to receive meta events for.

    -

    +

  • Repository webhooks
  • Organization webhooks
    • -

    +

    -

    +

    >milestones" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the pull_requests permission
    • -

    +

    -

    +

    >organizations" REST API.

    -

    +

  • GitHub Apps with the members permission
    • -

    +

    -

    +

    >Managing packages with GitHub Packages" to learn more about GitHub Packages.

    -

    +

  • Repository webhooks
  • Organization webhooks
    • -

    +

    -

    +

    for project pages, the default branch for user and organization pages) triggers this event.

    -

    +

  • Organization webhooks
  • GitHub Apps with the pages permission
    • -

    +

    The List GitHub Pages builds itself. @@ -10183,12 +10418,12 @@

    -

    +

    > endpoint.

    -

    +

    register the app -

    +

    The webhook configuration. @@ -10547,12 +10782,12 @@

    -

    +

    >project cards" REST API.

    -

    +

    organization_projects permission -

    +

    -

    +

    >project columns" REST API.

    -

    +

    organization_projects permission -

    +

    -

    +

    >projects" REST API.

    -

    +

    organization_projects permission -

    +

    -

    +

    >pull requests" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the pull_requests permission
    • -

    +

    -

    +

    >pull request reviews" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the pull_requests permission
    • -

    +

    -

    +

    >pull request review comments" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the pull_requests permission
    • -

    +

    -

    +

    when you push more than three tags at once.

    -

    +

  • Organization webhooks
  • GitHub Apps with the contents permission
    • -

    +

    -

    +

    >releases" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the contents permission
    • -

    +

    -

    +

    >Create a repository dispatch event" endpoint.

    -

    +

    this webhook. -

    +

    >repositories" REST API.

    -

    +

    event types except deleted -

    +

    -

    +

    "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ==" } } - - -

    - - Availability -

    -
      -
    • GitHub Apps with the security_events permission
      • -
    -

    - - Webhook payload object -

    - - - - - - - - - - - - - - - - - - - - - -
    KeyTypeDescription
    actionstring - The action that was performed. The action can be one of - published, updated, - performed, or withdrawn for all new - events. -
    security_advisoryobject - The details of the security advisory, including summary, - description, and severity. -
    -

    - - Webhook payload example -

    -
    - 
    {
-  "action": "published",
-  "security_advisory": {
-    "ghsa_id": "GHSA-rf4j-j272-fj86",
-    "summary": "Moderate severity vulnerability that affects django",
-    "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
-    "severity": "moderate",
-    "identifiers": [
-      {
-        "value": "GHSA-rf4j-j272-fj86",
-        "type": "GHSA"
-      },
-      {
-        "value": "CVE-2018-6188",
-        "type": "CVE"
-      }
-    ],
-    "references": [
-      {
-        "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
-      }
-    ],
-    "published_at": "2018-10-03T21:13:54Z",
-    "updated_at": "2018-10-03T21:13:54Z",
-    "withdrawn_at": null,
-    "vulnerabilities": [
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
-        "first_patched_version": {
-          "identifier": "2.0.2"
-        }
-      },
-      {
-        "package": {
-          "ecosystem": "pip",
-          "name": "django"
-        },
-        "severity": "moderate",
-        "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
-        "first_patched_version": {
-          "identifier": "1.11.10"
-        }
-      }
-    ]
-  }
-}

    @@ -15612,12 +15682,12 @@

    >starring" REST API.

    -

    +

  • Repository webhooks
  • Organization webhooks
    • -

    +

    -

    +

    >statuses" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the statuses permission
    • -

    +

    -

    +

    >teams" REST API.

    -

    +

  • Organization webhooks
  • GitHub Apps with the members permission
    • -

    +

    -

    +

    >repository is added to a team.

    -

    +

  • Organization webhooks
  • GitHub Apps with the members permission
    • -

    +

    -

    +

    >user

    When a user is created or deleted.

    -

    +

    >." -

    +

    repository that was starred.

    -

    +

  • Organization webhooks
  • GitHub Apps with the metadata permission
    • -

    +

    -

    +

    = 2.0.0, < 2.0.2", - "first_patched_version": { "identifier": "2.0.2" } - }, - { - "package": { "ecosystem": "pip", "name": "django" }, - "severity": "moderate", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { "identifier": "1.11.10" } - } - ] - } - }, { "action": "created", "repository": { diff --git a/payload-schemas/api.github.com/content_reference/created.schema.json b/payload-schemas/api.github.com/content_reference/created.schema.json deleted file mode 100644 index d093a35ea..000000000 --- a/payload-schemas/api.github.com/content_reference/created.schema.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema", - "$id": "content_reference$created", - "type": "object", - "required": [ - "action", - "content_reference", - "repository", - "sender", - "installation" - ], - "properties": { - "action": { "type": "string", "enum": ["created"] }, - "content_reference": { - "type": "object", - "required": ["id", "node_id", "reference"], - "properties": { - "id": { "type": "integer" }, - "node_id": { "type": "string" }, - "reference": { "type": "string", "format": "uri" } - }, - "additionalProperties": false - }, - "repository": { "$ref": "common/repository.schema.json" }, - "sender": { "$ref": "common/user.schema.json" }, - "installation": { "$ref": "common/installation-lite.schema.json" }, - "organization": { "$ref": "common/organization.schema.json" } - }, - "additionalProperties": false, - "title": "content_reference created event" -} diff --git a/payload-schemas/api.github.com/deploy_key/created.schema.json b/payload-schemas/api.github.com/deploy_key/created.schema.json index d4078d84f..31440405c 100644 --- a/payload-schemas/api.github.com/deploy_key/created.schema.json +++ b/payload-schemas/api.github.com/deploy_key/created.schema.json @@ -7,7 +7,7 @@ "action": { "type": "string", "enum": ["created"] }, "key": { "type": "object", - "description": "The [`deploy key`](https://docs.github.com/en/rest/reference/repos#get-a-deploy-key) resource.", + "description": "The [`deploy key`](https://docs.github.com/en/rest/reference/deployments#get-a-deploy-key) resource.", "required": [ "id", "key", diff --git a/payload-schemas/api.github.com/deploy_key/deleted.schema.json b/payload-schemas/api.github.com/deploy_key/deleted.schema.json index 1ead4f197..00697670b 100644 --- a/payload-schemas/api.github.com/deploy_key/deleted.schema.json +++ b/payload-schemas/api.github.com/deploy_key/deleted.schema.json @@ -7,7 +7,7 @@ "action": { "type": "string", "enum": ["deleted"] }, "key": { "type": "object", - "description": "The [`deploy key`](https://docs.github.com/en/rest/reference/repos#get-a-deploy-key) resource.", + "description": "The [`deploy key`](https://docs.github.com/en/rest/reference/deployments#get-a-deploy-key) resource.", "required": [ "id", "key", diff --git a/payload-schemas/api.github.com/deployment/created.schema.json b/payload-schemas/api.github.com/deployment/created.schema.json index 23fc9fe7a..131f4943f 100644 --- a/payload-schemas/api.github.com/deployment/created.schema.json +++ b/payload-schemas/api.github.com/deployment/created.schema.json @@ -14,7 +14,7 @@ "action": { "type": "string", "enum": ["created"] }, "deployment": { "type": "object", - "description": "The [deployment](https://docs.github.com/en/rest/reference/repos#list-deployments).", + "description": "The [deployment](https://docs.github.com/en/rest/reference/deployments#list-deployments).", "required": [ "url", "id", diff --git a/payload-schemas/api.github.com/deployment_status/created.schema.json b/payload-schemas/api.github.com/deployment_status/created.schema.json index b7a865f19..f98bccf47 100644 --- a/payload-schemas/api.github.com/deployment_status/created.schema.json +++ b/payload-schemas/api.github.com/deployment_status/created.schema.json @@ -13,7 +13,7 @@ "action": { "type": "string", "enum": ["created"] }, "deployment_status": { "type": "object", - "description": "The [deployment status](https://docs.github.com/en/rest/reference/repos#list-deployment-statuses).", + "description": "The [deployment status](https://docs.github.com/en/rest/reference/deployments#list-deployment-statuses).", "required": [ "url", "id", diff --git a/payload-types/schema.d.ts b/payload-types/schema.d.ts index 6471c2e38..68feb1b90 100644 --- a/payload-types/schema.d.ts +++ b/payload-types/schema.d.ts @@ -11,7 +11,6 @@ export type Schema = | CheckSuiteEvent | CodeScanningAlertEvent | CommitCommentEvent - | ContentReferenceEvent | CreateEvent | DeleteEvent | DeployKeyEvent @@ -95,7 +94,6 @@ export type AuthorAssociation = | "MEMBER" | "NONE" | "OWNER"; -export type ContentReferenceEvent = ContentReferenceCreatedEvent; export type DeployKeyEvent = DeployKeyCreatedEvent | DeployKeyDeletedEvent; export type DeploymentEvent = DeploymentCreatedEvent; export type DeploymentStatusEvent = DeploymentStatusCreatedEvent; @@ -1984,18 +1982,6 @@ export interface CommitCommentCreatedEvent { installation?: InstallationLite; organization?: Organization; } -export interface ContentReferenceCreatedEvent { - action: "created"; - content_reference: { - id: number; - node_id: string; - reference: string; - }; - repository: Repository; - sender: User; - installation: InstallationLite; - organization?: Organization; -} /** * A Git branch or tag is created. */ @@ -2049,7 +2035,7 @@ export interface DeleteEvent { export interface DeployKeyCreatedEvent { action: "created"; /** - * The [`deploy key`](https://docs.github.com/en/rest/reference/repos#get-a-deploy-key) resource. + * The [`deploy key`](https://docs.github.com/en/rest/reference/deployments#get-a-deploy-key) resource. */ key: { id: number; @@ -2068,7 +2054,7 @@ export interface DeployKeyCreatedEvent { export interface DeployKeyDeletedEvent { action: "deleted"; /** - * The [`deploy key`](https://docs.github.com/en/rest/reference/repos#get-a-deploy-key) resource. + * The [`deploy key`](https://docs.github.com/en/rest/reference/deployments#get-a-deploy-key) resource. */ key: { id: number; @@ -2087,7 +2073,7 @@ export interface DeployKeyDeletedEvent { export interface DeploymentCreatedEvent { action: "created"; /** - * The [deployment](https://docs.github.com/en/rest/reference/repos#list-deployments). + * The [deployment](https://docs.github.com/en/rest/reference/deployments#list-deployments). */ deployment: { url: string; @@ -2121,7 +2107,7 @@ export interface DeploymentCreatedEvent { export interface DeploymentStatusCreatedEvent { action: "created"; /** - * The [deployment status](https://docs.github.com/en/rest/reference/repos#list-deployment-statuses). + * The [deployment status](https://docs.github.com/en/rest/reference/deployments#list-deployment-statuses). */ deployment_status: { url: string; @@ -6297,7 +6283,6 @@ export interface EventPayloadMap { check_suite: CheckSuiteEvent; code_scanning_alert: CodeScanningAlertEvent; commit_comment: CommitCommentEvent; - content_reference: ContentReferenceEvent; create: CreateEvent; delete: DeleteEvent; deploy_key: DeployKeyEvent;