feat: Added overviews endpoint

backend/lib/controllers/index.js

@@ -17,6 +17,7 @@
  */
 
 const HomeController = require('./home.controller');
+const OverviewsController = require('./overviews.controller');
 const UsersController = require('./users.controller');
 const TagsController = require('./tags.controller');
 const SettingsController = require('./settings.controller');
@@ -25,6 +26,7 @@ const RunsController = require('./runs.controller');
 
 module.exports = {
     HomeController,
+    OverviewsController,
     RunsController,
     SettingsController,
     SubsystemsController,

backend/lib/controllers/overviews.controller.js

@@ -0,0 +1,43 @@
+/**
+ * This file is part of the ALICE Electronic Logbook v2, also known as Jiskefet.
+ * Copyright (C) 2020  Stichting Hogeschool van Amsterdam
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Get all overviews.
+ *
+ * @param {Object} request The *request* object represents the HTTP request and has properties for the request query
+ *                         string, parameters, body, HTTP headers, and so on.
+ * @param {Object} response The *response* object represents the HTTP response that an Express app sends when it gets an
+ *                          HTTP request.
+ * @param {Function} next The *next* object represents the next middleware function which is used to pass control to the
+ *                        next middleware function.
+ * @returns {undefined}
+ */
+const index = (request, response, next) => {
+    response.status(501).json({
+        errors: [
+            {
+                status: '501',
+                title:  'Not implemented',
+            },
+        ],
+    });
+};
+
+module.exports = {
+    index,
+};

backend/lib/routers/index.js

@@ -17,6 +17,7 @@
  */
 
 const homeRoute = require('./home.router');
+const overviewRoute = require('./overviews.router');
 const runsRoute = require('./runs.router');
 const settingsRoute = require('./settings.router');
 const subsystemsRoute = require('./subsystems.router');
@@ -26,6 +27,7 @@ const { appendPath, deepmerge } = require('../utils');
 
 const routes = [
     homeRoute,
+    overviewRoute,
     runsRoute,
     settingsRoute,
     subsystemsRoute,

backend/lib/routers/overviews.router.js

@@ -0,0 +1,26 @@
+/**
+ * This file is part of the ALICE Electronic Logbook v2, also known as Jiskefet.
+ * Copyright (C) 2020  Stichting Hogeschool van Amsterdam
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+const { OverviewsController } = require('../controllers');
+
+module.exports = {
+    method: 'get',
+    path: '/overviews',
+    controller: OverviewsController.index,
+    args: { public: true },
+};