@xen-orchestra/rest-api 0.16.0 → 0.17.0

package/dist/open-api/routes/routes.js

@@ -1938,6 +1938,38 @@ export function RegisterRoutes(app) {
         }
     });
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    const argsVmTemplateController_getVmTemplateMessages = {
+        req: { "in": "request", "name": "req", "required": true, "dataType": "object" },
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+        fields: { "in": "query", "name": "fields", "dataType": "string" },
+        ndjson: { "in": "query", "name": "ndjson", "dataType": "boolean" },
+        filter: { "in": "query", "name": "filter", "dataType": "string" },
+        limit: { "in": "query", "name": "limit", "dataType": "double" },
+    };
+    app.get('/rest/v0/vm-templates/:id/messages', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(VmTemplateController)), ...(fetchMiddlewares(VmTemplateController.prototype.getVmTemplateMessages)), async function VmTemplateController_getVmTemplateMessages(request, response, next) {
+        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        let validatedArgs = [];
+        try {
+            validatedArgs = templateService.getValidatedArgs({ args: argsVmTemplateController_getVmTemplateMessages, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(VmTemplateController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'getVmTemplateMessages',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: undefined,
+            });
+        }
+        catch (err) {
+            return next(err);
+        }
+    });
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     const argsVmSnapshotController_getVmSnapshots = {
         req: { "in": "request", "name": "req", "required": true, "dataType": "object" },
         fields: { "in": "query", "name": "fields", "dataType": "string" },

package/dist/vm-templates/vm-template.controller.mjs

@@ -10,7 +10,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { Example, Get, Security, Query, Request, Response, Route, Tags, Path, Delete, SuccessResponse } from 'tsoa';
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
-import { AlarmService } from '../alarms/alarm.service.mjs';
+import { AlarmService, RAW_ALARM_FILTER } from '../alarms/alarm.service.mjs';
 import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
 import { forbiddenOperationResp, incorrectStateResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
@@ -18,6 +18,7 @@ import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { partialVmTemplates, vmTemplate, vmTemplateIds, vmTemplateVdis, } from '../open-api/oa-examples/vm-template.oa-example.mjs';
 import { VmService } from '../vms/vm.service.mjs';
+import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
 let VmTemplateController = class VmTemplateController extends XapiXoController {
     #alarmService;
     #vmService;
@@ -87,6 +88,20 @@ let VmTemplateController = class VmTemplateController extends XapiXoController {
         const vdis = this.#vmService.getVmVdis(id, 'VM-template');
         return this.sendObjects(limitAndFilterArray(vdis, { filter, limit }), req, obj => obj.type.toLowerCase() + 's');
     }
+    /**
+     * @example id "6d50ba76-0f11-1ff1-4f6a-b502afc31b8e"
+     * @example fields "name,id,$object"
+     * @example filter "name:VM_STARTED"
+     * @example limit 42
+     */
+    getVmTemplateMessages(req, id, fields, ndjson, filter, limit) {
+        const vmTemplate = this.getObject(id);
+        const messages = this.restApi.getObjectsByType('message', {
+            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} $object:${vmTemplate.uuid} !${RAW_ALARM_FILTER}`,
+            limit,
+        });
+        return this.sendObjects(Object.values(messages), req, 'messages');
+    }
 };
 __decorate([
     Example(vmTemplateIds),
@@ -146,6 +161,19 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmTemplateController.prototype, "getVmTemplateVdis", null);
+__decorate([
+    Example(messageIds),
+    Example(partialMessages),
+    Get('{id}/messages'),
+    Tags('messages'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmTemplateController.prototype, "getVmTemplateMessages", null);
 VmTemplateController = __decorate([
     Route('vm-templates'),
     Security('*'),

package/open-api/spec/swagger.json

@@ -10867,7 +10867,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.16.0",
+		"version": "0.17.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -14449,6 +14449,111 @@
 				]
 			}
 		},
+		"/vm-templates/{id}/messages": {
+			"get": {
+				"operationId": "GetVmTemplateMessages",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoMessage___"
+								},
+								"examples": {
+									"Example 1": {
+										"value": [
+											"/rest/v0/messages/f775eaeb-abe5-94e0-9682-14c37c3a1dfe",
+											"/rest/v0/messages/ed2d1623-3e65-8d39-7a14-4eb69274c5e3"
+										]
+									},
+									"Example 2": {
+										"value": [
+											{
+												"name": "VM_STARTED",
+												"body": "VM 'Alpine MRA' (uuid: cef5f68c-61ae-3831-d2e6-1590d4934acf) started on host: XCP 8.3.0 master (uuid: b61a5c92-700e-4966-a13b-00633f03eea8)",
+												"id": "f775eaeb-abe5-94e0-9682-14c37c3a1dfe",
+												"$object": "cef5f68c-61ae-3831-d2e6-1590d4934acf",
+												"href": "/rest/v0/messages/f775eaeb-abe5-94e0-9682-14c37c3a1dfe"
+											},
+											{
+												"name": "VM_STARTED",
+												"body": "VM 'Alpine MRA' (uuid: cef5f68c-61ae-3831-d2e6-1590d4934acf) started on host: XCP 8.3.0 master (uuid: b61a5c92-700e-4966-a13b-00633f03eea8)",
+												"id": "ed2d1623-3e65-8d39-7a14-4eb69274c5e3",
+												"$object": "cef5f68c-61ae-3831-d2e6-1590d4934acf",
+												"href": "/rest/v0/messages/ed2d1623-3e65-8d39-7a14-4eb69274c5e3"
+											}
+										]
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					}
+				},
+				"tags": [
+					"messages",
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "6d50ba76-0f11-1ff1-4f6a-b502afc31b8e"
+					},
+					{
+						"in": "query",
+						"name": "fields",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "name,id,$object"
+					},
+					{
+						"in": "query",
+						"name": "ndjson",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					},
+					{
+						"in": "query",
+						"name": "filter",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "name:VM_STARTED"
+					},
+					{
+						"in": "query",
+						"name": "limit",
+						"required": false,
+						"schema": {
+							"format": "double",
+							"type": "number"
+						},
+						"example": 42
+					}
+				]
+			}
+		},
 		"/vm-snapshots": {
 			"get": {
 				"operationId": "GetVmSnapshots",

package/package.json

@@ -6,7 +6,7 @@
   "main": "./dist/index.mjs",
   "name": "@xen-orchestra/rest-api",
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/rest-api",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "REST API to manage your XOA",
   "license": "AGPL-3.0-or-later",
   "private": false,