api

package
v0.0.40 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 27, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DeleteDeploymentEndpoint added in v0.0.29

func DeleteDeploymentEndpoint(router *http.ServeMux, config config.Config, ctrl interfaces.Events)

DeleteDeploymentEndpoint godoc @Summary delete deployment @Description delete deployment, meant for internal use by the process-deployment service, only admins may access this endpoint @Tags deployment @Security Bearer @Param deplid path string true "deployment id" @Param userid path string true "user id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-deployments/{userid}/{deplid} [DELETE]

func EventStatesEndpoints

func EventStatesEndpoints(router *http.ServeMux, config config.Config, ctrl interfaces.Events)

EventStatesEndpoints godoc @Summary get event-states @Description get event-states @Tags event @Produce json @Security Bearer @Param ids query string true "comma seperated list of event-ids" @Success 200 {object} EventStates @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /event-states [GET]

func EventsEndpoints

func EventsEndpoints(router *http.ServeMux, config config.Config, ctrl interfaces.Events)

EventsEndpoints godoc @Summary check event @Description check event @Tags event @Produce json @Security Bearer @Param id path string true "event id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /events/{id} [HEAD]

func HealthEndpoints

func HealthEndpoints(router *http.ServeMux, config config.Config, ctrl interfaces.Events)

HealthEndpoints godoc @Summary health @Description check service health @Tags health @Security Bearer @Success 200 @Router /health [POST]

func Router

func Router(config config.Config, ctrl interfaces.Events) http.Handler

Router doc @title Event-Deployment @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.

func SetDeploymentEndpoint added in v0.0.29

func SetDeploymentEndpoint(router *http.ServeMux, config config.Config, ctrl interfaces.Events)

SetDeploymentEndpoint godoc @Summary deploy process @Description deploy process, meant for internal use by the process-deployment service, only admins may access this endpoint @Tags deployment @Security Bearer @Param message body model.Deployment true "deployment" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /process-deployments [PUT]

func Start

func Start(ctx context.Context, config config.Config, ctrl interfaces.Events) error

func SwaggerEndpoints added in v0.0.29

func SwaggerEndpoints(router *http.ServeMux, config config.Config, ctrl interfaces.Events)

func UpdateDeploymentsOfDeviceGroup added in v0.0.31

func UpdateDeploymentsOfDeviceGroup(router *http.ServeMux, config config.Config, ctrl interfaces.Events)

UpdateDeploymentsOfDeviceGroup godoc @Summary update event-deployments of device-group @Description update event-deployments of device-group, meant for internal use by the process-deployment service, only admins may access this endpoint @Tags deployment @Security Bearer @Param id path string true "device-group id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-groups/{id} [POST]

Types

type EventStates added in v0.0.29

type EventStates = map[string]bool

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL