@xen-orchestra/rest-api 0.2.0 → 0.4.0

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

@@ -7,10 +7,10 @@ export class XapiXoController extends BaseController {
         this.#type = type;
     }
     getObjects({ filter, limit } = {}) {
-        if (filter !== undefined) {
+        if (filter !== undefined && typeof filter === 'string') {
             filter = CM.parse(filter).createPredicate();
         }
-        return this.restApi.getObjectsByType(this.#type, { filter, limit });
+        return this.restApi.getObjectsByType(this.#type, { filter: filter, limit });
     }
     getObject(id) {
         return this.restApi.getObject(id, this.#type);

package/dist/alarms/alarm.controller.mjs

@@ -0,0 +1,130 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import * as CM from 'complex-matcher';
+import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { noSuchObject } from 'xo-common/api-errors.js';
+import { provide } from 'inversify-binding-decorators';
+import { alarm, alarmIds, partialAlarms } from '../open-api/oa-examples/alarm.oa-example.mjs';
+import { BASE_URL } from '../index.mjs';
+import { 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';
+// E.g: 'value: 0.6\nconfig:\n<variable>\n<name value="cpu_usage"/>\n<alarm_trigger_level value="0.4"/>\n<alarm_trigger_period value ="60"/>\n</variable>';
+const ALARM_BODY_REGEX = /^value:\s*(Infinity|NaN|-Infinity|\d+(?:\.\d+)?)\s*config:\s*<variable>\s*<name value="(.*?)"/;
+const ALARM_NAMES = ['ALARM', 'BOND_STATUS_CHANGED', 'MULTIPATH_PERIODIC_ALERT'];
+export const alarmPredicate = CM.parse(`name:|(${ALARM_NAMES.join(' ')})`).createPredicate();
+let AlarmController = class AlarmController extends XapiXoController {
+    constructor(restApi) {
+        super('message', restApi);
+    }
+    #parseAlarm({ $object, body, ...alarm }) {
+        let object;
+        try {
+            object = this.restApi.getObject($object);
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        }
+        catch (err) {
+            object = {
+                type: 'unknown',
+                uuid: $object,
+            };
+        }
+        let href;
+        if (object.type !== 'unknown') {
+            href = `${BASE_URL}/${object.type.toLowerCase() + 's'}/${object.uuid}`;
+        }
+        const [, value, name] = body.match(ALARM_BODY_REGEX) ?? [];
+        return {
+            ...alarm,
+            body: {
+                value, // Keep the value as a string because NaN, Infinity, -Infinity is not valid JSON
+                name: name ?? body, // for 'BOND_STATUS_CHANGED' and 'MULTIPATH_PERIODIC_ALERT', body is a non-xml string. ("body": "The status of the eth0+eth1 bond is: 1/2 up")
+            },
+            object: {
+                type: object.type,
+                uuid: object.uuid,
+                href,
+            },
+        };
+    }
+    /**
+     * Override parent getObjects in order to only get `ALARM` messages
+     */
+    getObjects({ filter, limit = Infinity } = {}) {
+        const rawAlarms = this.restApi.getObjectsByType('message', {
+            filter: alarmPredicate,
+        });
+        let userFilter = () => true;
+        if (filter !== undefined) {
+            userFilter = CM.parse(filter).createPredicate();
+        }
+        const alarms = {};
+        for (const id in rawAlarms) {
+            if (limit === 0) {
+                break;
+            }
+            const alarm = this.#parseAlarm(rawAlarms[id]);
+            if (userFilter(alarm)) {
+                alarms[id] = alarm;
+                limit--;
+            }
+        }
+        return alarms;
+    }
+    /**
+     * Override parent getObject in order to only get `ALARM` message
+     */
+    getObject(id) {
+        const maybeAlarm = this.restApi.getObject(id, 'message');
+        if (!alarmPredicate(maybeAlarm)) {
+            /* throw */ noSuchObject(id, 'alarm');
+        }
+        return this.#parseAlarm(maybeAlarm);
+    }
+    /**
+     * @example fields "body,id,object"
+     * @example filter "body:name:physical_utilisation"
+     * @example limit 42
+     */
+    getAlarms(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "0c98c71c-2f9c-d5c2-b9b6-2c8371730eab"
+     */
+    getAlarm(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(alarmIds),
+    Example(partialAlarms),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], AlarmController.prototype, "getAlarms", null);
+__decorate([
+    Example(alarm),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], AlarmController.prototype, "getAlarm", null);
+AlarmController = __decorate([
+    Route('alarms'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('alarms'),
+    provide(AlarmController),
+    __param(0, inject(RestApi))
+], AlarmController);
+export { AlarmController };

package/dist/index.mjs

@@ -9,13 +9,33 @@ import { setupContainer } from './ioc/ioc.mjs';
 const require = createRequire(import.meta.url);
 const swaggerOpenApiSpec = require('../open-api/spec/swagger.json');
 export const BASE_URL = '/rest/v0';
+const SWAGGER_UI_OPTIONS = {
+    swaggerOptions: {
+        displayRequestDuration: true,
+        docExpansion: 'none', // collapse all tags by default
+        filter: true, // add a tags searchbar,
+        tagsSorter: 'alpha',
+        operationsSorter: (prev, next) => {
+            // sort endpoints inside a tag alphabetically > HTTP verb
+            const pathComparison = prev.get('path').localeCompare(next.get('path'));
+            if (pathComparison !== 0) {
+                return pathComparison;
+            }
+            const METHOD_ORDER = { get: 1, post: 2, put: 3, delete: 4, patch: 5 };
+            const prevMethod = METHOD_ORDER[prev.get('method')];
+            const nextMethod = METHOD_ORDER[next.get('method')];
+            return prevMethod - nextMethod;
+        },
+        requestSnippetsEnabled: true, // add more snippets (bash, PowerShell, CMD)
+    },
+};
 export default function setupRestApi(express, xoApp) {
     setupContainer(xoApp);
     RegisterRoutes(express);
     // do not register the doc at the root level, or it may lead to unwated behaviour
     // uncomment when all endpoints are migrated to this API
     // express.get('/rest/v0', (_req, res) => res.redirect('/rest/v0/docs'))
-    express.use(`${BASE_URL}/docs`, swaggerUi.serve, swaggerUi.setup(swaggerOpenApiSpec));
+    express.use(`${BASE_URL}/docs`, swaggerUi.serve, swaggerUi.setup(swaggerOpenApiSpec, SWAGGER_UI_OPTIONS));
     express.use(BASE_URL, tsoaToXoErrorHandler);
     express.use(BASE_URL, genericErrorHandler);
 }

package/dist/messages/message.controller.mjs

@@ -0,0 +1,83 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import * as CM from 'complex-matcher';
+import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+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 { 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';
+import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+let MessageController = class MessageController extends XapiXoController {
+    constructor(restapi) {
+        super('message', restapi);
+    }
+    /**
+     * Override parent getObjects in order to exclude `ALARM` messages
+     */
+    getObjects({ filter, limit = Infinity } = {}) {
+        let userfilter = () => true;
+        if (filter !== undefined) {
+            userfilter = CM.parse(filter).createPredicate();
+        }
+        const messagePredicate = (obj) => !alarmPredicate(obj) && userfilter(obj);
+        return super.getObjects({ filter: messagePredicate, limit });
+    }
+    /**
+     * Override parent getObject in order to exclude`ALARM` message
+     */
+    getObject(id) {
+        const message = super.getObject(id);
+        if (alarmPredicate(message)) {
+            /* throw */ noSuchObject(id, 'message');
+        }
+        return message;
+    }
+    /**
+     * @example fields "name,body,id,$object"
+     * @example filter "name:VM_STARTED"
+     * @example limit 42
+     */
+    getMessages(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "f775eaeb-abe5-94e0-9682-14c37c3a1dfe"
+     */
+    getMessage(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(messageIds),
+    Example(partialMessages),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], MessageController.prototype, "getMessages", null);
+__decorate([
+    Example(message),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], MessageController.prototype, "getMessage", null);
+MessageController = __decorate([
+    Route('messages'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('message'),
+    provide(MessageController),
+    __param(0, inject(RestApi))
+], MessageController);
+export { MessageController };

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

@@ -7,6 +7,10 @@ export const unauthorizedResp = {
     status: 401,
     description: 'Authentication required',
 };
+export const featureUnauthorized = {
+    status: 403,
+    description: 'Feature unauthorized',
+};
 export const notFoundResp = {
     status: 404,
     description: 'Resource not found',

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

@@ -0,0 +1,49 @@
+export const alarmIds = [
+    '/rest/v0/alarms/0c98c71c-2f9c-d5c2-b9b6-2c8371730eab',
+    '/rest/v0/alarms/6a4cc401-6cba-0d41-3b02-b848c5017343',
+];
+export const partialAlarms = [
+    {
+        body: {
+            value: '0.0',
+            name: 'physical_utilisation',
+        },
+        id: '0c98c71c-2f9c-d5c2-b9b6-2c8371730eab',
+        object: {
+            type: 'unknown',
+            uuid: '3f607494-26f1-b328-b626-d81cf007de37',
+        },
+        href: '/rest/v0/alarms/0c98c71c-2f9c-d5c2-b9b6-2c8371730eab',
+    },
+    {
+        body: {
+            value: '0.2',
+            name: 'physical_utilisation',
+        },
+        id: '6a4cc401-6cba-0d41-3b02-b848c5017343',
+        object: {
+            type: 'SR',
+            uuid: '8aa2fb4a-143e-c2bc-05d4-c68bbb101d41',
+            href: '/rest/v0/srs/8aa2fb4a-143e-c2bc-05d4-c68bbb101d41',
+        },
+        href: '/rest/v0/alarms/6a4cc401-6cba-0d41-3b02-b848c5017343',
+    },
+];
+export const alarm = {
+    name: 'ALARM',
+    time: 1724862780,
+    type: 'message',
+    uuid: '0c98c71c-2f9c-d5c2-b9b6-2c8371730eab',
+    $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    _xapiRef: 'OpaqueRef:87ccf385-4197-11aa-3ca0-32213c4cb56d',
+    id: '0c98c71c-2f9c-d5c2-b9b6-2c8371730eab',
+    body: {
+        value: '0.0',
+        name: 'physical_utilisation',
+    },
+    object: {
+        type: 'unknown',
+        uuid: '3f607494-26f1-b328-b626-d81cf007de37',
+    },
+};

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

@@ -0,0 +1,32 @@
+export const messageIds = [
+    '/rest/v0/messages/f775eaeb-abe5-94e0-9682-14c37c3a1dfe',
+    '/rest/v0/messages/ed2d1623-3e65-8d39-7a14-4eb69274c5e3',
+];
+export const partialMessages = [
+    {
+        name: 'VM_STARTED',
+        body: "VM 'Alpine MRA' (uuid: cef5f68c-61ae-3831-d2e6-1590d4934acf) started on host: XCP 8.3.0 master (uuid: b61a5c92-700e-4966-a13b-00633f03eea8)",
+        id: 'f775eaeb-abe5-94e0-9682-14c37c3a1dfe',
+        $object: 'cef5f68c-61ae-3831-d2e6-1590d4934acf',
+        href: '/rest/v0/messages/f775eaeb-abe5-94e0-9682-14c37c3a1dfe',
+    },
+    {
+        name: 'VM_STARTED',
+        body: "VM 'Alpine MRA' (uuid: cef5f68c-61ae-3831-d2e6-1590d4934acf) started on host: XCP 8.3.0 master (uuid: b61a5c92-700e-4966-a13b-00633f03eea8)",
+        id: 'ed2d1623-3e65-8d39-7a14-4eb69274c5e3',
+        $object: 'cef5f68c-61ae-3831-d2e6-1590d4934acf',
+        href: '/rest/v0/messages/ed2d1623-3e65-8d39-7a14-4eb69274c5e3',
+    },
+];
+export const message = {
+    body: "VM 'Alpine MRA' (uuid: cef5f68c-61ae-3831-d2e6-1590d4934acf) started on host: XCP 8.3.0 master (uuid: b61a5c92-700e-4966-a13b-00633f03eea8)",
+    name: 'VM_STARTED',
+    time: 1709908890,
+    $object: 'cef5f68c-61ae-3831-d2e6-1590d4934acf',
+    id: 'f775eaeb-abe5-94e0-9682-14c37c3a1dfe',
+    type: 'message',
+    uuid: 'f775eaeb-abe5-94e0-9682-14c37c3a1dfe',
+    $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    _xapiRef: 'OpaqueRef:7544478e-84d3-2381-69e7-b0698ab45d9b',
+};

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

@@ -0,0 +1,70 @@
+export const poolIds = [
+    '/rest/v0/pools/b7569d99-30f8-178a-7d94-801de3e29b5b',
+    '/rest/v0/pools/355ee47d-ff4c-4924-3db2-fd86ae629676',
+];
+export const partialPools = [
+    {
+        auto_poweron: true,
+        name_label: 'XCP 8.3.0 XO Team',
+        id: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+        href: '/rest/v0/pools/b7569d99-30f8-178a-7d94-801de3e29b5b',
+    },
+    {
+        auto_poweron: true,
+        name_label: 'XO Lab',
+        id: '355ee47d-ff4c-4924-3db2-fd86ae629676',
+        href: '/rest/v0/pools/355ee47d-ff4c-4924-3db2-fd86ae629676',
+    },
+];
+export const pool = {
+    auto_poweron: true,
+    crashDumpSr: '86a9757d-9c05-9fe0-e79a-8243cb1f37f3',
+    current_operations: {},
+    default_SR: '86a9757d-9c05-9fe0-e79a-8243cb1f37f3',
+    HA_enabled: false,
+    haSrs: [],
+    master: '438aca0f-429c-4ae6-accc-93c306e636a0',
+    tags: [],
+    name_description: 'Main Lyon Lab',
+    name_label: 'XO Lab',
+    xosanPackInstallationTime: null,
+    otherConfig: {
+        'xo:clientInfo:v9sc05bvrh': '{"lastConnected":1744102763392,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:218b43e8-5622-4d81-adce-69be4252c4de': '{"lastConnected":1744102538271,"networkInterfaces":{"wlp0s20f3":[{"address":"10.234.213.181","netmask":"255.255.255.0","family":"IPv4","mac":"6a:8e:98:da:15:36","internal":false,"cidr":"10.234.213.181/24"},{"address":"2a0d:e487:319f:7520:16da:8a1a:c6fb:7fc3","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"6a:8e:98:da:15:36","internal":false,"cidr":"2a0d:e487:319f:7520:16da:8a1a:c6fb:7fc3/64","scopeid":0},{"address":"fe80::9400:57c5:e2d:94ff","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"6a:8e:98:da:15:36","internal":false,"cidr":"fe80::9400:57c5:e2d:94ff/64","scopeid":2}],"wg1":[{"address":"10.200.205.81","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.81/24"}],"wg0":[{"address":"10.200.200.81","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.81/24"}]}}',
+        'xo:clientInfo:1gywgvavm02': '{"lastConnected":1744102486813,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:5vtpi83kh8a': '{"lastConnected":1744102149901,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:t0yxso5g6s': '{"lastConnected":1744101989898,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:0w4we05jsnof': '{"lastConnected":1744101895389,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:wp0r9dsmnbf': '{"lastConnected":1744101746158,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:p7r15qcczse': '{"lastConnected":1744101242926,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:1mnh07a7l2x': '{"lastConnected":1744101089247,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:ou6a9jn1dxa': '{"lastConnected":1744100523539,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:d6363a9d-03e5-f598-ebe6-b98b4fcf4ea6': '{"lastConnected":1744098018490,"networkInterfaces":{"eth0":[{"address":"172.16.210.100","netmask":"255.255.254.0","family":"IPv4","mac":"c2:f3:1b:b6:9f:b1","internal":false,"cidr":"172.16.210.100/23"},{"address":"2a01:240:ab08:4:c0f3:1bff:feb6:9fb1","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"c2:f3:1b:b6:9f:b1","internal":false,"cidr":"2a01:240:ab08:4:c0f3:1bff:feb6:9fb1/64","scopeid":0},{"address":"fe80::c0f3:1bff:feb6:9fb1","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"c2:f3:1b:b6:9f:b1","internal":false,"cidr":"fe80::c0f3:1bff:feb6:9fb1/64","scopeid":2}],"eth1":[{"address":"10.1.0.100","netmask":"255.255.0.0","family":"IPv4","mac":"1e:ba:68:4f:28:82","internal":false,"cidr":"10.1.0.100/16"},{"address":"2a01:240:ab08:5:1::100","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"1e:ba:68:4f:28:82","internal":false,"cidr":"2a01:240:ab08:5:1::100/64","scopeid":0},{"address":"fe80::1cba:68ff:fe4f:2882","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"1e:ba:68:4f:28:82","internal":false,"cidr":"fe80::1cba:68ff:fe4f:2882/64","scopeid":3}]}}',
+        'xo:clientInfo:mz05bzlp2d9': '{"lastConnected":1744096801517,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:vuy2k7qxs1d': '{"lastConnected":1744096735180,"networkInterfaces":{"wlp58s0":[{"address":"192.168.1.22","netmask":"255.255.255.0","family":"IPv4","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"192.168.1.22/24"},{"address":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"2a01:cb15:8411:4700:4aff:d5e9:6604:f90b/64","scopeid":0},{"address":"fe80::1d04:d88d:50de:799a","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"be:7b:03:70:e6:fe","internal":false,"cidr":"fe80::1d04:d88d:50de:799a/64","scopeid":2}],"wg-grenoble":[{"address":"10.200.205.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.205.115/24"}],"wg-lyon":[{"address":"10.200.200.115","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.115/24"}]}}',
+        'xo:clientInfo:218b43e8-5622-4d81-adce-69be4252c4df': '{"lastConnected":1744096374953,"networkInterfaces":{"wlp2s0":[{"address":"192.168.0.18","netmask":"255.255.255.0","family":"IPv4","mac":"9c:b6:d0:94:f0:43","internal":false,"cidr":"192.168.0.18/24"},{"address":"fe80::c233:3934:9928:1120","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"9c:b6:d0:94:f0:43","internal":false,"cidr":"fe80::c233:3934:9928:1120/64","scopeid":2}],"wg0":[{"address":"10.200.200.9","netmask":"255.255.255.0","family":"IPv4","mac":"00:00:00:00:00:00","internal":false,"cidr":"10.200.200.9/24"}],"enx001cc25011b2":[{"address":"192.168.0.15","netmask":"255.255.255.0","family":"IPv4","mac":"00:1c:c2:50:11:b2","internal":false,"cidr":"192.168.0.15/24"},{"address":"fe80::2f62:2392:9f4d:ca13","netmask":"ffff:ffff:ffff:ffff::","family":"IPv6","mac":"00:1c:c2:50:11:b2","internal":false,"cidr":"fe80::2f62:2392:9f4d:ca13/64","scopeid":5}],"wg2":[{"address":"fdab:cdea:bcde:e7c8::9","netmask":"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff","family":"IPv6","mac":"00:00:00:00:00:00","internal":false,"cidr":"fdab:cdea:bcde:e7c8::9/128","scopeid":0}]}}',
+        auto_poweron: 'true',
+        migrationCompression: 'true',
+        'xo:backupNetwork': '6c4e1cdc-9fe0-0603-e53d-4790d1fce8dd',
+        jft: 'test',
+        'xo:355ee47d': '{"bar":1,"foo":1}',
+        'memory-ratio-hvm': '0.25',
+        'xo:appliance:218b43e8-5622-4d81-adce-69be4252c4df': '{"lastConnected":1644397147011}',
+        'xscontainer-public-secret-uuid': 'd95d1d3c-29b9-e1b3-1c03-5d27ab82ef76',
+        'memory-ratio-pv': '0.25',
+        'xscontainer-private-secret-uuid': '68c7c1a0-eb42-f21a-e872-7a19468dbd6d',
+    },
+    cpus: {
+        cores: 120,
+        sockets: 6,
+    },
+    zstdSupported: true,
+    vtpmSupported: false,
+    platform_version: '3.2.1',
+    id: '355ee47d-ff4c-4924-3db2-fd86ae629676',
+    type: 'pool',
+    uuid: '355ee47d-ff4c-4924-3db2-fd86ae629676',
+    $pool: '355ee47d-ff4c-4924-3db2-fd86ae629676',
+    $poolId: '355ee47d-ff4c-4924-3db2-fd86ae629676',
+    _xapiRef: 'OpaqueRef:1c3f19c8-f80a-464d-9c48-a2c19d4e4fc3',
+};

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

@@ -0,0 +1,29 @@
+export const scheduleIds = [
+    '/rest/v0/schedules/ada358a4-1087-4ad4-9863-42b68bd711c2',
+    '/rest/v0/schedules/853864bd-b67e-425e-9880-86bb3bbf1bf1',
+];
+export const partialSchedules = [
+    {
+        enabled: true,
+        jobId: 'a87827cf-57fc-48a6-aa77-a0a14771f8f3',
+        cron: '0 0 * * *',
+        id: 'cf7249f8-d20b-494f-97f4-b1f32f94e780',
+        href: '/rest/v0/schedules/cf7249f8-d20b-494f-97f4-b1f32f94e780',
+    },
+    {
+        enabled: true,
+        jobId: 'e7129e6b-84ba-439c-8b7e-34f7bc357dbd',
+        cron: '0 0 * * *',
+        id: 'd1f79c6b-90f7-49f4-9adb-bcb85f236dea',
+        href: '/rest/v0/schedules/d1f79c6b-90f7-49f4-9adb-bcb85f236dea',
+    },
+];
+export const schedule = {
+    cron: '0 0 * * *',
+    enabled: true,
+    jobId: 'a87827cf-57fc-48a6-aa77-a0a14771f8f3',
+    name: 'job-schedule',
+    timezone: 'Europe/Paris',
+    userId: 'd558dd75-c928-45f6-b8e3-4375bdda59f8',
+    id: 'cf7249f8-d20b-494f-97f4-b1f32f94e780',
+};

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

@@ -0,0 +1,37 @@
+export const vifIds = [
+    '/rest/v0/vifs/f028c5d4-578a-332c-394e-087aaca32dd3',
+    '/rest/v0/vifs/9cc245bf-8dac-8550-e1ae-54bc679b68d9',
+];
+export const partialVifs = [
+    {
+        attached: true,
+        id: 'f028c5d4-578a-332c-394e-087aaca32dd3',
+        device: '0',
+        href: '/rest/v0/vifs/f028c5d4-578a-332c-394e-087aaca32dd3',
+    },
+    {
+        attached: true,
+        id: '9cc245bf-8dac-8550-e1ae-54bc679b68d9',
+        device: '0',
+        href: '/rest/v0/vifs/9cc245bf-8dac-8550-e1ae-54bc679b68d9',
+    },
+];
+export const vif = {
+    type: 'VIF',
+    allowedIpv4Addresses: [],
+    allowedIpv6Addresses: [],
+    attached: true,
+    device: '0',
+    lockingMode: 'network_default',
+    MAC: 'fe:2e:01:f9:75:38',
+    MTU: 1500,
+    other_config: {},
+    txChecksumming: true,
+    $network: '6b6ca0f5-6611-0636-4b0a-1fb1c8e96414',
+    $VM: '9c3842a5-d9e5-ab9c-958e-264fea958690',
+    id: 'f028c5d4-578a-332c-394e-087aaca32dd3',
+    uuid: 'f028c5d4-578a-332c-394e-087aaca32dd3',
+    $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    _xapiRef: 'OpaqueRef:ba0730b3-bd19-ff79-2e02-5c5a5338064f',
+};

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

@@ -0,0 +1,71 @@
+export const vmControllerIds = [
+    '/rest/v0/vm-controller/9b4775bd-9493-490a-9afa-f786a44caa4f',
+    '/rest/v0/vm-controller/e3fc847c-159a-48dc-bee4-cf2da216a795',
+];
+export const partialVmControllers = [
+    {
+        type: 'VM-controller',
+        uuid: '9b4775bd-9493-490a-9afa-f786a44caa4f',
+        href: '/rest/v0/vm-controller/9b4775bd-9493-490a-9afa-f786a44caa4f',
+    },
+    {
+        type: 'VM-controller',
+        uuid: 'e3fc847c-159a-48dc-bee4-cf2da216a795',
+        href: '/rest/v0/vm-controller/e3fc847c-159a-48dc-bee4-cf2da216a795',
+    },
+];
+export const vmController = {
+    type: 'VM-controller',
+    addresses: {},
+    affinityHost: 'b61a5c92-700e-4966-a13b-00633f03eea8',
+    auto_poweron: false,
+    bios_strings: {},
+    blockedOperations: {},
+    boot: {},
+    CPUs: {
+        max: 8,
+        number: 8,
+    },
+    current_operations: {},
+    expNestedHvm: false,
+    viridian: false,
+    high_availability: '',
+    isFirmwareSupported: true,
+    memory: {
+        dynamic: [2785017856, 2785017856],
+        static: [2785017856, 2785017856],
+        size: 2785017856,
+    },
+    installTime: null,
+    name_description: 'The domain which manages physical devices and manages other domains',
+    name_label: 'Control domain on host: localhost.localdomain',
+    needsVtpm: false,
+    other: {
+        storage_driver_domain: 'OpaqueRef:254474d5-77b7-0947-da0f-af869dd2ca82',
+        is_system_domain: 'true',
+        perfmon: '<config><variable><name value="fs_usage"/><alarm_trigger_level value="0.9"/><alarm_trigger_period value="60"/><alarm_auto_inhibit_period value="3600"/></variable><variable><name value="mem_usage"/><alarm_trigger_level value="0.95"/><alarm_trigger_period value="60"/><alarm_auto_inhibit_period value="3600"/></variable><variable><name value="log_fs_usage"/><alarm_trigger_level value="0.9"/><alarm_trigger_period value="60"/><alarm_auto_inhibit_period value="3600"/></variable></config>',
+    },
+    os_version: null,
+    power_state: 'Running',
+    hasVendorDevice: false,
+    snapshots: [],
+    startDelay: 0,
+    startTime: null,
+    secureBoot: false,
+    tags: [],
+    VIFs: [],
+    VTPMs: [],
+    virtualizationMode: 'pv',
+    xenTools: false,
+    $containe: 'b61a5c92-700e-4966-a13b-00633f03eea8',
+    $VBDs: [],
+    VGPUs: [],
+    $VGPUs: [],
+    xenStoreData: {},
+    PV_args: '',
+    id: '9b4775bd-9493-490a-9afa-f786a44caa4f',
+    uuid: '9b4775bd-9493-490a-9afa-f786a44caa4f',
+    $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    _xapiRef: 'OpaqueRef:ca27fcfc-5083-d039-e752-2e6c3364bde9',
+};