@xen-orchestra/rest-api 0.32.0 → 0.33.0

package/open-api/spec/swagger.json

@@ -1479,6 +1479,775 @@
 				],
 				"type": "object"
 			},
+			"Partial_Record_VM_OPERATIONS.boolean-or-string-or-null__": {
+				"properties": {
+					"assert_operation_valid": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"awaiting_memory_live": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"call_plugin": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"changing_dynamic_range": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"changing_memory_limits": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"changing_memory_live": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"changing_NVRAM": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"changing_shadow_memory": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"changing_shadow_memory_live": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"changing_static_range": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"changing_VCPUs": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"changing_VCPUs_live": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"checkpoint": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"clean_reboot": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"clean_shutdown": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"clone": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"copy": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"create_template": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"create_vtpm": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"csvm": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"data_source_op": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"destroy": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"export": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"get_boot_record": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"hard_reboot": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"hard_shutdown": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"import": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"make_into_template": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"metadata_export": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"migrate_send": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"pause": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"pool_migrate": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"power_state_reset": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"provision": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"query_services": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"resume": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"resume_on": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"revert": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"reverting": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"send_sysrq": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"send_trigger": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"shutdown": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"snapshot": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"snapshot_with_quiesce": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"start": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"start_on": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"suspend": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"unpause": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					},
+					"update_allowed_operations": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "boolean"
+							}
+						],
+						"nullable": true
+					}
+				},
+				"type": "object",
+				"description": "Make all properties in T optional"
+			},
+			"Record_string.string-or-null_": {
+				"properties": {},
+				"additionalProperties": {
+					"type": "string",
+					"nullable": true
+				},
+				"type": "object",
+				"description": "Construct a type with a set of properties K of type T"
+			},
+			"UpdateVmRequestBody": {
+				"description": "Body of `PATCH /vms/{id}`.\n\nExtends {@link EditVmProps} with two REST-only properties that the xo-server\nresource-set mixin handles outside of `editVm`.",
+				"properties": {
+					"affinityHost": {
+						"type": "string",
+						"nullable": true
+					},
+					"autoPoweron": {
+						"type": "boolean"
+					},
+					"blockedOperations": {
+						"$ref": "#/components/schemas/Partial_Record_VM_OPERATIONS.boolean-or-string-or-null__"
+					},
+					"coresPerSocket": {
+						"anyOf": [
+							{
+								"type": "number",
+								"format": "double"
+							},
+							{
+								"type": "string"
+							}
+						],
+						"nullable": true
+					},
+					"cpuCap": {
+						"type": "number",
+						"format": "double",
+						"nullable": true
+					},
+					"cpuMask": {
+						"items": {
+							"type": "number",
+							"format": "double"
+						},
+						"type": "array"
+					},
+					"cpuWeight": {
+						"type": "number",
+						"format": "double",
+						"nullable": true
+					},
+					"cpus": {
+						"type": "number",
+						"format": "double"
+					},
+					"cpusStaticMax": {
+						"anyOf": [
+							{
+								"type": "number",
+								"format": "double"
+							},
+							{
+								"type": "string"
+							}
+						]
+					},
+					"creation": {
+						"properties": {
+							"user": {
+								"type": "string"
+							}
+						},
+						"type": "object",
+						"description": "Update VM creation metadata stored under `other_config.xo:*`. The object is\nmerged with the existing data."
+					},
+					"expNestedHvm": {
+						"type": "boolean"
+					},
+					"hasVendorDevice": {
+						"type": "boolean"
+					},
+					"highAvailability": {
+						"type": "string",
+						"enum": [
+							"best-effort",
+							"restart",
+							""
+						]
+					},
+					"hvmBootFirmware": {
+						"type": "string",
+						"nullable": true
+					},
+					"memory": {
+						"anyOf": [
+							{
+								"type": "number",
+								"format": "double"
+							},
+							{
+								"type": "string"
+							}
+						]
+					},
+					"memoryMax": {
+						"anyOf": [
+							{
+								"type": "number",
+								"format": "double"
+							},
+							{
+								"type": "string"
+							}
+						]
+					},
+					"memoryMin": {
+						"anyOf": [
+							{
+								"type": "number",
+								"format": "double"
+							},
+							{
+								"type": "string"
+							}
+						]
+					},
+					"memoryStaticMax": {
+						"anyOf": [
+							{
+								"type": "number",
+								"format": "double"
+							},
+							{
+								"type": "string"
+							}
+						]
+					},
+					"nameDescription": {
+						"type": "string"
+					},
+					"nameLabel": {
+						"type": "string"
+					},
+					"nestedVirt": {
+						"type": "boolean"
+					},
+					"nicType": {
+						"type": "string",
+						"nullable": true
+					},
+					"notes": {
+						"type": "string",
+						"nullable": true
+					},
+					"PV_args": {
+						"type": "string"
+					},
+					"secureBoot": {
+						"type": "boolean"
+					},
+					"startDelay": {
+						"type": "number",
+						"format": "double"
+					},
+					"suspendSr": {
+						"type": "string",
+						"nullable": true
+					},
+					"tags": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"uefiMode": {
+						"type": "string",
+						"enum": [
+							"setup",
+							"user"
+						]
+					},
+					"vga": {
+						"type": "string",
+						"enum": [
+							"std",
+							"cirrus"
+						]
+					},
+					"videoram": {
+						"type": "number",
+						"enum": [
+							1,
+							2,
+							4,
+							8,
+							16
+						]
+					},
+					"viridian": {
+						"type": "boolean"
+					},
+					"virtualizationMode": {
+						"type": "string",
+						"enum": [
+							"pv",
+							"hvm"
+						]
+					},
+					"xenStoreData": {
+						"$ref": "#/components/schemas/Record_string.string-or-null_"
+					},
+					"resourceSet": {
+						"type": "string",
+						"nullable": true,
+						"description": "Moves the VM in/out of a resource set."
+					},
+					"share": {
+						"type": "boolean",
+						"description": "When `true` and the VM is in a resource set, share the VM with all members\nof that resource set. `false` is a no-op."
+					}
+				},
+				"type": "object",
+				"additionalProperties": false
+			},
 			"StatValues": {
 				"items": {
 					"type": "number",
@@ -7871,7 +8640,42 @@
 									"revert-snapshot",
 									"shutdown:clean",
 									"shutdown:hard",
-									"update:datasources"
+									"update:affinityHost",
+									"update:autoPoweron",
+									"update:blockedOperations",
+									"update:coresPerSocket",
+									"update:cpuCap",
+									"update:cpuMask",
+									"update:cpuWeight",
+									"update:cpus",
+									"update:cpusStaticMax",
+									"update:creation",
+									"update:datasources",
+									"update:expNestedHvm",
+									"update:hasVendorDevice",
+									"update:highAvailability",
+									"update:hvmBootFirmware",
+									"update:memory",
+									"update:memoryMax",
+									"update:memoryMin",
+									"update:memoryStaticMax",
+									"update:nameDescription",
+									"update:nameLabel",
+									"update:nestedVirt",
+									"update:nicType",
+									"update:notes",
+									"update:PV_args",
+									"update:resourceSet",
+									"update:secureBoot",
+									"update:share",
+									"update:startDelay",
+									"update:suspendSr",
+									"update:uefiMode",
+									"update:vga",
+									"update:videoram",
+									"update:viridian",
+									"update:virtualizationMode",
+									"update:xenStoreData"
 								]
 							},
 							"selector": {
@@ -15581,7 +16385,42 @@
 									"revert-snapshot",
 									"shutdown:clean",
 									"shutdown:hard",
-									"update:datasources"
+									"update:affinityHost",
+									"update:autoPoweron",
+									"update:blockedOperations",
+									"update:coresPerSocket",
+									"update:cpuCap",
+									"update:cpuMask",
+									"update:cpuWeight",
+									"update:cpus",
+									"update:cpusStaticMax",
+									"update:creation",
+									"update:datasources",
+									"update:expNestedHvm",
+									"update:hasVendorDevice",
+									"update:highAvailability",
+									"update:hvmBootFirmware",
+									"update:memory",
+									"update:memoryMax",
+									"update:memoryMin",
+									"update:memoryStaticMax",
+									"update:nameDescription",
+									"update:nameLabel",
+									"update:nestedVirt",
+									"update:nicType",
+									"update:notes",
+									"update:PV_args",
+									"update:resourceSet",
+									"update:secureBoot",
+									"update:share",
+									"update:startDelay",
+									"update:suspendSr",
+									"update:uefiMode",
+									"update:vga",
+									"update:videoram",
+									"update:viridian",
+									"update:virtualizationMode",
+									"update:xenStoreData"
 								]
 							},
 							"selector": {
@@ -17232,7 +18071,42 @@
 									"revert-snapshot",
 									"shutdown:clean",
 									"shutdown:hard",
-									"update:datasources"
+									"update:affinityHost",
+									"update:autoPoweron",
+									"update:blockedOperations",
+									"update:coresPerSocket",
+									"update:cpuCap",
+									"update:cpuMask",
+									"update:cpuWeight",
+									"update:cpus",
+									"update:cpusStaticMax",
+									"update:creation",
+									"update:datasources",
+									"update:expNestedHvm",
+									"update:hasVendorDevice",
+									"update:highAvailability",
+									"update:hvmBootFirmware",
+									"update:memory",
+									"update:memoryMax",
+									"update:memoryMin",
+									"update:memoryStaticMax",
+									"update:nameDescription",
+									"update:nameLabel",
+									"update:nestedVirt",
+									"update:nicType",
+									"update:notes",
+									"update:PV_args",
+									"update:resourceSet",
+									"update:secureBoot",
+									"update:share",
+									"update:startDelay",
+									"update:suspendSr",
+									"update:uefiMode",
+									"update:vga",
+									"update:videoram",
+									"update:viridian",
+									"update:virtualizationMode",
+									"update:xenStoreData"
 								]
 							},
 							"selector": {
@@ -18394,7 +19268,42 @@
 									"revert-snapshot",
 									"shutdown:clean",
 									"shutdown:hard",
-									"update:datasources"
+									"update:affinityHost",
+									"update:autoPoweron",
+									"update:blockedOperations",
+									"update:coresPerSocket",
+									"update:cpuCap",
+									"update:cpuMask",
+									"update:cpuWeight",
+									"update:cpus",
+									"update:cpusStaticMax",
+									"update:creation",
+									"update:datasources",
+									"update:expNestedHvm",
+									"update:hasVendorDevice",
+									"update:highAvailability",
+									"update:hvmBootFirmware",
+									"update:memory",
+									"update:memoryMax",
+									"update:memoryMin",
+									"update:memoryStaticMax",
+									"update:nameDescription",
+									"update:nameLabel",
+									"update:nestedVirt",
+									"update:nicType",
+									"update:notes",
+									"update:PV_args",
+									"update:resourceSet",
+									"update:secureBoot",
+									"update:share",
+									"update:startDelay",
+									"update:suspendSr",
+									"update:uefiMode",
+									"update:vga",
+									"update:videoram",
+									"update:viridian",
+									"update:virtualizationMode",
+									"update:xenStoreData"
 								]
 							},
 							"selector": {
@@ -18455,7 +19364,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.32.0",
+		"version": "0.33.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -18964,6 +19873,67 @@
 				],
 				"x-mcp-exposure": "allow"
 			},
+			"patch": {
+				"operationId": "UpdateVm",
+				"responses": {
+					"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": "Partial update of a VM. Only the fields present in the body are modified;\neverything else is left untouched.\n\nOperations are applied sequentially: if one fails, previously applied\nchanges are not rolled back.\n\nRequired privilege per field provided in the body:\n- resource: vm, action: update:<field> (e.g. update:nameLabel, update:cpus, ...)\n\nSpecial fields:\n- `xenStoreData` keys are automatically prefixed with `vm-data/` when missing",
+				"tags": [
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					}
+				],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/UpdateVmRequestBody"
+							},
+							"example": {
+								"nameLabel": "web-prod-01",
+								"nameDescription": "Production web frontend — managed by n8n",
+								"notes": "Docker containers: nginx, app-1, app-2"
+							}
+						}
+					}
+				}
+			},
 			"delete": {
 				"operationId": "DeleteVm",
 				"responses": {