Class FilesCoverageRequestAttributes

Attributes for requesting per-file code coverage data. Exactly one of commit_sha, branch, or pr_number must be provided. At most one of service, codeowner, or flag may be provided.

Hierarchy

  • FilesCoverageRequestAttributes

Constructors

constructor

Properties

additionalProperties? branch? changedOnly? codeowner? commitSha? flag? prNumber? repositoryId? repositoryUrl? service?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional branch

branch?: string

The branch name.

Optional changedOnly

changedOnly?: boolean

When true, return coverage data only for files that were changed in the specified scope.

Optional codeowner

codeowner?: string

Filter coverage by code owner. At most one of service, codeowner, or flag may be provided.

Optional commitSha

commitSha?: string

The commit SHA (40-character hexadecimal string).

Optional flag

flag?: string

Filter coverage by coverage flag. At most one of service, codeowner, or flag may be provided.

Optional prNumber

prNumber?: number

The pull request number. Must be a positive integer.

Optional repositoryId

repositoryId?: string

Deprecated: use repository_url instead. The repository URL.

Optional repositoryUrl

repositoryUrl?: string

The repository URL. Accepts a full URL with or without a scheme (for example, https://github.com/org/repo or github.com/org/repo).

Optional service

service?: string

Filter coverage by service name. At most one of service, codeowner, or flag may be provided.

Settings

Member Visibility

Theme

Generated using TypeDoc