@xen-orchestra/rest-api 0.17.0 → 0.19.0

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

@@ -10,14 +10,16 @@ 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 { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { Delete, Example, Get, Path, Put, Query, Request, Response, Route, Security, SuccessResponse, Tags } from 'tsoa';
 import { AlarmService } from '../alarms/alarm.service.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 { badRequestResp, 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';
+import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
+import { taskIds, partialTasks } from '../open-api/oa-examples/task.oa-example.mjs';
 let VmControllerController = class VmControllerController extends XapiXoController {
     #alarmService;
     #vmService;
@@ -65,6 +67,42 @@ let VmControllerController = class VmControllerController extends XapiXoControll
         const vdis = this.#vmService.getVmVdis(id, 'VM-controller');
         return this.sendObjects(limitAndFilterArray(vdis, { filter, limit }), req, obj => obj.type.toLowerCase() + 's');
     }
+    /**
+     * @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');
+    }
+    /**
+     * @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');
+    }
+    /**
+     * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
+     * @example tag "from-rest-api"
+     */
+    async putVmControllerTag(id, tag) {
+        const vmController = this.getXapiObject(id);
+        await vmController.$call('add_tags', tag);
+    }
+    /**
+     * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
+     * @example tag "from-rest-api"
+     */
+    async deleteVmControllerTag(id, tag) {
+        const vmController = this.getXapiObject(id);
+        await vmController.$call('remove_tags', tag);
+    }
 };
 __decorate([
     Example(vmControllerIds),
@@ -106,9 +144,50 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmControllerController.prototype, "getVmControllerVdis", null);
+__decorate([
+    Example(messageIds),
+    Example(partialMessages),
+    Get('{id}/messages'),
+    Tags('messages'),
+    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, "getVmControllerMessages", null);
+__decorate([
+    Example(taskIds),
+    Example(partialTasks),
+    Get('{id}/tasks'),
+    Tags('tasks'),
+    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, "getVmControllerTasks", null);
+__decorate([
+    Put('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], VmControllerController.prototype, "putVmControllerTag", null);
+__decorate([
+    Delete('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], VmControllerController.prototype, "deleteVmControllerTag", null);
 VmControllerController = __decorate([
     Route('vm-controllers'),
     Security('*'),
+    Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('vms'),
     provide(VmControllerController),

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

@@ -7,12 +7,13 @@ 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 { Delete, Example, Get, Path, Query, Request, Response, Route, Security, SuccessResponse, Tags } from 'tsoa';
+import { Delete, Example, Get, Path, Put, Query, Request, Response, Route, Security, SuccessResponse, Tags } from 'tsoa';
 import { inject } from 'inversify';
-import { AlarmService, RAW_ALARM_FILTER } from '../alarms/alarm.service.mjs';
+import { AlarmService } from '../alarms/alarm.service.mjs';
 import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { forbiddenOperationResp, incorrectStateResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { partialTasks, taskIds } from '../open-api/oa-examples/task.oa-example.mjs';
+import { badRequestResp, forbiddenOperationResp, incorrectStateResp, noContentResp, 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';
@@ -96,13 +97,35 @@ let VmSnapshotController = class VmSnapshotController extends XapiXoController {
      * @example limit 42
      */
     getVmSnapshotsMessages(req, id, fields, ndjson, filter, limit) {
-        const vm = this.getObject(id);
-        const messages = this.restApi.getObjectsByType('message', {
-            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} $object:${vm.uuid} !${RAW_ALARM_FILTER}`,
-            limit,
-        });
+        const messages = this.getMessagesForObject(id, { filter, limit });
         return this.sendObjects(Object.values(messages), req, 'messages');
     }
+    /**
+     * @example id "d68fca2c-41e6-be87-d790-105c1642a090"
+     * @example fields "id,status,properties"
+     * @example filter "status:failure"
+     * @example limit 42
+     */
+    async getVmSnapshotTasks(req, id, fields, ndjson, filter, limit) {
+        const tasks = await this.getTasksForObject(id, { filter, limit });
+        return this.sendObjects(Object.values(tasks), req, 'tasks');
+    }
+    /**
+     * @example id "d68fca2c-41e6-be87-d790-105c1642a090"
+     * @example tag "from-rest-api"
+     */
+    async putVmSnapshotTag(id, tag) {
+        const vmSnapshot = this.getXapiObject(id);
+        await vmSnapshot.$call('add_tags', tag);
+    }
+    /**
+     * @example id "d68fca2c-41e6-be87-d790-105c1642a090"
+     * @example tag "from-rest-api"
+     */
+    async deleteVmSnapshotTag(id, tag) {
+        const vmSnapshot = this.getXapiObject(id);
+        await vmSnapshot.$call('remove_tags', tag);
+    }
 };
 __decorate([
     Example(vmSnapshotIds),
@@ -175,9 +198,37 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmSnapshotController.prototype, "getVmSnapshotsMessages", null);
+__decorate([
+    Example(taskIds),
+    Example(partialTasks),
+    Get('{id}/tasks'),
+    Tags('tasks'),
+    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, "getVmSnapshotTasks", null);
+__decorate([
+    Put('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], VmSnapshotController.prototype, "putVmSnapshotTag", null);
+__decorate([
+    Delete('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], VmSnapshotController.prototype, "deleteVmSnapshotTag", null);
 VmSnapshotController = __decorate([
     Route('vm-snapshots'),
     Security('*'),
+    Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('vms'),
     provide(VmSnapshotController),

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

@@ -7,18 +7,19 @@ 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, Security, Query, Request, Response, Route, Tags, Path, Delete, SuccessResponse } from 'tsoa';
+import { Example, Get, Security, Query, Request, Response, Route, Tags, Path, Delete, SuccessResponse, Put } from 'tsoa';
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
-import { AlarmService, RAW_ALARM_FILTER } from '../alarms/alarm.service.mjs';
+import { AlarmService } from '../alarms/alarm.service.mjs';
 import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { forbiddenOperationResp, incorrectStateResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { badRequestResp, forbiddenOperationResp, incorrectStateResp, noContentResp, 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, vmTemplateVdis, } from '../open-api/oa-examples/vm-template.oa-example.mjs';
 import { VmService } from '../vms/vm.service.mjs';
 import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
+import { partialTasks, taskIds } from '../open-api/oa-examples/task.oa-example.mjs';
 let VmTemplateController = class VmTemplateController extends XapiXoController {
     #alarmService;
     #vmService;
@@ -95,13 +96,35 @@ let VmTemplateController = class VmTemplateController extends XapiXoController {
      * @example limit 42
      */
     getVmTemplateMessages(req, id, fields, ndjson, filter, limit) {
-        const vmTemplate = this.getObject(id);
-        const messages = this.restApi.getObjectsByType('message', {
-            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} $object:${vmTemplate.uuid} !${RAW_ALARM_FILTER}`,
-            limit,
-        });
+        const messages = this.getMessagesForObject(id, { filter, limit });
         return this.sendObjects(Object.values(messages), req, 'messages');
     }
+    /**
+     * @example id "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+     * @example fields "id,status,properties"
+     * @example filter "status:failure"
+     * @example limit 42
+     */
+    async getVmTemplateTasks(req, id, fields, ndjson, filter, limit) {
+        const tasks = await this.getTasksForObject(id, { filter, limit });
+        return this.sendObjects(Object.values(tasks), req, 'tasks');
+    }
+    /**
+     * @example id "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+     * @example tag "from-rest-api"
+     */
+    async putVmTemplateTag(id, tag) {
+        const vmTemplate = this.getXapiObject(id);
+        await vmTemplate.$call('add_tags', tag);
+    }
+    /**
+     * @example id "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+     * @example tag "from-rest-api"
+     */
+    async deleteVmTemplateTag(id, tag) {
+        const vmTemplate = this.getXapiObject(id);
+        await vmTemplate.$call('remove_tags', tag);
+    }
 };
 __decorate([
     Example(vmTemplateIds),
@@ -174,9 +197,37 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmTemplateController.prototype, "getVmTemplateMessages", null);
+__decorate([
+    Example(taskIds),
+    Example(partialTasks),
+    Get('{id}/tasks'),
+    Tags('tasks'),
+    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, "getVmTemplateTasks", null);
+__decorate([
+    Put('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], VmTemplateController.prototype, "putVmTemplateTag", null);
+__decorate([
+    Delete('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], VmTemplateController.prototype, "deleteVmTemplateTag", null);
 VmTemplateController = __decorate([
     Route('vm-templates'),
     Security('*'),
+    Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('vms'),
     provide(VmTemplateController),

package/dist/vms/vm.controller.mjs

@@ -11,8 +11,8 @@ import { Example, Get, Path, Post, Query, Request, Response, Route, Security, Ta
 import { inject } from 'inversify';
 import { incorrectState, invalidParameters } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
-import { AlarmService, RAW_ALARM_FILTER } from '../alarms/alarm.service.mjs';
-import { asynchronousActionResp, createdResp, forbiddenOperationResp, incorrectStateResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { AlarmService } from '../alarms/alarm.service.mjs';
+import { asynchronousActionResp, badRequestResp, createdResp, forbiddenOperationResp, incorrectStateResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { BASE_URL } from '../index.mjs';
 import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
@@ -21,7 +21,6 @@ import { RestApi } from '../rest-api/rest-api.mjs';
 import { partialTasks, taskIds, 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';
-import { TaskService } from '../tasks/task.service.mjs';
 import { BackupJobService } from '../backup-jobs/backup-job.service.mjs';
 import { partialVmBackupJobs, vmBackupJobIds } from '../open-api/oa-examples/backup-job.oa-example.mjs';
 import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
@@ -29,13 +28,11 @@ const IGNORED_VDIS_TAG = '[NOSNAP]';
 let VmController = class VmController extends XapiXoController {
     #alarmService;
     #vmService;
-    #taskService;
     #backupJobService;
-    constructor(restApi, alarmService, vmService, taskService, backupJobService) {
+    constructor(restApi, alarmService, vmService, backupJobService) {
         super('VM', restApi);
         this.#alarmService = alarmService;
         this.#vmService = vmService;
-        this.#taskService = taskService;
         this.#backupJobService = backupJobService;
     }
     /**
@@ -376,11 +373,7 @@ let VmController = class VmController extends XapiXoController {
      * @example limit 42
      */
     getVmMessages(req, id, fields, ndjson, filter, limit) {
-        const vm = this.getObject(id);
-        const messages = this.restApi.getObjectsByType('message', {
-            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} $object:${vm.uuid} !${RAW_ALARM_FILTER}`,
-            limit,
-        });
+        const messages = this.getMessagesForObject(id, { filter, limit });
         return this.sendObjects(Object.values(messages), req, 'messages');
     }
     /**
@@ -390,12 +383,24 @@ let VmController = class VmController extends XapiXoController {
      * @example limit 42
      */
     async getVmTasks(req, id, fields, ndjson, filter, limit) {
-        const vm = this.getObject(id);
-        const tasks = await this.#taskService.getTasks({
-            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} |(properties:objectId:${vm.id} properties:params:id:${vm.id})`,
-            limit,
-        });
-        return this.sendObjects(tasks, req, 'tasks');
+        const tasks = await this.getTasksForObject(id, { filter, limit });
+        return this.sendObjects(Object.values(tasks), req, 'tasks');
+    }
+    /**
+     * @example id "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+     * @example tag "from-rest-api"
+     */
+    async putVmTag(id, tag) {
+        const vm = this.getXapiObject(id);
+        await vm.$call('add_tags', tag);
+    }
+    /**
+     * @example id "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+     * @example tag "from-rest-api"
+     */
+    async deleteVmTag(id, tag) {
+        const vm = this.getXapiObject(id);
+        await vm.$call('remove_tags', tag);
     }
 };
 __decorate([
@@ -617,9 +622,24 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmController.prototype, "getVmTasks", null);
+__decorate([
+    Put('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], VmController.prototype, "putVmTag", null);
+__decorate([
+    Delete('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], VmController.prototype, "deleteVmTag", null);
 VmController = __decorate([
     Route('vms'),
     Security('*'),
+    Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('vms')
     // the `provide` decorator is mandatory on class that injects/receives dependencies.
@@ -629,7 +649,6 @@ VmController = __decorate([
     __param(0, inject(RestApi)),
     __param(1, inject(AlarmService)),
     __param(2, inject(VmService)),
-    __param(3, inject(TaskService)),
-    __param(4, inject(BackupJobService))
+    __param(3, inject(BackupJobService))
 ], VmController);
 export { VmController };

package/dist/xoa/xoa.controller.mjs

@@ -11,7 +11,7 @@ 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 { unauthorizedResp } from '../open-api/common/response.common.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';
 import { NDJSON_CONTENT_TYPE } from '../helpers/utils.helper.mjs';
@@ -47,6 +47,7 @@ __decorate([
 XoaController = __decorate([
     Route(''),
     Security('*'),
+    Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('xoa'),
     provide(XoaController),