api

Documentation

Index

• Constants
• func GetAPIPrefix() []string
• func InitAPIBean() []interface{}
• func NewReverseProxy(target *url.URL) *httputil.ReverseProxy
• func NewWorkflow() interface{}
• func RegisterAPI(ws Interface)
• func ValidateAlias(fl validator.FieldLevel) bool
• func ValidateEmail(fl validator.FieldLevel) bool
• func ValidateName(fl validator.FieldLevel) bool
• func ValidatePassword(fl validator.FieldLevel) bool
• func ValidatePayloadType(fl validator.FieldLevel) bool
• type CloudShell
  • func NewCloudShell() *CloudShell
  • func (c *CloudShell) GetWebServiceRoute() *restful.WebService
• type CloudShellView
  • func NewCloudShellView() *CloudShellView
  • func (c *CloudShellView) GetWebServiceRoute() *restful.WebService
• type Cluster
  • func NewCluster() *Cluster
  • func (c *Cluster) GetWebServiceRoute() *restful.WebService
• type Interface
  • func Config() Interface
  • func ConfigTemplate() Interface
  • func GetRegisteredAPI() []Interface
  • func NewAddon() Interface
  • func NewAddonRegistry() Interface
  • func NewApplication() Interface
  • func NewAuthentication() Interface
  • func NewDefinition() Interface
  • func NewEnabledAddon() Interface
  • func NewEnv() Interface
  • func NewOAMApplication() Interface
  • func NewPayloadTypes() Interface
  • func NewPipeline() Interface
  • func NewProject() Interface
  • func NewRBAC() Interface
  • func NewRepository() Interface
  • func NewSystemInfo() Interface
  • func NewTarget() Interface
  • func NewUser() Interface
  • func NewVelaQL() Interface
  • func NewWebhook() Interface
• type Target
  • func (dt *Target) GetWebServiceRoute() *restful.WebService
• type Workflow

Constants

const (
	// Project is the project name key of query param
	Project string = "projectName"
	// Pipeline is the pipeline name of query param
	Pipeline string = "pipelineName"
	// PipelineRun is the pipeline run name of query param
	PipelineRun string = "runName"
	// ContextName is the context name of query param
	ContextName string = "contextName"
)

Functions

func GetAPIPrefix

func GetAPIPrefix() []string

GetAPIPrefix return the prefix of the api route path

func InitAPIBean

func InitAPIBean() []interface{}

InitAPIBean inits all API handlers, pass in the required parameter object. It can be implemented using the idea of dependency injection.

func NewReverseProxy

func NewReverseProxy(target *url.URL) *httputil.ReverseProxy

NewReverseProxy proxy for requests of the cloud shell

func NewWorkflow

func NewWorkflow() interface{}

NewWorkflow new workflow api interface

func RegisterAPI

func RegisterAPI(ws Interface)

RegisterAPI register API handler

func ValidateAlias

func ValidateAlias(fl validator.FieldLevel) bool

ValidateAlias custom check alias field

func ValidateEmail

func ValidateEmail(fl validator.FieldLevel) bool

ValidateEmail custom check email field

func ValidateName

func ValidateName(fl validator.FieldLevel) bool

ValidateName custom check name field

func ValidatePassword

func ValidatePassword(fl validator.FieldLevel) bool

ValidatePassword custom check password field

func ValidatePayloadType

func ValidatePayloadType(fl validator.FieldLevel) bool

ValidatePayloadType check PayloadType

Types

type CloudShell

type CloudShell struct {
	RbacService       service.RBACService       `inject:""`
	CloudShellService service.CloudShellService `inject:""`
}

CloudShell provide the API for preparing the cloud shell environment

func NewCloudShell

func NewCloudShell() *CloudShell

NewCloudShell create the cloudshell api instance

func (*CloudShell) GetWebServiceRoute

func (c *CloudShell) GetWebServiceRoute() *restful.WebService

GetWebServiceRoute -

type CloudShellView

type CloudShellView struct {
	RbacService       service.RBACService       `inject:""`
	CloudShellService service.CloudShellService `inject:""`
}

CloudShellView provide the view handler

func NewCloudShellView

func NewCloudShellView() *CloudShellView

NewCloudShellView new cloud share

func (*CloudShellView) GetWebServiceRoute

func (c *CloudShellView) GetWebServiceRoute() *restful.WebService

GetWebServiceRoute -

type Cluster

type Cluster struct {
	ClusterService service.ClusterService `inject:""`
	RbacService    service.RBACService    `inject:""`
}

Cluster cluster manage

func NewCluster

func NewCluster() *Cluster

NewCluster new cluster

func (*Cluster) GetWebServiceRoute

func (c *Cluster) GetWebServiceRoute() *restful.WebService

GetWebServiceRoute -

type Interface

type Interface interface {
	GetWebServiceRoute() *restful.WebService
}

Interface the API should define the http route

func Config

func Config() Interface

Config returns config web service

func ConfigTemplate

func ConfigTemplate() Interface

ConfigTemplate returns config web service

func GetRegisteredAPI

func GetRegisteredAPI() []Interface

GetRegisteredAPI return all API handlers

func NewAddon

func NewAddon() Interface

NewAddon returns addon web service

func NewAddonRegistry

func NewAddonRegistry() Interface

NewAddonRegistry returns addon registry web service

func NewApplication

func NewApplication() Interface

NewApplication new application manage

func NewAuthentication

func NewAuthentication() Interface

NewAuthentication is the of authentication

func NewDefinition

func NewDefinition() Interface

NewDefinition new definition

func NewEnabledAddon

func NewEnabledAddon() Interface

NewEnabledAddon returns enabled addon web service

func NewEnv

func NewEnv() Interface

NewEnv new env

func NewOAMApplication

func NewOAMApplication() Interface

NewOAMApplication new oam application

func NewPayloadTypes

func NewPayloadTypes() Interface

NewPayloadTypes new -

func NewPipeline

func NewPipeline() Interface

NewPipeline new pipeline manage

func NewProject

func NewProject() Interface

NewProject new project

func NewRBAC

func NewRBAC() Interface

NewRBAC new rbac

func NewRepository

func NewRepository() Interface

NewRepository will return the repository

func NewSystemInfo

func NewSystemInfo() Interface

NewSystemInfo return systemInfo

func NewTarget

func NewTarget() Interface

NewTarget new Target Interface

func NewUser

func NewUser() Interface

NewUser is the of user

func NewVelaQL

func NewVelaQL() Interface

NewVelaQL new velaQL

func NewWebhook

func NewWebhook() Interface

NewWebhook new application manage

type Target

type Target struct {
	TargetService      service.TargetService      `inject:""`
	ApplicationService service.ApplicationService `inject:""`
	RbacService        service.RBACService        `inject:""`
}

Target target web service

func (*Target) GetWebServiceRoute

func (dt *Target) GetWebServiceRoute() *restful.WebService

GetWebServiceRoute get web service

type Workflow

type Workflow struct {
	WorkflowService    service.WorkflowService    `inject:""`
	ApplicationService service.ApplicationService `inject:""`
}

Workflow workflow api