dougal-software/lib/www/server/api/middleware/index.js

module.exports = {
	event: require('./event'),
	files: require('./files'),
	plan: require('./plan'),
	line: require('./line'),
	linename: require('./linename'),
	project: require('./project'),
	sequence: require('./sequence'),
	user: require('./user'),
	auth: require('./auth'),
	gis: require('./gis'),
	label: require('./label'),
	navdata: require('./navdata'),
	vessel: require('./vessel'),
	queue: require('./queue'),
	qc: require('./qc'),
	configuration: require('./configuration'),
	info: require('./info'),
	meta: require('./meta'),
	openapi: require('./openapi'),
	rss: require('./rss'),
	etag: require('./etag'),
	version: require('./version'),
	admin: require('./admin'),
	compress: require('./compress'),
	comparisons: require('./comparisons'),
};
Initial commit 2020-08-08 23:59:13 +02:00			`module.exports = {`
			`event: require('./event'),`
Add API `files` endpoint. Used to download files. It relies on `imports.paths` being set appropriately in `etc/config.yaml` to indicate which parts of the filesystem are accessible to users via Dougal. 2023-08-30 13:51:31 +02:00			`files: require('./files'),`
Add planner endpoints 2020-10-08 16:36:15 +02:00			`plan: require('./plan'),`
Initial commit 2020-08-08 23:59:13 +02:00			`line: require('./line'),`
Add API endpoint to retrieve line name properties. This will be needed by the configuration GUI. 2025-07-09 16:38:41 +02:00			`linename: require('./linename'),`
Initial commit 2020-08-08 23:59:13 +02:00			`project: require('./project'),`
			`sequence: require('./sequence'),`
			`user: require('./user'),`
			`auth: require('./auth'),`
API: Add label querying endpoint. Labels can be associated with events and can have display properties such as a description and colour, this is why we need an endpoint for the client to retrieve them. 2020-08-12 11:41:28 +02:00			`gis: require('./gis'),`
Add API endpoint to retrieve survey configuration. The endpoint /project/:project/configuration/:path()? returns the contents of the survey configuration YAML file for a given project. To retrieve the full configuration: /project/:project/configuration To retrieve a specific subset (e.g., binning parameters): * /project/:project/configuration/binning To retrieve a specific value (e.g., inline bin width): * /project/:project/configuration/binning/I_width 2020-08-16 10:06:43 +02:00			`label: require('./label'),`
Add endpoint to retrieve real-time input data 2020-09-01 10:56:25 +02:00			`navdata: require('./navdata'),`
Add new `/vessel/track` endpoints. This is a variation on /navdata but returns data more suitable for plotting vessel tracks on the map. 2025-08-10 21:39:35 +02:00			`vessel: require('./vessel'),`
Add ASAQC queue endpoints to API 2021-10-03 22:01:21 +02:00			`queue: require('./queue'),`
Add API middleware for returning QC results 2022-03-09 17:41:27 +01:00			`qc: require('./qc'),`
Add `info` API endpoint. It queries a project's `info` table. 2020-09-09 15:55:04 +02:00			`configuration: require('./configuration'),`
Add endpoints for setting and retrieving metadata 2020-09-20 18:11:33 +02:00			`info: require('./info'),`
Serve OpenAPI document on API root. When a client makes a request for `/` (the root of the API), the OpenAPI description is served in an appropriate format according to the `Accept` request header, as follows: Accept: text/html => HTML version Accept: application/json => JSON version Accept: * => YAML version 2020-12-29 16:20:57 +01:00			`meta: require('./meta'),`
Show development activity log. A button in the help dialogue takes the user to the /feed/… frontend URL, where the latest development activity is shown, taken from the GitLab RSS feed for the project. 2021-05-08 00:46:31 +02:00			`openapi: require('./openapi'),`
Add ETag middleware 2023-09-01 12:27:44 +02:00			`rss: require('./rss'),`
Add /version API endpoint 2023-11-02 19:48:30 +01:00			`etag: require('./etag'),`
Add diagnostics API endpoint. Only available with write access and above. Reports used and available filesystem sizes and database space usage. 2024-05-08 16:27:32 +02:00			`version: require('./version'),`
Add compression to some endpoints. Consideration will be given to adding (conditional) compression to all endpoints. 2025-08-11 01:53:50 +02:00			`admin: require('./admin'),`
			`compress: require('./compress'),`
Add comparison API endpoints 2025-08-18 14:11:20 +02:00			`comparisons: require('./comparisons'),`
Initial commit 2020-08-08 23:59:13 +02:00			`};`