docs: name & description updates (#58)

Co-authored-by: Octokit Bot <[email protected]>

Author: github-actions[bot]

docs/checks/createSuite.md

@@ -2,7 +2,7 @@
 
 **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
 
-By default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Set preferences for check suites on a repository](https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)". Your GitHub App must have the `checks:write` permission to create check suites.
+By default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites.
 
 ```js
 octokit.checks.createSuite({

docs/checks/get.md

@@ -1,4 +1,4 @@
-# Get a single check run
+# Get a check run
 
 **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
 
@@ -41,4 +41,4 @@ check_run_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/runs/#get-a-single-check-run).
+See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/runs/#get-a-check-run).

docs/checks/getSuite.md

@@ -1,4 +1,4 @@
-# Get a single check suite
+# Get a check suite
 
 **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
 
@@ -41,4 +41,4 @@ check_suite_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/suites/#get-a-single-check-suite).
+See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/suites/#get-a-check-suite).

docs/checks/listAnnotations.md

@@ -1,4 +1,4 @@
-# List annotations for a check run
+# List check run annotations
 
 Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.
 
@@ -49,4 +49,4 @@ Page number of the results to fetch.
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/runs/#list-annotations-for-a-check-run).
+See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/runs/#list-check-run-annotations).

docs/checks/listForRef.md

@@ -1,4 +1,4 @@
-# List check runs for a specific ref
+# List check runs for a Git reference
 
 **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
 
@@ -66,4 +66,4 @@ Page number of the results to fetch.
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-specific-ref).
+See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-git-reference).

docs/checks/listSuitesForRef.md

@@ -1,4 +1,4 @@
-# List check suites for a specific ref
+# List check suites for a Git reference
 
 **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
 
@@ -61,4 +61,4 @@ Page number of the results to fetch.
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref).
+See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-git-reference).

docs/checks/rerequestSuite.md

@@ -1,4 +1,4 @@
-# Rerequest check suite
+# Rerequest a check suite
 
 Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://developer.github.com/v3/activity/events/types/#checksuiteevent) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
 
@@ -41,4 +41,4 @@ check_suite_id parameter
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/suites/#rerequest-check-suite).
+See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/suites/#rerequest-a-check-suite).

docs/checks/setSuitesPreferences.md

@@ -1,4 +1,4 @@
-# Set preferences for check suites on a repository
+# Update repository preferences for check suites
 
 Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://developer.github.com/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.
 
@@ -50,4 +50,4 @@ Set to `true` to enable automatic creation of CheckSuite events upon pushes to t
   </tbody>
 </table>
 
-See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository).
+See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites).

scripts/update-endpoints/generated/endpoints.json

@@ -18391,15 +18391,15 @@
     "renamed": null
   },
   {
-    "name": "Get a single check run",
+    "name": "Get a check run",
     "scope": "checks",
     "id": "get",
     "method": "GET",
     "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}",
     "isDeprecated": false,
     "isLegacy": false,
     "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
-    "documentationUrl": "https://developer.github.com/v3/checks/runs/#get-a-single-check-run",
+    "documentationUrl": "https://developer.github.com/v3/checks/runs/#get-a-check-run",
     "previews": [{ "name": "antiope" }],
     "headers": [
       {
@@ -18463,15 +18463,15 @@
     "renamed": null
   },
   {
-    "name": "List annotations for a check run",
+    "name": "List check run annotations",
     "scope": "checks",
     "id": "listAnnotations",
     "method": "GET",
     "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations",
     "isDeprecated": false,
     "isLegacy": false,
     "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.",
-    "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-annotations-for-a-check-run",
+    "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-check-run-annotations",
     "previews": [{ "name": "antiope" }],
     "headers": [
       {
@@ -18568,7 +18568,7 @@
     "url": "/repos/{owner}/{repo}/check-suites",
     "isDeprecated": false,
     "isLegacy": false,
-    "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Set preferences for check suites on a repository](https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)\". Your GitHub App must have the `checks:write` permission to create check suites.",
+    "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.",
     "documentationUrl": "https://developer.github.com/v3/checks/suites/#create-a-check-suite",
     "previews": [{ "name": "antiope" }],
     "headers": [
@@ -18633,15 +18633,15 @@
     "renamed": null
   },
   {
-    "name": "Set preferences for check suites on a repository",
+    "name": "Update repository preferences for check suites",
     "scope": "checks",
     "id": "setSuitesPreferences",
     "method": "PATCH",
     "url": "/repos/{owner}/{repo}/check-suites/preferences",
     "isDeprecated": false,
     "isLegacy": false,
     "description": "Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://developer.github.com/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.",
-    "documentationUrl": "https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository",
+    "documentationUrl": "https://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites",
     "previews": [{ "name": "antiope" }],
     "headers": [
       {
@@ -18731,15 +18731,15 @@
     "renamed": null
   },
   {
-    "name": "Get a single check suite",
+    "name": "Get a check suite",
     "scope": "checks",
     "id": "getSuite",
     "method": "GET",
     "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}",
     "isDeprecated": false,
     "isLegacy": false,
     "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.",
-    "documentationUrl": "https://developer.github.com/v3/checks/suites/#get-a-single-check-suite",
+    "documentationUrl": "https://developer.github.com/v3/checks/suites/#get-a-check-suite",
     "previews": [{ "name": "antiope" }],
     "headers": [
       {
@@ -18940,15 +18940,15 @@
     "renamed": null
   },
   {
-    "name": "Rerequest check suite",
+    "name": "Rerequest a check suite",
     "scope": "checks",
     "id": "rerequestSuite",
     "method": "POST",
     "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest",
     "isDeprecated": false,
     "isLegacy": false,
     "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://developer.github.com/v3/activity/events/types/#checksuiteevent) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
-    "documentationUrl": "https://developer.github.com/v3/checks/suites/#rerequest-check-suite",
+    "documentationUrl": "https://developer.github.com/v3/checks/suites/#rerequest-a-check-suite",
     "previews": [{ "name": "antiope" }],
     "headers": [
       {
@@ -20510,15 +20510,15 @@
     "renamed": null
   },
   {
-    "name": "List check runs for a specific ref",
+    "name": "List check runs for a Git reference",
     "scope": "checks",
     "id": "listForRef",
     "method": "GET",
     "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs",
     "isDeprecated": false,
     "isLegacy": false,
     "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
-    "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-specific-ref",
+    "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-git-reference",
     "previews": [{ "name": "antiope" }],
     "headers": [
       {
@@ -20647,15 +20647,15 @@
     "renamed": null
   },
   {
-    "name": "List check suites for a specific ref",
+    "name": "List check suites for a Git reference",
     "scope": "checks",
     "id": "listSuitesForRef",
     "method": "GET",
     "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites",
     "isDeprecated": false,
     "isLegacy": false,
     "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.",
-    "documentationUrl": "https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref",
+    "documentationUrl": "https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-git-reference",
     "previews": [{ "name": "antiope" }],
     "headers": [
       {

src/generated/types.ts

@@ -28988,7 +28988,7 @@ export type RestEndpointMethods = {
     /**
      * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
      *
-     * By default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Set preferences for check suites on a repository](https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)". Your GitHub App must have the `checks:write` permission to create check suites.
+     * By default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites.
      */
     createSuite: {
       (params?: RequestParameters & ChecksCreateSuiteParams): Promise<