api

Documentation

Index

• Variables
• func Register(service *Service)
• type CreatePipelineRequest
• type CreatePipelineResponse
• type GetPipelineResponse
• type Job
• type Pipeline
• type Service
  • func NewService(service *pipeline.Service) *Service
• type UpdatePipelineRequest
• type UpdatePipelineResponse

Variables

var Module = fx.Options(
	fx.Invoke(Register),
	fx.Provide(NewService),
)

Module for fx.

Functions

func Register

func Register(service *Service)

Register routes.

Types

type CreatePipelineRequest

type CreatePipelineRequest struct {
	Pipeline *Pipeline `json:"pipeline,omitempty"`
}

CreatePipelineRequest with a definition.

type CreatePipelineResponse

type CreatePipelineResponse struct {
	Meta     map[string]string `json:"meta,omitempty"`
	Pipeline *Pipeline         `json:"pipeline,omitempty"`
}

CreatePipelineResponse a map of meta and the new pipeline.

type GetPipelineResponse

type GetPipelineResponse struct {
	Meta     map[string]string `json:"meta,omitempty"`
	Pipeline *Pipeline         `json:"pipeline,omitempty"`
}

GetPipelineResponse a map of meta and the pipeline.

type Job

type Job struct {
	Name  string   `json:"name,omitempty"`
	Steps []string `json:"steps,omitempty"`
}

Job of the pipeline.

type Pipeline

type Pipeline struct {
	Name string `json:"name,omitempty"`
	Jobs []*Job `json:"jobs,omitempty"`
	ID   uint64 `json:"id,omitempty"`
}

Pipeline to be executed.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service for v1.

func NewService

func NewService(service *pipeline.Service) *Service

NewService for v1.

type UpdatePipelineRequest

type UpdatePipelineRequest struct {
	Pipeline *Pipeline `json:"pipeline,omitempty"`
}

UpdatePipelineRequest with a definition.

type UpdatePipelineResponse

type UpdatePipelineResponse struct {
	Meta     map[string]string `json:"meta,omitempty"`
	Pipeline *Pipeline         `json:"pipeline,omitempty"`
}

UpdatePipelineResponse a map of meta and the updated pipeline.