View Source GitHub.Checks (GitHub REST API Client v0.0.1-beta.0)

Provides API endpoints related to checks

Link to this section Summary

Link to this section Functions

Link to this function

create(owner, repo, body, opts \\ [])

View Source
@spec create(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Check.Run.t()} | {:error, GitHub.Error.t()}

Create a check run

resources

Resources

Link to this function

create_suite(owner, repo, body, opts \\ [])

View Source
@spec create_suite(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Check.Suite.t()} | {:error, GitHub.Error.t()}

Create a check suite

resources

Resources

Link to this function

get(owner, repo, check_run_id, opts \\ [])

View Source
@spec get(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.Check.Run.t()} | {:error, GitHub.Error.t()}

Get a check run

resources

Resources

Link to this function

get_suite(owner, repo, check_suite_id, opts \\ [])

View Source
@spec get_suite(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.Check.Suite.t()} | {:error, GitHub.Error.t()}

Get a check suite

resources

Resources

Link to this function

list_annotations(owner, repo, check_run_id, opts \\ [])

View Source
@spec list_annotations(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.Check.Annotation.t()]} | {:error, GitHub.Error.t()}

List check run annotations

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_for_ref(owner, repo, ref, opts \\ [])

View Source
@spec list_for_ref(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List check runs for a Git reference

options

Options

  • check_name (String.t()): Returns check runs with the specified name.
  • status (String.t()): Returns check runs with the specified status.
  • filter (String.t()): Filters check runs by their completed_at timestamp. latest returns the most recent check runs.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.
  • app_id (integer):

resources

Resources

Link to this function

list_for_suite(owner, repo, check_suite_id, opts \\ [])

View Source
@spec list_for_suite(String.t(), String.t(), integer(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List check runs in a check suite

options

Options

  • check_name (String.t()): Returns check runs with the specified name.
  • status (String.t()): Returns check runs with the specified status.
  • filter (String.t()): Filters check runs by their completed_at timestamp. latest returns the most recent check runs.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_suites_for_ref(owner, repo, ref, opts \\ [])

View Source
@spec list_suites_for_ref(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List check suites for a Git reference

options

Options

  • app_id (integer): Filters check suites by GitHub App id.
  • check_name (String.t()): Returns check runs with the specified name.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

rerequest_run(owner, repo, check_run_id, opts \\ [])

View Source
@spec rerequest_run(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Rerequest a check run

resources

Resources

Link to this function

rerequest_suite(owner, repo, check_suite_id, opts \\ [])

View Source
@spec rerequest_suite(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Rerequest a check suite

resources

Resources

Link to this function

set_suites_preferences(owner, repo, body, opts \\ [])

View Source
@spec set_suites_preferences(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Check.SuitePreference.t()} | {:error, GitHub.Error.t()}

Update repository preferences for check suites

resources

Resources

Link to this function

update(owner, repo, check_run_id, body, opts \\ [])

View Source
@spec update(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.Check.Run.t()} | {:error, GitHub.Error.t()}

Update a check run

resources

Resources