@xen-orchestra/rest-api 0.6.0 → 0.8.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/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/{open-api/networks → networks}/network.controller.mjs

@@ -10,10 +10,10 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 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 '../oa-examples/network.oa-example.mjs';
-import { notFoundResp, unauthorizedResp } from '../common/response.common.mjs';
-import { RestApi } from '../../rest-api/rest-api.mjs';
-import { XapiXoController } from '../../abstract-classes/xapi-xo-controller.mjs';
+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);

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/pif.oa-example.mjs

@@ -0,0 +1,51 @@
+export const pifIds = [
+    '/rest/v0/pifs/d9e42451-3794-089f-de81-4ee0e6137bee',
+    '/rest/v0/pifs/3f258258-ffd9-7bf2-2b47-74a0af2ea3b3',
+];
+export const partialPifs = [
+    {
+        attached: true,
+        device: 'eth0',
+        deviceName: 'MT27520 Family [ConnectX-3 Pro]',
+        id: 'd9e42451-3794-089f-de81-4ee0e6137bee',
+        href: '/rest/v0/pifs/d9e42451-3794-089f-de81-4ee0e6137bee',
+    },
+    {
+        attached: true,
+        device: 'eth1',
+        deviceName: 'MT27520 Family [ConnectX-3 Pro]',
+        id: '3f258258-ffd9-7bf2-2b47-74a0af2ea3b3',
+        href: '/rest/v0/pifs/3f258258-ffd9-7bf2-2b47-74a0af2ea3b3',
+    },
+];
+export const pif = {
+    type: 'PIF',
+    attached: true,
+    isBondMaster: false,
+    isBondSlave: false,
+    device: 'eth0',
+    deviceName: 'MT27520 Family [ConnectX-3 Pro]',
+    dns: '',
+    disallowUnplug: false,
+    gateway: '',
+    ip: '',
+    ipv6: [],
+    mac: 'ec:eb:b8:8e:d1:12',
+    management: false,
+    carrier: true,
+    mode: 'None',
+    ipv6Mode: 'None',
+    mtu: 1500,
+    netmask: '',
+    physical: true,
+    primaryAddressType: 'IPv4',
+    vlan: -1,
+    speed: 10000,
+    $host: 'b61a5c92-700e-4966-a13b-00633f03eea8',
+    $network: 'ac9b098e-df7f-50d3-b013-95d4cd550c61',
+    id: 'd9e42451-3794-089f-de81-4ee0e6137bee',
+    uuid: 'd9e42451-3794-089f-de81-4ee0e6137bee',
+    $pool: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    $poolId: 'b7569d99-30f8-178a-7d94-801de3e29b5b',
+    _xapiRef: 'OpaqueRef:d94c0e13-ce19-c545-bcf2-c4cbbd3d43b8',
+};

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',