simapi

Documentation

Overview

Package simapi contains definitions of JSON objects used in the simulation API.

Index

• type Error
• type ExecRequest
• type NodeConfig
• type NodeResponse
• type StartNodeResponse
• type TestRequest

Types

type Error

type Error struct {
	Error string `json:"error"`
}

type ExecRequest

type ExecRequest struct {
	Command []string `json:"command"`
}

type NodeConfig

type NodeConfig struct {
	Client      string            `json:"client"`
	Networks    []string          `json:"networks"`
	Environment map[string]string `json:"environment"`
}

NodeConfig contains the launch parameters for a client container.

type NodeResponse

type NodeResponse struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

NodeResponse is the description of a running client as returned by the API.

type StartNodeResponse

type StartNodeResponse struct {
	ID string `json:"id"` // Container ID.
	IP string `json:"ip"` // IP address in bridge network
}

StartNodeReponse is returned by the client startup endpoint.

type TestRequest

type TestRequest struct {
	Name        string `json:"name"`
	DisplayName string `json:"display_name"`
	Location    string `json:"location"`
	Category    string `json:"category"`
	Description string `json:"description"`
}