Noizu Labs: Github API
v0.5.0

Noizu.Github.Api.Checks (Noizu Labs: Github API v0.5.0)

GitHub checks API.

Link to this section Summary

Functions

create(body, options \\ nil)

Create a check run

create_suite(body, options \\ nil)

Create a check suite

get(check_run_id, options \\ nil)

Get a check run

get_suite(check_suite_id, options \\ nil)

Get a check suite

list_annotations(check_run_id, options \\ nil)

List check run annotations

list_for_ref(ref, options \\ nil)

List check runs for a Git reference

list_for_suite(check_suite_id, options \\ nil)

List check runs in a check suite

list_suites_for_ref(ref, options \\ nil)

List check suites for a Git reference

rerequest_run(check_run_id, body, options \\ nil)

Rerequest a check run

rerequest_suite(check_suite_id, body, options \\ nil)

Rerequest a check suite

set_suites_preferences(body, options \\ nil)

Update repository preferences for check suites

update(check_run_id, body, options \\ nil)

Update a check run

Link to this section Functions

Link to this function

create(body, options \\ nil)

Create a check run

@see https://docs.github.com/rest/checks/runs#create-a-check-run

Link to this function

create_suite(body, options \\ nil)

Create a check suite

@see https://docs.github.com/rest/checks/suites#create-a-check-suite

Link to this function

get(check_run_id, options \\ nil)

Get a check run

@see https://docs.github.com/rest/checks/runs#get-a-check-run

Link to this function

get_suite(check_suite_id, options \\ nil)

Get a check suite

@see https://docs.github.com/rest/checks/suites#get-a-check-suite

Link to this function

list_annotations(check_run_id, options \\ nil)

List check run annotations

@see https://docs.github.com/rest/checks/runs#list-check-run-annotations

Link to this function

list_for_ref(ref, options \\ nil)

List check runs for a Git reference

@see https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference

Link to this function

list_for_suite(check_suite_id, options \\ nil)

List check runs in a check suite

@see https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite

Link to this function

list_suites_for_ref(ref, options \\ nil)

List check suites for a Git reference

@see https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference

Link to this function

rerequest_run(check_run_id, body, options \\ nil)

Rerequest a check run

@see https://docs.github.com/rest/checks/runs#rerequest-a-check-run

Link to this function

rerequest_suite(check_suite_id, body, options \\ nil)

Rerequest a check suite

@see https://docs.github.com/rest/checks/suites#rerequest-a-check-suite

Link to this function

set_suites_preferences(body, options \\ nil)

Update repository preferences for check suites

@see https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites

Link to this function

update(check_run_id, body, options \\ nil)

Update a check run

@see https://docs.github.com/rest/checks/runs#update-a-check-run