Skip to content

Latest commit

 

History

History
191 lines (112 loc) · 5.67 KB

board.md

File metadata and controls

191 lines (112 loc) · 5.67 KB

Board Schema

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

Boards depict issues moving across Statuses.

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

Board Type

object (Board)

Board Properties

Property Type Required Nullable Defined by
_type string Required cannot be null Board
id string Required cannot be null Board
self string Required cannot be null Board
name string Required cannot be null Board
boardType string Required cannot be null Board
createdAt string Optional cannot be null Board
updatedAt string Optional cannot be null Board
deletedAt string Optional cannot be null Board

_type

_type

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

_type Type

string

_type Constraints

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

"Board"

id

The unique ID of this board.

id

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

id Type

string

self

The canonical URI for this record.

self

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

self Type

string

self Constraints

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

name

The name of the board.

name

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

name Type

string

boardType

The type of board.

boardType

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

boardType Type

string

boardType Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"kanban"
"scrum"
"simple"

createdAt

The time this the board was created.

createdAt

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

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 board was updated.

updatedAt

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

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 this board was deleted.

deletedAt

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

deletedAt Type

string

deletedAt Constraints

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