View Source GitHub.Checks (GitHub REST API Client v0.0.1-beta.0)
Provides API endpoints related to checks
Link to this section Summary
Functions
Create a check run
Create a check suite
Get a check run
Get a check suite
List check run annotations
List check runs for a Git reference
List check runs in a check suite
List check suites for a Git reference
Rerequest a check run
Rerequest a check suite
Update repository preferences for check suites
Update a check run
Link to this section Functions
@spec create(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Check.Run.t()} | {:error, GitHub.Error.t()}
Create a check run
resources
Resources
@spec create_suite(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Check.Suite.t()} | {:error, GitHub.Error.t()}
Create a check suite
resources
Resources
@spec get(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Check.Run.t()} | {:error, GitHub.Error.t()}
Get a check run
resources
Resources
@spec get_suite(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Check.Suite.t()} | {:error, GitHub.Error.t()}
Get a check suite
resources
Resources
@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
@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 specifiedname
.status
(String.t()): Returns check runs with the specifiedstatus
.filter
(String.t()): Filters check runs by theircompleted_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
@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 specifiedname
.status
(String.t()): Returns check runs with the specifiedstatus
.filter
(String.t()): Filters check runs by theircompleted_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
@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 Appid
.check_name
(String.t()): Returns check runs with the specifiedname
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec rerequest_run(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
Rerequest a check run
resources
Resources
@spec rerequest_suite(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
Rerequest a check suite
resources
Resources
@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
@spec update(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Check.Run.t()} | {:error, GitHub.Error.t()}
Update a check run