response

Documentation

Index

• type ProjectErrorResponse
• type ProjectResponse
• type TaskCreatedResponse
• type TaskErrorResponse
• type TaskResponse

Types

type ProjectErrorResponse

type ProjectErrorResponse struct {
	// ID of the task created
	ID string `json:"id" validate:"required"`
	// Error represents an error
	Error string `json:"error,omitempty" validate:"string"`
}

ProjectErrorResponse represents a response when a there is an error

type ProjectResponse

type ProjectResponse struct {
	// Format represents the project format
	Format string `json:"format" validate:"required"`
	// Name represents the project name
	Name string `json:"name" validate:"required"`
	// Source represents the project source
	Reference string `json:"reference" validate:"required"`
	// Storage represents the project type
	Storage string `json:"storage" validate:"required"`
}

ProjectResponse represents a response describing a project

type TaskCreatedResponse

type TaskCreatedResponse struct {
	// ID of the task created
	ID string `json:"id" validate:"required"`
}

TaskCreatedResponse represents a response when a task is created

type TaskErrorResponse

type TaskErrorResponse struct {
	// ID of the task created
	ID string `json:"id" validate:"required"`
	// Error represents an error
	Error string `json:"error,omitempty" validate:"string"`
}

TaskErrorResponse represents a response when a there is an error

type TaskResponse

type TaskResponse struct {
	// Command identifies the command to be executed
	Command string `json:"command" validate:"required"`
	// CompletedAt represents the time the task was completed
	CompletedAt string `json:"completed_at"`
	// CreatedAt represents the time the task was created
	CreatedAt string `json:"created_at"`
	// ErrorMessage represents an error message
	ErrorMessage string `json:"error_message,omitempty"`
	// ExecutedAt represents the time the task was executed
	ExecutedAt string `json:"executed_at"`
	// ID represents the task ID
	ID string `json:"id" validate:"required"`
	// Parameters represents the parameters to be used
	Parameters interface{} `json:"parameters" validate:"required"`
	// Project represents the project
	ProjectID string `json:"project_id"`
	// Status represents the status of the task
	Status string `json:"status" validate:"required"`
}

TaskResponse represents a response describing a task