response

Documentation

Index

• type AgentInfo
• type AgentSecretInfo
• type AgentTriggerInfo
• type AgentVerboseInfo
• type AgentWorkflowInfo
• type HTTPError
• type HTTPMessage
• type JWTAuth
• type KVPair
• type OauthLogin
• type PipelineInfo
• type PipelineRunInfo
• type PipelineRunVerboseInfo
• type RegistryItem
• type RegistryItemsFromPrefix
• type SecretInfo
• type WorkflowInfo

Types

type AgentInfo

type AgentInfo struct {
	Name string `json:"name"`

	Available bool `json:"available"`

	Address string `json:"address"`

	Secure bool `json:"secure"`
}

AgentInfo contains a list of registry items keys

type AgentSecretInfo

type AgentSecretInfo struct {
	Name string `json:"name"`

	Type string `json:"type"`
}

AgentSecretInfo contains the info about the secret for the agent.

type AgentTriggerInfo

type AgentTriggerInfo struct {
	Name string `json:"name"`

	Pipelines []string `json:"pipelines"`
}

AgentTriggerInfo is the info about trigger on the agent.

type AgentVerboseInfo

type AgentVerboseInfo struct {
	Name string `json:"name"`

	Healthy bool `json:"healthy"`

	Address string `json:"address"`

	Secure bool `json:"secure"`

	ServerName string `json:"serverName"`

	Workflows []AgentWorkflowInfo `json:"workflows"`

	Secrets []AgentSecretInfo `json:"secrets"`
}

AgentVerboseInfo contains verbose information about the agent.

type AgentWorkflowInfo

type AgentWorkflowInfo struct {
	Name string `json:"name"`

	Triggers []AgentTriggerInfo `json:"triggers"`
}

AgentWorkflowInfo contains the info about the workflow on the agent.

type HTTPError

type HTTPError struct {
	Error string `json:"error" example:"Invalid authentication type provided."`
}

HTTPError is the response type for any, general simple error that occur for a HTTP request.

type HTTPMessage

type HTTPMessage struct {
	Message string `json:"message" example:"Messsage in response to your request"`
}

HTTPMessage is the general HTTP response for a request.

type JWTAuth

type JWTAuth struct {
	Token string `json:"token" example:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"`

	ExpiresIn time.Duration `json:"expiresIn" example:"3600"`

	UserEmail string `json:"userEmail" example:"example@example.com"`
	UserName  string `json:"userName" example:"fristonio"`
}

JWTAuth is the reponse for JWT authentication if succedded. It returns the token along with other relevant information in the json structure.

type KVPair

type KVPair struct {
	Key string `json:"key"`

	Value string `json:"value"`
}

KVPair contains a key value pair.

type OauthLogin

type OauthLogin struct {
	// LoginURL is the URL to be used for logging in.
	LoginURL string `json:"loginURL" example:"https://xxxx.io/login"`
}

OauthLogin is the reponse for a user login to xene.

type PipelineInfo

type PipelineInfo struct {
	Workflow string `json:"workflow"`

	Name string `json:"name"`

	Spec string `json:"spec"`

	Runs []PipelineRunInfo `json:"runs"`

	Warnings []string `json:"warnings"`
}

PipelineInfo contains verbose information about a particular pipeline.

type PipelineRunInfo

type PipelineRunInfo struct {
	RunID string `json:"runID"`

	Status string `json:"status"`

	Agent string `json:"agent"`

	StartTime int64 `json:"startTime"`

	EndTime int64 `json:"endTime"`
}

PipelineRunInfo contains information about a particular pipeline run.

type PipelineRunVerboseInfo

type PipelineRunVerboseInfo struct {
	RunID string `json:"runID"`

	Status string `json:"status"`

	RunInfo string `json:"runInfo"`

	BaseLogURL string `json:"baseLogURL"`
}

PipelineRunVerboseInfo contains verbose information about a particular pipeline run.

type RegistryItem

type RegistryItem struct {
	// Items contains the Serialized kvstore item
	Item KVPair `json:"item"`
}

RegistryItem is the reponse of registry item get on the apiserver.

type RegistryItemsFromPrefix

type RegistryItemsFromPrefix struct {
	Count int `json:"count" example:"2"`

	// Items contains the Serialized kvstore items
	Items []KVPair `json:"items"`
}

RegistryItemsFromPrefix is the response of list prefix query on registry items.

type SecretInfo

type SecretInfo struct {
	Name string `json:"name"`

	Type string `json:"type"`

	Restricted bool `json:"restricted"`
}

SecretInfo contains information about a secret

type WorkflowInfo

type WorkflowInfo struct {
	Name string `json:"name"`

	Pipelines []string `json:"pipelines"`

	Triggers []string `json:"triggers"`

	Agents []string `json:"agents"`
}

WorkflowInfo contains information about a xene workflow