From: Marcin Haba <marcin.haba@bacula.pl>
Date: Fri, 9 Dec 2022 14:56:06 +0000 (+0100)
Subject: baculum: Add documentation for component actions
X-Git-Tag: Release-13.0.2~33
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=449c01f05a3d2a86d890732c1ddf7121f78d1c58;p=thirdparty%2Fbacula.git

baculum: Add documentation for component actions
---

diff --git a/gui/baculum/protected/API/openapi_baculum.json b/gui/baculum/protected/API/openapi_baculum.json
index 1fd74dafd..74472c08f 100644
--- a/gui/baculum/protected/API/openapi_baculum.json
+++ b/gui/baculum/protected/API/openapi_baculum.json
@@ -6427,6 +6427,55 @@
 				]
 			}
 		},
+		"/api/v2/actions/{component}/{action}/": {
+			"get": {
+				"tags": ["actions"],
+				"summary": "Run Bacula component action",
+				"description": "Run Bacula component action.",
+				"responses": {
+					"200": {
+						"description": "Run Bacula component action",
+						"content": {
+							"application/json": {
+								"schema": {
+									"type": "object",
+									"properties": {
+										"output": {
+											"type": "string"
+										},
+										"error": {
+											"type": "integer",
+											"description": "Error code",
+											"enum": [0, 110, 111, 112, 113, 1000]
+										}
+									}
+								}
+							}
+						}
+					}
+				},
+				"parameters": [
+					{
+						"name": "component",
+						"in": "path",
+						"required": true,
+						"description": "Component name: director, storage or client.",
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "action",
+						"in": "path",
+						"required": true,
+						"description": "Component action: start, stop or restart.",
+						"schema": {
+							"type": "string"
+						}
+					}
+				]
+			}
+		},
 		"/api/v2/objects": {
 			"get": {
 				"tags": ["objects"],