@xen-orchestra/rest-api 0.13.1 → 0.15.0

package/dist/abstract-classes/xo-controller.mjs

@@ -7,23 +7,17 @@ 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 * as CM from 'complex-matcher';
 import { inject } from 'inversify';
 import { BaseController } from './base-controller.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
+import { limitAndFilterArray } from '../helpers/utils.helper.mjs';
 let XoController = class XoController extends BaseController {
     constructor(restApi) {
         super(restApi);
     }
-    async getObjects({ filter, limit = Infinity } = {}) {
+    async getObjects(opts = {}) {
         let objects = await this.getAllCollectionObjects();
-        if (filter !== undefined) {
-            const predicate = CM.parse(filter).createPredicate();
-            objects = objects.filter(predicate);
-        }
-        if (limit < objects.length) {
-            objects.length = limit;
-        }
+        objects = limitAndFilterArray(objects, opts);
         const objectById = {};
         objects.forEach(obj => {
             objectById[obj.id] = obj;

package/dist/helpers/error.helper.mjs

@@ -0,0 +1,10 @@
+export class ApiError extends Error {
+    #status;
+    constructor(message, status) {
+        super(message);
+        this.#status = status;
+    }
+    get status() {
+        return this.#status;
+    }
+}

package/dist/helpers/object-wrapper.helper.mjs

@@ -3,13 +3,16 @@ import pick from 'lodash/pick.js';
 import { BASE_URL } from '../index.mjs';
 const { join } = path.posix;
 export function makeObjectMapper(req, path) {
-    if (path === undefined) {
-        path = req.path;
-    }
-    else {
-        path = `${BASE_URL}/${path}`;
-    }
-    const makeUrl = ({ id }) => join(path, typeof id === 'number' ? String(id) : id);
+    const makeUrl = (obj) => {
+        let _path;
+        if (path === undefined) {
+            _path = req.path;
+        }
+        else {
+            _path = `${BASE_URL}/${typeof path === 'string' ? path : path(obj)}`;
+        }
+        return join(_path, typeof obj.id === 'number' ? String(obj.id) : obj.id);
+    };
     let objectMapper;
     const { query } = req;
     const { fields } = query;

package/dist/helpers/utils.helper.mjs

@@ -1,3 +1,4 @@
+import * as CM from 'complex-matcher';
 import { createLogger } from '@xen-orchestra/log';
 import { isPromise } from 'node:util/types';
 export const NDJSON_CONTENT_TYPE = 'application/x-ndjson';
@@ -75,3 +76,13 @@ export function escapeUnsafeComplexMatcher(maybeString) {
     }
     return `(${maybeString})`;
 }
+export function limitAndFilterArray(array, { filter, limit = Infinity } = {}) {
+    if (filter !== undefined) {
+        const predicate = typeof filter === 'string' ? CM.parse(filter).createPredicate() : filter;
+        array = array.filter(predicate);
+    }
+    if (limit < array.length) {
+        array = array.slice(0, limit);
+    }
+    return array;
+}

package/dist/hosts/host.controller.mjs

@@ -14,15 +14,18 @@ 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 { host, hostIds, hostStats, partialHosts } from '../open-api/oa-examples/host.oa-example.mjs';
+import { host, hostIds, hostSmt, hostMissingPatches, hostStats, partialHosts, } from '../open-api/oa-examples/host.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
-import { internalServerErrorResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { featureUnauthorized, internalServerErrorResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { HostService } from './host.service.mjs';
 let HostController = class HostController extends XapiXoController {
     #alarmService;
-    constructor(restApi, alarmService) {
+    #hostService;
+    constructor(restApi, alarmService, hostService) {
         super('host', restApi);
         this.#alarmService = alarmService;
+        this.#hostService = hostService;
     }
     /**
      * @example fields "id,name_label,productBrand"
@@ -94,6 +97,26 @@ let HostController = class HostController extends XapiXoController {
         });
         return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
+    /**
+     * Returns a boolean indicating whether SMT (Simultaneous Multi-Threading) is enabled
+     *
+     * @example id "b61a5c92-700e-4966-a13b-00633f03eea8"
+     */
+    async gethostSmt(id) {
+        const hostId = id;
+        const xapiHost = this.getXapiObject(hostId);
+        const enabled = Boolean(await xapiHost.$xapi.isHyperThreadingEnabled(hostId));
+        return { enabled };
+    }
+    /**
+     * Host must be running
+     *
+     * @example id "b61a5c92-700e-4966-a13b-00633f03eea8"
+     */
+    async getMissingPatches(id) {
+        const { missingPatches } = await this.#hostService.getMissingPatchesInfo({ filter: host => host.id === id });
+        return missingPatches;
+    }
 };
 __decorate([
     Example(hostIds),
@@ -148,6 +171,20 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], HostController.prototype, "getHostAlarms", null);
+__decorate([
+    Example(hostSmt),
+    Get('{id}/smt'),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path())
+], HostController.prototype, "gethostSmt", null);
+__decorate([
+    Example(hostMissingPatches),
+    Get('{id}/missing_patches'),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(featureUnauthorized.status, featureUnauthorized.description),
+    __param(0, Path())
+], HostController.prototype, "getMissingPatches", null);
 HostController = __decorate([
     Route('hosts'),
     Security('*'),
@@ -155,6 +192,7 @@ HostController = __decorate([
     Tags('hosts'),
     provide(HostController),
     __param(0, inject(RestApi)),
-    __param(1, inject(AlarmService))
+    __param(1, inject(AlarmService)),
+    __param(2, inject(HostService))
 ], HostController);
 export { HostController };

package/dist/hosts/host.service.mjs

@@ -41,13 +41,12 @@ export class HostService {
             total,
         };
     }
-    async getMissingPatchesInfo(opts) {
-        if (!(await this.#restApi.xoApp.hasFeatureAuthorization('LIST_MISSING_PATCHES'))) {
-            return {
-                hasAuthorization: false,
-            };
-        }
-        const hosts = Object.values(this.#restApi.getObjectsByType('host', opts));
+    /**
+     * Throw if no authorization
+     */
+    async getMissingPatchesInfo({ filter, } = {}) {
+        await this.#restApi.xoApp.checkFeatureAuthorization('LIST_MISSING_PATCHES');
+        const hosts = Object.values(this.#restApi.getObjectsByType('host', { filter }));
         const missingPatches = new Map();
         const poolsWithMissingPatches = new Set();
         let nHostsWithMissingPatches = 0;

package/dist/hosts/host.type.mjs

@@ -0,0 +1 @@
+export {};

package/dist/index.mjs

@@ -32,6 +32,10 @@ const SWAGGER_UI_OPTIONS = {
 export default function setupRestApi(express, xoApp) {
     setupContainer(xoApp);
     RegisterRoutes(express);
+    express.get(`${BASE_URL}/docs/swagger.json`, (_req, res) => {
+        res.setHeader('Content-Type', 'application/json');
+        res.json(swaggerOpenApiSpec);
+    });
     // do not register the doc at the root level, or it may lead to unwanted behaviour
     // uncomment when all endpoints are migrated to this API
     // express.get('/rest/v0', (_req, res) => res.redirect('/rest/v0/docs'))

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

@@ -1,5 +1,6 @@
 import { createLogger } from '@xen-orchestra/log';
 import { featureUnauthorized, forbiddenOperation, incorrectState, invalidCredentials, invalidParameters, noSuchObject, notImplemented, objectAlreadyExists, unauthorized, } from 'xo-common/api-errors.js';
+import { ApiError } from '../helpers/error.helper.mjs';
 const log = createLogger('xo:rest-api:error-handler');
 // must have 4 parameters to be recognized as an error middleware by express
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -14,7 +15,10 @@ export default function genericErrorHandler(error, req, res, _next) {
         data: 'data' in error ? error.data : undefined,
     };
     let statusCode;
-    if (noSuchObject.is(error)) {
+    if (error instanceof ApiError) {
+        statusCode = error.status;
+    }
+    else if (noSuchObject.is(error)) {
         statusCode = 404;
     }
     else if (unauthorized.is(error) || forbiddenOperation.is(error)) {

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

@@ -39,3 +39,7 @@ export const forbiddenOperationResp = {
     status: 403,
     description: 'Forbidden',
 };
+export const badRequestResp = {
+    status: 400,
+    description: 'Bad request',
+};

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

@@ -775,3 +775,34 @@ export const hostStats = {
         },
     },
 };
+export const hostSmt = { enabled: true };
+export const hostMissingPatches = [
+    {
+        url: 'http://www.samba.org/',
+        version: '4.10.16',
+        name: 'libsmbclient',
+        license: 'GPLv3+ and LGPLv3+',
+        changelog: {
+            date: 1690286400,
+            description: '- resolves: #2222250 - Fix netlogon capabilities level 2',
+            author: 'Andreas Schneider <asn@redhat.com> - 4.10.16-25',
+        },
+        release: '25.el7_9',
+        size: 149400,
+        description: 'The SMB client library',
+    },
+    {
+        url: 'http://www.openssh.com/portable.html',
+        version: '7.4p1',
+        name: 'openssh',
+        license: 'BSD',
+        changelog: {
+            date: 1742212800,
+            description: '- Fix CVE-2025-26465 - Fix cases where error codes were not correctly set',
+            author: 'Lucas Ravagnier <lucas.ravagnier@vates.tech> - 7.4p1-23.3.2 + 0.10.3-2.23.3.2',
+        },
+        release: '23.3.2.xcpng8.2',
+        size: 429044,
+        description: 'An open source implementation of SSH protocol versions 1 and 2',
+    },
+];

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

@@ -473,3 +473,33 @@ export const poolDashboard = {
         percent: 8.333333333333334,
     },
 };
+export const poolMissingPatches = [
+    {
+        url: 'http://www.samba.org/',
+        version: '4.10.16',
+        name: 'libsmbclient',
+        license: 'GPLv3+ and LGPLv3+',
+        changelog: {
+            date: 1690286400,
+            description: '- resolves: #2222250 - Fix netlogon capabilities level 2',
+            author: 'Andreas Schneider <asn@redhat.com> - 4.10.16-25',
+        },
+        release: '25.el7_9',
+        size: 149400,
+        description: 'The SMB client library',
+    },
+    {
+        url: 'http://www.openssh.com/portable.html',
+        version: '7.4p1',
+        name: 'openssh',
+        license: 'BSD',
+        changelog: {
+            date: 1742212800,
+            description: '- Fix CVE-2025-26465 - Fix cases where error codes were not correctly set',
+            author: 'Lucas Ravagnier <lucas.ravagnier@vates.tech> - 7.4p1-23.3.2 + 0.10.3-2.23.3.2',
+        },
+        release: '23.3.2.xcpng8.2',
+        size: 429044,
+        description: 'An open source implementation of SSH protocol versions 1 and 2',
+    },
+];

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

@@ -1 +1,47 @@
 export const taskLocation = '/rest/v0/tasks/0m7kl0j9l';
+export const taskIds = ['/rest/v0/tasks/0mdd1basu', '/rest/v0/tasks/0mdd1t24g'];
+export const partialTasks = [
+    {
+        status: 'failure',
+        id: '0mdd1basu',
+        properties: {
+            method: 'xoa.licenses.getSelf',
+            params: {},
+            name: 'API call: xoa.licenses.getSelf',
+            userId: 'e531b8c9-3876-4ed9-8fd2-0476d5f825c9',
+            type: 'api.call',
+        },
+        href: '/rest/v0/tasks/0mdd1basu',
+    },
+    {
+        status: 'failure',
+        id: '0mdd1t24g',
+        properties: {
+            method: 'xoa.licenses.getSelf',
+            params: {},
+            name: 'API call: xoa.licenses.getSelf',
+            userId: 'e531b8c9-3876-4ed9-8fd2-0476d5f825c9',
+            type: 'api.call',
+        },
+        href: '/rest/v0/tasks/0mdd1t24g',
+    },
+];
+export const task = {
+    id: '0mdd1basu',
+    properties: {
+        method: 'xoa.licenses.getSelf',
+        params: {},
+        name: 'API call: xoa.licenses.getSelf',
+        userId: 'e531b8c9-3876-4ed9-8fd2-0476d5f825c9',
+        type: 'api.call',
+    },
+    start: 1753098047598,
+    status: 'failure',
+    updatedAt: 1753098047696,
+    end: 1753098047600,
+    result: {
+        message: 'invalid status closed, expected open',
+        name: 'ConnectionError',
+        stack: 'ConnectionError: invalid status closed, expected open\n    at JsonRpcWebSocketClient._assertStatus (/home/debian/xoa/node_modules/jsonrpc-websocket-client/src/websocket-client.js:141:13)\n    at JsonRpcWebSocketClient.send (/home/debian/xoa/node_modules/jsonrpc-websocket-client/src/websocket-client.js:128:10)\n    at Peer.<anonymous> (/home/debian/xoa/node_modules/jsonrpc-websocket-client/src/index.js:47:12)\n    at Peer.emit (node:events:518:28)\n    at Peer.emit (/home/debian/xen-orchestra/@xen-orchestra/log/configure.js:52:17)\n    at Peer.push (/home/debian/xoa/node_modules/json-rpc-peer/src/index.js:196:52)\n    at /home/debian/xoa/node_modules/json-rpc-peer/src/index.js:142:12\n    at Promise._execute (/home/debian/xen-orchestra/node_modules/bluebird/js/release/debuggability.js:384:9)\n    at Promise._resolveFromExecutor (/home/debian/xen-orchestra/node_modules/bluebird/js/release/promise.js:518:18)\n    at new Promise (/home/debian/xen-orchestra/node_modules/bluebird/js/release/promise.js:103:10)\n    at Peer.request (/home/debian/xoa/node_modules/json-rpc-peer/src/index.js:139:12)\n    at JsonRpcWebSocketClient.call (/home/debian/xoa/node_modules/jsonrpc-websocket-client/src/index.js:63:23)\n    at Xoa.apply [as _getSelfLicenses] (/home/debian/xoa/packages/xo-server-xoa/src/index.js:929:26)\n    at Xo.call (file:///home/debian/xen-orchestra/packages/xo-server/src/xo-mixins/api.mjs:269:25)\n    at file:///home/debian/xen-orchestra/packages/xo-server/src/xo-mixins/api.mjs:421:33\n    at AsyncLocalStorage.run (node:internal/async_local_storage/async_hooks:91:14)\n    at Task.runInside (/home/debian/xen-orchestra/@vates/task/index.js:175:41)\n    at Task.run (/home/debian/xen-orchestra/@vates/task/index.js:159:31)\n    at run (file:///home/debian/xen-orchestra/packages/xo-server/src/xo-mixins/api.mjs:421:16)\n    at Api.#callApiMethod (file:///home/debian/xen-orchestra/packages/xo-server/src/xo-mixins/api.mjs:469:24)',
+    },
+};

package/dist/open-api/oa-examples/vm-controller.oa-example.mjs

@@ -69,3 +69,17 @@ export const vmController = {
     $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
     _xapiRef: 'OpaqueRef:ca27fcfc-5083-d039-e752-2e6c3364bde9',
 };
+export const vmControllerVdis = [
+    {
+        VDI_type: 'user',
+        id: '6b67c24d-5f09-4845-b753-0b73abf658f0',
+        name_label: 'debian 12 hub disk',
+        href: '/rest/v0/vdi-snapshots/6b67c24d-5f09-4845-b753-0b73abf658f0',
+    },
+    {
+        VDI_type: 'user',
+        id: '11d85da8-7caf-4a47-b030-15e78adb3f72',
+        name_label: 'xoa root',
+        href: '/rest/v0/vdi-snapshots/11d85da8-7caf-4a47-b030-15e78adb3f72',
+    },
+];

package/dist/open-api/oa-examples/vm-snapshot.oa-example.mjs

@@ -176,3 +176,17 @@ export const vmSnapshot = {
     suspendVdi: 'string',
     type: 'VM-snapshot',
 };
+export const vmSnapshotVdis = [
+    {
+        VDI_type: 'user',
+        id: 'a2831a61-6b1c-41e3-a328-bdfd13e76488',
+        name_label: 'Debian Buster 10_oreva',
+        href: '/rest/v0/vdi-snapshots/a2831a61-6b1c-41e3-a328-bdfd13e76488',
+    },
+    {
+        VDI_type: 'user',
+        id: '41c52deb-0083-471e-bd72-252ea06a48b9',
+        name_label: 'MRA XCP 8.2_uvuvo',
+        href: '/rest/v0/vdi-snapshots/41c52deb-0083-471e-bd72-252ea06a48b9',
+    },
+];

package/dist/open-api/oa-examples/vm-template.oa-example.mjs

@@ -89,3 +89,17 @@ export const vmTemplate = {
     $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
     _xapiRef: 'OpaqueRef:3a9b74fe-57d5-52f7-31ec-fbb0de9e8a1e',
 };
+export const vmTemplateVdis = [
+    {
+        VDI_type: 'user',
+        id: 'cbfeabfc-20c8-46eb-a094-84076eb29f04',
+        name_label: 'Hard disk 1',
+        href: '/rest/v0/vdis/cbfeabfc-20c8-46eb-a094-84076eb29f04',
+    },
+    {
+        VDI_type: 'user',
+        id: 'bee66a2e-68a4-4ff8-9ed4-2f429587524f',
+        name_label: 'Hard disk 2',
+        href: '/rest/v0/vdis/bee66a2e-68a4-4ff8-9ed4-2f429587524f',
+    },
+];

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

@@ -243,3 +243,17 @@ export const vmStatsExample = {
         ],
     },
 };
+export const vmVdis = [
+    {
+        VDI_type: 'user',
+        id: '11045407-4764-4c1c-8865-63f89d686b1b',
+        name_label: 'Debian Bookworm 12_ogupi',
+        href: '/rest/v0/vdis/11045407-4764-4c1c-8865-63f89d686b1b',
+    },
+    {
+        VDI_type: 'user',
+        id: '0eb73d40-e5f8-443d-b611-a52e03858a6a',
+        name_label: 'MRA TrueNAS_emodi',
+        href: '/rest/v0/vdis/0eb73d40-e5f8-443d-b611-a52e03858a6a',
+    },
+];