@xen-orchestra/rest-api 0.17.0 → 0.19.0

package/dist/networks/network.controller.mjs

@@ -7,16 +7,18 @@ 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, Response, Request, Route, Security, Tags, Delete, SuccessResponse } from 'tsoa';
+import { Example, Get, Path, Query, Response, Request, Route, Security, Tags, Delete, SuccessResponse, Put } 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 { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
 import { network, networkIds, partialNetworks } from '../open-api/oa-examples/network.oa-example.mjs';
-import { noContentResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { badRequestResp, 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 { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
+import { partialTasks, taskIds } from '../open-api/oa-examples/task.oa-example.mjs';
 let NetworkController = class NetworkController extends XapiXoController {
     #alarmService;
     constructor(restApi, alarmService) {
@@ -58,6 +60,42 @@ let NetworkController = class NetworkController extends XapiXoController {
         });
         return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
+    /**
+     * @example id "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+     * @example fields "name,id,$object"
+     * @example filter "name:VM_STARTED"
+     * @example limit 42
+     */
+    getNetworkMessages(req, id, fields, ndjson, filter, limit) {
+        const messages = this.getMessagesForObject(id, { filter, limit });
+        return this.sendObjects(Object.values(messages), req, 'messages');
+    }
+    /**
+     * @example id "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+     * @example fields "id,status,properties"
+     * @example filter "status:failure"
+     * @example limit 42
+     */
+    async getNetworkTasks(req, id, fields, ndjson, filter, limit) {
+        const tasks = await this.getTasksForObject(id, { filter, limit });
+        return this.sendObjects(Object.values(tasks), req, 'tasks');
+    }
+    /**
+     * @example id "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+     * @example tag "from-rest-api"
+     */
+    async putNetworkTag(id, tag) {
+        const network = this.getXapiObject(id);
+        await network.$call('add_tags', tag);
+    }
+    /**
+     * @example id "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+     * @example tag "from-rest-api"
+     */
+    async deleteNetworkTag(id, tag) {
+        const network = this.getXapiObject(id);
+        await network.$call('remove_tags', tag);
+    }
 };
 __decorate([
     Example(networkIds),
@@ -93,9 +131,50 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], NetworkController.prototype, "getNetworkAlarms", 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())
+], NetworkController.prototype, "getNetworkMessages", 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())
+], NetworkController.prototype, "getNetworkTasks", null);
+__decorate([
+    Put('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], NetworkController.prototype, "putNetworkTag", null);
+__decorate([
+    Delete('{id}/tags/{tag}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path()),
+    __param(1, Path())
+], NetworkController.prototype, "deleteNetworkTag", null);
 NetworkController = __decorate([
     Route('networks'),
     Security('*'),
+    Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('networks'),
     provide(NetworkController),

package/dist/open-api/oa-examples/backup-archive.oa-example.mjs

@@ -0,0 +1,60 @@
+export const backupArchiveIds = [
+    '/rest/v0/backup-archives/231264c3-af43-4ec0-a3be-394c5b1fdbfc//xo-vm-backups/6ef7c09e-677b-1e6f-0546-7ab30413c61c/20250801T080832Z.json',
+    '/rest/v0/backup-archives/1af95910-01b4-4e87-9c2f-d895cafe0776//xo-vm-backups/7cf6150f-a978-09e6-6b41-0d1d41967bdc/20250918T132942Z.json',
+];
+export const partialBackupArchives = [
+    {
+        id: '231264c3-af43-4ec0-a3be-394c5b1fdbfc//xo-vm-backups/6ef7c09e-677b-1e6f-0546-7ab30413c61c/20250801T080832Z.json',
+        backupRepository: '231264c3-af43-4ec0-a3be-394c5b1fdbfc',
+        disks: [
+            {
+                id: '/xo-vm-backups/6ef7c09e-677b-1e6f-0546-7ab30413c61c/vdis/8b650248-ddd6-4188-ad8b-c0502865ac6c/f1f3c902-dcaa-4ec6-943e-6162c9d85fb2/20250801T080832Z.vhd',
+                name: 'debian 12 hub disk',
+                uuid: 'cbe1e3ba-8e5c-4c79-9e4d-708144518d50',
+            },
+            {
+                id: '/xo-vm-backups/6ef7c09e-677b-1e6f-0546-7ab30413c61c/vdis/8b650248-ddd6-4188-ad8b-c0502865ac6c/870e6142-d4e4-4622-bd19-6b101c8da3cc/20250801T080832Z.vhd',
+                name: 'XO CloudConfigDrive',
+                uuid: 'bea8193d-80ba-4a72-94e4-901f03ffc225',
+            },
+        ],
+        href: '/rest/v0/backup-archives/231264c3-af43-4ec0-a3be-394c5b1fdbfc/xo-vm-backups/6ef7c09e-677b-1e6f-0546-7ab30413c61c/20250801T080832Z.json',
+    },
+    {
+        id: '1af95910-01b4-4e87-9c2f-d895cafe0776//xo-vm-backups/7cf6150f-a978-09e6-6b41-0d1d41967bdc/20250918T132942Z.json',
+        backupRepository: '1af95910-01b4-4e87-9c2f-d895cafe0776',
+        disks: [
+            {
+                id: '/xo-vm-backups/803c2676-c309-721e-7123-e6c3de854c32/vdis/ce91bf34-099c-4241-a608-3373f101c02b/7384cf5a-3202-4a21-bfd0-8da467449fa6/20250916T144850Z.vhd',
+                name: 'AlmaLinux 9_ivopu',
+                uuid: '73ed06ed-fdc8-43ef-a1c4-253e9005fbe0',
+            },
+        ],
+        href: '/rest/v0/backup-archives/1af95910-01b4-4e87-9c2f-d895cafe0776//xo-vm-backups/7cf6150f-a978-09e6-6b41-0d1d41967bdc/20250918T132942Z.json',
+    },
+];
+export const backupArchive = {
+    type: 'xo-vm-backup',
+    backupRepository: '1af95910-01b4-4e87-9c2f-d895cafe0776',
+    disks: [
+        {
+            id: '/xo-vm-backups/7cf6150f-a978-09e6-6b41-0d1d41967bdc/vdis/f2599aa4-7bb4-434b-bf71-cf0ebe1e06a4/007e4f3e-6315-4779-aab5-461b519836f3/20250918T132942Z.alias.vhd',
+            name: 'min-alpine-mra_alegi',
+            uuid: 'c922ef3c-9d76-4482-87f8-a4da5849ee45',
+        },
+    ],
+    id: '1af95910-01b4-4e87-9c2f-d895cafe0776//xo-vm-backups/7cf6150f-a978-09e6-6b41-0d1d41967bdc/20250918T132942Z.json',
+    jobId: 'f2599aa4-7bb4-434b-bf71-cf0ebe1e06a4',
+    mode: 'delta',
+    scheduleId: '8db1c2da-2635-436f-8f78-62079fea3aa6',
+    size: 0,
+    timestamp: 1758202182963,
+    vm: {
+        uuid: '7cf6150f-a978-09e6-6b41-0d1d41967bdc',
+        name_description: 'root:vateslab',
+        name_label: 'mra_vtp_test',
+    },
+    differencingVhds: 1,
+    dynamicVhds: 0,
+    withMemory: false,
+};

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

@@ -0,0 +1,41 @@
+export const pbdIds = [
+    '/rest/v0/pbds/16b2a60f-7c4d-f45f-7c7a-963b06fc587d',
+    '/rest/v0/pbds/28d93f56-23cb-527c-080a-805e54593a0d',
+];
+export const partialPbds = [
+    {
+        attached: true,
+        id: '16b2a60f-7c4d-f45f-7c7a-963b06fc587d',
+        device_config: {
+            device: '/dev/disk/by-id/ata-YP0120GWCGV_2H5020013956-part3',
+        },
+        href: '/rest/v0/pbds/16b2a60f-7c4d-f45f-7c7a-963b06fc587d',
+    },
+    {
+        attached: true,
+        id: '28d93f56-23cb-527c-080a-805e54593a0d',
+        device_config: {
+            path: '/opt/xensource/packages/iso',
+            location: '/opt/xensource/packages/iso',
+            legacy_mode: 'true',
+        },
+        href: '/rest/v0/pbds/28d93f56-23cb-527c-080a-805e54593a0d',
+    },
+];
+export const pbd = {
+    type: 'PBD',
+    attached: true,
+    host: '669df518-4e5d-4d84-b93a-9be2cdcdfca1',
+    SR: '8aa2fb4a-143e-c2bc-05d4-c68bbb101d41',
+    device_config: {
+        device: '/dev/disk/by-id/ata-YP0120GWCGV_2H5020013956-part3',
+    },
+    otherConfig: {
+        storage_driver_domain: 'OpaqueRef:6a7cfe18-1b68-205f-080a-3a64fb5f0e19',
+    },
+    id: '16b2a60f-7c4d-f45f-7c7a-963b06fc587d',
+    uuid: '16b2a60f-7c4d-f45f-7c7a-963b06fc587d',
+    $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    _xapiRef: 'OpaqueRef:fc6b3830-610b-adc8-2ea4-b7769f0931bf',
+};

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

@@ -57,3 +57,15 @@ export const authenticationTokens = [
         id: 'ktdlq-BX_GdS5N8MR0v7QIuoSymBw4Ys4EOxsOdqpnE',
     },
 ];
+export const authenticationToken = {
+    token: {
+        client: {
+            id: 'my-fav-client',
+        },
+        created_at: 1760346600297,
+        description: 'token for CLI usage',
+        id: 'fhIUz8AtMLndzMd3ksfoTpHb0tWyKHmT6-M3o_hUbRg',
+        user_id: '722d17b9-699b-49d2-8193-be1ac573d3de',
+        expiration: 1760350200297,
+    },
+};