From: Marcin Haba <marcin.haba@bacula.pl>
Date: Tue, 14 May 2019 17:30:09 +0000 (+0200)
Subject: baculum: Update API documentation to job estimate endpoint
X-Git-Tag: Release-9.6.0~226
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=b4131b6afd28d6db01a75ec84e5d04a91ad5e339;p=thirdparty%2Fbacula.git

baculum: Update API documentation to job estimate endpoint
---

diff --git a/gui/baculum/protected/API/openapi_baculum.json b/gui/baculum/protected/API/openapi_baculum.json
index 11ad23b834..d6b9f0584d 100644
--- a/gui/baculum/protected/API/openapi_baculum.json
+++ b/gui/baculum/protected/API/openapi_baculum.json
@@ -946,6 +946,47 @@
 			}
 		},
 		"/api/v1/jobs/estimate": {
+			"get": {
+				"tags": ["jobs"],
+				"summary": "Get estimate output",
+				"description": "Get estimate output by output identifier",
+				"responses": {
+					"200": {
+						"description": "Estimate output",
+						"content": {
+							"application/json": {
+								"schema": {
+									"type": "object",
+									"properties": {
+										"output": {
+											"type": "array",
+											"items": {
+												"type": "string",
+												"description": "Estimate output."
+											}
+										},
+										"error": {
+											"type": "integer",
+											"description": "Error code",
+											"enum": [0, 1, 1000]
+										}
+									}
+								}
+							}
+						}
+					}
+				},
+				"parameters": [{
+					"name": "out_id",
+					"in": "query",
+					"description": "Output identifier acquired during estimate start.",
+					"required": true,
+					"schema": {
+						"type": "string",
+						"pattern": "[a-zA-Z0-9]+"
+					}
+				}]
+			},
 			"post": {
 				"tags": ["jobs"],
 				"summary": "Estimate job bytes and files",
@@ -962,8 +1003,8 @@
 										"output": {
 											"type": "array",
 											"items": {
-												"description": "Output with estimated bytes and files",
-												"type": "string"
+												"type": "string",
+												"description": "JSON string with output identifier"
 											}
 										},
 										"error": {