@xen-orchestra/rest-api 0.30.0 → 0.31.0

package/open-api/spec/swagger.json

@@ -2488,7 +2488,6 @@
 				"required": [
 					"status",
 					"start",
-					"result",
 					"properties",
 					"id"
 				],
@@ -5690,11 +5689,8 @@
 			"UnbrandedXoVif": {
 				"$ref": "#/components/schemas/Unbrand_XoVif_"
 			},
-			"Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM__": {
+			"Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM-or-other_config-or-qos_algorithm_params__": {
 				"properties": {
-					"other_config": {
-						"$ref": "#/components/schemas/Record_string.string_"
-					},
 					"device": {
 						"type": "string"
 					},
@@ -5720,9 +5716,6 @@
 					"locking_mode": {
 						"$ref": "#/components/schemas/VIF_LOCKING_MODE"
 					},
-					"qos_algorithm_params": {
-						"$ref": "#/components/schemas/Record_string.string_"
-					},
 					"qos_algorithm_type": {
 						"type": "string"
 					}
@@ -5730,14 +5723,14 @@
 				"type": "object",
 				"description": "From T, pick a set of properties whose keys are in the union K"
 			},
-			"Omit_CreateVifParams_91_0_93_.network-or-VM_": {
-				"$ref": "#/components/schemas/Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM__",
+			"Omit_CreateVifParams_91_0_93_.network-or-VM-or-other_config-or-qos_algorithm_params_": {
+				"$ref": "#/components/schemas/Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM-or-other_config-or-qos_algorithm_params__",
 				"description": "Construct a type with the properties of T except for those in type K."
 			},
 			"CreateVifBody": {
 				"allOf": [
 					{
-						"$ref": "#/components/schemas/Omit_CreateVifParams_91_0_93_.network-or-VM_"
+						"$ref": "#/components/schemas/Omit_CreateVifParams_91_0_93_.network-or-VM-or-other_config-or-qos_algorithm_params_"
 					},
 					{
 						"properties": {
@@ -5749,6 +5742,20 @@
 					},
 					{
 						"properties": {
+							"qos_algorithm_params": {
+								"properties": {},
+								"additionalProperties": {
+									"type": "string"
+								},
+								"type": "object"
+							},
+							"other_config": {
+								"properties": {},
+								"additionalProperties": {
+									"type": "string"
+								},
+								"type": "object"
+							},
 							"vmId": {
 								"type": "string"
 							},
@@ -6328,7 +6335,11 @@
 						"type": "string"
 					},
 					"permission": {
-						"type": "string"
+						"type": "string",
+						"enum": [
+							"none",
+							"admin"
+						]
 					},
 					"pw_hash": {
 						"type": "string"
@@ -6401,7 +6412,11 @@
 						"type": "string"
 					},
 					"permission": {
-						"type": "string"
+						"type": "string",
+						"enum": [
+							"none",
+							"admin"
+						]
 					},
 					"pw_hash": {
 						"type": "string"
@@ -6428,7 +6443,11 @@
 						"type": "string"
 					},
 					"permission": {
-						"type": "string"
+						"type": "string",
+						"enum": [
+							"none",
+							"admin"
+						]
 					},
 					"preferences": {
 						"$ref": "#/components/schemas/Record_string.string_"
@@ -6894,6 +6913,9 @@
 									"*",
 									"read",
 									"allow-vm",
+									"disable",
+									"enable",
+									"evacuate",
 									"export:logs",
 									"update:tags"
 								]
@@ -7102,8 +7124,10 @@
 							"action": {
 								"type": "string",
 								"enum": [
+									"update",
 									"*",
-									"read"
+									"read",
+									"update:management"
 								]
 							},
 							"selector": {
@@ -7356,6 +7380,7 @@
 									"import",
 									"update",
 									"*",
+									"delete",
 									"read",
 									"update:tags",
 									"import:vdi",
@@ -7844,6 +7869,7 @@
 									"reboot",
 									"reboot:clean",
 									"reboot:hard",
+									"revert-snapshot",
 									"shutdown:clean",
 									"shutdown:hard",
 									"update:datasources"
@@ -8095,7 +8121,6 @@
 				"required": [
 					"id",
 					"properties",
-					"result",
 					"start",
 					"status"
 				],
@@ -14479,6 +14504,9 @@
 									"*",
 									"read",
 									"allow-vm",
+									"disable",
+									"enable",
+									"evacuate",
 									"export:logs",
 									"update:tags"
 								]
@@ -14711,8 +14739,10 @@
 							"action": {
 								"type": "string",
 								"enum": [
+									"update",
 									"*",
-									"read"
+									"read",
+									"update:management"
 								]
 							},
 							"selector": {
@@ -14993,6 +15023,7 @@
 									"import",
 									"update",
 									"*",
+									"delete",
 									"read",
 									"update:tags",
 									"import:vdi",
@@ -15533,6 +15564,7 @@
 									"reboot",
 									"reboot:clean",
 									"reboot:hard",
+									"revert-snapshot",
 									"shutdown:clean",
 									"shutdown:hard",
 									"update:datasources"
@@ -16019,6 +16051,9 @@
 									"*",
 									"read",
 									"allow-vm",
+									"disable",
+									"enable",
+									"evacuate",
 									"export:logs",
 									"update:tags"
 								]
@@ -16275,8 +16310,10 @@
 							"action": {
 								"type": "string",
 								"enum": [
+									"update",
 									"*",
-									"read"
+									"read",
+									"update:management"
 								]
 							},
 							"selector": {
@@ -16585,6 +16622,7 @@
 									"import",
 									"update",
 									"*",
+									"delete",
 									"read",
 									"update:tags",
 									"import:vdi",
@@ -17177,6 +17215,7 @@
 									"reboot",
 									"reboot:clean",
 									"reboot:hard",
+									"revert-snapshot",
 									"shutdown:clean",
 									"shutdown:hard",
 									"update:datasources"
@@ -17538,6 +17577,9 @@
 									"*",
 									"read",
 									"allow-vm",
+									"disable",
+									"enable",
+									"evacuate",
 									"export:logs",
 									"update:tags"
 								]
@@ -17710,8 +17752,10 @@
 							"action": {
 								"type": "string",
 								"enum": [
+									"update",
 									"*",
-									"read"
+									"read",
+									"update:management"
 								]
 							},
 							"selector": {
@@ -17922,6 +17966,7 @@
 									"import",
 									"update",
 									"*",
+									"delete",
 									"read",
 									"update:tags",
 									"import:vdi",
@@ -18332,6 +18377,7 @@
 									"reboot",
 									"reboot:clean",
 									"reboot:hard",
+									"revert-snapshot",
 									"shutdown:clean",
 									"shutdown:hard",
 									"update:datasources"
@@ -18395,7 +18441,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.30.0",
+		"version": "0.31.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -20993,6 +21039,104 @@
 				]
 			}
 		},
+		"/vms/{id}/actions/revert_snapshot": {
+			"post": {
+				"operationId": "RevertSnapshotVm",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"403": {
+						"description": "Forbidden"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"description": "Required privilege:\n- resource: vm, action: revert-snapshot\n- resource: vm, action: snapshot (if `snapshotBefore: true`)",
+				"tags": [
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"properties": {
+									"snapshotBefore": {
+										"type": "boolean"
+									},
+									"snapshotId": {
+										"type": "string"
+									}
+								},
+								"required": [
+									"snapshotId"
+								],
+								"type": "object"
+							},
+							"example": {
+								"snapshotId": "f07ab729-c0e8-721c-45ec-f11276377030",
+								"snapshotBefore": true
+							}
+						}
+					}
+				}
+			}
+		},
 		"/vms/{id}/actions/snapshot": {
 			"post": {
 				"operationId": "SnapshotVm",
@@ -25042,7 +25186,14 @@
 							},
 							"example": {
 								"networkId": "6b6ca0f5-6611-0636-4b0a-1fb1c1e96414",
-								"vmId": "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+								"vmId": "613f541c-4bed-fc77-7ca8-2db6b68f079c",
+								"other_config": {
+									"ethtool-tx": "false"
+								},
+								"qos_algorithm_params": {
+									"kbps": "42"
+								},
+								"qos_algorithm_type": "ratelimit"
 							}
 						}
 					}
@@ -28207,7 +28358,11 @@
 							"schema": {
 								"properties": {
 									"permission": {
-										"type": "string"
+										"type": "string",
+										"enum": [
+											"none",
+											"admin"
+										]
 									},
 									"password": {
 										"type": "string"
@@ -29637,6 +29792,46 @@
 						"example": "c4284e12-37c9-7967-b9e8-83ef229c3e03"
 					}
 				]
+			},
+			"delete": {
+				"operationId": "DeleteSr",
+				"responses": {
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"403": {
+						"description": "Forbidden"
+					},
+					"404": {
+						"description": "Resource not found"
+					}
+				},
+				"description": "Required privilege:\n- resource: sr, action: delete",
+				"tags": [
+					"srs"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "c4284e12-37c9-7967-b9e8-83ef229c3e03"
+					}
+				]
 			}
 		},
 		"/srs/{id}/alarms": {
@@ -44962,6 +45157,9 @@
 					"401": {
 						"description": "Authentication required"
 					},
+					"403": {
+						"description": "Forbidden"
+					},
 					"404": {
 						"description": "Resource not found"
 					},
@@ -44972,7 +45170,7 @@
 						"description": "Internal server error, XenServer/XCP-ng error"
 					}
 				},
-				"description": "Reconfigure the management interface of the host to use the given PIF.\n\nThe target PIF must already have an IP address configured.",
+				"description": "Required privilege:\n- resource: pif, action: update:management\n\nReconfigure the management interface of the host to use the given PIF.\n\nThe target PIF must already have an IP address configured.",
 				"tags": [
 					"hosts"
 				],
@@ -45053,6 +45251,9 @@
 					"401": {
 						"description": "Authentication required"
 					},
+					"403": {
+						"description": "Forbidden"
+					},
 					"404": {
 						"description": "Resource not found"
 					},
@@ -45063,7 +45264,7 @@
 						"description": "Internal server error, XenServer/XCP-ng error"
 					}
 				},
-				"description": "Disable a host.\n\nSet `evacuate` to `true` to also evacuate all running VMs to other hosts in the pool.\n\nUse `vmIdsToForceMigrate` to unblock VMs whose migration is currently blocked (e.g. by `pool_migrate` or `migrate_send` blocked operations).\n\nUse `force` to ignore evacuation errors.",
+				"description": "Required privileges:\n- resource: host, action: disable\n- resource: host, action: evacuate (if `evacuate: true`)\n\nDisable a host.\n\nSet `evacuate` to `true` to also evacuate all running VMs to other hosts in the pool.\n\nUse `vmIdsToForceMigrate` to unblock VMs whose migration is currently blocked (e.g. by `pool_migrate` or `migrate_send` blocked operations).\n\nUse `force` to ignore evacuation errors.",
 				"tags": [
 					"hosts"
 				],
@@ -45176,6 +45377,9 @@
 					"401": {
 						"description": "Authentication required"
 					},
+					"403": {
+						"description": "Forbidden"
+					},
 					"404": {
 						"description": "Resource not found"
 					},
@@ -45183,7 +45387,7 @@
 						"description": "Internal server error, XenServer/XCP-ng error"
 					}
 				},
-				"description": "Enable a host, taking it out of disabled state.",
+				"description": "Required privilege:\n- resource: host, action: enable\n\nEnable a host, taking it out of disabled state.",
 				"tags": [
 					"hosts"
 				],

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.30.0",
+  "version": "0.31.0",
   "description": "REST API to manage your XOA",
   "license": "AGPL-3.0-or-later",
   "private": false,
@@ -28,6 +28,7 @@
     "@eslint/js": "^9.19.0",
     "@types/express": "^5.0.0",
     "@types/swagger-ui-express": "^4.1.7",
+    "openapi-types": "^12.1.3",
     "rimraf": "^6.0.1",
     "typescript": "~5.6.3",
     "typescript-eslint": "^8.23.0"
@@ -35,11 +36,11 @@
   "dependencies": {
     "@vates/async-each": "^1.0.3",
     "@vates/task": "^0.7.0",
-    "@vates/types": "^1.24.0",
-    "@xen-orchestra/acl": "^1.0.0",
-    "@xen-orchestra/backups": "^0.72.1",
+    "@vates/types": "^1.25.0",
+    "@xen-orchestra/acl": "^1.1.0",
+    "@xen-orchestra/backups": "^0.73.0",
     "@xen-orchestra/log": "^0.7.2",
-    "@xen-orchestra/xapi": "^8.7.2",
+    "@xen-orchestra/xapi": "^8.8.0",
     "complex-matcher": "^1.1.1",
     "golike-defer": "^0.5.1",
     "inversify": "^6.2.2",
@@ -51,7 +52,9 @@
     "tsoa": "^6.6.0",
     "value-matcher": "^0.2.0",
     "xo-common": "^0.9.1",
-    "xo-remote-parser": "^0.10.1"
+    "xo-remote-parser": "^0.10.1",
+    "zod": "^4.3.6",
+    "zod-openapi": "^5.4.6"
   },
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {

package/turbo.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "outputs": ["dist/**", "open-api/spec/**"]
+    }
+  }
+}