fix(GHES): event description updates

octokit · Apr 28, 2022 · 1897f26 · 1897f26
1 parent eef5591
commit 1897f26
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/payload-examples/ghes-31/index.json b/payload-examples/ghes-31/index.json
@@ -25,7 +25,7 @@
       },
       "check_run[check_suite][pull_requests]": {
         "type": "array",
-        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
+        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
       },
       "check_run[check_suite][deployment]": {
         "type": "object",
@@ -89,7 +89,7 @@
       },
       "check_suite[pull_requests]": {
         "type": "array",
-        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
+        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
       },
       "repository": {
         "type": "object",
@@ -1432,7 +1432,7 @@
   },
   {
     "name": "secret_scanning_alert",
-    "description": "Activity related to secret scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see \"[About secret scanning](https://docs.github.com/en/enterprise-server@3.1/github/administering-a-repository/about-secret-scanning).\"",
+    "description": "Activity related to secret scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see the \"[secret scanning API](https://docs.github.com/en/enterprise-server@3.1/rest/secret-scanning).\"",
     "properties": {
       "alert": {
         "type": "object",
@@ -1460,7 +1460,7 @@
   },
   {
     "name": "security_advisory",
-    "description": "Activity related to a security advisory that has been reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nThe security advisory dataset also powers the GitHub Dependabot alerts. For more information, see \"[About alerts for vulnerable dependencies](https://docs.github.com/en/enterprise-server@3.1/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).\"",
+    "description": "Activity related to a security advisory that has been reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nThe security advisory dataset also powers the GitHub Dependabot alerts. For more information, see \"[About Dependabot alerts](https://docs.github.com/en/enterprise-server@3.1/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).\"",
     "properties": {
       "security_advisory": {
         "type": "object",

diff --git a/payload-examples/ghes-32/index.json b/payload-examples/ghes-32/index.json
@@ -25,7 +25,7 @@
       },
       "check_run[check_suite][pull_requests]": {
         "type": "array",
-        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
+        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
       },
       "check_run[check_suite][deployment]": {
         "type": "object",
@@ -89,7 +89,7 @@
       },
       "check_suite[pull_requests]": {
         "type": "array",
-        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
+        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
       },
       "repository": {
         "type": "object",
@@ -1432,7 +1432,7 @@
   },
   {
     "name": "secret_scanning_alert",
-    "description": "Activity related to secret scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see \"[About secret scanning](https://docs.github.com/en/enterprise-server@3.2/github/administering-a-repository/about-secret-scanning).\"",
+    "description": "Activity related to secret scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see the \"[secret scanning API](https://docs.github.com/en/enterprise-server@3.2/rest/secret-scanning).\"",
     "properties": {
       "alert": {
         "type": "object",
@@ -1460,7 +1460,7 @@
   },
   {
     "name": "security_advisory",
-    "description": "Activity related to a security advisory that has been reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nThe security advisory dataset also powers the GitHub Dependabot alerts. For more information, see \"[About alerts for vulnerable dependencies](https://docs.github.com/en/enterprise-server@3.2/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).\"",
+    "description": "Activity related to a security advisory that has been reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nThe security advisory dataset also powers the GitHub Dependabot alerts. For more information, see \"[About Dependabot alerts](https://docs.github.com/en/enterprise-server@3.2/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).\"",
     "properties": {
       "security_advisory": {
         "type": "object",

diff --git a/payload-examples/ghes-33/index.json b/payload-examples/ghes-33/index.json
@@ -53,7 +53,7 @@
       },
       "check_run[check_suite][pull_requests]": {
         "type": "array",
-        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
+        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
       },
       "check_run[check_suite][deployment]": {
         "type": "object",
@@ -117,7 +117,7 @@
       },
       "check_suite[pull_requests]": {
         "type": "array",
-        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
+        "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
       },
       "repository": {
         "type": "object",
@@ -1460,7 +1460,7 @@
   },
   {
     "name": "secret_scanning_alert",
-    "description": "Activity related to secret scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see \"[About secret scanning](https://docs.github.com/en/enterprise-server@3.3/github/administering-a-repository/about-secret-scanning).\"",
+    "description": "Activity related to secret scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see the \"[secret scanning API](https://docs.github.com/en/enterprise-server@3.3/rest/secret-scanning).\"",
     "properties": {
       "alert": {
         "type": "object",
@@ -1488,7 +1488,7 @@
   },
   {
     "name": "security_advisory",
-    "description": "Activity related to a security advisory that has been reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nThe security advisory dataset also powers the GitHub Dependabot alerts. For more information, see \"[About alerts for vulnerable dependencies](https://docs.github.com/en/enterprise-server@3.3/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).\"",
+    "description": "Activity related to a security advisory that has been reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub.\n\nThe security advisory dataset also powers the GitHub Dependabot alerts. For more information, see \"[About Dependabot alerts](https://docs.github.com/en/enterprise-server@3.3/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).\"",
     "properties": {
       "security_advisory": {
         "type": "object",