@xen-orchestra/rest-api 0.5.0 → 0.7.0

package/README.md

@@ -48,6 +48,7 @@ class Foo extends Controller {
  @Example(['foo', 'bar'])
  @Get('{id}')
  @Security('*')
+ @Middlewares(json())
  @SuccessResponse(202)
  @Response(404)
  getFoo(@Path() id: string) {

package/dist/groups/group.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 { group, groupIds, partialGroups } from '../open-api/oa-examples/group.oa-example.mjs';
+import { XoController } from '../abstract-classes/xo-controller.mjs';
+let GroupController = class GroupController extends XoController {
+    // --- abstract methods
+    getAllCollectionObjects() {
+        return this.restApi.xoApp.getAllGroups();
+    }
+    getCollectionObject(id) {
+        return this.restApi.xoApp.getGroup(id);
+    }
+    /**
+     * @example fields "name,id,users"
+     * @example filter "users:length:>0"
+     * @example limit 42
+     */
+    async getGroups(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(await this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "7d98fee4-3357-41a7-ac3f-9124212badb7"
+     */
+    getGroup(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(groupIds),
+    Example(partialGroups),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], GroupController.prototype, "getGroups", null);
+__decorate([
+    Example(group),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], GroupController.prototype, "getGroup", null);
+GroupController = __decorate([
+    Route('groups'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('groups'),
+    provide(GroupController)
+], GroupController);
+export { GroupController };

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

@@ -1,5 +1,5 @@
 import { createLogger } from '@xen-orchestra/log';
-import { featureUnauthorized, forbiddenOperation, invalidCredentials, invalidParameters, noSuchObject, notImplemented, unauthorized, } from 'xo-common/api-errors.js';
+import { featureUnauthorized, forbiddenOperation, incorrectState, invalidCredentials, invalidParameters, noSuchObject, notImplemented, objectAlreadyExists, unauthorized, } from 'xo-common/api-errors.js';
 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
@@ -19,12 +19,19 @@ export default function genericErrorHandler(error, req, res, _next) {
     else if (invalidCredentials.is(error)) {
         res.status(401);
     }
+    else if (objectAlreadyExists.is(error)) {
+        res.status(409);
+    }
     else if (invalidParameters.is(error)) {
         res.status(422);
     }
     else if (notImplemented.is(error)) {
         res.status(501);
     }
+    else if (incorrectState.is(error)) {
+        res.status(409);
+        responseError.data = error.data;
+    }
     else {
         if (error.name === 'XapiError') {
             responseError.info = 'This is a XenServer/XCP-ng error, not an XO error';

package/dist/networks/network.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, Response, Request, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { provide } from 'inversify-binding-decorators';
+import { network, networkIds, partialNetworks } from '../open-api/oa-examples/network.oa-example.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';
+let NetworkController = class NetworkController extends XapiXoController {
+    constructor(restApi) {
+        super('network', restApi);
+    }
+    /**
+     * @example fields "nbd,name_label,id"
+     * @example filter "nbd?"
+     * @example limit 42
+     */
+    getNetworks(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+     */
+    getNetwork(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(networkIds),
+    Example(partialNetworks),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], NetworkController.prototype, "getNetworks", null);
+__decorate([
+    Example(network),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], NetworkController.prototype, "getNetwork", null);
+NetworkController = __decorate([
+    Route('networks'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('networks'),
+    provide(NetworkController),
+    __param(0, inject(RestApi))
+], NetworkController);
+export { NetworkController };

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

@@ -1,3 +1,7 @@
+export const createdResp = {
+    status: 201,
+    description: 'Resource created',
+};
 export const actionAsyncroneResp = {
     status: 202,
     description: 'Action executed asynchronously',
@@ -23,3 +27,11 @@ export const internalServerErrorResp = {
     status: 500,
     description: 'Internal server error, XenServer/XCP-ng error',
 };
+export const resourceAlreadyExists = {
+    status: 409,
+    description: 'Resource already exists',
+};
+export const invalidParameters = {
+    status: 422,
+    description: 'Invalid parameters',
+};

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

@@ -0,0 +1,23 @@
+export const groupIds = [
+    '/rest/v0/groups/7d98fee4-3357-41a7-ac3f-9124212badb7',
+    '/rest/v0/groups/7981ba62-c395-4546-bfa4-d1261653a77f',
+];
+export const partialGroups = [
+    {
+        name: 'group 1',
+        id: '7d98fee4-3357-41a7-ac3f-9124212badb7',
+        users: ['722d17b9-699b-49d2-8193-be1ac573d3de'],
+        href: '/rest/v0/groups/7d98fee4-3357-41a7-ac3f-9124212badb7',
+    },
+    {
+        name: 'group 2',
+        id: '7981ba62-c395-4546-bfa4-d1261653a77f',
+        users: ['722d17b9-699b-49d2-8193-be1ac573d3de', '088124f3-41b6-4258-9653-6eedc7b46111'],
+        href: '/rest/v0/groups/7981ba62-c395-4546-bfa4-d1261653a77f',
+    },
+];
+export const group = {
+    name: 'group 1',
+    users: ['722d17b9-699b-49d2-8193-be1ac573d3de'],
+    id: '7d98fee4-3357-41a7-ac3f-9124212badb7',
+};

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

@@ -0,0 +1,50 @@
+export const networkIds = [
+    '/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+    '/rest/v0/networks/6b6ca0f5-6611-0636-4b0a-1fb1c8e96414',
+];
+export const partialNetworks = [
+    {
+        nbd: true,
+        name_label: 'Host internal management network',
+        id: '9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+        href: '/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+    },
+    {
+        nbd: true,
+        name_label: 'Lab v2 (VLAN 11)',
+        id: '6b6ca0f5-6611-0636-4b0a-1fb1c8e96414',
+        href: '/rest/v0/networks/6b6ca0f5-6611-0636-4b0a-1fb1c8e96414',
+    },
+];
+export const network = {
+    automatic: false,
+    bridge: 'xenapi',
+    current_operations: {},
+    defaultIsLocked: false,
+    MTU: 1500,
+    name_description: 'Network on which guests will be assigned a private link-local IP address which can be used to talk XenAPI',
+    name_label: 'Host internal management network',
+    other_config: {
+        is_guest_installer_network: 'true',
+        is_host_internal_management_network: 'true',
+        ip_begin: '169.254.0.1',
+        ip_end: '169.254.255.254',
+        netmask: '255.255.0.0',
+    },
+    tags: [],
+    PIFs: [],
+    VIFs: [
+        '2d039fc8-e522-75db-34c9-536b9553bd5a',
+        '38623621-d30e-0307-dcef-eb7ed6c69f0c',
+        'cc4b090f-5ff1-254b-558f-f7ac237e6fc5',
+        'a9f3d042-a2e1-102f-74fc-ff1df41c6eb3',
+    ],
+    nbd: false,
+    insecureNbd: false,
+    id: '9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+    type: 'network',
+    uuid: '9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f',
+    $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    _xapiRef: 'OpaqueRef:eb906e77-2221-5399-4a26-60f0ad069b61',
+};

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

@@ -1,3 +1,4 @@
+export const serverId = { id: '38068475-3a1d-4a64-95df-8782cdea02ac' };
 export const serverIds = [
     '/rest/v0/servers/f07ab729-c0e8-721c-45ec-f11276377030',
     '/rest/v0/servers/d5d1c4a3-4c5e-ca7b-6be8-33c824f87571',