@xen-orchestra/rest-api 0.25.0 → 0.26.0

package/dist/index.mjs

@@ -5,6 +5,7 @@ import tsoaToXoErrorHandler from './middlewares/tsoa-to-xo-error.middleware.mjs'
 import { RegisterRoutes } from './open-api/routes/routes.js';
 import { setupContainer } from './ioc/ioc.mjs';
 import { setupApiContext } from './middlewares/authentication.middleware.mjs';
+import { logMiddleware } from './middlewares/log.middleware.mjs';
 // Avoid using "import from" to import a json file as this requires assert/with and will break compatibility with recent node versions
 // https://github.com/nodejs/node/issues/51622
 const require = createRequire(import.meta.url);
@@ -34,6 +35,7 @@ const SWAGGER_UI_OPTIONS = {
 export default function setupRestApi(express, xoApp) {
     setupContainer(xoApp);
     express.use(BASE_URL, setupApiContext(xoApp));
+    express.use(BASE_URL, logMiddleware);
     RegisterRoutes(express);
     express.get(`${BASE_URL}/docs/swagger.json`, (_req, res) => {
         res.setHeader('Content-Type', 'application/json');

package/dist/middlewares/log.middleware.mjs

@@ -0,0 +1,12 @@
+import { createLogger } from '@xen-orchestra/log';
+const log = createLogger('xo:rest-api');
+export function logMiddleware(req, res, next) {
+    const start = Date.now();
+    res.on('finish', () => {
+        const duration = Date.now() - start;
+        const { method, originalUrl } = req;
+        const { statusCode } = res;
+        log.debug(`[${new Date().toISOString()}] ${method} ${originalUrl} ${statusCode} ${duration}ms`);
+    });
+    next();
+}

package/dist/open-api/routes/routes.js

@@ -4747,6 +4747,34 @@ export function RegisterRoutes(app) {
         }
     });
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    const argsSrController_scanSr = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+        sync: { "in": "query", "name": "sync", "dataType": "boolean" },
+    };
+    app.post('/rest/v0/srs/:id/actions/scan', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(SrController)), ...(fetchMiddlewares(SrController.prototype.scanSr)), async function SrController_scanSr(request, response, next) {
+        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        let validatedArgs = [];
+        try {
+            validatedArgs = templateService.getValidatedArgs({ args: argsSrController_scanSr, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(SrController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'scanSr',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: 202,
+            });
+        }
+        catch (err) {
+            return next(err);
+        }
+    });
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     const argsSmController_getSrs = {
         req: { "in": "request", "name": "req", "required": true, "dataType": "object" },
         fields: { "in": "query", "name": "fields", "dataType": "string" },

package/dist/srs/sr.controller.mjs

@@ -21,7 +21,7 @@ import { vdiId } from '../open-api/oa-examples/vdi.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
-import { taskIds, partialTasks } from '../open-api/oa-examples/task.oa-example.mjs';
+import { taskIds, partialTasks, taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 let SrController = class SrController extends XapiXoController {
     #alarmService;
     constructor(restApi, alarmService) {
@@ -132,6 +132,24 @@ let SrController = class SrController extends XapiXoController {
             },
         });
     }
+    /**
+     * @example id "b61a5c92-700e-4966-a13b-00633f03eea8"
+     */
+    async scanSr(id, sync) {
+        const srId = id;
+        const action = async () => {
+            const sr = this.getXapiObject(srId);
+            await sr.$xapi.callAsync('SR.scan', sr.$ref);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'SR scan',
+                objectId: srId,
+            },
+        });
+    }
 };
 __decorate([
     Example(srIds),
@@ -214,6 +232,7 @@ __decorate([
     __param(1, Path())
 ], SrController.prototype, "deleteSrTag", null);
 __decorate([
+    Example(taskLocation),
     Post('{id}/actions/reclaim_space'),
     SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
     Response(noContentResp.status, noContentResp.description),
@@ -223,6 +242,17 @@ __decorate([
     __param(0, Path()),
     __param(1, Query())
 ], SrController.prototype, "reclaimSpaceSr", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/scan'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(invalidParametersResp.status, invalidParametersResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], SrController.prototype, "scanSr", null);
 SrController = __decorate([
     Route('srs'),
     Security('*'),

package/open-api/spec/swagger.json

@@ -12346,7 +12346,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.25.0",
+		"version": "0.26.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -23024,6 +23024,82 @@
 							"application/json": {
 								"schema": {
 									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"srs"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "b61a5c92-700e-4966-a13b-00633f03eea8"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
+		"/srs/{id}/actions/scan": {
+			"post": {
+				"operationId": "ScanSr",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
 								}
 							}
 						}

package/package.json

@@ -6,7 +6,7 @@
   "main": "./dist/index.mjs",
   "name": "@xen-orchestra/rest-api",
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/rest-api",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "REST API to manage your XOA",
   "license": "AGPL-3.0-or-later",
   "private": false,
@@ -36,10 +36,10 @@
     "@vates/async-each": "^1.0.1",
     "@vates/task": "^0.6.1",
     "@vates/types": "^1.20.0",
-    "@xen-orchestra/backups": "^0.69.0",
+    "@xen-orchestra/backups": "^0.69.1",
     "@xen-orchestra/log": "^0.7.1",
     "@xen-orchestra/xapi": "^8.6.6",
-    "complex-matcher": "^1.0.0",
+    "complex-matcher": "^1.1.0",
     "golike-defer": "^0.5.1",
     "inversify": "^6.2.2",
     "inversify-binding-decorators": "^4.0.0",