Skip to content

Latest commit

 

History

History
207 lines (120 loc) · 6.66 KB

release.md

File metadata and controls

207 lines (120 loc) · 6.66 KB

Release Schema

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

Releases make a Package available in a ReleaseStage.

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

Release Type

object (Release)

Release Properties

Property Type Required Nullable Defined by
_type string Required cannot be null Release
id string Required cannot be null Release
self string Required cannot be null Release
package Merged Optional cannot be null Release
releaseStage string Optional cannot be null Release
htmlUrl string Optional cannot be null Release
createdAt string Optional cannot be null Release
updatedAt string Optional cannot be null Release
deletedAt string Optional cannot be null Release

_type

_type

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

_type Type

string

_type Constraints

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

"Release"

id

The unique ID of this release.

id

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

id Type

string

self

The canonical URI for this record.

self

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

self Type

string

self Constraints

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

package

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

package

  • is optional
  • Type: merged type (Details)
  • cannot be null
  • defined in: Release

package Type

merged type (Details)

one (and only one) of

releaseStage

The stage of the release.

releaseStage

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

releaseStage Type

string

htmlUrl

The URL for a human to view this release.

htmlUrl

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

htmlUrl Type

string

htmlUrl Constraints

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

createdAt

The time release was created.

createdAt

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

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

updatedAt

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

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

deletedAt

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

deletedAt Type

string

deletedAt Constraints

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