@xen-orchestra/rest-api 0.11.0 → 0.13.0

package/dist/messages/message.controller.mjs

@@ -12,7 +12,7 @@ import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } f
 import { inject } from 'inversify';
 import { noSuchObject } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
-import { alarmPredicate } from '../alarms/alarm.controller.mjs';
+import { alarmPredicate } from '../alarms/alarm.service.mjs';
 import { message, messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';

package/dist/middlewares/generic-error-handler.middleware.mjs

@@ -9,7 +9,10 @@ export default function genericErrorHandler(error, req, res, _next) {
         res.status(500).json({ error });
         return;
     }
-    const responseError = { error: error.message };
+    const responseError = {
+        error: error.message,
+        data: 'data' in error ? error.data : undefined,
+    };
     let statusCode;
     if (noSuchObject.is(error)) {
         statusCode = 404;
@@ -19,7 +22,6 @@ export default function genericErrorHandler(error, req, res, _next) {
     }
     else if (featureUnauthorized.is(error)) {
         statusCode = 403;
-        responseError.data = error.data;
     }
     else if (invalidCredentials.is(error)) {
         statusCode = 401;
@@ -35,7 +37,6 @@ export default function genericErrorHandler(error, req, res, _next) {
     }
     else if (incorrectState.is(error)) {
         statusCode = 409;
-        responseError.data = error.data;
     }
     else {
         if (error.name === 'XapiError') {

package/dist/networks/network.controller.mjs

@@ -10,13 +10,18 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { Example, Get, Path, Query, Response, Request, Route, Security, Tags, Delete, SuccessResponse } 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 { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 let NetworkController = class NetworkController extends XapiXoController {
-    constructor(restApi) {
+    #alarmService;
+    constructor(restApi, alarmService) {
         super('network', restApi);
+        this.#alarmService = alarmService;
     }
     /**
      * @example fields "nbd,name_label,id"
@@ -39,6 +44,20 @@ let NetworkController = class NetworkController extends XapiXoController {
         const networkId = id;
         await this.getXapiObject(networkId).$xapi.deleteNetwork(networkId);
     }
+    /**
+     * @example id "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+     * @example fields "id,time"
+     * @example filter "time:>1747053793"
+     * @example limit 42
+     */
+    getNetworkAlarms(req, id, fields, ndjson, filter, limit) {
+        const network = this.getObject(id);
+        const alarms = this.#alarmService.getAlarms({
+            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${network.uuid}`,
+            limit,
+        });
+        return this.sendObjects(Object.values(alarms), req, 'alarms');
+    }
 };
 __decorate([
     Example(networkIds),
@@ -62,12 +81,25 @@ __decorate([
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], NetworkController.prototype, "deleteNetwork", null);
+__decorate([
+    Example(genericAlarmsExample),
+    Get('{id}/alarms'),
+    Tags('alarms'),
+    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, "getNetworkAlarms", null);
 NetworkController = __decorate([
     Route('networks'),
     Security('*'),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('networks'),
     provide(NetworkController),
-    __param(0, inject(RestApi))
+    __param(0, inject(RestApi)),
+    __param(1, inject(AlarmService))
 ], NetworkController);
 export { NetworkController };

package/dist/open-api/common/response.common.mjs

@@ -35,3 +35,7 @@ export const invalidParameters = {
     status: 422,
     description: 'Invalid parameters',
 };
+export const forbiddenOperationResp = {
+    status: 403,
+    description: 'Forbidden',
+};

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

@@ -47,3 +47,15 @@ export const alarm = {
         uuid: '3f607494-26f1-b328-b626-d81cf007de37',
     },
 };
+export const genericAlarmsExample = [
+    {
+        id: '7e87b95e-8ebb-31c5-30ad-ff2eb079604b',
+        time: 1747053794,
+        href: '/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604b',
+    },
+    {
+        id: '7e87b95e-8ebb-31c5-30ad-ff2eb079604c',
+        time: 1747053795,
+        href: '/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604c',
+    },
+];

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

@@ -0,0 +1,31 @@
+export const backupRepositoryIds = [
+    '/rest/v0/backup-repositories/7497c970-6780-4462-a452-fcb8a406ee64',
+    '/rest/v0/backup-repositories/f681cef1-617e-4650-ac31-ffdaead076bf',
+];
+export const partialBackupRepositories = [
+    {
+        id: '7497c970-6780-4462-a452-fcb8a406ee64',
+        name: 'test',
+        enabled: true,
+        href: '/rest/v0/backup-repositories/7497c970-6780-4462-a452-fcb8a406ee64',
+    },
+    {
+        id: 'f681cef1-617e-4650-ac31-ffdaead076bf',
+        name: 'S3_Remote',
+        enabled: true,
+        href: '/rest/v0/backup-repositories/f681cef1-617e-4650-ac31-ffdaead076bf',
+    },
+];
+export const backupRepository = {
+    enabled: true,
+    name: 'S3_Remote',
+    benchmarks: [
+        {
+            readRate: 7999965.197905305,
+            timestamp: 1751469269245,
+            writeRate: 7767798.704316632,
+        },
+    ],
+    id: '677e50c5-8d8a-4c89-b1ac-e2f4593d0ebb',
+    url: 's3://FOIS5DY532RGXD62TJ52:obfuscated-q3oi6d9X8uenGvdLnHk2@s3.us-east-2.amazonaws.com/with-lock/backup?useVhdDirectory=true',
+};

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

@@ -21,3 +21,6 @@ export const group = {
     users: ['722d17b9-699b-49d2-8193-be1ac573d3de'],
     id: '7d98fee4-3357-41a7-ac3f-9124212badb7',
 };
+export const groupId = {
+    id: '67bfee1d-a021-4307-a53a-9fec2b2bd67d',
+};

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

@@ -272,3 +272,204 @@ export const poolStats = {
         },
     },
 };
+export const poolDashboard = {
+    hosts: {
+        status: {
+            running: 3,
+            disabled: 0,
+            halted: 0,
+            total: 3,
+        },
+        topFiveUsage: {
+            ram: [
+                {
+                    name_label: 'XCP XO 8.3.0 master',
+                    id: 'b61a5c92-700e-4966-a13b-00633f03eea8',
+                    size: 34359738368,
+                    usage: 6254059520,
+                    percent: 18.201708793640137,
+                },
+                {
+                    name_label: 'XCP XO 8.3.0 slave',
+                    id: '84e555d8-267a-4720-aa5f-fd19035aadae',
+                    size: 34359738368,
+                    usage: 3544117248,
+                    percent: 10.314738750457764,
+                },
+                {
+                    name_label: 'XCP XO 8.3.0 slave 2',
+                    id: '669df518-4e5d-4d84-b93a-9be2cdcdfca1',
+                    size: 34359738368,
+                    usage: 3544117248,
+                    percent: 10.314738750457764,
+                },
+            ],
+            cpu: [
+                {
+                    percent: 6.471593483001921,
+                    id: 'b61a5c92-700e-4966-a13b-00633f03eea8',
+                    name_label: 'XCP XO 8.3.0 master',
+                },
+                {
+                    percent: 2.340522127838084,
+                    id: '84e555d8-267a-4720-aa5f-fd19035aadae',
+                    name_label: 'XCP XO 8.3.0 slave',
+                },
+                {
+                    percent: 1.5935676943627188,
+                    id: '669df518-4e5d-4d84-b93a-9be2cdcdfca1',
+                    name_label: 'XCP XO 8.3.0 slave 2',
+                },
+            ],
+        },
+        missingPatches: {
+            hasAuthorization: true,
+            missingPatches: [
+                {
+                    url: 'http://www.xen.org',
+                    version: '25.6.0',
+                    name: 'xenopsd-xc',
+                    license: 'LGPL-2.1-or-later WITH OCaml-LGPL-linking-exception',
+                    changelog: {
+                        date: 1750852800,
+                        description: '- Fix remote syslog configuration being broken on updates',
+                        author: 'Andrii Sultanov <andriy.sultanov@vates.tech> - 25.6.0-1.9',
+                    },
+                    release: '1.9.xcpng8.3',
+                    size: 5421696,
+                    description: 'Xenopsd using xc',
+                },
+                {
+                    url: 'http://www.xen.org',
+                    version: '25.6.0',
+                    name: 'forkexecd',
+                    license: 'LGPL-2.1-or-later WITH OCaml-LGPL-linking-exception',
+                    changelog: {
+                        date: 1750852800,
+                        description: '- Fix remote syslog configuration being broken on updates',
+                        author: 'Andrii Sultanov <andriy.sultanov@vates.tech> - 25.6.0-1.9',
+                    },
+                    release: '1.9.xcpng8.3',
+                    size: 2498124,
+                    description: 'A subprocess management service',
+                },
+            ],
+        },
+    },
+    vms: {
+        status: {
+            running: 2,
+            halted: 38,
+            paused: 0,
+            total: 40,
+            suspended: 0,
+        },
+        topFiveUsage: {
+            ram: [
+                {
+                    id: 'db822c15-6f7d-8920-10bd-68d40fb12ac6',
+                    name_label: 'MRA alpine',
+                    memory: 536858624,
+                    memoryFree: 423256064,
+                    percent: 21.160610060349892,
+                },
+                {
+                    id: 'fe10b378-db7b-d2a4-eef6-0f1cde75d409',
+                    name_label: 'pbt_test',
+                    memory: 2147471360,
+                    memoryFree: 1813676032,
+                    percent: 15.54364515482991,
+                },
+            ],
+            cpu: [
+                {
+                    id: 'db822c15-6f7d-8920-10bd-68d40fb12ac6',
+                    name_label: 'MRA alpine',
+                    percent: 1.04830558411777,
+                },
+                {
+                    id: 'fe10b378-db7b-d2a4-eef6-0f1cde75d409',
+                    name_label: 'pbt_test',
+                    percent: 0.3743608540389682,
+                },
+            ],
+        },
+    },
+    srs: {
+        topFiveUsage: [
+            {
+                name_label: 'Local storage',
+                id: '4cb0d74e-a7c1-0b7d-46e3-09382c012abb',
+                percent: 45.51916716586373,
+                physical_usage: 33539653632,
+                size: 73682485248,
+            },
+            {
+                name_label: 'Local storage',
+                id: 'c4284e12-37c9-7967-b9e8-83ef229c3e03',
+                percent: 23.527768920458005,
+                physical_usage: 17335844864,
+                size: 73682485248,
+            },
+            {
+                name_label: 'XOSTOR NVME',
+                id: 'c787b75c-3e0d-70fa-d0c3-cbfd382d7e33',
+                percent: 18.56945625131877,
+                physical_usage: 95048891392,
+                size: 511856082944,
+            },
+            {
+                name_label: 'Local storage',
+                id: '8aa2fb4a-143e-c2bc-05d4-c68bbb101d41',
+                percent: 16.016159531372924,
+                physical_usage: 11801104384,
+                size: 73682485248,
+            },
+        ],
+    },
+    alarms: [
+        {
+            name: 'ALARM',
+            time: 1749572297,
+            id: '71ef8836-56e4-97ca-02d1-e118ee1aad98',
+            type: 'message',
+            uuid: '71ef8836-56e4-97ca-02d1-e118ee1aad98',
+            $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+            $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+            _xapiRef: 'OpaqueRef:fed2a9e5-6c72-dada-6f27-7475583ff3e7',
+            body: {
+                value: '1.054742',
+                name: 'mem_usage',
+            },
+            object: {
+                type: 'VM-controller',
+                uuid: '9b4775bd-9493-490a-9afa-f786a44caa4f',
+                href: '/rest/v0/vm-controllers/9b4775bd-9493-490a-9afa-f786a44caa4f',
+            },
+        },
+        {
+            name: 'ALARM',
+            time: 1748688413,
+            id: 'ef9008da-e244-9875-4b83-12de733c8aa9',
+            type: 'message',
+            uuid: 'ef9008da-e244-9875-4b83-12de733c8aa9',
+            $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+            $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+            _xapiRef: 'OpaqueRef:d03c24dc-037d-ac8b-80ea-c5a1106cd678',
+            body: {
+                value: '0.962104',
+                name: 'mem_usage',
+            },
+            object: {
+                type: 'VM-controller',
+                uuid: '9b4775bd-9493-490a-9afa-f786a44caa4f',
+                href: '/rest/v0/vm-controllers/9b4775bd-9493-490a-9afa-f786a44caa4f',
+            },
+        },
+    ],
+    cpuProvisioning: {
+        total: 48,
+        assigned: 4,
+        percent: 8.333333333333334,
+    },
+};

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

@@ -24,3 +24,4 @@ export const user = {
     preferences: {},
     id: '722d17b9-699b-49d2-8193-be1ac573d3de',
 };
+export const userId = { id: '722d17b9-699b-49d2-8193-be1ac573d3de' };