@xen-orchestra/rest-api 0.5.0 → 0.7.0

package/open-api/spec/swagger.json

@@ -4443,6 +4443,38 @@
 				],
 				"type": "object"
 			},
+			"InsertableXoServer": {
+				"properties": {
+					"host": {
+						"type": "string"
+					},
+					"httpProxy": {
+						"type": "string"
+					},
+					"label": {
+						"type": "string"
+					},
+					"username": {
+						"type": "string"
+					},
+					"allowUnauthorized": {
+						"type": "boolean"
+					},
+					"password": {
+						"type": "string"
+					},
+					"readOnly": {
+						"type": "boolean"
+					}
+				},
+				"required": [
+					"host",
+					"username",
+					"password"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
 			"Partial_Unbrand_XoSchedule__": {
 				"properties": {
 					"cron": {
@@ -4759,6 +4791,202 @@
 				],
 				"type": "object"
 			},
+			"Record_string.attaching_": {
+				"properties": {},
+				"type": "object",
+				"description": "Construct a type with a set of properties K of type T"
+			},
+			"Partial_Unbrand_XoNetwork__": {
+				"properties": {
+					"$pool": {
+						"type": "string"
+					},
+					"$poolId": {
+						"type": "string",
+						"deprecated": true
+					},
+					"_xapiRef": {
+						"type": "string"
+					},
+					"uuid": {
+						"type": "string"
+					},
+					"MTU": {
+						"type": "number",
+						"format": "double"
+					},
+					"PIFs": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"VIFs": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"automatic": {
+						"type": "boolean"
+					},
+					"bridge": {
+						"type": "string"
+					},
+					"current_operations": {
+						"$ref": "#/components/schemas/Record_string.attaching_"
+					},
+					"defaultIsLocked": {
+						"type": "boolean"
+					},
+					"id": {
+						"type": "string"
+					},
+					"insecureNbd": {
+						"type": "boolean"
+					},
+					"name_description": {
+						"type": "string"
+					},
+					"name_label": {
+						"type": "string"
+					},
+					"nbd": {
+						"type": "boolean"
+					},
+					"other_config": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"tags": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"type": {
+						"type": "string",
+						"enum": [
+							"network"
+						]
+					}
+				},
+				"type": "object",
+				"description": "Make all properties in T optional"
+			},
+			"WithHref_Partial_Unbrand_XoNetwork___": {
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Partial_Unbrand_XoNetwork__"
+					},
+					{
+						"properties": {
+							"href": {
+								"type": "string"
+							}
+						},
+						"required": [
+							"href"
+						],
+						"type": "object"
+					}
+				]
+			},
+			"Unbrand_XoNetwork_": {
+				"properties": {
+					"$pool": {
+						"type": "string"
+					},
+					"$poolId": {
+						"type": "string",
+						"deprecated": true
+					},
+					"_xapiRef": {
+						"type": "string"
+					},
+					"uuid": {
+						"type": "string"
+					},
+					"MTU": {
+						"type": "number",
+						"format": "double"
+					},
+					"PIFs": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"VIFs": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"automatic": {
+						"type": "boolean"
+					},
+					"bridge": {
+						"type": "string"
+					},
+					"current_operations": {
+						"$ref": "#/components/schemas/Record_string.attaching_"
+					},
+					"defaultIsLocked": {
+						"type": "boolean"
+					},
+					"id": {
+						"type": "string"
+					},
+					"insecureNbd": {
+						"type": "boolean"
+					},
+					"name_description": {
+						"type": "string"
+					},
+					"name_label": {
+						"type": "string"
+					},
+					"nbd": {
+						"type": "boolean"
+					},
+					"other_config": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"tags": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"type": {
+						"type": "string",
+						"enum": [
+							"network"
+						],
+						"nullable": false
+					}
+				},
+				"required": [
+					"$pool",
+					"$poolId",
+					"_xapiRef",
+					"uuid",
+					"MTU",
+					"PIFs",
+					"VIFs",
+					"automatic",
+					"bridge",
+					"current_operations",
+					"defaultIsLocked",
+					"id",
+					"name_description",
+					"name_label",
+					"other_config",
+					"tags",
+					"type"
+				],
+				"type": "object"
+			},
 			"Partial_UnbrandedXoAlarm_": {
 				"properties": {
 					"$pool": {
@@ -5948,6 +6176,76 @@
 			},
 			"XapiHostStats": {
 				"$ref": "#/components/schemas/XapiStatsResponse__cpus-Record_string.number-Array_--ioThroughput_58__r-Record_string.number-Array_--w-Record_string.number-Array__--iops_58__r-Record_string.number-Array_--w-Record_string.number-Array__--iowait-Record_string.number-Array_--latency_58__r-Record_string.number-Array_--w-Record_string.number-Array__--load-number-Array--memory-number-Array--memoryFree-number-Array--pifs_58__rx-Record_string.number-Array_--tx-Record_string.number-Array____"
+			},
+			"Partial_Unbrand_XoGroup__": {
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"name": {
+						"type": "string"
+					},
+					"provider": {
+						"type": "string"
+					},
+					"providerGroupId": {
+						"type": "string"
+					},
+					"users": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					}
+				},
+				"type": "object",
+				"description": "Make all properties in T optional"
+			},
+			"WithHref_Partial_Unbrand_XoGroup___": {
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Partial_Unbrand_XoGroup__"
+					},
+					{
+						"properties": {
+							"href": {
+								"type": "string"
+							}
+						},
+						"required": [
+							"href"
+						],
+						"type": "object"
+					}
+				]
+			},
+			"Unbrand_XoGroup_": {
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"name": {
+						"type": "string"
+					},
+					"provider": {
+						"type": "string"
+					},
+					"providerGroupId": {
+						"type": "string"
+					},
+					"users": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					}
+				},
+				"required": [
+					"id",
+					"name",
+					"users"
+				],
+				"type": "object"
 			}
 		},
 		"securitySchemes": {
@@ -5960,7 +6258,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.5.0",
+		"version": "0.7.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -7466,11 +7764,261 @@
 					"404": {
 						"description": "Resource not found"
 					},
-					"422": {
-						"description": "Invalid granularity, VM is halted or host could not be found"
+					"422": {
+						"description": "Invalid granularity, VM is halted or host could not be found"
+					}
+				},
+				"description": "\nVM must be running",
+				"tags": [
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					},
+					{
+						"in": "query",
+						"name": "granularity",
+						"required": false,
+						"schema": {
+							"$ref": "#/components/schemas/XapiStatsGranularity"
+						}
+					}
+				]
+			}
+		},
+		"/vms/{id}/actions/start": {
+			"post": {
+				"operationId": "StartVm",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"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"
+						}
+					}
+				]
+			}
+		},
+		"/vms/{id}/actions/clean_shutdown": {
+			"post": {
+				"operationId": "CleanShutdownVm",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {
+									"anyOf": [
+										{
+											"type": "string"
+										},
+										{}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"description": "Requires guest tools to be installed",
+				"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"
+						}
+					}
+				]
+			}
+		},
+		"/vms/{id}/actions/clean_reboot": {
+			"post": {
+				"operationId": "CleanRebootVm",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"anyOf": [
+										{},
+										{
+											"type": "string"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					}
+				},
+				"description": "Requires guest tools to be installed",
+				"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"
+						}
+					}
+				]
+			}
+		},
+		"/vms/{id}/actions/hard_shutdown": {
+			"post": {
+				"operationId": "HardShutdownVm",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {
+									"anyOf": [
+										{
+											"type": "string"
+										},
+										{}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
 					}
 				},
-				"description": "\nVM must be running",
 				"tags": [
 					"vms"
 				],
@@ -7491,24 +8039,31 @@
 					},
 					{
 						"in": "query",
-						"name": "granularity",
+						"name": "sync",
 						"required": false,
 						"schema": {
-							"$ref": "#/components/schemas/XapiStatsGranularity"
+							"type": "boolean"
 						}
 					}
 				]
 			}
 		},
-		"/vms/{id}/actions/start": {
+		"/vms/{id}/actions/hard_reboot": {
 			"post": {
-				"operationId": "StartVm",
+				"operationId": "HardRebootVm",
 				"responses": {
 					"202": {
 						"description": "Action executed asynchronously",
 						"content": {
 							"text/plain": {
-								"schema": {},
+								"schema": {
+									"anyOf": [
+										{},
+										{
+											"type": "string"
+										}
+									]
+								},
 								"examples": {
 									"Example 1": {
 										"value": "/rest/v0/tasks/0m7kl0j9l"
@@ -9455,6 +10010,71 @@
 						"example": 42
 					}
 				]
+			},
+			"post": {
+				"operationId": "AddServer",
+				"responses": {
+					"201": {
+						"description": "Resource created",
+						"content": {
+							"application/json": {
+								"schema": {
+									"properties": {
+										"id": {
+											"type": "string"
+										}
+									},
+									"required": [
+										"id"
+									],
+									"type": "object"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"id": "38068475-3a1d-4a64-95df-8782cdea02ac"
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"409": {
+						"description": "Resource already exists"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					}
+				},
+				"tags": [
+					"servers"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/InsertableXoServer"
+							},
+							"example": {
+								"allowUnauthorized": true,
+								"host": "192.168.1.10",
+								"label": "Example server",
+								"username": "root",
+								"password": "awes0meP4ssword"
+							}
+						}
+					}
+				}
 			}
 		},
 		"/servers/{id}": {
@@ -9515,6 +10135,138 @@
 				]
 			}
 		},
+		"/servers/{id}/actions/connect": {
+			"post": {
+				"operationId": "ConnectServer",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {
+									"anyOf": [
+										{},
+										{
+											"type": "string"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"409": {
+						"description": "The server is already connected"
+					}
+				},
+				"tags": [
+					"servers"
+				],
+				"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"
+						}
+					}
+				]
+			}
+		},
+		"/servers/{id}/actions/disconnect": {
+			"post": {
+				"operationId": "DisconnectServer",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {
+									"anyOf": [
+										{},
+										{
+											"type": "string"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"409": {
+						"description": "The server is already disconnected"
+					}
+				},
+				"tags": [
+					"servers"
+				],
+				"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"
+						}
+					}
+				]
+			}
+		},
 		"/schedules": {
 			"get": {
 				"operationId": "GetSchedules",
@@ -9922,6 +10674,179 @@
 				]
 			}
 		},
+		"/networks": {
+			"get": {
+				"operationId": "GetNetworks",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"anyOf": [
+										{
+											"items": {
+												"type": "string"
+											},
+											"type": "array"
+										},
+										{
+											"items": {
+												"$ref": "#/components/schemas/WithHref_Partial_Unbrand_XoNetwork___"
+											},
+											"type": "array"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": [
+											"/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f",
+											"/rest/v0/networks/6b6ca0f5-6611-0636-4b0a-1fb1c8e96414"
+										]
+									},
+									"Example 2": {
+										"value": [
+											{
+												"nbd": true,
+												"name_label": "Host internal management network",
+												"id": "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f",
+												"href": "/rest/v0/networks/9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+											},
+											{
+												"nbd": true,
+												"name_label": "Lab v2 (VLAN 11)",
+												"id": "6b6ca0f5-6611-0636-4b0a-1fb1c8e96414",
+												"href": "/rest/v0/networks/6b6ca0f5-6611-0636-4b0a-1fb1c8e96414"
+											}
+										]
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					}
+				},
+				"tags": [
+					"networks"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "query",
+						"name": "fields",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "nbd,name_label,id"
+					},
+					{
+						"in": "query",
+						"name": "filter",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "nbd?"
+					},
+					{
+						"in": "query",
+						"name": "limit",
+						"required": false,
+						"schema": {
+							"format": "double",
+							"type": "number"
+						},
+						"example": 42
+					}
+				]
+			}
+		},
+		"/networks/{id}": {
+			"get": {
+				"operationId": "GetNetwork",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Unbrand_XoNetwork_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"automatic": false,
+											"bridge": "xenapi",
+											"current_operations": {},
+											"defaultIsLocked": false,
+											"MTU": 1500,
+											"name_description": "Network on which guests will be assigned a private link-local IP address which can be used to talk XenAPI",
+											"name_label": "Host internal management network",
+											"other_config": {
+												"is_guest_installer_network": "true",
+												"is_host_internal_management_network": "true",
+												"ip_begin": "169.254.0.1",
+												"ip_end": "169.254.255.254",
+												"netmask": "255.255.0.0"
+											},
+											"tags": [],
+											"PIFs": [],
+											"VIFs": [
+												"2d039fc8-e522-75db-34c9-536b9553bd5a",
+												"38623621-d30e-0307-dcef-eb7ed6c69f0c",
+												"cc4b090f-5ff1-254b-558f-f7ac237e6fc5",
+												"a9f3d042-a2e1-102f-74fc-ff1df41c6eb3"
+											],
+											"nbd": false,
+											"insecureNbd": false,
+											"id": "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f",
+											"type": "network",
+											"uuid": "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f",
+											"$pool": "b7569d99-30f8-178a-7d94-801de3e29b5b",
+											"$poolId": "b7569d99-30f8-178a-7d94-801de3e29b5b",
+											"_xapiRef": "OpaqueRef:eb906e77-2221-5399-4a26-60f0ad069b61"
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					}
+				},
+				"tags": [
+					"networks"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+					}
+				]
+			}
+		},
 		"/alarms": {
 			"get": {
 				"operationId": "GetAlarms",
@@ -16828,6 +17753,159 @@
 					}
 				]
 			}
+		},
+		"/groups": {
+			"get": {
+				"operationId": "GetGroups",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"anyOf": [
+										{
+											"items": {
+												"type": "string"
+											},
+											"type": "array"
+										},
+										{
+											"items": {
+												"$ref": "#/components/schemas/WithHref_Partial_Unbrand_XoGroup___"
+											},
+											"type": "array"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": [
+											"/rest/v0/groups/7d98fee4-3357-41a7-ac3f-9124212badb7",
+											"/rest/v0/groups/7981ba62-c395-4546-bfa4-d1261653a77f"
+										]
+									},
+									"Example 2": {
+										"value": [
+											{
+												"name": "group 1",
+												"id": "7d98fee4-3357-41a7-ac3f-9124212badb7",
+												"users": [
+													"722d17b9-699b-49d2-8193-be1ac573d3de"
+												],
+												"href": "/rest/v0/groups/7d98fee4-3357-41a7-ac3f-9124212badb7"
+											},
+											{
+												"name": "group 2",
+												"id": "7981ba62-c395-4546-bfa4-d1261653a77f",
+												"users": [
+													"722d17b9-699b-49d2-8193-be1ac573d3de",
+													"088124f3-41b6-4258-9653-6eedc7b46111"
+												],
+												"href": "/rest/v0/groups/7981ba62-c395-4546-bfa4-d1261653a77f"
+											}
+										]
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					}
+				},
+				"tags": [
+					"groups"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "query",
+						"name": "fields",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "name,id,users"
+					},
+					{
+						"in": "query",
+						"name": "filter",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "users:length:>0"
+					},
+					{
+						"in": "query",
+						"name": "limit",
+						"required": false,
+						"schema": {
+							"format": "double",
+							"type": "number"
+						},
+						"example": 42
+					}
+				]
+			}
+		},
+		"/groups/{id}": {
+			"get": {
+				"operationId": "GetGroup",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Unbrand_XoGroup_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"name": "group 1",
+											"users": [
+												"722d17b9-699b-49d2-8193-be1ac573d3de"
+											],
+											"id": "7d98fee4-3357-41a7-ac3f-9124212badb7"
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					}
+				},
+				"tags": [
+					"groups"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "7d98fee4-3357-41a7-ac3f-9124212badb7"
+					}
+				]
+			}
 		}
 	},
 	"servers": [