@xen-orchestra/rest-api 0.28.2 → 0.30.0

package/dist/vifs/vif.controller.mjs

@@ -10,17 +10,18 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { Body, Delete, Example, Get, Middlewares, Path, Post, Query, Request, Response, Route, Security, SuccessResponse, Tags, } from 'tsoa';
 import { inject } from 'inversify';
 import { json } from 'express';
+import { acl } from '../middlewares/acl.middleware.mjs';
 import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
 import { provide } from 'inversify-binding-decorators';
 import { RestApi } from '../rest-api/rest-api.mjs';
-import { badRequestResp, createdResp, internalServerErrorResp, invalidParameters as invalidParametersResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { asynchronousActionResp, badRequestResp, createdResp, internalServerErrorResp, invalidParameters as invalidParametersResp, noContentResp, forbiddenOperationResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { invalidParameters } from 'xo-common/api-errors.js';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { partialVifs, vif, vifId, vifIds } from '../open-api/oa-examples/vif.oa-example.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
 import { AlarmService } from '../alarms/alarm.service.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 VifController = class VifController extends XapiXoController {
     #alarmService;
     constructor(restApi, alarmService) {
@@ -28,52 +29,81 @@ let VifController = class VifController extends XapiXoController {
         this.#alarmService = alarmService;
     }
     /**
+     * Returns all VIFs that match the following privilege:
+     * - resource: vif, action: read
+     *
      * @example fields "attached,id,device"
      * @example filter "attached?"
      * @example limit 42
      */
-    getVifs(req, fields, ndjson, filter, limit) {
-        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    getVifs(req, fields, ndjson, markdown, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter })), req, {
+            limit,
+            privilege: { action: 'read', resource: 'vif' },
+        });
     }
     /**
+     * Required privilege:
+     * - resource: vif, action: read
+     *
      * @example id "f028c5d4-578a-332c-394e-087aaca32dd3"
      */
     getVif(id) {
         return this.getObject(id);
     }
     /**
+     * Returns all alarms that match the following privilege:
+     * - resource: alarm, action: read
+     *
      * @example id "f028c5d4-578a-332c-394e-087aaca32dd3"
      * @example fields "id,time"
      * @example filter "time:>1747053793"
      * @example limit 42
      */
-    getVifAlarms(req, id, fields, ndjson, filter, limit) {
+    getVifAlarms(req, id, fields, ndjson, markdown, filter, limit) {
         const vif = this.getObject(id);
         const alarms = this.#alarmService.getAlarms({
             filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${vif.uuid}`,
+        });
+        return this.sendObjects(Object.values(alarms), req, {
+            path: 'alarms',
             limit,
+            privilege: { action: 'read', resource: 'alarm' },
         });
-        return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
     /**
+     * Returns all messages that match the following privilege:
+     * - resource: message, action: read
+     *
      * @example id "f028c5d4-578a-332c-394e-087aaca32dd3"
      * @example fields "name,id,$object"
      * @example filter "name:VM_STARTED"
      * @example limit 42
      */
-    getVifMessages(req, id, fields, ndjson, filter, limit) {
-        const messages = this.getMessagesForObject(id, { filter, limit });
-        return this.sendObjects(Object.values(messages), req, 'messages');
+    getVifMessages(req, id, fields, ndjson, markdown, filter, limit) {
+        const messages = this.getMessagesForObject(id, { filter });
+        return this.sendObjects(Object.values(messages), req, {
+            path: 'messages',
+            limit,
+            privilege: { action: 'read', resource: 'message' },
+        });
     }
     /**
+     * Returns all tasks that match the following privilege:
+     * - resource: task, action: read
+     *
      * @example id "f028c5d4-578a-332c-394e-087aaca32dd3"
      * @example fields "id,status,properties"
      * @example filter "status:failure"
      * @example limit 42
      */
-    async getVifTasks(req, id, fields, ndjson, filter, limit) {
-        const tasks = await this.getTasksForObject(id, { filter, limit });
-        return this.sendObjects(Object.values(tasks), req, 'tasks');
+    async getVifTasks(req, id, fields, ndjson, markdown, filter, limit) {
+        const tasks = await this.getTasksForObject(id, { filter });
+        return this.sendObjects(Object.values(tasks), req, {
+            path: 'tasks',
+            limit,
+            privilege: { action: 'read', resource: 'task' },
+        });
     }
     /**
      * @example body {
@@ -106,26 +136,73 @@ let VifController = class VifController extends XapiXoController {
         const xapi = this.getXapi(id);
         await xapi.deleteVif(id);
     }
+    /**
+     * Hotplug the VIF, dynamically attaching it to the running VM
+     * Requires PV drivers to be installed on the VM
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async connectVif(id, sync) {
+        const vifId = id;
+        const action = async () => {
+            const xapi = this.getXapi(vifId);
+            await xapi.connectVif(vifId);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'connect VIF',
+                objectId: vifId,
+            },
+        });
+    }
+    /**
+     * Hot-unplug the VIF, dynamically detaching it from the running VM
+     * Requires PV drivers to be installed on the VM
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async disconnectVif(id, sync) {
+        const vifId = id;
+        const action = async () => {
+            const xapi = this.getXapi(vifId);
+            await xapi.disconnectVif(vifId);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'disconnect VIF',
+                objectId: vifId,
+            },
+        });
+    }
 };
 __decorate([
     Example(vifIds),
     Example(partialVifs),
     Get(''),
+    Security('*', ['acl']),
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], VifController.prototype, "getVifs", null);
 __decorate([
     Example(vif),
     Get('{id}'),
+    Middlewares(acl({ resource: 'vif', action: 'read', objectId: 'params.id' })),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], VifController.prototype, "getVif", null);
 __decorate([
     Example(genericAlarmsExample),
     Get('{id}/alarms'),
+    Security('*', ['acl']),
     Tags('alarms'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -133,12 +210,14 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], VifController.prototype, "getVifAlarms", null);
 __decorate([
     Example(messageIds),
     Example(partialMessages),
     Get('{id}/messages'),
+    Security('*', ['acl']),
     Tags('messages'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -146,12 +225,14 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], VifController.prototype, "getVifMessages", null);
 __decorate([
     Example(taskIds),
     Example(partialTasks),
     Get('{id}/tasks'),
+    Security('*', ['acl']),
     Tags('tasks'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -159,7 +240,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], VifController.prototype, "getVifTasks", null);
 __decorate([
     Example(vifId),
@@ -178,6 +260,26 @@ __decorate([
     Response(internalServerErrorResp.status, internalServerErrorResp.description),
     __param(0, Path())
 ], VifController.prototype, "destroyVif", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/connect'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VifController.prototype, "connectVif", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/disconnect'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VifController.prototype, "disconnectVif", null);
 VifController = __decorate([
     Route('vifs'),
     Security('*'),

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

@@ -10,11 +10,12 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { inject } from 'inversify';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
-import { Delete, Example, Get, Path, Put, Query, Request, Response, Route, Security, SuccessResponse, Tags } from 'tsoa';
+import { Delete, Example, Get, Path, Put, Query, Request, Response, Route, Security, SuccessResponse, Tags, Middlewares } from 'tsoa';
 import { AlarmService } from '../alarms/alarm.service.mjs';
 import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
+import { acl } from '../middlewares/acl.middleware.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { badRequestResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { badRequestResp, forbiddenOperationResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { provide } from 'inversify-binding-decorators';
 import { partialVmControllers, vmController, vmControllerIds, vmControllerVdis, } from '../open-api/oa-examples/vm-controller.oa-example.mjs';
 import { VmService } from '../vms/vm.service.mjs';
@@ -29,65 +30,103 @@ let VmControllerController = class VmControllerController extends XapiXoControll
         this.#vmService = vmService;
     }
     /**
+     * Returns all VM controllers that match the following privilege:
+     * - resource: vm-controller, action: read
      *
      * @example fields "type,uuid"
      * @example filter "power_state:Running"
      * @example limit 42
      */
-    getVmControllers(req, fields, ndjson, filter, limit) {
-        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    getVmControllers(req, fields, ndjson, markdown, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter })), req, {
+            limit,
+            privilege: { action: 'read', resource: 'vm-controller' },
+        });
     }
     /**
+     * Required privilege:
+     * - resource: vm-controller, action: read
+     *
      * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
      */
     getVmController(id) {
         return this.getObject(id);
     }
     /**
+     * Returns all alarms that match the following privilege:
+     * - resource: alarm, action: read
+     *
      * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
      * @example fields "id,time"
      * @example filter "time:>1747053793"
      * @example limit 42
      */
-    getVmControllerAlarms(req, id, fields, ndjson, filter, limit) {
+    getVmControllerAlarms(req, id, fields, ndjson, markdown, filter, limit) {
         const vmController = this.getObject(id);
         const alarms = this.#alarmService.getAlarms({
             filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${vmController.uuid}`,
+        });
+        return this.sendObjects(Object.values(alarms), req, {
+            path: 'alarms',
             limit,
+            privilege: { action: 'read', resource: 'alarm' },
         });
-        return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
     /**
+     * Returns all VDIs that match the following privilege:
+     * - resource: vdi, action: read
+     *
      * @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) {
+    getVmControllerVdis(req, id, fields, ndjson, markdown, filter, limit) {
         const vdis = this.#vmService.getVmVdis(id, 'VM-controller');
-        return this.sendObjects(limitAndFilterArray(vdis, { filter, limit }), req, obj => obj.type.toLowerCase() + 's');
+        return this.sendObjects(limitAndFilterArray(vdis, { filter }), req, {
+            path: obj => obj.type.toLowerCase() + 's',
+            limit,
+            privilege: { action: 'read', resource: 'vdi' },
+        });
     }
     /**
+     * Returns all messages that match the following privilege:
+     * - resource: message, action: read
+     *
      * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
      * @example fields "name,id,$object"
      * @example filter "name:VM_STARTED"
      * @example limit 42
      */
-    getVmControllerMessages(req, id, fields, ndjson, filter, limit) {
-        const messages = this.getMessagesForObject(id, { filter, limit });
-        return this.sendObjects(Object.values(messages), req, 'messages');
+    getVmControllerMessages(req, id, fields, ndjson, markdown, filter, limit) {
+        const messages = this.getMessagesForObject(id, { filter });
+        return this.sendObjects(Object.values(messages), req, {
+            path: 'messages',
+            limit,
+            privilege: { action: 'read', resource: 'message' },
+        });
     }
     /**
+     * Returns all tasks that match the following privilege:
+     * - resource: task, action: read
+     *
      * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
      * @example fields "id,status,properties"
      * @example filter "status:failure"
      * @example limit 42
      */
-    async getVmControllerTasks(req, id, fields, ndjson, filter, limit) {
-        const tasks = await this.getTasksForObject(id, { filter, limit });
-        return this.sendObjects(Object.values(tasks), req, 'tasks');
+    async getVmControllerTasks(req, id, fields, ndjson, markdown, filter, limit) {
+        const tasks = await this.getTasksForObject(id, { filter });
+        return this.sendObjects(Object.values(tasks), req, {
+            path: 'tasks',
+            limit,
+            privilege: { action: 'read', resource: 'task' },
+        });
     }
     /**
+     * Required privilege:
+     * - resource: vm-controller, action: update:tags
+     *
      * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
      * @example tag "from-rest-api"
      */
@@ -96,6 +135,9 @@ let VmControllerController = class VmControllerController extends XapiXoControll
         await vmController.$call('add_tags', tag);
     }
     /**
+     * Required privilege:
+     * - resource: vm-controller, action: update:tags
+     *
      * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
      * @example tag "from-rest-api"
      */
@@ -108,21 +150,26 @@ __decorate([
     Example(vmControllerIds),
     Example(partialVmControllers),
     Get(''),
+    Security('*', ['acl']),
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], VmControllerController.prototype, "getVmControllers", null);
 __decorate([
     Example(vmController),
     Get('{id}'),
+    Middlewares(acl({ resource: 'vm-controller', action: 'read', objectId: 'params.id' })),
     Response(notFoundResp.status, notFoundResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     __param(0, Path())
 ], VmControllerController.prototype, "getVmController", null);
 __decorate([
     Example(genericAlarmsExample),
     Get('{id}/alarms'),
+    Security('*', ['acl']),
     Tags('alarms'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -130,11 +177,13 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], VmControllerController.prototype, "getVmControllerAlarms", null);
 __decorate([
     Example(vmControllerVdis),
     Get('{id}/vdis'),
+    Security('*', ['acl']),
     Tags('vdis'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -142,12 +191,14 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], VmControllerController.prototype, "getVmControllerVdis", null);
 __decorate([
     Example(messageIds),
     Example(partialMessages),
     Get('{id}/messages'),
+    Security('*', ['acl']),
     Tags('messages'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -155,12 +206,14 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], VmControllerController.prototype, "getVmControllerMessages", null);
 __decorate([
     Example(taskIds),
     Example(partialTasks),
     Get('{id}/tasks'),
+    Security('*', ['acl']),
     Tags('tasks'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -168,18 +221,23 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], VmControllerController.prototype, "getVmControllerTasks", null);
 __decorate([
     Put('{id}/tags/{tag}'),
+    Middlewares(acl({ resource: 'vm-controller', action: 'update:tags', objectId: 'params.id' })),
     SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path()),
     __param(1, Path())
 ], VmControllerController.prototype, "putVmControllerTag", null);
 __decorate([
     Delete('{id}/tags/{tag}'),
+    Middlewares(acl({ resource: 'vm-controller', action: 'update:tags', objectId: 'params.id' })),
     SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path()),
     __param(1, Path())