@xen-orchestra/rest-api 0.28.2 → 0.30.0

package/dist/pbds/pbd.controller.mjs

@@ -9,8 +9,9 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 };
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
-import { Route, Security, Request, Response, Get, Query, Path, Tags, Example, Post, SuccessResponse } from 'tsoa';
-import { asynchronousActionResp, badRequestResp, internalServerErrorResp, invalidParameters as invalidParametersResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { Middlewares, Route, Security, Request, Response, Get, Query, Path, Tags, Example, Post, SuccessResponse } from 'tsoa';
+import { acl } from '../middlewares/acl.middleware.mjs';
+import { asynchronousActionResp, badRequestResp, internalServerErrorResp, invalidParameters as invalidParametersResp, noContentResp, forbiddenOperationResp, 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 { partialPbds, pbd, pbdIds } from '../open-api/oa-examples/pbd.oa-example.mjs';
@@ -20,14 +21,23 @@ let PbdController = class PbdController extends XapiXoController {
         super('PBD', restApi);
     }
     /**
+     * Returns all PBDs that match the following privilege:
+     * - resource: pbd, action: read
+     *
      * @example fields "attached,id,device_config"
      * @example filter "attached?"
      * @example limit 42
      */
-    getPbds(req, fields, ndjson, filter, limit) {
-        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    getPbds(req, fields, ndjson, markdown, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter })), req, {
+            limit,
+            privilege: { action: 'read', resource: 'pbd' },
+        });
     }
     /**
+     * Required privilege:
+     * - resource: pbd, action: read
+     *
      * @example id "16b2a60f-7c4d-f45f-7c7a-963b06fc587d"
      */
     getPbd(id) {
@@ -74,15 +84,20 @@ __decorate([
     Example(pbdIds),
     Example(partialPbds),
     Get(''),
+    Security('*', ['acl']),
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], PbdController.prototype, "getPbds", null);
 __decorate([
     Example(pbd),
     Get('{id}'),
+    Middlewares(acl({ resource: 'pbd', action: 'read', objectId: 'params.id' })),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], PbdController.prototype, "getPbd", null);
 __decorate([

package/dist/pcis/pci.controller.mjs

@@ -7,10 +7,11 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { Example, Get, Middlewares, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
-import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { acl } from '../middlewares/acl.middleware.mjs';
+import { badRequestResp, forbiddenOperationResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { partialPcis, pci, pciIds } from '../open-api/oa-examples/pci.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
@@ -19,14 +20,23 @@ let PciController = class PciController extends XapiXoController {
         super('PCI', restApi);
     }
     /**
+     * Returns all PCIs that match the following privilege:
+     * - resource: pci, action: read
+     *
      * @example fields "class_name,device_name,id"
      * @example filter "class_name:Non-Volatile memory controller"
      * @example limit 42
      */
-    getPcis(req, fields, ndjson, filter, limit) {
-        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    getPcis(req, fields, ndjson, markdown, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter })), req, {
+            limit,
+            privilege: { action: 'read', resource: 'pci' },
+        });
     }
     /**
+     * Required privilege:
+     * - resource: pci, action: read
+     *
      * @example id "9377b642-cc71-8749-1e71-308898b652da"
      */
     getPci(id) {
@@ -37,15 +47,19 @@ __decorate([
     Example(pciIds),
     Example(partialPcis),
     Get(''),
+    Security('*', ['acl']),
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], PciController.prototype, "getPcis", null);
 __decorate([
     Example(pci),
     Get('{id}'),
+    Middlewares(acl({ resource: 'pci', action: 'read', objectId: 'params.id' })),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], PciController.prototype, "getPci", null);

package/dist/pgpus/pgpu.controller.mjs

@@ -10,8 +10,9 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { inject } from 'inversify';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
-import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
-import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { Example, Get, Middlewares, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { acl } from '../middlewares/acl.middleware.mjs';
+import { badRequestResp, forbiddenOperationResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { provide } from 'inversify-binding-decorators';
 import { partialPgpus, pgpu, pgpuIds } from '../open-api/oa-examples/pgpu.oa-example.mjs';
 let PgpuController = class PgpuController extends XapiXoController {
@@ -19,14 +20,23 @@ let PgpuController = class PgpuController extends XapiXoController {
         super('PGPU', restApi);
     }
     /**
+     * Returns all PGPUs that match the following privilege:
+     * - resource: pgpu, action: read
+     *
      * @example fields "id,dom0Access,gpuGroup"
      * @example filter "dom0Access:enabled"
      * @example limit 42
      */
-    getPgpus(req, fields, ndjson, filter, limit) {
-        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    getPgpus(req, fields, ndjson, markdown, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter })), req, {
+            limit,
+            privilege: { action: 'read', resource: 'pgpu' },
+        });
     }
     /**
+     * Required privilege:
+     * - resource: pgpu, action: read
+     *
      * @example id "838335fa-ee21-15e1-760a-a37a3a4ef1db"
      */
     getPgpu(id) {
@@ -37,15 +47,19 @@ __decorate([
     Example(pgpuIds),
     Example(partialPgpus),
     Get(''),
+    Security('*', ['acl']),
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], PgpuController.prototype, "getPgpus", null);
 __decorate([
     Example(pgpu),
     Get('{id}'),
+    Middlewares(acl({ resource: 'pgpu', action: 'read', objectId: 'params.id' })),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], PgpuController.prototype, "getPgpu", null);

package/dist/pifs/pif.controller.mjs

@@ -7,13 +7,14 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { Example, Get, Middlewares, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
 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 { acl } from '../middlewares/acl.middleware.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { badRequestResp, forbiddenOperationResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { partialPifs, pif, pifIds } from '../open-api/oa-examples/pif.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
@@ -26,73 +27,107 @@ let PifController = class PifController extends XapiXoController {
         this.#alarmService = alarmService;
     }
     /**
+     * Returns all PIFs that match the following privilege:
+     * - resource: pif, action: read
+     *
      * @example fields "attached,device,deviceName,id"
      * @example filter "attached?"
      * @example limit 42
      */
-    getPifs(req, fields, ndjson, filter, limit) {
-        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    getPifs(req, fields, ndjson, markdown, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter })), req, {
+            limit,
+            privilege: { action: 'read', resource: 'pif' },
+        });
     }
     /**
+     * Required privilege:
+     * - resource: pif, action: read
+     *
      * @example id "d9e42451-3794-089f-de81-4ee0e6137bee"
      */
     getPif(id) {
         return this.getObject(id);
     }
     /**
+     * Returns all alarms that match the following privilege:
+     * - resource: alarm, action: read
+     *
      * @example id "d9e42451-3794-089f-de81-4ee0e6137bee"
      * @example fields "id,time"
      * @example filter "time:>1747053793"
      * @example limit 42
      */
-    getPifAlarms(req, id, fields, ndjson, filter, limit) {
+    getPifAlarms(req, id, fields, ndjson, markdown, filter, limit) {
         const pif = this.getObject(id);
         const alarms = this.#alarmService.getAlarms({
             filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${pif.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 "d9e42451-3794-089f-de81-4ee0e6137bee"
      * @example fields "name,id,$object"
      * @example filter "name:VM_STARTED"
      * @example limit 42
      */
-    getPifMessages(req, id, fields, ndjson, filter, limit) {
-        const messages = this.getMessagesForObject(id, { filter, limit });
-        return this.sendObjects(Object.values(messages), req, 'messages');
+    getPifMessages(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 "d9e42451-3794-089f-de81-4ee0e6137bee"
      * @example fields "id,status,properties"
      * @example filter "status:failure"
      * @example limit 42
      */
-    async getPifTasks(req, id, fields, ndjson, filter, limit) {
-        const tasks = await this.getTasksForObject(id, { filter, limit });
-        return this.sendObjects(Object.values(tasks), req, 'tasks');
+    async getPifTasks(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' },
+        });
     }
 };
 __decorate([
     Example(pifIds),
     Example(partialPifs),
     Get(''),
+    Security('*', ['acl']),
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], PifController.prototype, "getPifs", null);
 __decorate([
     Example(pif),
     Get('{id}'),
+    Middlewares(acl({ resource: 'pif', action: 'read', objectId: 'params.id' })),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], PifController.prototype, "getPif", null);
 __decorate([
     Example(genericAlarmsExample),
     Get('{id}/alarms'),
+    Security('*', ['acl']),
     Tags('alarms'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -100,12 +135,14 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], PifController.prototype, "getPifAlarms", null);
 __decorate([
     Example(messageIds),
     Example(partialMessages),
     Get('{id}/messages'),
+    Security('*', ['acl']),
     Tags('messages'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -113,12 +150,14 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], PifController.prototype, "getPifMessages", null);
 __decorate([
     Example(taskIds),
     Example(partialTasks),
     Get('{id}/tasks'),
+    Security('*', ['acl']),
     Tags('tasks'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Request()),
@@ -126,7 +165,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], PifController.prototype, "getPifTasks", null);
 PifController = __decorate([
     Route('pifs'),