{
  "opencollection": "1.0.0",
  "info": {
    "name": "github-repos-api Suites API",
    "version": "1.1.4"
  },
  "items": [
    {
      "info": {
        "name": "Suites",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GitHub Create Check Suite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/repos/:owner/:repo/check-suites",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.9/rest/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://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**Note:** The Checks API only looks for "
        },
        {
          "info": {
            "name": "GitHub Update Repository Preferences for Check Suites",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}/repos/:owner/:repo/check-suites/preferences",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Changes the default automatic flow when creating check suites. By default, a check suite 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://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites."
        },
        {
          "info": {
            "name": "GitHub Get Check Suite",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/repos/:owner/:repo/check-suites/:check_suite_id",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "check_suite_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the check suite."
              }
            ]
          },
          "docs": "Gets a single check suite using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository."
        },
        {
          "info": {
            "name": "GitHub List Check Runs in Check Suite",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/repos/:owner/:repo/check-suites/:check_suite_id/check-runs",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "check_suite_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the check suite."
              },
              {
                "name": "check_name",
                "value": "",
                "type": "query",
                "description": "Returns check runs with the specified `name`."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Returns check runs with the specified `status`."
              },
              {
                "name": "filter",
                "value": "latest",
                "type": "query",
                "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              }
            ]
          },
          "docs": "Lists check runs for a check suite using its `id`.\n\n**Note:** The endpoints to manage checks only look 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository."
        },
        {
          "info": {
            "name": "GitHub Rerequest Check Suite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/repos/:owner/:repo/check-suites/:check_suite_id/rerequest",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "check_suite_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the check suite."
              }
            ]
          },
          "docs": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint."
        },
        {
          "info": {
            "name": "GitHub List Check Suites for Git Reference",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/repos/:owner/:repo/commits/:ref/check-suites",
            "headers": [
              {
                "name": "Authorization",
                "value": "example_value"
              },
              {
                "name": "X-GitHub-Api-Version",
                "value": "example_value"
              },
              {
                "name": "Accept",
                "value": "example_value"
              }
            ],
            "params": [
              {
                "name": "owner",
                "value": "",
                "type": "path",
                "description": "The account owner of the repository. The name is not case sensitive."
              },
              {
                "name": "repo",
                "value": "",
                "type": "path",
                "description": "The name of the repository without the `.git` extension. The name is not case sensitive."
              },
              {
                "name": "ref",
                "value": "",
                "type": "path",
                "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation."
              },
              {
                "name": "app_id",
                "value": "1",
                "type": "query",
                "description": "Filters check suites by GitHub App `id`."
              },
              {
                "name": "check_name",
                "value": "",
                "type": "query",
                "description": "Returns check runs with the specified `name`."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              }
            ]
          },
          "docs": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n**Note:** The endpoints to manage checks only look 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository."
        }
      ]
    }
  ],
  "bundled": true
}