@xen-orchestra/rest-api 0.19.0 → 0.20.0

package/dist/middlewares/authentication.middleware.mjs

@@ -8,6 +8,9 @@ const log = createLogger('xo:rest-api:authentication');
 // for now only support "xoa-admin"
 // TSOA spec require this function to be async
 export async function expressAuthentication(req, securityName) {
+    if (securityName === 'none') {
+        return undefined;
+    }
     const restApi = iocContainer.get(RestApi);
     const user = restApi.getCurrentUser();
     const authType = req.res.locals.authType;

package/dist/open-api/oa-examples/gui-routes.oa-example.mjs

@@ -0,0 +1,4 @@
+export const guiRoutes = {
+    xo5: '/',
+    xo6: '/v6',
+};

package/dist/open-api/oa-examples/ping.oa-example.mjs

@@ -0,0 +1,4 @@
+export const pingResponse = {
+    result: 'pong',
+    timestamp: 1760955186850,
+};

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

@@ -96,6 +96,16 @@ const models = {
         "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "poolsStatus": { "dataType": "nestedObjectLiteral", "nestedProperties": { "unknown": { "dataType": "double", "required": true }, "unreachable": { "dataType": "double", "required": true }, "connected": { "dataType": "double", "required": true } }, "required": true }, "resourcesOverview": { "dataType": "nestedObjectLiteral", "nestedProperties": { "srSize": { "dataType": "double", "required": true }, "memorySize": { "dataType": "double", "required": true }, "nCpus": { "dataType": "double", "required": true } }, "required": true }, "backups": { "dataType": "union", "subSchemas": [{ "ref": "DashboardBackupsInfo" }, { "ref": "PromiseWriteInStreamError" }] }, "storageRepositories": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "size": { "dataType": "nestedObjectLiteral", "nestedProperties": { "used": { "dataType": "double", "required": true }, "total": { "dataType": "double", "required": true }, "replicated": { "dataType": "double", "required": true }, "other": { "dataType": "double", "required": true }, "available": { "dataType": "double", "required": true } }, "required": true } } }, { "ref": "PromiseWriteInStreamError" }], "required": true }, "backupRepositories": { "dataType": "union", "subSchemas": [{ "ref": "DashboardBackupRepositoriesSizeInfo" }, { "ref": "PromiseWriteInStreamError" }] }, "missingPatches": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "hasAuthorization": { "dataType": "enum", "enums": [false], "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "nHostsFailed": { "dataType": "double", "required": true }, "nPoolsWithMissingPatches": { "dataType": "double", "required": true }, "nHostsWithMissingPatches": { "dataType": "double", "required": true }, "hasAuthorization": { "dataType": "enum", "enums": [true], "required": true } } }], "required": true }, "vmsStatus": { "dataType": "nestedObjectLiteral", "nestedProperties": { "total": { "dataType": "double", "required": true }, "unknown": { "dataType": "double", "required": true }, "inactive": { "dataType": "double", "required": true }, "active": { "dataType": "double", "required": true } }, "required": true }, "hostsStatus": { "dataType": "nestedObjectLiteral", "nestedProperties": { "total": { "dataType": "double", "required": true }, "unknown": { "dataType": "double", "required": true }, "halted": { "dataType": "double", "required": true }, "running": { "dataType": "double", "required": true } }, "required": true }, "nHostsEol": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "ref": "PromiseWriteInStreamError" }] }, "nHosts": { "dataType": "double", "required": true }, "nPools": { "dataType": "double", "required": true } }, "validators": {} },
     },
     // 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
+    "PingResponse": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "timestamp": { "dataType": "double", "required": true }, "result": { "dataType": "enum", "enums": ["pong"], "required": true } }, "validators": {} },
+    },
+    // 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
+    "XoGuiRoutes": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "xo6": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }], "required": true }, "xo5": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }], "required": true } }, "validators": {} },
+    },
+    // 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
     "Record_string.string_": {
         "dataType": "refAlias",
         "type": { "dataType": "nestedObjectLiteral", "nestedProperties": {}, "validators": {} },
@@ -695,7 +705,7 @@ const models = {
     // 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
     "Unbrand_CreateVmBody_": {
         "dataType": "refAlias",
-        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "memory": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "name_label": { "dataType": "string", "required": true }, "clone": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "gpuGroup": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "vgpuType": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "autoPoweron": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "vifs": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "network": { "dataType": "string", "required": true }, "mtu": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "mac": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "ipv6_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "ipv4_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "device": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "device": { "dataType": "string", "required": true }, "destroy": { "dataType": "enum", "enums": [true], "required": true } } }] } }, { "dataType": "undefined" }] }, "copyHostBiosStrings": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "template": { "dataType": "string", "required": true }, "affinity": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "vdis": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "sr": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "size": { "dataType": "double", "required": true }, "name_label": { "dataType": "string", "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "sr": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "size": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "name_label": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "userdevice": { "dataType": "string", "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "userdervice": { "dataType": "string", "required": true }, "destroy": { "dataType": "enum", "enums": [true], "required": true } } }] } }, { "dataType": "undefined" }] }, "install": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "repository": { "dataType": "string", "required": true }, "method": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["network"] }, { "dataType": "enum", "enums": ["cdrom"] }], "required": true } } }, { "dataType": "undefined" }] }, "cloud_config": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "network_config": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "boot": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "destroy_cloud_config_vdi": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] } }, "validators": {} },
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "memory": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "name_label": { "dataType": "string", "required": true }, "clone": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "gpuGroup": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "vgpuType": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "autoPoweron": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "vifs": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "network": { "dataType": "string", "required": true }, "mtu": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "mac": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "ipv6_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "ipv4_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "device": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "device": { "dataType": "string", "required": true }, "destroy": { "dataType": "enum", "enums": [true], "required": true } } }] } }, { "dataType": "undefined" }] }, "copyHostBiosStrings": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "hvmBootFirmware": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["uefi"] }, { "dataType": "enum", "enums": ["bios"] }, { "dataType": "undefined" }] }, "template": { "dataType": "string", "required": true }, "affinity": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "vdis": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "sr": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "size": { "dataType": "double", "required": true }, "name_label": { "dataType": "string", "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "sr": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "size": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "name_label": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "userdevice": { "dataType": "string", "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "userdervice": { "dataType": "string", "required": true }, "destroy": { "dataType": "enum", "enums": [true], "required": true } } }] } }, { "dataType": "undefined" }] }, "install": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "repository": { "dataType": "string", "required": true }, "method": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["network"] }, { "dataType": "enum", "enums": ["cdrom"] }], "required": true } } }, { "dataType": "undefined" }] }, "cloud_config": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "network_config": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "boot": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "destroy_cloud_config_vdi": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] } }, "validators": {} },
     },
     // 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
     "XapiHostStatsRaw": {
@@ -1167,6 +1177,56 @@ 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 argsXoaController_ping = {};
+    app.get('/rest/v0/ping', authenticateMiddleware([{ "none": [] }]), ...(fetchMiddlewares(XoaController)), ...(fetchMiddlewares(XoaController.prototype.ping)), async function XoaController_ping(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: argsXoaController_ping, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(XoaController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'ping',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: undefined,
+            });
+        }
+        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 argsXoaController_getGuiRoutes = {};
+    app.get('/rest/v0/gui-routes', authenticateMiddleware([{ "none": [] }]), ...(fetchMiddlewares(XoaController)), ...(fetchMiddlewares(XoaController.prototype.getGuiRoutes)), async function XoaController_getGuiRoutes(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: argsXoaController_getGuiRoutes, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(XoaController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'getGuiRoutes',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: undefined,
+            });
+        }
+        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 argsVmController_getVms = {
         req: { "in": "request", "name": "req", "required": true, "dataType": "object" },
         fields: { "in": "query", "name": "fields", "dataType": "string" },

package/dist/xoa/xoa.controller.mjs

@@ -11,6 +11,8 @@ import { Controller, Example, Get, Query, Request, Response, Route, Security, Ta
 import { inject } from 'inversify';
 import { PassThrough } from 'node:stream';
 import { provide } from 'inversify-binding-decorators';
+import { guiRoutes } from '../open-api/oa-examples/gui-routes.oa-example.mjs';
+import { pingResponse } from '../open-api/oa-examples/ping.oa-example.mjs';
 import { badRequestResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { xoaDashboard } from '../open-api/oa-examples/xoa.oa-example.mjs';
 import { XoaService } from './xoa.service.mjs';
@@ -37,18 +39,37 @@ let XoaController = class XoaController extends Controller {
             return dashboard;
         }
     }
+    ping() {
+        return {
+            result: 'pong',
+            timestamp: Date.now(),
+        };
+    }
+    getGuiRoutes() {
+        return this.#xoaService.getGuiRoutes();
+    }
 };
 __decorate([
     Example(xoaDashboard),
     Get('dashboard'),
+    Response(badRequestResp.status, badRequestResp.description),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
     __param(0, Request()),
     __param(1, Query())
 ], XoaController.prototype, "getDashboard", null);
+__decorate([
+    Security('none'),
+    Example(pingResponse),
+    Get('ping')
+], XoaController.prototype, "ping", null);
+__decorate([
+    Security('none'),
+    Example(guiRoutes),
+    Get('gui-routes')
+], XoaController.prototype, "getGuiRoutes", null);
 XoaController = __decorate([
     Route(''),
     Security('*'),
-    Response(badRequestResp.status, badRequestResp.description),
-    Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('xoa'),
     provide(XoaController),
     __param(0, inject(XoaService))

package/dist/xoa/xoa.service.mjs

@@ -481,4 +481,21 @@ export class XoaService {
             vmsStatus,
         };
     }
+    getGuiRoutes() {
+        const mounts = this.#restApi.xoApp.config.getOptional('http.mounts') ?? {};
+        let xo5Mount;
+        let xo6Mount;
+        for (const [key, value] of Object.entries(mounts)) {
+            if (value.includes('xo-web/dist')) {
+                xo5Mount = key;
+            }
+            else if (value.includes('@xen-orchestra/web/dist')) {
+                xo6Mount = key;
+            }
+        }
+        return {
+            xo5: xo5Mount,
+            xo6: xo6Mount,
+        };
+    }
 }

package/open-api/spec/swagger.json

@@ -437,6 +437,37 @@
 				],
 				"type": "object"
 			},
+			"PingResponse": {
+				"properties": {
+					"timestamp": {
+						"type": "number",
+						"format": "double"
+					},
+					"result": {
+						"type": "string",
+						"enum": [
+							"pong"
+						],
+						"nullable": false
+					}
+				},
+				"required": [
+					"timestamp",
+					"result"
+				],
+				"type": "object"
+			},
+			"XoGuiRoutes": {
+				"properties": {
+					"xo6": {
+						"type": "string"
+					},
+					"xo5": {
+						"type": "string"
+					}
+				},
+				"type": "object"
+			},
 			"Record_string.string_": {
 				"properties": {},
 				"type": "object",
@@ -7308,6 +7339,13 @@
 					"copyHostBiosStrings": {
 						"type": "boolean"
 					},
+					"hvmBootFirmware": {
+						"type": "string",
+						"enum": [
+							"uefi",
+							"bios"
+						]
+					},
 					"template": {
 						"type": "string",
 						"description": "template UUID"
@@ -11443,7 +11481,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.19.0",
+		"version": "0.20.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -11565,6 +11603,74 @@
 				]
 			}
 		},
+		"/ping": {
+			"get": {
+				"operationId": "Ping",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/PingResponse"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"result": "pong",
+											"timestamp": 1760955186850
+										}
+									}
+								}
+							}
+						}
+					}
+				},
+				"tags": [
+					"xoa"
+				],
+				"security": [
+					{
+						"none": []
+					}
+				],
+				"parameters": []
+			}
+		},
+		"/gui-routes": {
+			"get": {
+				"operationId": "GetGuiRoutes",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/XoGuiRoutes"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"xo5": "/",
+											"xo6": "/v6"
+										}
+									}
+								}
+							}
+						}
+					}
+				},
+				"tags": [
+					"xoa"
+				],
+				"security": [
+					{
+						"none": []
+					}
+				],
+				"parameters": []
+			}
+		},
 		"/vms": {
 			"get": {
 				"operationId": "GetVms",

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.19.0",
+  "version": "0.20.0",
   "description": "REST API to manage your XOA",
   "license": "AGPL-3.0-or-later",
   "private": false,
@@ -35,8 +35,8 @@
   "dependencies": {
     "@vates/async-each": "^1.0.1",
     "@vates/task": "^0.6.1",
-    "@vates/types": "^1.13.0",
-    "@xen-orchestra/backups": "^0.65.0",
+    "@vates/types": "^1.14.0",
+    "@xen-orchestra/backups": "^0.66.0",
     "@xen-orchestra/log": "^0.7.1",
     "complex-matcher": "^1.0.0",
     "golike-defer": "^0.5.1",