Go models

Generated from eve-iac OpenAPI/semantics. Do not edit manually.

Every public OpenAPI component schema plus generated query types.

Model Kind
LooseObject object
ValidateData object
BulkResult object
SuccessEnvelope object
ErrorEnvelope object
LoginRequest object
LogoutRequest object
ProjectPayload object
AuthoringPayload object
ConsolePayload object
ConsoleTarget object
HealthData object
LoginData object
StatusOkData object
SessionData object
CapabilitiesData object
ProjectModeCaps object
LifecycleCaps object
Template object
TemplateDetail object
TemplateImage object
TemplateAttribute object
TemplatesData object
TemplateImagesData object
TemplateAttributesData object
NetworkType object
NetworkTypesData object
Icon object
IconsData object
Iface object
LinkCompletionsData object
InterfacesPreviewData object
ImportData object
DeployData object
PlanSummary object
PlanAction object
PlanData object
ReconcileData object
DestroyData object
ProjectStatusData object
InspectionData object
OpenData object
ConsoleRecord object
ConsolesData object
ConsoleExecData object
ConsoleExecManyData object
ConsoleAttachData object
ListTemplatesQuery object
CompleteLinkInterfacesRequest ref
PreviewInterfacesRequest ref
ValidateProjectRequest ref
ImportProjectRequest object
DeployProjectRequest ref
PlanProjectRequest ref
ReconcileProjectRequest ref
DestroyProjectRequest ref
GetProjectStatusRequest ref
InspectProjectRequest ref
OpenProjectRequest ref
ListProjectConsolesRequest ref
ExecProjectRequest object
ExecConsoleRequest ref
ExecConsoleManyRequest ref
AttachConsoleRequest ref

Direction is a named string type with DirectionToEve and DirectionFromEve. The HTTP wire remains a free string.

LooseObject

Type: map[string]any

ValidateData

Field Go type Required Semantics
status (Status) string yes

Used by: validateProject

BulkResult

Field Go type Required Semantics
requested (Requested) int yes
started (Started) int yes
already_running (AlreadyRunning) int yes
already_starting (AlreadyStarting) int yes
stopped (Stopped) int yes
already_stopped (AlreadyStopped) int yes
wiped (Wiped) int yes
failed (Failed) int yes
invalid (Invalid) int yes

Used by: execProject

SuccessEnvelope

Field Go type Required Semantics
ok (Ok) bool yes
data (Data) any no
error (Error) *string no
code (Code) *string no

ErrorEnvelope

Field Go type Required Semantics
ok (Ok) bool yes
error (Error) *string no
code (Code) *string no
data (Data) any no

LoginRequest

Field Go type Required Semantics
username (Username) string yes
password (Password) string yes

Used by: login

LogoutRequest

Type: map[string]any

Used by: logout

ProjectPayload

decodeProject body. Unknown fields are ignored. dir/out non-empty are rejected. Do not treat omitted optional fields as serialized defaults.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

Used by: validateProject, importProject, deployProject, planProject, reconcileProject, destroyProject, getProjectStatus, inspectProject, openProject, listProjectConsoles, execProject

AuthoringPayload

Field Go type Required Semantics
dir (Dir) *string no Rejected when non-empty.
yaml (YAML) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
template (Template) *string no
attributes (Attributes) map[string]any no
excludeUsed (ExcludeUsed) *bool no
eth_format (EthFormat) *string no

Used by: completeLinkInterfaces, previewInterfaces

ConsolePayload

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
manifest (Manifest) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command (Command) *string no
timeout_ms (TimeoutMs) *int no
targets (Targets) []ConsoleTarget no
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

Used by: execConsole, execConsoleMany, attachConsole

ConsoleTarget

Field Go type Required Semantics
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command (Command) *string no

HealthData

Field Go type Required Semantics
status (Status) *string no
tls (Tls) *bool no
version (Version) *string no

Used by: getHealth

LoginData

Field Go type Required Semantics
token (Token) *string no
username (Username) *string no

Used by: login

StatusOkData

Field Go type Required Semantics
status (Status) *string no

Used by: logout

SessionData

Field Go type Required Semantics
username (Username) *string no

Used by: getSession

CapabilitiesData

Field Go type Required Semantics
eveReachable (EveReachable) *bool no
eveBaseUrl (EveBaseUrl) *string no
features (Features) map[string]bool no
projectModes (ProjectModes) map[string]ProjectModeCaps no

Used by: getCapabilities

ProjectModeCaps

Field Go type Required Semantics
inspect (Inspect) *bool no
open (Open) *bool no
console (Console) *bool no
lifecycle (Lifecycle) *LifecycleCaps no
topology_mutation (TopologyMutation) *bool no
reconcile (Reconcile) *bool no
destroy (Destroy) *bool no
presentation_restore (PresentationRestore) *bool no
source_mutation (SourceMutation) *bool no

LifecycleCaps

Field Go type Required Semantics
start (Start) *bool no
stop (Stop) *bool no
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)

Template

Field Go type Required Semantics
id (ID) *string no
description (Description) *string no
type (Type) *string no
provisioned (Provisioned) *bool no
configSupported (ConfigSupported) *bool no

TemplateDetail

Field Go type Required Semantics
id (ID) *string no
description (Description) *string no
type (Type) *string no
provisioned (Provisioned) *bool no
configSupported (ConfigSupported) *bool no
images (Images) []TemplateImage no
default (Default) *string no
attributes (Attributes) []TemplateAttribute no

Used by: getTemplate

TemplateImage

Field Go type Required Semantics
id (ID) *string no
available (Available) *bool no

TemplateAttribute

Field Go type Required Semantics
name (Name) *string no
label (Label) *string no
kind (Kind) *string no
group (Group) *string no
values (Values) []string no

TemplatesData

Field Go type Required Semantics
templates (Templates) []Template no

Used by: listTemplates

TemplateImagesData

Field Go type Required Semantics
template (Template) *string no
type (Type) *string no
provisioned (Provisioned) *bool no
default (Default) *string no
images (Images) []TemplateImage no

Used by: listTemplateImages

TemplateAttributesData

Field Go type Required Semantics
template (Template) *string no
type (Type) *string no
attributes (Attributes) []TemplateAttribute no

Used by: listTemplateAttributes

NetworkType

Field Go type Required Semantics
id (ID) *string no
label (Label) *string no
icon (Icon) *string no
supported (Supported) *bool no

NetworkTypesData

Field Go type Required Semantics
types (Types) []NetworkType no
natOnly (NatOnly) *bool no

Used by: listNetworkTypes

Icon

Field Go type Required Semantics
id (ID) *string no
label (Label) *string no

IconsData

Field Go type Required Semantics
icons (Icons) []Icon no

Used by: listIcons

Iface

Field Go type Required Semantics
id (ID) *int no
name (Name) *string no
type (Type) *string no
used (Used) *bool no

LinkCompletionsData

Field Go type Required Semantics
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
items (Items) []Iface no

Used by: completeLinkInterfaces

InterfacesPreviewData

Field Go type Required Semantics
items (Items) []Iface no

Used by: previewInterfaces

ImportData

Field Go type Required Semantics
name (Name) *string no
yaml (YAML) *string no
files (Files) map[string]string no
mode (Mode) *string no
source_lab (SourceLab) *string no
managed_lab (ManagedLab) *string no
lab (Lab) *string no
state (State) any no
source (Source) any no

Used by: importProject

DeployData

Field Go type Required Semantics
lab (Lab) *string no
nodes (Nodes) *int no
links (Links) *int no
state (State) any no
unsupported (Unsupported) []string no

Used by: deployProject

PlanSummary

Field Go type Required Semantics
creates (Creates) *int no
updates (Updates) *int no
deletes (Deletes) *int no
blocked (Blocked) *int no

PlanAction

Field Go type Required Semantics
op (Op) *string no
kind (Kind) *string no
key (Key) *string no
side (Side) *string no
direction (Direction) *string no omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
type (Type) *string no
applicable (Applicable) *bool no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve

PlanData

Field Go type Required Semantics
lab (Lab) *string no
exists (Exists) *bool no
summary (Summary) *PlanSummary no
operations (Operations) []PlanAction no
actions (Actions) []PlanAction no
applicable (Applicable) *bool no
blocked (Blocked) []PlanAction no
text (Text) *string no
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
locked (Locked) *bool no
lock (Lock) *int no
direction (Direction) *string no omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
unsupported (Unsupported) []string no

Used by: planProject

ReconcileData

Field Go type Required Semantics
lab (Lab) *string no
applied (Applied) *int no
skippedPrune (SkippedPrune) *int no
fullDeploy (FullDeploy) *bool no
applicable (Applicable) *bool no
summary (Summary) *PlanSummary no
operations (Operations) []PlanAction no
blocked (Blocked) []PlanAction no
direction (Direction) *string no omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
state (State) any no
yaml (YAML) *string no
files (Files) map[string]string no
source (Source) any no
manifest (Manifest) *string no

Used by: reconcileProject

DestroyData

Field Go type Required Semantics
lab (Lab) *string no

Used by: destroyProject

ProjectStatusData

Field Go type Required Semantics
mode (Mode) *string no
source_lab (SourceLab) *string no
managed_lab (ManagedLab) *string no
runtime_lab (RuntimeLab) *string no
capabilities (Capabilities) *ProjectModeCaps no
locked (Locked) *bool no
lock (Lock) *int no

Used by: getProjectStatus

InspectionData

Field Go type Required Semantics
observation (Observation) *bool no
desired_state (DesiredState) *bool no
mode (Mode) *string no
source_lab (SourceLab) any no
managed_lab (ManagedLab) any no
runtime_lab (RuntimeLab) *string no
capabilities (Capabilities) *ProjectModeCaps no
cached (Cached) *bool no

Used by: inspectProject

OpenData

Field Go type Required Semantics
url (URL) *string no
ttl (TTL) *int no
lab (Lab) *string no

Used by: openProject

ConsoleRecord

Field Go type Required Semantics
id (ID) *int no
key (Key) *string no
name (Name) *string no
template (Template) *string no
console (Console) *string no
status (Status) *int no
url (URL) *string no

ConsolesData

Field Go type Required Semantics
lab (Lab) *string no
html5 (Html5) *bool no
consoles (Consoles) []ConsoleRecord no

Used by: listProjectConsoles

ConsoleExecData

Field Go type Required Semantics
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
name (Name) *string no
console_type (ConsoleType) *string no
command (Command) *string no
output (Output) *string no
duration_ms (DurationMs) *int no

Used by: execConsole

ConsoleExecManyData

Field Go type Required Semantics
results (Results) []any no

Used by: execConsoleMany

ConsoleAttachData

Field Go type Required Semantics
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
name (Name) *string no
console_type (ConsoleType) *string no
stream (Stream) *string no
transport (Transport) *string no

Used by: attachConsole

ListTemplatesQuery

Generated query object. Omit the whole argument to send no query string.

Field Go type Required Semantics
provisioned (Provisioned) *string no Only the string true filters to provisioned templates. Omitted means all.

Used by: listTemplates

CompleteLinkInterfacesRequest

Request body alias of AuthoringPayload. Same wire shape.

Alias of AuthoringPayload.

Field Go type Required Semantics
dir (Dir) *string no Rejected when non-empty.
yaml (YAML) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
template (Template) *string no
attributes (Attributes) map[string]any no
excludeUsed (ExcludeUsed) *bool no
eth_format (EthFormat) *string no

PreviewInterfacesRequest

Request body alias of AuthoringPayload. Same wire shape.

Alias of AuthoringPayload.

Field Go type Required Semantics
dir (Dir) *string no Rejected when non-empty.
yaml (YAML) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
template (Template) *string no
attributes (Attributes) map[string]any no
excludeUsed (ExcludeUsed) *bool no
eth_format (EthFormat) *string no

ValidateProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

ImportProjectRequest

Request body for importProject.

Field Go type Required Semantics
lab (Lab) string yes
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

Used by: importProject

DeployProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

PlanProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

ReconcileProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

DestroyProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

GetProjectStatusRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

InspectProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

OpenProjectRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

ListProjectConsolesRequest

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

ExecProjectRequest

Request body for execProject.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
source (Source) any no
manifest (Manifest) *string no
prune (Prune) *bool no omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
wipe (Wipe) *bool no explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
action (Action) string yes
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
id (ID) *int no
stopmode (Stopmode) *int no 0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
refresh (Refresh) *bool no omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
replace (Replace) *bool no omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
plan_identity (PlanIdentity) *string no omitted: recompute the live plan. present: opaque token from the last plan of the same direction
direction (Direction) *string no Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

Used by: execProject

ExecConsoleRequest

Request body alias of ConsolePayload. Same wire shape.

Alias of ConsolePayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
manifest (Manifest) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command (Command) *string no
timeout_ms (TimeoutMs) *int no
targets (Targets) []ConsoleTarget no
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

ExecConsoleManyRequest

Request body alias of ConsolePayload. Same wire shape.

Alias of ConsolePayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
manifest (Manifest) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command (Command) *string no
timeout_ms (TimeoutMs) *int no
targets (Targets) []ConsoleTarget no
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.

AttachConsoleRequest

Request body alias of ConsolePayload. Same wire shape.

Alias of ConsolePayload.

Field Go type Required Semantics
lab (Lab) *string no
yaml (YAML) *string no
files (Files) map[string]string no
state (State) any no
manifest (Manifest) *string no
node (Node) *string no omitted: all nodes. empty string: all nodes. named: that IaC node key
command (Command) *string no
timeout_ms (TimeoutMs) *int no
targets (Targets) []ConsoleTarget no
dir (Dir) *string no Rejected when non-empty.
out (Out) *string no Rejected when non-empty.