handle XapiError

@xen-orchestra/rest-api/.USAGE.md

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

@xen-orchestra/rest-api/README.md

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

@xen-orchestra/rest-api/src/middlewares/generic-error-handler.middleware.mts

@@ -21,6 +21,7 @@ export default function genericErrorHandler(error: unknown, req: Request, res: R
     return
   }
 
+  const responseError: { error: string; info?: string } = { error: error.message }
   if (noSuchObject.is(error)) {
     res.status(404)
   } else if (unauthorized.is(error) || forbiddenOperation.is(error) || featureUnauthorized.is(error)) {
@@ -32,11 +33,14 @@ export default function genericErrorHandler(error: unknown, req: Request, res: R
   } else if (notImplemented.is(error)) {
     res.status(501)
   } else {
+    if (error.name === 'XapiError') {
+      responseError.info = 'This is a XenServer/XCP-ng error, not an XO error'
+    }
     res.status(500)
     log.error(error)
   }
 
   log.info(`[${req.method}] ${req.path} (${res.statusCode})`)
 
-  res.json({ error: error.message })
+  res.json(responseError)
 }

@xen-orchestra/rest-api/src/open-api/oa-examples/task.oa-example.mts

@@ -1 +1 @@
-export const taskLocation = 'rest/v0/tasks/0m7kl0j9l'
+export const taskLocation = '/rest/v0/tasks/0m7kl0j9l'

@xen-orchestra/rest-api/src/vms/vm.controller.mts

@@ -51,14 +51,14 @@ export class VmController extends XapiXoController<XoVm> {
   }
 
   /**
-   *
    * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
    */
   @Example(taskLocation)
   @Post('{id}/actions/start')
   @SuccessResponse(202, 'Action executed asynchronously')
   @Response(204, 'No content')
   @Response(404, 'VM not found')
+  @Response(500, 'Internal server error, XenServer/XCP-ng error')
   async startVm(@Path() id: string, @Query() sync?: boolean) {
     const vmId = id as XoVm['id']
     const action = () => this.getXapiObject(vmId).$callAsync('start', false, false)