Types

Described here are all Constellation related types used in requests and responses for the konstellat.io API.

Revisions

Read more about revisions here.

History

Field	Type	Note
events	{ hash: string; stamp: { author: string; timestamp: string; message: string } }[]	Hashes and Stamps

Revision

Field	Type	Note
projectId	string	GUID/UUID
hash	string	Hashes
variants	string[]	Variants
nodes		Nodes
stamp	{ author: string; timestamp: string; message: string }	Stamps

Revision Diff

Field	Type	Note
hash	string	Hashes
shortHash	string	Hashes
stamp	{ author: string; timestamp: string; message: string }	Stamps
nodes	NodeDiff[]	NodeDiff

Nodes

Read more about nodes here.

Node

Field	Type	Note
id	string	IDs
name	string	1 to 255 bytes (UTF8)
description	string	0 to 255 bytes (UTF8)
versionValue	string	Values
versionSchema	string	Schemas
statusResult	string	Results
statusStrategy	string	Strategies
stamp	{ author: string; timestamp: string; message: string }	Stamp
children	string[]	Children
metadata	Record<string, { bool?: boolean, int?: number, float?: number, string?: string }>	Metadata

Node Diff

Field	Type	Note
id	{ from: string; to: string }	Node
name	{ from: string; to: string }	-||-
description	{ from: string; to: string }	-||-
versionValue	{ from: string; to: string }	-||-
versionSchema	{ from: string; to: string }	-||-
statusResult	{ from: string; to: string }	-||-
statusStrategy	{ from: string; to: string }	-||-
stamp	{ from: { author: string; timestamp: string; message: string }; to: { author: string; timestamp: string; message: string } }	-||-
children	{ from: string; to: string }[]	-||-
metadata	Record<string, { from: { bool?: boolean, int?: number, float?: number, string?: string }; to: { bool?: boolean, int?: number, float?: number, string?: string } }>	-||-

Versions

Read more about node versions here.

Schemas

Name	Value
Random	"Random"
Custom	"Custom"
SemVer	"SemVer"
Incremental	"Incremental"
Hash	"Hash"

Values

All version schemas use strings encoded/decoded in UTF8 as values (e.g. "1.2.3" for SemVer and "alpha" for Custom) but are validated differently. Read more about what version values are valid for what version schemas here.

Statuses

Read more about node statuses here.

Strategies

Name	Value
Manual	"Manual"
All Success	"AllSuccess"
Any Success	"AnySuccess"

Results

Read more about status results here.

Name	Value
Success	"Success"
Failure	"Failure"