Add OpenAPI support

envs/dev/backend.env

@@ -2,6 +2,7 @@ NODE_ENV='dev'
 PORT=8080
 MONGODB_URL='mongodb://mongodb:27017/nomad'
 HOST='0.0.0.0'
+VITE_API_URL=http://localhost:8080
 #Frontend host url
 FRONT_HOST_URL='http://localhost:3003'
 

envs/example/backend.env

@@ -2,6 +2,7 @@ NODE_ENV='dev'
 PORT=8080
 MONGODB_URL='mongodb://mongodb:27017/nomad'
 HOST='0.0.0.0'
+VITE_API_URL=http://localhost:8080
 #Frontend host url
 FRONT_HOST_URL='http://localhost:3003'
 

envs/example/frontend.env

@@ -1,7 +1,8 @@
-VITE_API_URL=http://localhost:8080
+VITE_API_URL=http://localhost:8080/api
+VITE_SOCKETS_URL=http://localhost:8080
 VITE_NMRIUM_URL=http://localhost:3000
 
 #Set true if corresponding NOMAD modules are used
 VITE_SUBMIT_ON=true
 VITE_BATCH_SUBMIT_ON=true
-VITE_DATASTORE_ON=true
+VITE_DATASTORE_ON=true

nomad-rest-api/app.js

@@ -6,10 +6,12 @@ import bodyParser from 'body-parser'
 import helmet from 'helmet'
 import moment from 'moment'
 import momentDurationFormatSetup from 'moment-duration-format'
+import swaggerUi from "swagger-ui-express";
 
 import trackerRoutes from './routes/tracker.js'
 import instrumentsRoutes from './routes/admin/insruments.js'
 import dashRoutes from './routes/dashboard.js'
+import { authLoginOpenApiDoc } from "./controllers/auth.js";
 import authRoutes from './routes/auth.js'
 import usersRoutes from './routes/admin/users.js'
 import groupsRoutes from './routes/admin/groups.js'
@@ -26,6 +28,12 @@ import datasetsRoutes from './routes/datasets.js'
 import statsRoutes from './routes/admin/stats.js'
 import collectionRoutes from './routes/collections.js'
 
+import autoExperimentRoutes from "./routes/v2/auto-experiments.js";
+import {
+  autoExperimentsOpenApiDoc,
+  downloadAutoExperimentOpenApiDoc,
+} from "./controllers/v2/auto-experiments.js";
+
 // file deepcode ignore UseCsurfForExpress: <Unclear how to fix>
 const app = express()
 momentDurationFormatSetup(moment)
@@ -61,6 +69,41 @@ app.use('/api/datasets', datasetsRoutes)
 app.use('/api/stats', statsRoutes)
 app.use('/api/collections', collectionRoutes)
 
+const swaggerDocument = {
+  openapi: "3.0.0",
+  info: {
+    title: "NOMAD REST API",
+    version: "2.0.0",
+    description: "REST API documentation",
+  },
+  servers: [
+    {
+      url: process.env.VITE_API_URL,
+    },
+  ],
+  components: {
+    securitySchemes: {
+      bearerAuth: {
+        type: "http",
+        scheme: "bearer",
+        bearerFormat: "JWT",
+      },
+    },
+  },
+  security: [
+    { bearerAuth: [] },
+  ],
+  paths: {
+    "/api/auth/login": authLoginOpenApiDoc,
+    "/api/v2/auto-experiments": autoExperimentsOpenApiDoc,
+    "/api/v2/auto-experiments/download": downloadAutoExperimentOpenApiDoc,
+  },
+}
+
+app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
+app.use("/api/v2/auto-experiments", autoExperimentRoutes);
+
+
 app.use((req, res) => {
   res.status(404).send()
 })

nomad-rest-api/controllers/auth.js

@@ -8,6 +8,67 @@ import transporter from '../utils/emailTransporter.js'
 
 const { verify } = jsonwebtoken
 
+export const authLoginOpenApiDoc = {
+  post: {
+    summary: 'Login to NOMAD',
+    description: 'Returns an access token for the user',
+    tags: ['Auth'],
+    requestBody: {
+      required: true,
+      content: {
+        'application/json': {
+          schema: {
+            type: 'object',
+            properties: {
+              username: {
+                type: 'string',
+              },
+              password: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      },
+    },
+    responses: {
+      200: {
+        description: 'Login successful',
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              properties: {
+                username: {
+                  type: 'string',
+                },
+                accessLevel: {
+                  type: 'string',
+                },
+                manualAccess: {
+                  type: 'boolean',
+                },
+                groupName: {
+                  type: 'string',
+                },
+                token: {
+                  type: 'string',
+                },
+                expiresIn: {
+                  type: 'number',
+                },
+              },
+            },
+          },
+        },
+      },
+      400: {
+        description: 'Wrong username or password',
+      },
+    },
+  },
+}
+
 export async function postLogin(req, res) {
   try {
     const user = await User.findOne({ username: req.body.username })