Checks API (checks:v1alpha)

Additions

Methods


• ▼ ▲ checks.accounts.repos.scans.generate

  Path : v1alpha/{+parent}/scans:generate

  HTTP Method : POST

  Parameter Order : parent

  Parameters :

  parent

  Type : string

  Description : Required. Resource name of the repo. Example: `accounts/123/repos/456`

  Location : path

  Pattern : ^accounts/[^/]+/repos/[^/]+$

  Required : Yes

  Flat Path : v1alpha/accounts/{accountsId}/repos/{reposId}/scans:generate

  Description : Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and findings.

• ▼ ▲ checks.accounts.repos.scans.list

  Description : Lists repo scans for the specified repo.

  HTTP Method : GET

  Parameters :

  pageSize

  Description : Optional. The maximum number of repo scans to return. If unspecified, at most 10 repo scans will be returned. The maximum value is 50; values above 50 will be coerced to 50.

  Type : integer

  Format : int32

  Location : query

  parent

  Location : path

  Pattern : ^accounts/[^/]+/repos/[^/]+$

  Type : string

  Required : Yes

  Description : Required. Resource name of the repo. Example: `accounts/123/repos/456`

  pageToken

  Location : query

  Description : Optional. A page token received from a previous `ListRepoScans` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepoScans` must match the call that provided the page token.

  Type : string

  filter

  Description : Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter repo scans. Example: `scmMetadata.branch = main`

  Type : string

  Location : query

  Path : v1alpha/{+parent}/scans

  Flat Path : v1alpha/accounts/{accountsId}/repos/{reposId}/scans

  Parameter Order : parent

• ▼ ▲ checks.accounts.repos.scans.get

  Description : Gets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the name and sources fields.

  Parameters :

  name

  Description : Required. Resource name of the repo scan. Example: `accounts/123/repos/456/scans/789`

  Pattern : ^accounts/[^/]+/repos/[^/]+/scans/[^/]+$

  Required : Yes

  Type : string

  Location : path

  Parameter Order : name

  HTTP Method : GET

  Flat Path : v1alpha/accounts/{accountsId}/repos/{reposId}/scans/{scansId}

  Path : v1alpha/{+name}