@xen-orchestra/rest-api 0.2.0 → 0.4.0

package/dist/pools/pool.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, Response, Request, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { provide } from 'inversify-binding-decorators';
+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';
+import { partialPools, pool, poolIds } from '../open-api/oa-examples/pool.oa-example.mjs';
+let PoolController = class PoolController extends XapiXoController {
+    constructor(restApi) {
+        super('pool', restApi);
+    }
+    /**
+     *
+     * @example fields "auto_poweron,name_label,id"
+     * @example filter "auto_poweron?"
+     * @example limit 42
+     */
+    getPools(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "355ee47d-ff4c-4924-3db2-fd86ae629676"
+     */
+    getPool(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(poolIds),
+    Example(partialPools),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], PoolController.prototype, "getPools", null);
+__decorate([
+    Example(pool),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], PoolController.prototype, "getPool", null);
+PoolController = __decorate([
+    Route('pools'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('pools'),
+    provide(PoolController),
+    __param(0, inject(RestApi))
+], PoolController);
+export { PoolController };

package/dist/schedules/schedule.controller.mjs

@@ -0,0 +1,89 @@
+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, Post, Query, Request, Response, Route, Security, SuccessResponse, Tags } from 'tsoa';
+import { provide } from 'inversify-binding-decorators';
+import { actionAsyncroneResp, featureUnauthorized, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { partialSchedules, schedule, scheduleIds } from '../open-api/oa-examples/schedule.oa-example.mjs';
+import { taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
+import { XoController } from '../abstract-classes/xo-controller.mjs';
+let ScheduleController = class ScheduleController extends XoController {
+    // --- abstract methods
+    getAllCollectionObjects() {
+        return this.restApi.xoApp.getAllSchedules();
+    }
+    getCollectionObject(id) {
+        return this.restApi.xoApp.getSchedule(id);
+    }
+    /**
+     * @example fields "enabled,jobId,cron,id"
+     * @example filter "enabled?"
+     * @example limit 42
+     */
+    async getSchedules(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(await this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "cf7249f8-d20b-494f-97f4-b1f32f94e780"
+     */
+    async getSchedule(id) {
+        return this.getObject(id);
+    }
+    /**
+     * @example id "cf7249f8-d20b-494f-97f4-b1f32f94e780"
+     */
+    async runSchedule(id, sync) {
+        const scheduleId = id;
+        const action = async () => {
+            const xoApp = this.restApi.xoApp;
+            const schedule = await this.getObject(scheduleId);
+            const job = await xoApp.getJob(schedule.jobId);
+            await xoApp.runJob(job, schedule);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: { name: 'run schedule', objectId: scheduleId },
+        });
+    }
+};
+__decorate([
+    Example(scheduleIds),
+    Example(partialSchedules),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], ScheduleController.prototype, "getSchedules", null);
+__decorate([
+    Example(schedule),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], ScheduleController.prototype, "getSchedule", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/run'),
+    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(featureUnauthorized.status, featureUnauthorized.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], ScheduleController.prototype, "runSchedule", null);
+ScheduleController = __decorate([
+    Route('schedules'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('schedules'),
+    provide(ScheduleController)
+], ScheduleController);
+export { ScheduleController };

package/dist/vifs/vif.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 { 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';
+import { partialVifs, vif, vifIds } from '../open-api/oa-examples/vif.oa-example.mjs';
+let VifController = class VifController extends XapiXoController {
+    constructor(restApi) {
+        super('VIF', restApi);
+    }
+    /**
+     * @example fields "attached,id,device"
+     * @example filter "attached?"
+     * @example limit 42
+     */
+    getVifs(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "f028c5d4-578a-332c-394e-087aaca32dd3"
+     */
+    getVif(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(vifIds),
+    Example(partialVifs),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], VifController.prototype, "getVifs", null);
+__decorate([
+    Example(vif),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], VifController.prototype, "getVif", null);
+VifController = __decorate([
+    Route('vifs'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('vifs'),
+    provide(VifController),
+    __param(0, inject(RestApi))
+], VifController);
+export { VifController };

package/dist/vm-controller/vm-controller.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 { inject } from 'inversify';
+import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
+import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { provide } from 'inversify-binding-decorators';
+import { partialVmControllers, vmController, vmControllerIds, } from '../open-api/oa-examples/vm-controller.oa-example.mjs';
+let VmControllerController = class VmControllerController extends XapiXoController {
+    constructor(restApi) {
+        super('VM-controller', restApi);
+    }
+    /**
+     *
+     * @example fields "type,uuid"
+     * @example filter "power_state:Running"
+     * @example limit 42
+     */
+    getVmControllers(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "9b4775bd-9493-490a-9afa-f786a44caa4f"
+     */
+    getVmController(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(vmControllerIds),
+    Example(partialVmControllers),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], VmControllerController.prototype, "getVmControllers", null);
+__decorate([
+    Example(vmController),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], VmControllerController.prototype, "getVmController", null);
+VmControllerController = __decorate([
+    Route('vm-controllers'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('vms'),
+    provide(VmControllerController),
+    __param(0, inject(RestApi))
+], VmControllerController);
+export { VmControllerController };

package/dist/vm-snapshots/vm-snapshot.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 { inject } from 'inversify';
+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 { provide } from 'inversify-binding-decorators';
+import { partialVmSnapshots, vmSnapshot, vmSnapshotIds } from '../open-api/oa-examples/vm-snapshot.oa-example.mjs';
+let VmSnapshotController = class VmSnapshotController extends XapiXoController {
+    constructor(restApi) {
+        super('VM-snapshot', restApi);
+    }
+    /**
+     *
+     * @example fields "uuid,snapshot_time,$snapshot_of"
+     * @example filter "snapshot_time:>1725020038"
+     * @example limit 42
+     */
+    getVmSnapshots(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "d68fca2c-41e6-be87-d790-105c1642a090"
+     */
+    getVmSnapshot(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(vmSnapshotIds),
+    Example(partialVmSnapshots),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], VmSnapshotController.prototype, "getVmSnapshots", null);
+__decorate([
+    Example(vmSnapshot),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], VmSnapshotController.prototype, "getVmSnapshot", null);
+VmSnapshotController = __decorate([
+    Route('vm-snapshots'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('vms'),
+    provide(VmSnapshotController),
+    __param(0, inject(RestApi))
+], VmSnapshotController);
+export { VmSnapshotController };

package/dist/vm-templates/vm-template.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, Security, Query, Request, Response, Route, Tags, Path } 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 { partialVmTemplates, vmTemplate, vmTemplateIds } from '../open-api/oa-examples/vm-template.oa-example.mjs';
+let VmTemplateController = class VmTemplateController extends XapiXoController {
+    constructor(restApi) {
+        super('VM-template', restApi);
+    }
+    /**
+     * @example fields "id,isDefaultTemplate,name_label"
+     * @example filter "isDefaultTemplate?"
+     * @example limit 42
+     * */
+    getVmTemplates(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "b7569d99-30f8-178a-7d94-801de3e29b5b-f873abe0-b138-4995-8f6f-498b423d234d"
+     * */
+    getVmTemplate(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(vmTemplateIds),
+    Example(partialVmTemplates),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], VmTemplateController.prototype, "getVmTemplates", null);
+__decorate([
+    Example(vmTemplate),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], VmTemplateController.prototype, "getVmTemplate", null);
+VmTemplateController = __decorate([
+    Route('vm-templates'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('vms'),
+    provide(VmTemplateController),
+    __param(0, inject(RestApi))
+], VmTemplateController);
+export { VmTemplateController };