Documentation
¶
Index ¶
- func GetPluginInfo(svc service.PluginService) fiber.Handler
- func GetPluginsList(svc service.PluginService) fiber.Handler
- func PluginHeartbeat(svc service.PluginService) fiber.Handler
- func RefreshToken(svc service.PluginService) fiber.Handler
- func RegisterPlugin(svc service.PluginService) fiber.Handler
- func RegisterRoutes(r fiber.Router, svc service.PluginService, middlewares ...fiber.Handler)
- func UnregisterPlugin(svc service.PluginService) fiber.Handler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetPluginInfo ¶
func GetPluginInfo(svc service.PluginService) fiber.Handler
@Summary Get a plugin info @Description Get a plugin info @Id get-plugin-info @Tags Plugin @Produce json @Success 200 {object} entities.PluginResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/plugin/{plugin_slug} [get] @Param plugin_slug path string true "Slug of the plugin" @Security Keycloak
func GetPluginsList ¶
func GetPluginsList(svc service.PluginService) fiber.Handler
@Summary Get a list of all registered plugins @Description Get a list of all registered plugins @Id get-plugins-list @Tags Plugin @Produce json @Success 200 {object} entities.PluginListResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/plugin [get] @Security Keycloak
func PluginHeartbeat ¶
func PluginHeartbeat(svc service.PluginService) fiber.Handler
@Summary Heartbeat for a plugin @Description Heartbeat for a plugin @Id plugin-heartbeat @Tags Plugin @Produce json @Success 200 {object} string @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/plugin/{plugin_slug}/heartbeat [post] @Param plugin_slug path string true "Name of the plugin specified by slug during registration" @Security Keycloak
func RefreshToken ¶
func RefreshToken(svc service.PluginService) fiber.Handler
@Summary Refresh plugin token @Description Refresh plugin token @Id refresh-plugin-token @Tags Plugin @Accept json @Produce json @Param body body entities.PluginAuth true "Plugin authentication" @Success 200 {object} entities.ClientTokenResponse @Failure 400 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/plugin/{plugin_slug}/token/refresh [post] @Param plugin_slug path string true "Slug of the plugin"
func RegisterPlugin ¶
func RegisterPlugin(svc service.PluginService) fiber.Handler
@Summary Register a plugin @Description Register a plugin @Id register-plugin @Tags Plugin @Produce json @Success 200 {object} entities.ClientTokenResponse @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 403 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/plugin [post]
@Param body body entities.PluginRegisterRequest true "Plugin registration request"
func RegisterRoutes ¶
func RegisterRoutes(r fiber.Router, svc service.PluginService, middlewares ...fiber.Handler)
func UnregisterPlugin ¶
func UnregisterPlugin(svc service.PluginService) fiber.Handler
@Summary Unregister a plugin @Description Unregister a plugin @Id unregister-plugin @Tags Plugin @Produce json @Success 204 @Failure 401 {object} HTTPError @Failure 404 {object} HTTPError @Failure 500 {object} HTTPError @Router /v1/plugin/{plugin_slug}/unregister [post] @Param plugin_slug path string true "Slug of the plugin" @Security Keycloak
Types ¶
This section is empty.
Source Files