MinimumAPIVersion sets the earliest API version that we support.

ValidationReport vars provide an abstraction to make sense of the 'status' field in ValidationReports.

ValidationReport vars provide an abstraction to make sense of the 'status' field in ValidationReports.

ErrBadInput indicates that the user passed incomplete or bad data to a routine.

ErrDataNotFound inidicates that the API returned a status code inidicating that the requested data does not exist or is not available.

ErrForbidden indicates that the API server returned a 403.

ErrHTTPNotOk indicates that the API returned a non-200 status code that we don't know how to handle.

ErrLoginFailed indicates that the login process failed for unspecified reasons.

ErrMustChangePassword is used to signal that the user must change their password before proceeding.

ErrNotAuthorized indicates that the API server returned a 401.

ErrNotSupported indicates that the API server does not support this command.

Conch contains auth and configuration data.

corresponds to conch.git/json-schema/input.yaml;NewUserToken.

Device represents what the API docs call a "DetailedDevice" Instead of having multiple structs representing partial datasets, like the API chooses to do, this library will always hand back Devices.

DeviceLocation represents the location of a device, including its datacenter, room and rack.

DeviceDisk ...

HardwareProduct is a type of Device.

HardwareProductTarget represents the HardwareProduct that a device should have based on its location.

HardwareProfile is a detailed accounting of either the actual hardware or intended hardware configuration of a Device, depending on the API endpoint in question.

HardwareVendor ...

corresponds to conch.git/json-schema/response.yaml;NewUserToken.

Nic is a network interface card, including its peer switch info.

*/.

User represents a person able to access the Conch API or UI.

UserDetailed ...

corresponds to conch.git/json-schema/response.yaml;UserToken.

Validation represents device validations loaded into Conch.

ValidationPlan represents an organized association of Validations.

ValidationReport represents the result from the validation engine, comparing field data to expectations.

ValidationResult is a result of running a validation on a device.

ValidationState is the result of running a validation plan on a device.

Workspace represents a Conch data partition which allows users to create custom lists of hardware.

WorkspaceAndRole ...

WorkspaceRelay represents a Conch Relay unit, a physical piece of hardware that mediates Livesys interactions in the field.

WorkspaceRelayLocation ...

WorkspaceUser ...

This is a piece of fun from /workspace/:id/rack/:id/layout The payload looks like: { "my-device-id": 47 } Where '47' is the rack unit start for the device */.

WorkspaceRelays ...