Skip to content

Latest commit

 

History

History
215 lines (125 loc) · 6.33 KB

metric.md

File metadata and controls

215 lines (125 loc) · 6.33 KB

Metric Schema

https://platform.codeclimate.com/schemas/metric

A series of values relating to an object.

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

Metric Type

object (Metric)

Metric Properties

Property Type Required Nullable Defined by
_type string Required cannot be null Metric
id string Required cannot be null Metric
self string Required cannot be null Metric
record string Optional cannot be null Metric
key string Optional cannot be null Metric
name string Optional cannot be null Metric
unit string Optional cannot be null Metric
createdAt string Optional cannot be null Metric
updatedAt string Optional cannot be null Metric
deletedAt string Optional cannot be null Metric

_type

_type

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

_type Type

string

_type Constraints

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

"Metric"

id

The unique ID of this metric.

id

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

id Type

string

self

The canonical URI for this record.

self

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

self Type

string

self Constraints

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

record

The record of the metric.

record

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

record Type

string

key

The key of the metric.

key

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

key Type

string

name

The name of the metric.

name

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

name Type

string

unit

The unit of how the metric is measured.

unit

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

unit Type

string

createdAt

The time the metric was created.

createdAt

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

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 the metric was updated.

updatedAt

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

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 the metric was deleted.

deletedAt

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

deletedAt Type

string

deletedAt Constraints

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