osp-web

Overview

The Web module is responsible for the communication between front-end and back-end.

The Web module exposes an HTTP/Websocket API to the front-end. The requests on the API are translated and sent to modules responsible for the task. Then the module responses are translated and sent back to the front-end over the API.

List of configuration files

Filename	Short description	Format	Documentation
module.service	Each service is described in its own file and then assembled	yml	See the Swarm administration or Official documentation
module.web	Define the module configuration	json	module.web
endpoint.webhook	Define a endpoint that can be used to trigger a webhook.	json	endpoint.webhook
owner.webhook	Define how to handle a request received on the endpoint.	json	owner.webhook
severity.ospp	Define the property of a severity (name, description).	json	severity.ospp
severity.web	Define how to display the link severity.	json	severity.web
filter.ospp	Define the property of a filter (name, description).	json	filter.ospp
filter.web	Define the filter available to the front-end.	json	filter.web
view.ospp	Define the property of a view (name, description, fields).	json	view.ospp
view.web	Define how to display an alarm.	json	view.web
menu.web	Define a menu to interact with the a dashboard.	json	menu.web
dashboard.view	Define the information displayed on the dashboard.	json	dashboard.web
dashboard.web	Define the property of the link dashboard.	json	dashboard.web