Documentation
¶
Index ¶
- func GetRouter(config config.Config, ctrl *ctrl.Ctrl) http.Handler
- func Start(ctx context.Context, config config.Config, ctrl *ctrl.Ctrl) error
- type DependenciesEndpoints
- type DeploymentsEndpoints
- func (this *DeploymentsEndpoints) DeleteDeployment(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
- func (this *DeploymentsEndpoints) Deploy(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
- func (this *DeploymentsEndpoints) GetDeployment(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
- func (this *DeploymentsEndpoints) GetStartParameters(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
- func (this *DeploymentsEndpoints) ListDeployments(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
- func (this *DeploymentsEndpoints) PrepareDeployment(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
- func (this *DeploymentsEndpoints) PrepareDeploymentByModelId(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
- func (this *DeploymentsEndpoints) UpdateDeployment(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
- type EndpointMethod
- type HealthEndpoints
- type Swagger
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetRouter ¶ added in v0.0.15
GetRouter doc @title Process-Deployment API @version 0.1 @license.name Apache 2.0 @license.url http://www.apache.org/licenses/LICENSE-2.0.html @BasePath / @securityDefinitions.apikey Bearer @in header @name Authorization @description Type "Bearer" followed by a space and JWT token.
Types ¶
type DependenciesEndpoints ¶
type DependenciesEndpoints struct{}
func (*DependenciesEndpoints) GetDependency ¶ added in v0.0.15
func (this *DependenciesEndpoints) GetDependency(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
GetDependency godoc @Summary get dependencies @Description get dependencies of deployment @Tags dependencies @Produce json @Security Bearer @Param id path string true "deployment id" @Success 200 {object} dependencymodel.Dependencies @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /dependencies/{id} [GET]
func (*DependenciesEndpoints) ListDependencies ¶ added in v0.0.15
func (this *DependenciesEndpoints) ListDependencies(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
ListDependencies godoc @Summary list dependencies @Description list dependencies @Tags dependencies @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Success 200 {array} dependencymodel.Dependencies @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /dependencies [GET]
type DeploymentsEndpoints ¶
type DeploymentsEndpoints struct{}
func (*DeploymentsEndpoints) DeleteDeployment ¶ added in v0.0.15
func (this *DeploymentsEndpoints) DeleteDeployment(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
DeleteDeployment godoc @Summary delete process deployment @Description delete process deployment @Tags deployment @Security Bearer @Param id path string true "deployment id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v3/deployments/{id} [DELETE]
func (*DeploymentsEndpoints) Deploy ¶ added in v0.0.15
func (this *DeploymentsEndpoints) Deploy(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
Deploy godoc @Summary deploy process @Description deploy process @Tags deployment @Produce json @Security Bearer @Param source query string false "source of deployment (e.g. smart-service)" @Param optional_service_selection query integer false "set to true to disable validation, that a service must be selected" @Param message body deploymentmodel.Deployment true "process deployment" @Success 200 {object} deploymentmodel.Deployment @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v3/deployments [POST]
func (*DeploymentsEndpoints) GetDeployment ¶ added in v0.0.15
func (this *DeploymentsEndpoints) GetDeployment(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
GetDeployment godoc @Summary get process deployment @Description get process deployment @Tags deployment @Produce json @Security Bearer @Param id path string true "deployment id" @Param with_options query bool false "default true, omit SelectionOptions if set to false" @Success 200 {object} deploymentmodel.Deployment @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v3/deployments/{id} [GET]
func (*DeploymentsEndpoints) GetStartParameters ¶ added in v0.0.15
func (this *DeploymentsEndpoints) GetStartParameters(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
GetStartParameters godoc @Summary get start-parameters @Description get start-parameters of a process-model @Tags deployment @Produce json @Security Bearer @Param modelId path string true "process-model id" @Success 200 {array} deploymentmodel.ProcessStartParameter @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v3/start-parameters/{modelId} [GET]
func (*DeploymentsEndpoints) ListDeployments ¶ added in v0.0.15
func (this *DeploymentsEndpoints) ListDeployments(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
ListDeployments godoc @Summary list process deployments @Description list process deployments @Tags deployment @Produce json @Security Bearer @Param limit query integer false "default unlimited" @Param offset query integer false "default 0" @Param sort query string false "default name.asc" @Success 200 {array} deploymentmodel.Deployment @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v3/deployments [GET]
func (*DeploymentsEndpoints) PrepareDeployment ¶ added in v0.0.15
func (this *DeploymentsEndpoints) PrepareDeployment(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
PrepareDeployment godoc @Summary prepare process deployment @Description prepare process deployment @Tags deployment @Produce json @Security Bearer @Param with_options query bool false "default true, omit SelectionOptions if set to false" @Param message body messages.PrepareRequest true "model that should be prepared for deployment" @Success 200 {object} deploymentmodel.Deployment @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v3/prepared-deployments [POST]
func (*DeploymentsEndpoints) PrepareDeploymentByModelId ¶ added in v0.0.15
func (this *DeploymentsEndpoints) PrepareDeploymentByModelId(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
PrepareDeploymentByModelId godoc @Summary prepare process deployment with model-id @Description prepare process deployment with model-id @Tags deployment @Produce json @Security Bearer @Param modelId path string true "process-model id" @Param with_options query bool false "default true, omit SelectionOptions if set to false" @Success 200 {object} deploymentmodel.Deployment @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v3/prepared-deployments/{modelId} [GET]
func (*DeploymentsEndpoints) UpdateDeployment ¶ added in v0.0.15
func (this *DeploymentsEndpoints) UpdateDeployment(config config.Config, router *http.ServeMux, ctrl *ctrl.Ctrl)
UpdateDeployment godoc @Summary update process deployment @Description update process deployment @Tags deployment @Produce json @Security Bearer @Param id path string true "deployment id" @Param source query string false "source of deployment (e.g. smart-service)" @Param optional_service_selection query integer false "set to true to disable validation, that a service must be selected" @Param message body deploymentmodel.Deployment true "process deployment" @Success 200 {object} deploymentmodel.Deployment @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v3/deployments/{id} [PUT]
type EndpointMethod ¶ added in v0.0.15
type HealthEndpoints ¶
type HealthEndpoints struct{}
Source Files
Directories