Skip to content

add AppID field to ListCheckRunsOptions #2231

@dmitshur

Description

@dmitshur

Both https://docs.github.com/en/rest/reference/checks#list-check-runs-for-a-git-reference and https://docs.github.com/en/rest/reference/checks#list-check-suites-for-a-git-reference endpoints document the following query parameter:

Name Type In Description
app_id integer query Filters check suites by GitHub App id.

(Though the former is missing a description; perhaps it was added at a different time.)

The ListCheckSuiteOptions struct already has this field:

AppID *int `url:"app_id,omitempty"` // Filters check suites by GitHub App id.

I wanted to report that there's an opportunity to add it to the ListCheckRunsOptions struct for listing check runs, because it's not there yet:

go-github/github/checks.go

Lines 232 to 239 in fef3638

// ListCheckRunsOptions represents parameters to list check runs.
type ListCheckRunsOptions struct {
CheckName *string `url:"check_name,omitempty"` // Returns check runs with the specified name.
Status *string `url:"status,omitempty"` // Returns check runs with the specified status. Can be one of "queued", "in_progress", or "completed".
Filter *string `url:"filter,omitempty"` // Filters check runs by their completed_at timestamp. Can be one of "latest" (returning the most recent check runs) or "all". Default: "latest"
ListOptions
}

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions