@xen-orchestra/rest-api 0.1.1 → 0.2.0

package/dist/rest-api/rest-api.mjs

@@ -3,6 +3,12 @@ export class RestApi {
     constructor(xoApp) {
         this.#xoApp = xoApp;
     }
+    get tasks() {
+        return this.#xoApp.tasks;
+    }
+    get xoApp() {
+        return this.#xoApp;
+    }
     authenticateUser(...args) {
         return this.#xoApp.authenticateUser(...args);
     }
@@ -12,6 +18,9 @@ export class RestApi {
     getObjectsByType(type, opts) {
         return this.#xoApp.getObjectsByType(type, opts);
     }
+    getXapiObject(maybeId, type) {
+        return this.#xoApp.getXapiObject(maybeId, type);
+    }
     runWithApiContext(...args) {
         return this.#xoApp.runWithApiContext(...args);
     }

package/dist/servers/server.controller.mjs

@@ -0,0 +1,60 @@
+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 { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { provide } from 'inversify-binding-decorators';
+import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { partialServers, server, serverIds } from '../open-api/oa-examples/server.oa-example.mjs';
+import { XoController } from '../abstract-classes/xo-controller.mjs';
+let ServerController = class ServerController extends XoController {
+    // --- abstract methods
+    getAllCollectionObjects() {
+        return this.restApi.xoApp.getAllXenServers();
+    }
+    getCollectionObject(id) {
+        return this.restApi.xoApp.getXenServer(id);
+    }
+    /**
+     * @example fields "status,id"
+     * @example filter "status:/^connected$/"
+     * @example limit 42
+     */
+    async getServers(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(await this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    getServer(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(serverIds),
+    Example(partialServers),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], ServerController.prototype, "getServers", null);
+__decorate([
+    Example(server),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], ServerController.prototype, "getServer", null);
+ServerController = __decorate([
+    Route('servers'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('servers'),
+    provide(ServerController)
+], ServerController);
+export { ServerController };

package/dist/srs/sr.controller.mjs

@@ -0,0 +1,59 @@
+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 { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { provide } from 'inversify-binding-decorators';
+import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { partialSrs, sr, srIds } from '../open-api/oa-examples/sr.oa-example.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
+import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+let SrController = class SrController extends XapiXoController {
+    constructor(restApi) {
+        super('SR', restApi);
+    }
+    /**
+     * @example fields "uuid,name_label,allocationStrategy"
+     * @example filter "allocationStrategy:thin"
+     * @example limit 42
+     */
+    getSrs(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "c4284e12-37c9-7967-b9e8-83ef229c3e03"
+     */
+    getSr(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(srIds),
+    Example(partialSrs),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], SrController.prototype, "getSrs", null);
+__decorate([
+    Example(sr),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], SrController.prototype, "getSr", null);
+SrController = __decorate([
+    Route('srs'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('srs'),
+    provide(SrController),
+    __param(0, inject(RestApi))
+], SrController);
+export { SrController };

package/dist/vbds/vbd.controller.mjs

@@ -0,0 +1,61 @@
+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 { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { provide } from 'inversify-binding-decorators';
+import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { partialVbds, vbd, vbdIds } from '../open-api/oa-examples/vbd.oa-example.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
+import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+let VbdController = class VbdController extends XapiXoController {
+    constructor(restApi) {
+        super('VBD', restApi);
+    }
+    /**
+     *
+     * @example fields "device,bootable,uuid"
+     * @example filter "!bootable?"
+     * @example limit 42
+     */
+    getVbds(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    getVbd(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(vbdIds),
+    Example(partialVbds),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], VbdController.prototype, "getVbds", null);
+__decorate([
+    Example(vbd),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], VbdController.prototype, "getVbd", null);
+VbdController = __decorate([
+    Route('vbds'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('vbds'),
+    provide(VbdController),
+    __param(0, inject(RestApi))
+], VbdController);
+export { VbdController };

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

@@ -0,0 +1,59 @@
+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 { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { provide } from 'inversify-binding-decorators';
+import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
+import { partialVdiSnapshots, vdiSnapshot, vdiSnapshotIds } from '../open-api/oa-examples/vdi-snapshot.oa-example.mjs';
+import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+let VdiSnapshotController = class VdiSnapshotController extends XapiXoController {
+    constructor(restApi) {
+        super('VDI-snapshot', restApi);
+    }
+    /**
+     * @example fields "uuid,snapshot_time,$snapshot_of"
+     * @example filter "snapshot_time:>1725020038"
+     * @example limit 42
+     */
+    getVdiSnapshots(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "d2727772-735b-478f-b6f9-11e7db56dfd0"
+     */
+    getVdiSnapshot(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(vdiSnapshotIds),
+    Example(partialVdiSnapshots),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], VdiSnapshotController.prototype, "getVdiSnapshots", null);
+__decorate([
+    Example(vdiSnapshot),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], VdiSnapshotController.prototype, "getVdiSnapshot", null);
+VdiSnapshotController = __decorate([
+    Route('vdi-snapshots'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('vdis'),
+    provide(VdiSnapshotController),
+    __param(0, inject(RestApi))
+], VdiSnapshotController);
+export { VdiSnapshotController };

package/dist/vdis/vdi.controller.mjs

@@ -0,0 +1,59 @@
+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 { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { provide } from 'inversify-binding-decorators';
+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';
+import { partialVdis, vdi, vdiIds } from '../open-api/oa-examples/vdi.oa-example.mjs';
+let VdiController = class VdiController extends XapiXoController {
+    constructor(restApi) {
+        super('VDI', restApi);
+    }
+    /**
+     * @example fields "*"
+     * @example filter "snapshots:length:>2"
+     * @example limit 42
+     */
+    getVdis(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "c77f9955-c1d2-4b39-aa1c-73cdb2dacb7e"
+     */
+    getVdi(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(vdiIds),
+    Example(partialVdis),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], VdiController.prototype, "getVdis", null);
+__decorate([
+    Example(vdi),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], VdiController.prototype, "getVdi", null);
+VdiController = __decorate([
+    Route('vdis'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('vdis'),
+    provide(VdiController),
+    __param(0, inject(RestApi))
+], VdiController);
+export { VdiController };

package/dist/vms/vm.controller.mjs

@@ -7,11 +7,14 @@ 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, Request, Response, Route, Security } from 'tsoa';
+import { Example, Get, Path, Post, Query, Request, Response, Route, Security, Tags, SuccessResponse } from 'tsoa';
 import { inject } from 'inversify';
+import { incorrectState, invalidParameters } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
-import { partialVms, vm, vmIds } from '../open-api/examples/vm.example.mjs';
+import { actionAsyncroneResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { partialVms, vm, vmIds, vmStatsExample } from '../open-api/oa-examples/vm.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
+import { taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 let VmController = class VmController extends XapiXoController {
     constructor(restApi) {
@@ -33,6 +36,40 @@ let VmController = class VmController extends XapiXoController {
     getVm(id) {
         return this.getObject(id);
     }
+    /**
+     *
+     *  VM must be running
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async getVmStats(id, granularity) {
+        try {
+            return await this.restApi.xoApp.getXapiVmStats(id, granularity);
+        }
+        catch (error) {
+            if (incorrectState.is(error, {
+                property: 'resident_on',
+            })) {
+                /* throw */ invalidParameters(`VM ${id} is halted or host could not be found.`, error);
+            }
+            throw error;
+        }
+    }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async startVm(id, sync) {
+        const vmId = id;
+        const action = () => this.getXapiObject(vmId).$callAsync('start', false, false);
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'start VM',
+                objectId: vmId,
+            },
+        });
+    }
 };
 __decorate([
     Example(vmIds),
@@ -46,13 +83,32 @@ __decorate([
 __decorate([
     Example(vm),
     Get('{id}'),
-    Response(404),
+    Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], VmController.prototype, "getVm", null);
+__decorate([
+    Example(vmStatsExample),
+    Get('{id}/stats'),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(422, 'Invalid granularity, VM is halted or host could not be found'),
+    __param(0, Path()),
+    __param(1, Query())
+], VmController.prototype, "getVmStats", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/start'),
+    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VmController.prototype, "startVm", null);
 VmController = __decorate([
     Route('vms'),
     Security('*'),
-    Response(401)
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('vms')
     // the `provide` decorator is mandatory on class that injects/receives dependencies.
     // It automatically bind the class to the IOC container that handles dependency injection
     ,