Skip to content

Latest commit

 

History

History
245 lines (142 loc) · 8.37 KB

filecoverage.md

File metadata and controls

245 lines (142 loc) · 8.37 KB

FileCoverage Schema

https://platform.codeclimate.com/schemas/file-coverage

Information about test coverage of a file within a commit.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Allowed none FileCoverage.schema.json

FileCoverage Type

object (FileCoverage)

FileCoverage Properties

Property Type Required Nullable Defined by
_type string Optional cannot be null FileCoverage
self string Required cannot be null FileCoverage
repository Merged Required cannot be null FileCoverage
commitOid string Required cannot be null FileCoverage
file string Optional cannot be null FileCoverage
lineHits array Required cannot be null FileCoverage
filesCount integer Optional cannot be null FileCoverage
htmlUrl string Optional cannot be null FileCoverage
createdAt string Optional cannot be null FileCoverage
updatedAt string Optional cannot be null FileCoverage
deletedAt string Optional cannot be null FileCoverage

_type

_type

  • is optional
  • Type: string
  • cannot be null
  • defined in: FileCoverage

_type Type

string

_type Constraints

constant: the value of this property must be equal to:

"FileCoverage"

self

The canonical URI for this record.

self

  • is required
  • Type: string
  • cannot be null
  • defined in: FileCoverage

self Type

string

self Constraints

URI: the string must be a URI, according to RFC 3986

repository

The self URI of the Repository this test coverage applies to, or a nested Repository record.

repository

repository Type

merged type (Details)

one (and only one) of

commitOid

The commit oid this test coverage is for.

commitOid

  • is required
  • Type: string
  • cannot be null
  • defined in: FileCoverage

commitOid Type

string

file

The path of the file for these test results.

file

  • is optional
  • Type: string
  • cannot be null
  • defined in: FileCoverage

file Type

string

lineHits

The number of hits on each line in the file, starting with line 1. An entry for every line should be present.

lineHits

lineHits Type

an array of merged types (Details)

filesCount

The number of files.

filesCount

  • is optional
  • Type: integer
  • cannot be null
  • defined in: FileCoverage

filesCount Type

integer

filesCount Constraints

minimum: the value of this number must greater than or equal to: 0

htmlUrl

The URL to view this coverage.

htmlUrl

  • is optional
  • Type: string
  • cannot be null
  • defined in: FileCoverage

htmlUrl Type

string

htmlUrl Constraints

URI: the string must be a URI, according to RFC 3986

createdAt

The time this coverage was created.

createdAt

  • is optional
  • Type: string
  • cannot be null
  • defined in: FileCoverage

createdAt Type

string

createdAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

updatedAt

The time this coverage was last updated.

updatedAt

  • is optional
  • Type: string
  • cannot be null
  • defined in: FileCoverage

updatedAt Type

string

updatedAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

deletedAt

The time coverage was deleted.

deletedAt

  • is optional
  • Type: string
  • cannot be null
  • defined in: FileCoverage

deletedAt Type

string

deletedAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6