Skip to main content
GET
List pull request files with diff coverage

Authorizations

Authorization
string
header
required

Generate an API token at https://qlty.sh/user/settings/tokens

Path Parameters

ownerKeyOrId
string
required

Repository owner name (login) or workspace ID

Minimum string length: 3
Example:

"acme-corp"

projectKeyOrId
string
required

Repository name or project ID

Minimum string length: 3
Example:

"my-repo"

number
integer
required

Pull request number

Required range: x > 0
Example:

123

Response

Changed files with diff coverage

data
object[]
required
meta
object
required
unavailableReason
enum<string> | null
required

Why data is empty, or null when the files were listed:

  • no_coverage: No coverage has been processed yet. It wasn't uploaded, or it's still processing.
  • diff_too_large: The pull request changes more than 500 files, or GitHub couldn't return its diff.
  • no_changed_files: GitHub reports no changed files. It may not have computed the diff yet.
Available options:
no_coverage,
diff_too_large,
no_changed_files,
null