@xen-orchestra/rest-api 0.13.1 → 0.14.0

package/dist/vm-controller/vm-controller.controller.mjs

@@ -12,16 +12,19 @@ import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
 import { AlarmService } from '../alarms/alarm.service.mjs';
-import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
+import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
 import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { provide } from 'inversify-binding-decorators';
-import { partialVmControllers, vmController, vmControllerIds, } from '../open-api/oa-examples/vm-controller.oa-example.mjs';
+import { partialVmControllers, vmController, vmControllerIds, vmControllerVdis, } from '../open-api/oa-examples/vm-controller.oa-example.mjs';
+import { VmService } from '../vms/vm.service.mjs';
 let VmControllerController = class VmControllerController extends XapiXoController {
     #alarmService;
-    constructor(restApi, alarmService) {
+    #vmService;
+    constructor(restApi, alarmService, vmService) {
         super('VM-controller', restApi);
         this.#alarmService = alarmService;
+        this.#vmService = vmService;
     }
     /**
      *
@@ -52,6 +55,16 @@ let VmControllerController = class VmControllerController extends XapiXoControll
         });
         return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
+    /**
+     * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
+     * @example fields "VDI_type,id,name_label"
+     * @example filter "VDI_type:user"
+     * @example limit 42
+     */
+    getVmControllerVdis(req, id, fields, ndjson, filter, limit) {
+        const vdis = this.#vmService.getVmVdis(id, 'VM-controller');
+        return this.sendObjects(limitAndFilterArray(vdis, { filter, limit }), req, obj => obj.type.toLowerCase() + 's');
+    }
 };
 __decorate([
     Example(vmControllerIds),
@@ -81,6 +94,18 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmControllerController.prototype, "getVmControllerAlarms", null);
+__decorate([
+    Example(vmControllerVdis),
+    Get('{id}/vdis'),
+    Tags('vdis'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmControllerController.prototype, "getVmControllerVdis", null);
 VmControllerController = __decorate([
     Route('vm-controllers'),
     Security('*'),
@@ -88,6 +113,7 @@ VmControllerController = __decorate([
     Tags('vms'),
     provide(VmControllerController),
     __param(0, inject(RestApi)),
-    __param(1, inject(AlarmService))
+    __param(1, inject(AlarmService)),
+    __param(2, inject(VmService))
 ], VmControllerController);
 export { VmControllerController };

package/dist/vm-snapshots/vm-snapshot.controller.mjs

@@ -10,18 +10,21 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
 import { inject } from 'inversify';
 import { AlarmService } from '../alarms/alarm.service.mjs';
-import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
+import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
 import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { provide } from 'inversify-binding-decorators';
-import { partialVmSnapshots, vmSnapshot, vmSnapshotIds } from '../open-api/oa-examples/vm-snapshot.oa-example.mjs';
+import { partialVmSnapshots, vmSnapshot, vmSnapshotIds, vmSnapshotVdis, } from '../open-api/oa-examples/vm-snapshot.oa-example.mjs';
+import { VmService } from '../vms/vm.service.mjs';
 let VmSnapshotController = class VmSnapshotController extends XapiXoController {
     #alarmService;
-    constructor(restApi, alarmService) {
+    #vmService;
+    constructor(restApi, alarmService, vmService) {
         super('VM-snapshot', restApi);
         this.#alarmService = alarmService;
+        this.#vmService = vmService;
     }
     /**
      *
@@ -52,6 +55,16 @@ let VmSnapshotController = class VmSnapshotController extends XapiXoController {
         });
         return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
+    /**
+     * @example id "d68fca2c-41e6-be87-d790-105c1642a090"
+     * @example fields "VDI_type,id,name_label"
+     * @example filter "VDI_type:user"
+     * @example limit 42
+     */
+    getVmSnapshotVdis(req, id, fields, ndjson, filter, limit) {
+        const vdis = this.#vmService.getVmVdis(id, 'VM-snapshot');
+        return this.sendObjects(limitAndFilterArray(vdis, { filter, limit }), req, obj => obj.type.toLowerCase() + 's');
+    }
 };
 __decorate([
     Example(vmSnapshotIds),
@@ -81,6 +94,18 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmSnapshotController.prototype, "getVmSnapshotAlarms", null);
+__decorate([
+    Example(vmSnapshotVdis),
+    Get('{id}/vdis'),
+    Tags('vdis'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmSnapshotController.prototype, "getVmSnapshotVdis", null);
 VmSnapshotController = __decorate([
     Route('vm-snapshots'),
     Security('*'),
@@ -88,6 +113,7 @@ VmSnapshotController = __decorate([
     Tags('vms'),
     provide(VmSnapshotController),
     __param(0, inject(RestApi)),
-    __param(1, inject(AlarmService))
+    __param(1, inject(AlarmService)),
+    __param(2, inject(VmService))
 ], VmSnapshotController);
 export { VmSnapshotController };

package/dist/vm-templates/vm-template.controller.mjs

@@ -11,17 +11,20 @@ import { Example, Get, Security, Query, Request, Response, Route, Tags, Path } f
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
 import { AlarmService } from '../alarms/alarm.service.mjs';
-import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
+import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
 import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
-import { partialVmTemplates, vmTemplate, vmTemplateIds } from '../open-api/oa-examples/vm-template.oa-example.mjs';
+import { partialVmTemplates, vmTemplate, vmTemplateIds, vmTemplateVdis, } from '../open-api/oa-examples/vm-template.oa-example.mjs';
+import { VmService } from '../vms/vm.service.mjs';
 let VmTemplateController = class VmTemplateController extends XapiXoController {
     #alarmService;
-    constructor(restApi, alarmService) {
+    #vmService;
+    constructor(restApi, alarmService, vmService) {
         super('VM-template', restApi);
         this.#alarmService = alarmService;
+        this.#vmService = vmService;
     }
     /**
      * @example fields "id,isDefaultTemplate,name_label"
@@ -51,6 +54,16 @@ let VmTemplateController = class VmTemplateController extends XapiXoController {
         });
         return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
+    /**
+     * @example id "6d50ba76-0f11-1ff1-4f6a-b502afc31b8e"
+     * @example fields "VDI_type,id,name_label"
+     * @example filter "VDI_type:user"
+     * @example limit 42
+     */
+    getVmTemplateVdis(req, id, fields, ndjson, filter, limit) {
+        const vdis = this.#vmService.getVmVdis(id, 'VM-template');
+        return this.sendObjects(limitAndFilterArray(vdis, { filter, limit }), req, obj => obj.type.toLowerCase() + 's');
+    }
 };
 __decorate([
     Example(vmTemplateIds),
@@ -80,6 +93,18 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmTemplateController.prototype, "getVmTemplateAlarms", null);
+__decorate([
+    Example(vmTemplateVdis),
+    Get('{id}/vdis'),
+    Tags('vdis'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmTemplateController.prototype, "getVmTemplateVdis", null);
 VmTemplateController = __decorate([
     Route('vm-templates'),
     Security('*'),
@@ -87,6 +112,7 @@ VmTemplateController = __decorate([
     Tags('vms'),
     provide(VmTemplateController),
     __param(0, inject(RestApi)),
-    __param(1, inject(AlarmService))
+    __param(1, inject(AlarmService)),
+    __param(2, inject(VmService))
 ], VmTemplateController);
 export { VmTemplateController };

package/dist/vms/vm.controller.mjs

@@ -14,18 +14,21 @@ import { provide } from 'inversify-binding-decorators';
 import { AlarmService } from '../alarms/alarm.service.mjs';
 import { asynchronousActionResp, createdResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { BASE_URL } from '../index.mjs';
-import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
+import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { partialVms, vm, vmIds, vmStatsExample } from '../open-api/oa-examples/vm.oa-example.mjs';
+import { partialVms, vm, vmIds, vmStatsExample, vmVdis } from '../open-api/oa-examples/vm.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+import { VmService } from './vm.service.mjs';
 const IGNORED_VDIS_TAG = '[NOSNAP]';
 let VmController = class VmController extends XapiXoController {
     #alarmService;
-    constructor(restApi, alarmService) {
+    #vmService;
+    constructor(restApi, alarmService, vmService) {
         super('VM', restApi);
         this.#alarmService = alarmService;
+        this.#vmService = vmService;
     }
     /**
      *
@@ -313,6 +316,16 @@ let VmController = class VmController extends XapiXoController {
         });
         return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     * @example fields "VDI_type,id,name_label"
+     * @example filter "VDI_type:user"
+     * @example limit 42
+     */
+    getVmVdis(req, id, fields, ndjson, filter, limit) {
+        const vdis = this.#vmService.getVmVdis(id, 'VM');
+        return this.sendObjects(limitAndFilterArray(vdis, { filter, limit }), req, obj => obj.type.toLowerCase() + 's');
+    }
 };
 __decorate([
     Example(vmIds),
@@ -464,6 +477,18 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmController.prototype, "getVmAlarms", null);
+__decorate([
+    Example(vmVdis),
+    Get('{id}/vdis'),
+    Tags('vdis'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmController.prototype, "getVmVdis", null);
 VmController = __decorate([
     Route('vms'),
     Security('*'),
@@ -474,6 +499,7 @@ VmController = __decorate([
     ,
     provide(VmController),
     __param(0, inject(RestApi)),
-    __param(1, inject(AlarmService))
+    __param(1, inject(AlarmService)),
+    __param(2, inject(VmService))
 ], VmController);
 export { VmController };

package/dist/vms/vm.service.mjs

@@ -13,7 +13,7 @@ export class VmService {
         const xoApp = this.#restApi.xoApp;
         const xapi = xoApp.getXapi(pool);
         const currentUser = this.#restApi.getCurrentUser();
-        const xapiVm = await xapi.createVm(template, rest, undefined, currentUser?.id);
+        const xapiVm = await xapi.createVm(template, rest, undefined, currentUser.id);
         $defer.onFailure(() => xapi.VM_destroy(xapiVm.$ref));
         const xoVm = this.#restApi.getObject(xapiVm.uuid, 'VM');
         let cloudConfigVdi;
@@ -84,4 +84,17 @@ export class VmService {
             total,
         };
     }
+    getVmVdis(id, vmType) {
+        const getObject = this.#restApi.getObject.bind(this.#restApi);
+        const vdis = [];
+        const vm = getObject(id, vmType);
+        for (const vbdId of vm.$VBDs) {
+            const vbd = getObject(vbdId, 'VBD');
+            if (vbd.VDI !== undefined) {
+                const vdi = getObject(vbd.VDI, ['VDI-snapshot', 'VDI']);
+                vdis.push(vdi);
+            }
+        }
+        return vdis;
+    }
 }