Skip to content

Latest commit

 

History

History
181 lines (105 loc) · 6.04 KB

component.md

File metadata and controls

181 lines (105 loc) · 6.04 KB

Component Schema

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

Components are conceptual units of software, defined as a set of source files, which are composed into Applications. A Component might correspond directly with a Repository, consist of a subset of files within a monorepo, or be comprised of the union set of files spread across multiple repositories.

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

Component Type

object (Component)

Component Properties

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

_type

_type

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

_type Type

string

_type Constraints

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

"Component"

id

The unique ID of this Component.

id

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

id Type

string

self

The canonical URI for this record.

self

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

self Type

string

self Constraints

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

name

The component's name.

name

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

name Type

string

description

The component's description.

description

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

description Type

string

createdAt

The time this component was created.

createdAt

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

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

updatedAt

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

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 component was deleted.

deletedAt

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

deletedAt Type

string

deletedAt Constraints

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