Documentation
¶
Overview ¶
Frontend contains the frontend code for DigitalRebar Provision. It has the responsibility for providing the api interface to DigitalRebar Provision. Responses and routes are specified here.
Index ¶
- Variables
- type ActionPostResponse
- type ActionResponse
- type ActionsResponse
- type AuthSource
- type BootEnvActionBodyParameter
- type BootEnvActionPathParameter
- type BootEnvActionsPathParameter
- type BootEnvBodyParameter
- type BootEnvListPathParameter
- type BootEnvPatchBodyParameter
- type BootEnvPathParameter
- type BootEnvResponse
- type BootEnvsResponse
- type ContentBodyParameter
- type ContentParameter
- type ContentResponse
- type ContentSummaryResponse
- type ContentsResponse
- type DefaultAuthSource
- type ErrorResponse
- type EventBodyParameter
- type FileData
- type FileInfoResponse
- type FilePathPathParameter
- type FilePaths
- type FileResponse
- type FilesPathQueryParameter
- type FilesResponse
- type Frontend
- func (f *Frontend) Create(c *gin.Context, val store.KeySaver)
- func (f *Frontend) Exists(c *gin.Context, ref store.KeySaver, key string)
- func (f *Frontend) Fetch(c *gin.Context, ref store.KeySaver, key string)
- func (f *Frontend) Find(c *gin.Context, rt *backend.RequestTracker, prefix, key string) models.Model
- func (f *Frontend) GetInfo(c *gin.Context, drpid string) (*models.Info, *models.Error)
- func (f *Frontend) InitBootEnvApi()
- func (f *Frontend) InitContentApi()
- func (f *Frontend) InitEventApi()
- func (f *Frontend) InitFileApi()
- func (f *Frontend) InitIndexApi()
- func (f *Frontend) InitInfoApi(drpid string)
- func (f *Frontend) InitInterfaceApi()
- func (f *Frontend) InitIsoApi()
- func (f *Frontend) InitJobApi()
- func (f *Frontend) InitLeaseApi()
- func (f *Frontend) InitLogApi()
- func (f *Frontend) InitMachineApi()
- func (f *Frontend) InitParamApi()
- func (f *Frontend) InitPluginApi()
- func (f *Frontend) InitPluginProviderApi()
- func (f *Frontend) InitPrefApi()
- func (f *Frontend) InitProfileApi()
- func (f *Frontend) InitReservationApi()
- func (f *Frontend) InitRoleApi()
- func (f *Frontend) InitStageApi()
- func (f *Frontend) InitSubnetApi()
- func (f *Frontend) InitSystemApi()
- func (f *Frontend) InitTaskApi()
- func (f *Frontend) InitTemplateApi()
- func (f *Frontend) InitTenantApi()
- func (f *Frontend) InitUserApi(drpid string)
- func (fe *Frontend) InitWebSocket()
- func (f *Frontend) InitWorkflowApi()
- func (f *Frontend) List(c *gin.Context, ref store.KeySaver)
- func (f *Frontend) ListStats(c *gin.Context, ref store.KeySaver)
- func (f *Frontend) Patch(c *gin.Context, ref store.KeySaver, key string)
- func (f *Frontend) Publish(e *models.Event) error
- func (f *Frontend) Release()
- func (f *Frontend) Remove(c *gin.Context, ref store.KeySaver, key string)
- func (f *Frontend) Reserve() error
- func (f *Frontend) Unload()
- func (f *Frontend) Update(c *gin.Context, ref store.KeySaver, key string)
- type IndexParameter
- type IndexResponse
- type Indexer
- type IndexesResponse
- type InfoResponse
- type InterfaceParameter
- type InterfaceResponse
- type InterfacesResponse
- type IsoData
- type IsoInfoResponse
- type IsoPathPathParameter
- type IsoPaths
- type IsoResponse
- type IsosResponse
- type JobActionBodyParameter
- type JobActionPathParameter
- type JobActionsPathParameter
- type JobActionsResponse
- type JobBodyParameter
- type JobListPathParameter
- type JobLogPutBodyParameter
- type JobLogResponse
- type JobParamsBodyParameter
- type JobParamsResponse
- type JobPatchBodyParameter
- type JobPathParameter
- type JobResponse
- type JobsResponse
- type LeaseActionBodyParameter
- type LeaseActionPathParameter
- type LeaseActionsPathParameter
- type LeaseBodyParameter
- type LeaseListPathParameter
- type LeasePatchBodyParameter
- type LeasePathParameter
- type LeaseResponse
- type LeasesResponse
- type Lockable
- type LogResponse
- type MachineActionBodyParameter
- type MachineActionPathParameter
- type MachineActionsPathParameter
- type MachineBodyParameter
- type MachineGetParamPathParemeter
- type MachineGetParamsPathParameter
- type MachineListPathParameter
- type MachineParamResponse
- type MachineParamsResponse
- type MachinePatchBodyParameter
- type MachinePatchParamsParameter
- type MachinePathParameter
- type MachinePostParamParameter
- type MachinePostParamPathParemeter
- type MachinePostParamsParameter
- type MachineResponse
- type MachinesResponse
- type NoContentResponse
- type ParamBodyParameter
- type ParamListPathParameter
- type ParamParamsBodyParameter
- type ParamParamsResponse
- type ParamPatchBodyParameter
- type ParamPathParameter
- type ParamResponse
- type ParamsResponse
- type PluginActionBodyParameter
- type PluginActionPathParameter
- type PluginActionsPathParameter
- type PluginBodyParameter
- type PluginListPathParameter
- type PluginParamBodyParameter
- type PluginParamResponse
- type PluginParamsBodyParameter
- type PluginParamsPathParameter
- type PluginParamsResponse
- type PluginPatchBodyParameter
- type PluginPathParameter
- type PluginProviderData
- type PluginProviderInfoResponse
- type PluginProviderParameter
- type PluginProviderResponse
- type PluginProvidersResponse
- type PluginResponse
- type PluginsResponse
- type PrefBodyParameter
- type PrefsResponse
- type ProfileActionBodyParameter
- type ProfileActionPathParameter
- type ProfileActionsPathParameter
- type ProfileBodyParameter
- type ProfileListPathParameter
- type ProfileParamBodyParameter
- type ProfileParamResponse
- type ProfileParamsBodyParameter
- type ProfileParamsPathParameter
- type ProfileParamsResponse
- type ProfilePatchBodyParameter
- type ProfilePathParameter
- type ProfileResponse
- type ProfilesResponse
- type ReservationActionBodyParameter
- type ReservationActionPathParameter
- type ReservationActionsPathParameter
- type ReservationBodyParameter
- type ReservationListPathParameter
- type ReservationPatchBodyParameter
- type ReservationPathParameter
- type ReservationResponse
- type ReservationsResponse
- type RoleActionBodyParameter
- type RoleActionPathParameter
- type RoleActionsPathParameter
- type RoleBodyParameter
- type RoleListPathParameter
- type RolePatchBodyParameter
- type RolePathParameter
- type RoleResponse
- type RolesResponse
- type Sanitizable
- type SingleIndexParameter
- type SingleIndexResponse
- type StageActionBodyParameter
- type StageActionPathParameter
- type StageActionsPathParameter
- type StageBodyParameter
- type StageListPathParameter
- type StagePatchBodyParameter
- type StagePathParameter
- type StageResponse
- type StagesResponse
- type SubnetActionBodyParameter
- type SubnetActionPathParameter
- type SubnetActionsPathParameter
- type SubnetBodyParameter
- type SubnetListPathParameter
- type SubnetPatchBodyParameter
- type SubnetPathParameter
- type SubnetResponse
- type SubnetsResponse
- type SystemActionBodyParameter
- type SystemActionPathParameter
- type SystemActionsPathParameter
- type TaskActionBodyParameter
- type TaskActionPathParameter
- type TaskActionsPathParameter
- type TaskBodyParameter
- type TaskListPathParameter
- type TaskParamsBodyParameter
- type TaskParamsResponse
- type TaskPatchBodyParameter
- type TaskPathParameter
- type TaskResponse
- type TasksResponse
- type TemplateActionBodyParameter
- type TemplateActionPathParameter
- type TemplateActionsPathParameter
- type TemplateBodyParameter
- type TemplateListPathParameter
- type TemplatePatchBodyParameter
- type TemplatePathParameter
- type TemplateResponse
- type TemplatesResponse
- type TenantActionBodyParameter
- type TenantActionPathParameter
- type TenantActionsPathParameter
- type TenantBodyParameter
- type TenantListPathParameter
- type TenantPatchBodyParameter
- type TenantPathParameter
- type TenantResponse
- type TenantsResponse
- type UserActionBodyParameter
- type UserActionPathParameter
- type UserActionsPathParameter
- type UserBodyParameter
- type UserListPathParameter
- type UserPatchBodyParameter
- type UserPathParameter
- type UserPutPasswordParameter
- type UserResponse
- type UserTokenQueryRolesParameter
- type UserTokenQueryTTLParameter
- type UserTokenResponse
- type UsersResponse
- type WorkflowActionBodyParameter
- type WorkflowActionPathParameter
- type WorkflowActionsPathParameter
- type WorkflowBodyParameter
- type WorkflowListPathParameter
- type WorkflowPatchBodyParameter
- type WorkflowPathParameter
- type WorkflowResponse
- type WorkflowsResponse
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type ActionPostResponse ¶
type ActionPostResponse struct {
// in: body
Body interface{}
}
ActionPostResponse return on a successful POST of action swagger:response
type ActionResponse ¶
type ActionResponse struct { // in: body Body *models.AvailableAction }
ActionResponse return on a successful GET of a single Action swagger:response
type ActionsResponse ¶
type ActionsResponse struct { // in: body Body []*models.AvailableAction }
ActionsResponse return on a successful GET of all Actions swagger:response
type AuthSource ¶
func NewDefaultAuthSource ¶
func NewDefaultAuthSource(dt *backend.DataTracker) (das AuthSource)
type BootEnvActionBodyParameter ¶
type BootEnvActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
BootEnvActionBodyParameter used to post a BootEnv / Action in the path swagger:parameters postBootEnvAction
type BootEnvActionPathParameter ¶
type BootEnvActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
BootEnvActionPathParameter used to find a BootEnv / Action in the path swagger:parameters getBootEnvAction
type BootEnvActionsPathParameter ¶
type BootEnvActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
BootEnvActionsPathParameter used to find a BootEnv / Actions in the path swagger:parameters getBootEnvActions
type BootEnvBodyParameter ¶
BootEnvBodyParameter used to inject a BootEnv swagger:parameters createBootEnv putBootEnv
type BootEnvListPathParameter ¶
type BootEnvListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query OnlyUnknown string // in: query Name string }
BootEnvListPathParameter used to limit lists of BootEnv by path options swagger:parameters listBootEnvs listStatsBootEnvs
type BootEnvPatchBodyParameter ¶
type BootEnvPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
BootEnvPatchBodyParameter used to patch a BootEnv swagger:parameters patchBootEnv
type BootEnvPathParameter ¶
type BootEnvPathParameter struct { // in: path // required: true Name string `json:"name"` }
BootEnvPathParameter used to name a BootEnv in the path swagger:parameters putBootEnvs getBootEnv putBootEnv patchBootEnv deleteBootEnv headBootEnv
type BootEnvResponse ¶
BootEnvResponse returned on a successful GET, PUT, PATCH, or POST of a single bootenv swagger:response
type BootEnvsResponse ¶
BootEnvsResponse returned on a successful GET of all the bootenvs swagger:response
type ContentBodyParameter ¶
swagger:parameters uploadContent createContent
type ContentParameter ¶
type ContentParameter struct { // in: path Name string `json:"name"` }
swagger:parameters getContent deleteContent uploadContent
type ContentResponse ¶
ContentsResponse returned on a successful GET of a contents swagger:response
type ContentSummaryResponse ¶
type ContentSummaryResponse struct { // in: body Body *models.ContentSummary }
ContentSummaryResponse returned on a successful Post of a content swagger:response
type ContentsResponse ¶
type ContentsResponse struct { // in: body Body []*models.ContentSummary }
ContentsResponse returned on a successful GET of all contents swagger:response
type DefaultAuthSource ¶
type DefaultAuthSource struct {
// contains filtered or unexported fields
}
type ErrorResponse ¶
ErrorResponse is returned whenever an error occurs swagger:response
type EventBodyParameter ¶
EventBodyParameter is used to create an Event swagger:parameters postEvent
type FileData ¶
type FileData struct {
// in: body
Body interface{}
}
FileData body of the upload swagger:parameters uploadFile
type FileInfoResponse ¶
FileInfoResponse returned on a successful upload of a file swagger:response
type FilePathPathParameter ¶
type FilePathPathParameter struct { // in: path Path string `json:"path"` }
swagger:parameters uploadFile getFile deleteFile
type FileResponse ¶
type FileResponse struct { // in: body Body string }
This is a HACK - I can't figure out how to get swagger to render this a binary. So we lie. We also override this object from the server directory to have a binary format which turns it into a stream.
FileResponse returned on a successful GET of a file swagger:response
type FilesPathQueryParameter ¶
type FilesPathQueryParameter struct { // in: query Path string `json:"path"` }
swagger:parameters listFiles
type FilesResponse ¶
type FilesResponse struct { // in: body Body FilePaths }
FilesResponse returned on a successful GET of files swagger:response
type Frontend ¶
type Frontend struct { Logger logger.Logger FileRoot string MgmtApi *gin.Engine ApiGroup *gin.RouterGroup ApiPort int ProvPort int TftpPort int DhcpPort int BinlPort int NoDhcp bool NoTftp bool NoProv bool NoBinl bool SaasDir string // contains filtered or unexported fields }
func NewFrontend ¶
func NewFrontend( dt *backend.DataTracker, lgr logger.Logger, address string, apiport, provport, dhcpport, binlport int, fileRoot, localUI, UIUrl string, authSource AuthSource, pubs *backend.Publishers, drpid string, pc *midlayer.PluginController, noDhcp, noTftp, noProv, noBinl bool, saasDir string) (me *Frontend)
func (*Frontend) InitBootEnvApi ¶
func (f *Frontend) InitBootEnvApi()
func (*Frontend) InitContentApi ¶
func (f *Frontend) InitContentApi()
func (*Frontend) InitEventApi ¶
func (f *Frontend) InitEventApi()
func (*Frontend) InitFileApi ¶
func (f *Frontend) InitFileApi()
func (*Frontend) InitIndexApi ¶
func (f *Frontend) InitIndexApi()
func (*Frontend) InitInfoApi ¶
func (*Frontend) InitInterfaceApi ¶
func (f *Frontend) InitInterfaceApi()
func (*Frontend) InitIsoApi ¶
func (f *Frontend) InitIsoApi()
func (*Frontend) InitJobApi ¶
func (f *Frontend) InitJobApi()
func (*Frontend) InitLeaseApi ¶
func (f *Frontend) InitLeaseApi()
func (*Frontend) InitLogApi ¶
func (f *Frontend) InitLogApi()
func (*Frontend) InitMachineApi ¶
func (f *Frontend) InitMachineApi()
func (*Frontend) InitParamApi ¶
func (f *Frontend) InitParamApi()
func (*Frontend) InitPluginApi ¶
func (f *Frontend) InitPluginApi()
func (*Frontend) InitPluginProviderApi ¶
func (f *Frontend) InitPluginProviderApi()
func (*Frontend) InitPrefApi ¶
func (f *Frontend) InitPrefApi()
func (*Frontend) InitProfileApi ¶
func (f *Frontend) InitProfileApi()
func (*Frontend) InitReservationApi ¶
func (f *Frontend) InitReservationApi()
func (*Frontend) InitRoleApi ¶
func (f *Frontend) InitRoleApi()
func (*Frontend) InitStageApi ¶
func (f *Frontend) InitStageApi()
func (*Frontend) InitSubnetApi ¶
func (f *Frontend) InitSubnetApi()
func (*Frontend) InitSystemApi ¶
func (f *Frontend) InitSystemApi()
func (*Frontend) InitTaskApi ¶
func (f *Frontend) InitTaskApi()
func (*Frontend) InitTemplateApi ¶
func (f *Frontend) InitTemplateApi()
func (*Frontend) InitTenantApi ¶
func (f *Frontend) InitTenantApi()
func (*Frontend) InitUserApi ¶
func (*Frontend) InitWebSocket ¶
func (fe *Frontend) InitWebSocket()
func (*Frontend) InitWorkflowApi ¶
func (f *Frontend) InitWorkflowApi()
type IndexParameter ¶
type IndexParameter struct { // in: path Prefix string `json:"prefix"` }
swagger:parameters getIndex
type IndexResponse ¶
IndexResponse lists all of the static indexes for a specific type of object swagger:response
type IndexesResponse ¶
IndexesResponse lists all the static indexes for all the object types swagger:response
type InfoResponse ¶
InfosResponse returned on a successful GET of an info swagger:response
type InterfaceParameter ¶
type InterfaceParameter struct { // in: path Name string `json:"name"` }
swagger:parameters getInterface
type InterfaceResponse ¶
InterfacesResponse returned on a successful GET of an interfaces swagger:response
type InterfacesResponse ¶
InterfacesResponse returned on a successful GET of all interfaces swagger:response
type IsoData ¶
type IsoData struct {
// in: body
Body interface{}
}
IsoData body of the upload swagger:parameters uploadIso
type IsoInfoResponse ¶
IsoInfoResponse returned on a successful upload of an iso swagger:response
type IsoPathPathParameter ¶
type IsoPathPathParameter struct { // in: path Path string `json:"path"` }
swagger:parameters uploadIso getIso deleteIso
type IsoResponse ¶
type IsoResponse struct {
// in: body
Body interface{}
}
IsoResponse returned on a successful GET of an iso swagger:response
type IsosResponse ¶
type IsosResponse struct { // in: body Body IsoPaths }
IsosResponse returned on a successful GET of isos swagger:response
type JobActionBodyParameter ¶
type JobActionBodyParameter struct { // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
JobActionBodyParameter used to post a Job / Action in the path swagger:parameters postJobAction
type JobActionPathParameter ¶
type JobActionPathParameter struct { // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
JobActionPathParameter used to find a Job / Action in the path swagger:parameters getJobAction
type JobActionsPathParameter ¶
type JobActionsPathParameter struct { // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` // in: query Plugin string `json:"plugin"` }
JobActionsPathParameter used to find a Job / Actions in the path swagger:parameters getJobActions
type JobActionsResponse ¶
JobActionsResponse return on a successful GET of a Job's actions swagger:response
type JobBodyParameter ¶
JobBodyParameter used to inject a Job swagger:parameters createJob putJob
type JobListPathParameter ¶
type JobListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Uuid string // in: query Stage string // in: query Task string // in: query State string // in: query Machine string // in: query Archived string // in: query StartTime string // in: query EndTime string }
JobListPathParameter used to limit lists of Job by path options swagger:parameters listJobs listStatsJobs
type JobLogPutBodyParameter ¶
type JobLogPutBodyParameter struct { // in: body // required: true Body interface{} }
JobLogBodyParameter used to append to a Job log swagger:parameters putJobLog
type JobLogResponse ¶
type JobLogResponse struct { // in: body // format: binary Body string }
This is a HACK - I can't figure out how to get swagger to render this a binary. So we lie. We also override this object from the server directory to have a binary format which turns it into a stream.
JobLogResponse returned on a successful GET of a log swagger:response
type JobParamsBodyParameter ¶
type JobParamsBodyParameter struct { // in: body // required: true Body map[string]interface{} }
JobParamsBodyParameter used to set Job Params swagger:parameters postJobParams
type JobParamsResponse ¶
type JobParamsResponse struct { // in: body Body map[string]interface{} }
JobParamsResponse return on a successful GET of all Job's Params swagger:response
type JobPatchBodyParameter ¶
type JobPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
JobPatchBodyParameter used to patch a Job swagger:parameters patchJob
type JobPathParameter ¶
type JobPathParameter struct { // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` }
JobPathParameter used to find a Job in the path swagger:parameters putJobs getJob putJob patchJob deleteJob getJobParams postJobParams getJobActions getJobLog putJobLog headJob
type JobResponse ¶
JobResponse return on a successful GET, PUT, PATCH or POST of a single Job swagger:response
type JobsResponse ¶
JobsResponse return on a successful GET of all Jobs swagger:response
type LeaseActionBodyParameter ¶
type LeaseActionBodyParameter struct { // in: path // required: true Address string `json:"address"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
LeaseActionBodyParameter used to post a Lease / Action in the path swagger:parameters postLeaseAction
type LeaseActionPathParameter ¶
type LeaseActionPathParameter struct { // in: path // required: true Address string `json:"address"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
LeaseActionPathParameter used to find a Lease / Action in the path swagger:parameters getLeaseAction
type LeaseActionsPathParameter ¶
type LeaseActionsPathParameter struct { // in: path // required: true Address string `json:"address"` // in: query Plugin string `json:"plugin"` }
LeaseActionsPathParameter used to find a Lease / Actions in the path swagger:parameters getLeaseActions
type LeaseBodyParameter ¶
LeaseBodyParameter used to inject a Lease swagger:parameters createLease putLease
type LeaseListPathParameter ¶
type LeaseListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Addr string // in: query Token string // in: query Strategy string // in: query ExpireTime string }
LeaseListPathParameter used to limit lists of Lease by path options swagger:parameters listLeases listStatsLeases
type LeasePatchBodyParameter ¶
type LeasePatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
LeasePatchBodyParameter used to patch a Lease swagger:parameters patchLease
type LeasePathParameter ¶
type LeasePathParameter struct { // in: path // required: true // swagger:strfmt ipv4 Address string `json:"address"` }
LeasePathParameter used to address a Lease in the path swagger:parameters putLeases getLease putLease patchLease deleteLease headLease
type LeaseResponse ¶
LeaseResponse returned on a successful GET, PUT, PATCH, or POST of a single lease swagger:response
type LeasesResponse ¶
LeasesResponse returned on a successful GET of all the leases swagger:response
type LogResponse ¶
LogResponse is returned in response to a log dump request. swagger:response
type MachineActionBodyParameter ¶
type MachineActionBodyParameter struct { // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
MachineActionBodyParameter used to post a Machine / Action in the path swagger:parameters postMachineAction
type MachineActionPathParameter ¶
type MachineActionPathParameter struct { // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
MachineActionPathParameter used to find a Machine / Action in the path swagger:parameters getMachineAction
type MachineActionsPathParameter ¶
type MachineActionsPathParameter struct { // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` // in: query Plugin string `json:"plugin"` }
MachineActionsPathParameter used to find a Machine / Actions in the path swagger:parameters getMachineActions
type MachineBodyParameter ¶
type MachineBodyParameter struct { // in: query Force string `json:"force"` // in: body // required: true Body *models.Machine }
MachineBodyParameter used to inject a Machine swagger:parameters createMachine putMachine
type MachineGetParamPathParemeter ¶
type MachineGetParamPathParemeter struct { // in: query Aggregate string `json:"aggregate"` // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` // in: path //required: true Key string `json:"key"` }
MachineGetParamPathParemeter used to get a single Parameter for a single Machine
swagger:parameters getMachineParam
type MachineGetParamsPathParameter ¶
type MachineGetParamsPathParameter struct { // in: query Aggregate string `json:"aggregate"` // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` }
MachineGetParamsPathParameter used to find a Machine in the path swagger:parameters getMachineParams
type MachineListPathParameter ¶
type MachineListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Uuid string // in: query Name string // in: query BootEnv string // in: query Address string // in: query Runnable string }
MachineListPathParameter used to limit lists of Machine by path options swagger:parameters listMachines listStatsMachines
type MachineParamResponse ¶
type MachineParamResponse struct {
// in: body
Body interface{}
}
MachineParamResponse return on a successful GET of a single Machine param swagger:response
type MachineParamsResponse ¶
type MachineParamsResponse struct { // in: body Body map[string]interface{} }
MachineParamsResponse return on a successful GET of all Machine's Params swagger:response
type MachinePatchBodyParameter ¶
type MachinePatchBodyParameter struct { // in: query Force string `json:"force"` // in: body // required: true Body jsonpatch2.Patch }
MachinePatchBodyParameter used to patch a Machine swagger:parameters patchMachine
type MachinePatchParamsParameter ¶
type MachinePatchParamsParameter struct { // in: body // required: true Body jsonpatch2.Patch }
MachinePatchBodyParameter used to patch a Machine swagger:parameters patchMachineParams
type MachinePathParameter ¶
type MachinePathParameter struct { // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` }
MachinePathParameter used to find a Machine in the path swagger:parameters putMachines getMachine putMachine patchMachine deleteMachine headMachine patchMachineParams postMachineParams
type MachinePostParamParameter ¶
type MachinePostParamParameter struct { // in: body // required: true Body interface{} }
MachinePostParamParameter used to POST a machine parameter
type MachinePostParamPathParemeter ¶
type MachinePostParamPathParemeter struct { // in: path // required: true // swagger:strfmt uuid Uuid uuid.UUID `json:"uuid"` // in: path //required: true Key string `json:"key"` }
MachinePostParamPathParemeter used to get a single Parameter for a single Machine swagger:parameters postMachineParam
type MachinePostParamsParameter ¶
type MachinePostParamsParameter struct { // in: body // required: true Body map[string]interface{} }
MachinePostParamsParameter used to POST machine parameters
type MachineResponse ¶
MachineResponse return on a successful GET, PUT, PATCH or POST of a single Machine swagger:response
type MachinesResponse ¶
MachinesResponse return on a successful GET of all Machines swagger:response
type NoContentResponse ¶
type NoContentResponse struct { }
NoContentResponse is returned for deletes and auth errors swagger:response
type ParamBodyParameter ¶
ParamBodyParameter used to inject a Param swagger:parameters createParam putParam
type ParamListPathParameter ¶
type ParamListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Name string }
ParamListPathParameter used to limit lists of Param by path options swagger:parameters listParams listStatsParams
type ParamParamsBodyParameter ¶
type ParamParamsBodyParameter struct { // in: body // required: true Body map[string]interface{} }
ParamParamsBodyParameter used to set Param Params swagger:parameters postParamParams
type ParamParamsResponse ¶
type ParamParamsResponse struct { // in: body Body map[string]interface{} }
ParamParamsResponse return on a successful GET of all Param's Params swagger:response
type ParamPatchBodyParameter ¶
type ParamPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
ParamPatchBodyParameter used to patch a Param swagger:parameters patchParam
type ParamPathParameter ¶
type ParamPathParameter struct { // in: path // required: true Name string `json:"name"` }
ParamPathParameter used to name a Param in the path swagger:parameters putParams getParam putParam patchParam deleteParam getParamParams postParamParams headParam
type ParamResponse ¶
ParamResponse returned on a successful GET, PUT, PATCH, or POST of a single param swagger:response
type ParamsResponse ¶
ParamsResponse returned on a successful GET of all the params swagger:response
type PluginActionBodyParameter ¶
type PluginActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
PluginActionBodyParameter used to post a Plugin / Action in the path swagger:parameters postPluginAction
type PluginActionPathParameter ¶
type PluginActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
PluginActionPathParameter used to find a Plugin / Action in the path swagger:parameters getPluginAction
type PluginActionsPathParameter ¶
type PluginActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
PluginActionsPathParameter used to find a Plugin / Actions in the path swagger:parameters getPluginActions
type PluginBodyParameter ¶
PluginBodyParameter used to inject a Plugin swagger:parameters createPlugin putPlugin
type PluginListPathParameter ¶
type PluginListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Name string // in: query Provider string }
PluginListPathParameter used to limit lists of Plugin by path options swagger:parameters listPlugins listStatsPlugins
type PluginParamBodyParameter ¶
type PluginParamBodyParameter struct { // in: body // required: true Body interface{} }
PluginParamBodyParameter used to set Plugin Param swagger:parameters postPluginParam
type PluginParamResponse ¶
type PluginParamResponse struct {
// in: body
Body interface{}
}
PluginParamResponse return on a successful GET of one Plugin's Param swagger:response
type PluginParamsBodyParameter ¶
type PluginParamsBodyParameter struct { // in: body // required: true Body map[string]interface{} }
PluginParamsBodyParameter used to set Plugin Params swagger:parameters postPluginParams
type PluginParamsPathParameter ¶
type PluginParamsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Key string `json:"key"` }
PluginParamsPathParameter used to find a Plugin in the path swagger:parameters getPluginParam postPluginParam
type PluginParamsResponse ¶
type PluginParamsResponse struct { // in: body Body map[string]interface{} }
PluginParamsResponse return on a successful GET of all Plugin's Params swagger:response
type PluginPatchBodyParameter ¶
type PluginPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
PluginPatchBodyParameter used to patch a Plugin swagger:parameters patchPlugin
type PluginPathParameter ¶
type PluginPathParameter struct { // in: path // required: true Name string `json:"name"` }
PluginPathParameter used to find a Plugin in the path swagger:parameters putPlugins getPlugin putPlugin patchPlugin deletePlugin getPluginParams postPluginParams headPlugin patchPluginParams
type PluginProviderData ¶
type PluginProviderData struct {
// in: body
Body interface{}
}
PluginProviderData body of the upload swagger:parameters uploadPluginProvider
type PluginProviderInfoResponse ¶
type PluginProviderInfoResponse struct { // in: body Body *models.PluginProviderUploadInfo }
PluginProviderInfoResponse returned on a successful upload of an iso swagger:response
type PluginProviderParameter ¶
type PluginProviderParameter struct { // in: path Name string `json:"name"` }
swagger:parameters getPluginProvider headPluginProviders uploadPluginProvider deletePluginProvider
type PluginProviderResponse ¶
type PluginProviderResponse struct { // in: body Body *models.PluginProvider }
PluginProvidersResponse returned on a successful GET of an plugin_provider swagger:response
type PluginProvidersResponse ¶
type PluginProvidersResponse struct { // in: body Body []*models.PluginProvider }
PluginProvidersResponse returned on a successful GET of all plugin_provider swagger:response
type PluginResponse ¶
PluginResponse return on a successful GET, PUT, PATCH or POST of a single Plugin swagger:response
type PluginsResponse ¶
PluginsResponse return on a successful GET of all Plugins swagger:response
type PrefBodyParameter ¶
PrefBodyParameter is used to create or update a Pref swagger:parameters setPrefs
type PrefsResponse ¶
PrefsResponse returned on a successful GET of all preferences swagger:response
type ProfileActionBodyParameter ¶
type ProfileActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
ProfileActionBodyParameter used to post a Profile / Action in the path swagger:parameters postProfileAction
type ProfileActionPathParameter ¶
type ProfileActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
ProfileActionPathParameter used to find a Profile / Action in the path swagger:parameters getProfileAction
type ProfileActionsPathParameter ¶
type ProfileActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
ProfileActionsPathParameter used to find a Profile / Actions in the path swagger:parameters getProfileActions
type ProfileBodyParameter ¶
ProfileBodyParameter used to inject a Profile swagger:parameters createProfile putProfile
type ProfileListPathParameter ¶
type ProfileListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Name string }
ProfileListPathParameter used to limit lists of Profile by path options swagger:parameters listProfiles listStatsProfiles
type ProfileParamBodyParameter ¶
type ProfileParamBodyParameter struct { // in: body // required: true Body interface{} }
ProfileParamBodyParameter used to set Profile Param swagger:parameters postProfileParam
type ProfileParamResponse ¶
type ProfileParamResponse struct {
// in: body
Body interface{}
}
ProfileParamResponse return on a successful GET of a single Param for a Profile swagger:response
type ProfileParamsBodyParameter ¶
type ProfileParamsBodyParameter struct { // in: body // required: true Body map[string]interface{} }
ProfileParamsBodyParameter used to set Profile Params swagger:parameters postProfileParams
type ProfileParamsPathParameter ¶
type ProfileParamsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Key string `json:"key"` }
ProfileParamsPathParameter used to get or set a single Parameter in a Profile swagger:parameters getProfileParam postProfileParam
type ProfileParamsResponse ¶
type ProfileParamsResponse struct { // in: body Body map[string]interface{} }
ProfileParamsResponse return on a successful GET of all Profile's Params swagger:response
type ProfilePatchBodyParameter ¶
type ProfilePatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
ProfilePatchBodyParameter used to patch a Profile swagger:parameters patchProfile patchProfileParams
type ProfilePathParameter ¶
type ProfilePathParameter struct { // in: path // required: true Name string `json:"name"` }
ProfilePathParameter used to name a Profile in the path swagger:parameters putProfiles getProfile putProfile patchProfile deleteProfile getProfileParams patchProfileParams headProfile postProfileParams
type ProfileResponse ¶
ProfileResponse returned on a successful GET, PUT, PATCH, or POST of a single profile swagger:response
type ProfilesResponse ¶
ProfilesResponse returned on a successful GET of all the profiles swagger:response
type ReservationActionBodyParameter ¶
type ReservationActionBodyParameter struct { // in: path // required: true Address string `json:"address"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
ReservationActionBodyParameter used to post a Reservation / Action in the path swagger:parameters postReservationAction
type ReservationActionPathParameter ¶
type ReservationActionPathParameter struct { // in: path // required: true Address string `json:"address"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
ReservationActionPathParameter used to find a Reservation / Action in the path swagger:parameters getReservationAction
type ReservationActionsPathParameter ¶
type ReservationActionsPathParameter struct { // in: path // required: true Address string `json:"address"` // in: query Plugin string `json:"plugin"` }
ReservationActionsPathParameter used to find a Reservation / Actions in the path swagger:parameters getReservationActions
type ReservationBodyParameter ¶
type ReservationBodyParameter struct { // in: body // required: true Body *models.Reservation }
ReservationBodyParameter used to inject a Reservation swagger:parameters createReservation putReservation
type ReservationListPathParameter ¶
type ReservationListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Addr string // in: query Token string // in: query Strategy string // in: query NextServer string }
ReservationListPathParameter used to limit lists of Reservation by path options swagger:parameters listReservations listStatsReservations
type ReservationPatchBodyParameter ¶
type ReservationPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
ReservationPatchBodyParameter used to patch a Reservation swagger:parameters patchReservation
type ReservationPathParameter ¶
type ReservationPathParameter struct { // in: path // required: true // swagger:strfmt ipv4 Address string `json:"address"` }
ReservationPathParameter used to address a Reservation in the path swagger:parameters putReservations getReservation putReservation patchReservation deleteReservation headReservation
type ReservationResponse ¶
type ReservationResponse struct { // in: body Body *models.Reservation }
ReservationResponse returned on a successful GET, PUT, PATCH, or POST of a single reservation swagger:response
type ReservationsResponse ¶
type ReservationsResponse struct { //in: body Body []*models.Reservation }
ReservationsResponse returned on a successful GET of all the reservations swagger:response
type RoleActionBodyParameter ¶
type RoleActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
RoleActionBodyParameter used to post a Role / Action in the path swagger:parameters postRoleAction
type RoleActionPathParameter ¶
type RoleActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
RoleActionPathParameter used to find a Role / Action in the path swagger:parameters getRoleAction
type RoleActionsPathParameter ¶
type RoleActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
RoleActionsPathParameter used to find a Role / Actions in the path swagger:parameters getRoleActions
type RoleBodyParameter ¶
RoleBodyParameter used to inject a Role swagger:parameters createRole putRole
type RoleListPathParameter ¶
type RoleListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Name string }
RoleListPathParameter used to limit lists of Role by path options swagger:parameters listRoles listStatsRoles
type RolePatchBodyParameter ¶
type RolePatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
RolePatchBodyParameter used to patch a Role swagger:parameters patchRole
type RolePathParameter ¶
type RolePathParameter struct { // in: path // required: true Name string `json:"name"` }
RolePathParameter used to name a Role in the path swagger:parameters putRoles getRole putRole patchRole deleteRole headRole
type RoleResponse ¶
RoleResponse returned on a successful GET, PUT, PATCH, or POST of a single role swagger:response
type RolesResponse ¶
RolesResponse returned on a successful GET of all the roles swagger:response
type Sanitizable ¶
type SingleIndexParameter ¶
type SingleIndexParameter struct { // in: path Prefix string `json:"prefix"` // in: path Param string `json:"param"` }
swagger:parameters getSingleIndex
type SingleIndexResponse ¶
SingleIndexResponse tests to see if a single specific index exists. Unlike the other index API endpoints, you can probe for dynamic indexes this way. swagger:response
type StageActionBodyParameter ¶
type StageActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
StageActionBodyParameter used to post a Stage / Action in the path swagger:parameters postStageAction
type StageActionPathParameter ¶
type StageActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
StageActionPathParameter used to find a Stage / Action in the path swagger:parameters getStageAction
type StageActionsPathParameter ¶
type StageActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
StageActionsPathParameter used to find a Stage / Actions in the path swagger:parameters getStageActions
type StageBodyParameter ¶
StageBodyParameter used to inject a Stage swagger:parameters createStage putStage
type StageListPathParameter ¶
type StageListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Name string // in: query Reboot string // in: query BootEnv string }
StageListPathParameter used to limit lists of Stage by path options swagger:parameters listStages listStatsStages
type StagePatchBodyParameter ¶
type StagePatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
StagePatchBodyParameter used to patch a Stage swagger:parameters patchStage
type StagePathParameter ¶
type StagePathParameter struct { // in: path // required: true Name string `json:"name"` }
StagePathParameter used to name a Stage in the path swagger:parameters putStages getStage putStage patchStage deleteStage headStage
type StageResponse ¶
StageResponse returned on a successful GET, PUT, PATCH, or POST of a single stage swagger:response
type StagesResponse ¶
StagesResponse returned on a successful GET of all the stages swagger:response
type SubnetActionBodyParameter ¶
type SubnetActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
SubnetActionBodyParameter used to post a Subnet / Action in the path swagger:parameters postSubnetAction
type SubnetActionPathParameter ¶
type SubnetActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
SubnetActionPathParameter used to find a Subnet / Action in the path swagger:parameters getSubnetAction
type SubnetActionsPathParameter ¶
type SubnetActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
SubnetActionsPathParameter used to find a Subnet / Actions in the path swagger:parameters getSubnetActions
type SubnetBodyParameter ¶
SubnetBodyParameter used to inject a Subnet swagger:parameters createSubnet putSubnet
type SubnetListPathParameter ¶
type SubnetListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Strategy string // in: query NextServer string // in: query Subnet string // in: query Name string // in: query Enabled string // in: query Proxy string }
SubnetListPathParameter used to limit lists of Subnet by path options swagger:parameters listSubnets listStatsSubnets
type SubnetPatchBodyParameter ¶
type SubnetPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
SubnetPatchBodyParameter used to patch a Subnet swagger:parameters patchSubnet
type SubnetPathParameter ¶
type SubnetPathParameter struct { // in: path // required: true Name string `json:"name"` }
SubnetPathParameter used to name a Subnet in the path swagger:parameters putSubnets getSubnet putSubnet patchSubnet deleteSubnet headSubnet
type SubnetResponse ¶
SubnetResponse returned on a successful GET, PUT, PATCH, or POST of a single subnet swagger:response
type SubnetsResponse ¶
SubnetsResponse returned on a successful GET of all the subnets swagger:response
type SystemActionBodyParameter ¶
type SystemActionBodyParameter struct { // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
SystemActionBodyParameter used to post a System / Action in the path swagger:parameters postSystemAction
type SystemActionPathParameter ¶
type SystemActionPathParameter struct { // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
SystemActionPathParameter used to find a System / Action in the path swagger:parameters getSystemAction
type SystemActionsPathParameter ¶
type SystemActionsPathParameter struct { // in: query Plugin string `json:"plugin"` }
SystemActionsPathParameter used to find a System / Actions in the path swagger:parameters getSystemActions
type TaskActionBodyParameter ¶
type TaskActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
TaskActionBodyParameter used to post a Task / Action in the path swagger:parameters postTaskAction
type TaskActionPathParameter ¶
type TaskActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
TaskActionPathParameter used to find a Task / Action in the path swagger:parameters getTaskAction
type TaskActionsPathParameter ¶
type TaskActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
TaskActionsPathParameter used to find a Task / Actions in the path swagger:parameters getTaskActions
type TaskBodyParameter ¶
TaskBodyParameter used to inject a Task swagger:parameters createTask putTask
type TaskListPathParameter ¶
type TaskListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Name string }
TaskListPathParameter used to limit lists of Task by path options swagger:parameters listTasks listStatsTasks
type TaskParamsBodyParameter ¶
type TaskParamsBodyParameter struct { // in: body // required: true Body map[string]interface{} }
TaskParamsBodyParameter used to set Task Params swagger:parameters postTaskParams
type TaskParamsResponse ¶
type TaskParamsResponse struct { // in: body Body map[string]interface{} }
TaskParamsResponse return on a successful GET of all Task's Params swagger:response
type TaskPatchBodyParameter ¶
type TaskPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
TaskPatchBodyParameter used to patch a Task swagger:parameters patchTask
type TaskPathParameter ¶
type TaskPathParameter struct { // in: path // required: true Name string `json:"name"` }
TaskPathParameter used to find a Task in the path swagger:parameters putTasks getTask putTask patchTask deleteTask getTaskParams postTaskParams headTask
type TaskResponse ¶
TaskResponse return on a successful GET, PUT, PATCH or POST of a single Task swagger:response
type TasksResponse ¶
TasksResponse return on a successful GET of all Tasks swagger:response
type TemplateActionBodyParameter ¶
type TemplateActionBodyParameter struct { // in: path // required: true Id string `json:"id"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
TemplateActionBodyParameter used to post a Template / Action in the path swagger:parameters postTemplateAction
type TemplateActionPathParameter ¶
type TemplateActionPathParameter struct { // in: path // required: true Id string `json:"id"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
TemplateActionPathParameter used to find a Template / Action in the path swagger:parameters getTemplateAction
type TemplateActionsPathParameter ¶
type TemplateActionsPathParameter struct { // in: path // required: true Id string `json:"id"` // in: query Plugin string `json:"plugin"` }
TemplateActionsPathParameter used to find a Template / Actions in the path swagger:parameters getTemplateActions
type TemplateBodyParameter ¶
TemplateBodyParameter used to inject a Template swagger:parameters createTemplate putTemplate
type TemplateListPathParameter ¶
type TemplateListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query ID string }
TemplateListPathParameter used to limit lists of Template by path options swagger:parameters listTemplates listStatsTemplates
type TemplatePatchBodyParameter ¶
type TemplatePatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
TemplatePatchBodyParameter used to patch a Template swagger:parameters patchTemplate
type TemplatePathParameter ¶
type TemplatePathParameter struct { // in: path // required: true Id string `json:"id"` }
TemplatePathParameter used to id a Template in the path swagger:parameters putTemplates getTemplate putTemplate patchTemplate deleteTemplate headTemplate
type TemplateResponse ¶
TemplateResponse return on a successful GET, PUT, PATCH or POST of a single Template swagger:response
type TemplatesResponse ¶
TemplatesResponse return on a successful GET of all templates swagger:response
type TenantActionBodyParameter ¶
type TenantActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
TenantActionBodyParameter used to post a Tenant / Action in the path swagger:parameters postTenantAction
type TenantActionPathParameter ¶
type TenantActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
TenantActionPathParameter used to find a Tenant / Action in the path swagger:parameters getTenantAction
type TenantActionsPathParameter ¶
type TenantActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
TenantActionsPathParameter used to find a Tenant / Actions in the path swagger:parameters getTenantActions
type TenantBodyParameter ¶
TenantBodyParameter used to inject a Tenant swagger:parameters createTenant putTenant
type TenantListPathParameter ¶
type TenantListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Name string }
TenantListPathParameter used to limit lists of Tenant by path options swagger:parameters listTenants listStatsTenants
type TenantPatchBodyParameter ¶
type TenantPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
TenantPatchBodyParameter used to patch a Tenant swagger:parameters patchTenant
type TenantPathParameter ¶
type TenantPathParameter struct { // in: path // required: true Name string `json:"name"` }
TenantPathParameter used to name a Tenant in the path swagger:parameters putTenants getTenant putTenant patchTenant deleteTenant headTenant
type TenantResponse ¶
TenantResponse returned on a successful GET, PUT, PATCH, or POST of a single tenant swagger:response
type TenantsResponse ¶
TenantsResponse returned on a successful GET of all the tenants swagger:response
type UserActionBodyParameter ¶
type UserActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
UserActionBodyParameter used to post a User / Action in the path swagger:parameters postUserAction
type UserActionPathParameter ¶
type UserActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
UserActionPathParameter used to find a User / Action in the path swagger:parameters getUserAction
type UserActionsPathParameter ¶
type UserActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
UserActionsPathParameter used to find a User / Actions in the path swagger:parameters getUserActions
type UserBodyParameter ¶
UserBodyParameter used to inject a User swagger:parameters createUser putUser
type UserListPathParameter ¶
type UserListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Name string }
UserListPathParameter used to limit lists of User by path options swagger:parameters listUsers listStatsUsers
type UserPatchBodyParameter ¶
type UserPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
UserPatchBodyParameter used to patch a User swagger:parameters patchUser
type UserPathParameter ¶
type UserPathParameter struct { // in: path // required: true Name string `json:"name"` }
UserPathParameter used to name a User in the path swagger:parameters getUser putUser patchUser deleteUser getUserToken putUserPassword headUser
type UserPutPasswordParameter ¶
type UserPutPasswordParameter struct { // in: body // required: true Body models.UserPassword }
UserPutPassword used to set the User's password swagger:parameters putUserPassword
type UserResponse ¶
UserResponse returned on a successful GET, PUT, PATCH, or POST of a single user swagger:response
type UserTokenQueryRolesParameter ¶
type UserTokenQueryRolesParameter struct { // in: query Roles string `json:"roles"` }
UserTokenQueryRolesParameter is used to restrict the requested token to a subset of the Roles that a User has.
swagger:parameters getUserToken
type UserTokenQueryTTLParameter ¶
type UserTokenQueryTTLParameter struct { // in: query TTL int `json:"ttl"` }
swagger:parameters getUserToken
type UserTokenResponse ¶
UserTokenResponse returned on a successful GET of user token swagger:response UserTokenResponse
type UsersResponse ¶
UsersResponse returned on a successful GET of all the users swagger:response
type WorkflowActionBodyParameter ¶
type WorkflowActionBodyParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` // in: body // required: true Body map[string]interface{} }
WorkflowActionBodyParameter used to post a Workflow / Action in the path swagger:parameters postWorkflowAction
type WorkflowActionPathParameter ¶
type WorkflowActionPathParameter struct { // in: path // required: true Name string `json:"name"` // in: path // required: true Cmd string `json:"cmd"` // in: query Plugin string `json:"plugin"` }
WorkflowActionPathParameter used to find a Workflow / Action in the path swagger:parameters getWorkflowAction
type WorkflowActionsPathParameter ¶
type WorkflowActionsPathParameter struct { // in: path // required: true Name string `json:"name"` // in: query Plugin string `json:"plugin"` }
WorkflowActionsPathParameter used to find a Workflow / Actions in the path swagger:parameters getWorkflowActions
type WorkflowBodyParameter ¶
WorkflowBodyParameter used to inject a Workflow swagger:parameters createWorkflow putWorkflow
type WorkflowListPathParameter ¶
type WorkflowListPathParameter struct { // in: query Offest int `json:"offset"` // in: query Limit int `json:"limit"` // in: query Available string // in: query Valid string // in: query ReadOnly string // in: query Name string // in: query Reboot string // in: query BootEnv string }
WorkflowListPathParameter used to limit lists of Workflow by path options swagger:parameters listWorkflows listStatsWorkflows
type WorkflowPatchBodyParameter ¶
type WorkflowPatchBodyParameter struct { // in: body // required: true Body jsonpatch2.Patch }
WorkflowPatchBodyParameter used to patch a Workflow swagger:parameters patchWorkflow
type WorkflowPathParameter ¶
type WorkflowPathParameter struct { // in: path // required: true Name string `json:"name"` }
WorkflowPathParameter used to name a Workflow in the path swagger:parameters putWorkflows getWorkflow putWorkflow patchWorkflow deleteWorkflow headWorkflow
type WorkflowResponse ¶
WorkflowResponse returned on a successful GET, PUT, PATCH, or POST of a single workflow swagger:response
type WorkflowsResponse ¶
WorkflowsResponse returned on a successful GET of all the workflows swagger:response
Source Files
¶
- actions.go
- bootenvs.go
- content.go
- doc.go
- events.go
- files.go
- frontend.go
- indexes.go
- info.go
- interfaces.go
- isos.go
- jobs.go
- leases.go
- log.go
- machines.go
- params.go
- plugin_providers.go
- plugins.go
- prefs.go
- profiles.go
- reservations.go
- roles.go
- stages.go
- subnets.go
- system.go
- tasks.go
- templates.go
- tenants.go
- users.go
- websocket.go
- workflows.go