@xen-orchestra/rest-api 0.4.0 → 0.6.0

package/open-api/spec/swagger.json

@@ -3978,6 +3978,96 @@
 				],
 				"type": "object"
 			},
+			"Partial_Unbrand_XoUser__": {
+				"properties": {
+					"authProviders": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"email": {
+						"type": "string"
+					},
+					"groups": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"id": {
+						"type": "string"
+					},
+					"name": {
+						"type": "string"
+					},
+					"permission": {
+						"type": "string"
+					},
+					"pw_hash": {
+						"type": "string"
+					},
+					"preferences": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					}
+				},
+				"type": "object",
+				"description": "Make all properties in T optional"
+			},
+			"WithHref_Partial_Unbrand_XoUser___": {
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Partial_Unbrand_XoUser__"
+					},
+					{
+						"properties": {
+							"href": {
+								"type": "string"
+							}
+						},
+						"required": [
+							"href"
+						],
+						"type": "object"
+					}
+				]
+			},
+			"Unbrand_XoUser_": {
+				"properties": {
+					"authProviders": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"email": {
+						"type": "string"
+					},
+					"groups": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"id": {
+						"type": "string"
+					},
+					"name": {
+						"type": "string"
+					},
+					"permission": {
+						"type": "string"
+					},
+					"pw_hash": {
+						"type": "string"
+					},
+					"preferences": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					}
+				},
+				"required": [
+					"email",
+					"groups",
+					"id",
+					"permission",
+					"preferences"
+				],
+				"type": "object"
+			},
 			"Record_string.STORAGE_OPERATIONS_": {
 				"properties": {},
 				"type": "object",
@@ -4669,6 +4759,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": {
@@ -5858,6 +6144,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": {
@@ -5870,7 +6226,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.4.0",
+		"version": "0.6.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -7636,7 +7992,7 @@
 											"$VGPUs": [],
 											"xenStoreData": {},
 											"vga": "std",
-											"videoram": "8",
+											"videoram": 8,
 											"id": "b7569d99-30f8-178a-7d94-801de3e29b5b-f873abe0-b138-4995-8f6f-498b423d234d",
 											"isDefaultTemplate": true,
 											"template_info": {
@@ -8916,6 +9272,158 @@
 				]
 			}
 		},
+		"/users": {
+			"get": {
+				"operationId": "GetUsers",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"anyOf": [
+										{
+											"items": {
+												"type": "string"
+											},
+											"type": "array"
+										},
+										{
+											"items": {
+												"$ref": "#/components/schemas/WithHref_Partial_Unbrand_XoUser___"
+											},
+											"type": "array"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": [
+											"/rest/v0/users/088124f3-41b6-4258-9653-6eedc7b46111",
+											"/rest/v0/users/a8715f02-20e7-4881-8b02-28ce2260c39d"
+										]
+									},
+									"Example 2": {
+										"value": [
+											{
+												"permission": "none",
+												"name": "testName",
+												"id": "088124f3-41b6-4258-9653-6eedc7b46111",
+												"href": "/rest/v0/users/088124f3-41b6-4258-9653-6eedc7b46111"
+											},
+											{
+												"permission": "none",
+												"id": "a8715f02-20e7-4881-8b02-28ce2260c39d",
+												"href": "/rest/v0/users/a8715f02-20e7-4881-8b02-28ce2260c39d"
+											}
+										]
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					}
+				},
+				"tags": [
+					"users"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "query",
+						"name": "fields",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "permission,name,id"
+					},
+					{
+						"in": "query",
+						"name": "filter",
+						"required": false,
+						"schema": {
+							"type": "string"
+						},
+						"example": "permission:none"
+					},
+					{
+						"in": "query",
+						"name": "limit",
+						"required": false,
+						"schema": {
+							"format": "double",
+							"type": "number"
+						},
+						"example": 42
+					}
+				]
+			}
+		},
+		"/users/{id}": {
+			"get": {
+				"operationId": "GetUser",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Unbrand_XoUser_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"email": "admin@admin.net",
+											"permission": "admin",
+											"pw_hash": "***obfuscated***",
+											"groups": [
+												"7d98fee4-3357-41a7-ac3f-9124212badb7",
+												"7981ba62-c395-4546-bfa4-d1261653a77f"
+											],
+											"name": "admin@admin.net",
+											"preferences": {},
+											"id": "722d17b9-699b-49d2-8193-be1ac573d3de"
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					}
+				},
+				"tags": [
+					"users"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "722d17b9-699b-49d2-8193-be1ac573d3de"
+					}
+				]
+			}
+		},
 		"/srs": {
 			"get": {
 				"operationId": "GetSrs",
@@ -9680,6 +10188,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",
@@ -16586,6 +17267,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": [