models

Documentation

Index

• type CameraInput
• type CameraModelInput
• type ProxyInput
• type UserInput

Types

type CameraInput

type CameraInput struct {
	// a custom name given to the camera (a short description)
	// required: true
	// example: "garden fence"
	Name string `json:"name" binding:"required"`

	// Host an ip address or domain
	// required: true
	// example: 192.168.0.1 or example.com
	Host string `json:"host" binding:"required"`

	// Username is used to authenticate with the camera
	// required: true
	Username string `json:"username" binding:"required"`

	// Password is used to authenticate with the camera
	// required: true
	Password string `json:"password"`

	// ProxyUUID is the unique proxy identifier that should be added
	// to this camera
	// required: false
	ProxyUUID string `json:"proxyUUID,omitempty"`

	// LocationUUID is the unique location identifier linking this camera
	// to a specific location
	// required: false
	LocationUUID string `json:"locationUUID,omitempty"`
}

CameraInput is for creating and updating a camera object This is used to keep track and manage cameras swagger:model

type CameraModelInput

type CameraModelInput struct {
	// Name is a unique grouping for Cameras
	// required: true
	Name string `json:"name" binding:"required"`
}

CameraModelInput is for creating and updating a camera model object Many Cameras can be grouped under a singular CameraModelInput swagger:model

type ProxyInput

type ProxyInput struct {
	// Host is the IP or Domain to connect to
	// required: true
	// example: 192.168.1.1 or example.com
	Host string `json:"host" binding:"required"`

	// Port is used together with Host. If none are specified, no Port will be used.
	// required: false
	// example: 9000
	Port string `json:"port,omitempty"`

	// Username for authenticating with the proxy server.
	// required: false
	Username string `json:"username,omitempty"`

	// Password for authenticating with the proxy server.
	// required: false
	Password string `json:"password,omitempty"`

	// Scheme for connecting to the ProxyInput server, such as HTTP, HTTPS or SOCKS5
	// required: true
	// example: HTTPS
	Scheme string `json:"scheme" binding:"required"`

	// Protocol to use, for connecting with the ProxyInput server, such as TCP or UDP
	// required: true
	// example: UDP
	Protocol string `json:"protocol" binding:"required"`
}

ProxyInput is a network configuration for connecting to a proxy server The ProxyInput setting can be reused across many cameras swagger:model

type UserInput

type UserInput struct {
	// Username is the unique identifier of the user
	// required: true
	Username string `json:"username" binding:"required"`

	// Password for authenticating the user
	// required: true
	Password string `json:"password" binding:"required"`
}

UserInput holds the user information for authentication swagger:model