Skip to content

Latest commit

 

History

History
415 lines (242 loc) · 14.5 KB

codeissue.md

File metadata and controls

415 lines (242 loc) · 14.5 KB

CodeIssue Schema

https://platform.codeclimate.com/schemas/code-issue

An issue with a source code file, like a bug risk or vulnerability.

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

CodeIssue Type

object (CodeIssue)

CodeIssue Properties

Property Type Required Nullable Defined by
_type string Required cannot be null CodeIssue
id string Required cannot be null CodeIssue
self string Required cannot be null CodeIssue
checkName string Optional cannot be null CodeIssue
title string Required cannot be null CodeIssue
message string Optional cannot be null CodeIssue
source string Optional cannot be null CodeIssue
severity string Optional cannot be null CodeIssue
status string Optional cannot be null CodeIssue
statusDetails string Optional cannot be null CodeIssue
statusUpdatedAt string Optional cannot be null CodeIssue
statusUpdatedBy Merged Optional cannot be null CodeIssue
rawDetails string Optional cannot be null CodeIssue
path string Optional cannot be null CodeIssue
location object Optional cannot be null CodeIssue
estimatedRemediationMinutes integer Optional cannot be null CodeIssue
categories array Optional cannot be null CodeIssue
htmlUrl string Optional cannot be null CodeIssue
createdAt string Optional cannot be null CodeIssue
updatedAt string Optional cannot be null CodeIssue
deletedAt string Optional cannot be null CodeIssue

_type

_type

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

_type Type

string

_type Constraints

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

"CodeIssue"

id

The unique ID of this code issue.

id

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

id Type

string

self

The canonical URI for this record.

self

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

self Type

string

self Constraints

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

checkName

The check name of this code issue.

checkName

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

checkName Type

string

title

The title of this code issue.

title

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

title Type

string

message

The message associated with this code issue.

message

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

message Type

string

source

The source of this code issue.

source

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

source Type

string

severity

The severity of this code issue.

severity

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

severity Type

string

status

The status of this code issue.

status

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

status Type

string

statusDetails

The details of the status of this code issue.

statusDetails

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

statusDetails Type

string

statusUpdatedAt

When the status was updated.

statusUpdatedAt

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

statusUpdatedAt Type

string

statusUpdatedAt Constraints

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

statusUpdatedBy

The self URI of the Actor, or a nested Actor record.

statusUpdatedBy

statusUpdatedBy Type

merged type (Details)

one (and only one) of

rawDetails

The raw details of this code issue.

rawDetails

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

rawDetails Type

string

path

The path to this code issue.

path

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

path Type

string

location

Location of the code issue.

location

location Type

object (Details)

estimatedRemediationMinutes

The estimated time it will take to fix the issue.

estimatedRemediationMinutes

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

estimatedRemediationMinutes Type

integer

categories

Code issue categories.

categories

  • is optional
  • Type: string[]
  • cannot be null
  • defined in: CodeIssue

categories Type

string[]

htmlUrl

The URL to view this code issue.

htmlUrl

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

htmlUrl Type

string

htmlUrl Constraints

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

createdAt

The time code issue was created.

createdAt

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

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 code issue was updated.

updatedAt

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

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 code issue was deleted.

deletedAt

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

deletedAt Type

string

deletedAt Constraints

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