]> git.ipfire.org Git - thirdparty/bacula.git/commitdiff
baculum: Update API documentation
authorMarcin Haba <marcin.haba@bacula.pl>
Fri, 15 Sep 2023 08:23:18 +0000 (10:23 +0200)
committerMarcin Haba <marcin.haba@bacula.pl>
Thu, 2 Nov 2023 07:32:54 +0000 (08:32 +0100)
gui/baculum/protected/API/openapi_baculum.json

index 8d812a6cff5e64985203ee2c32020df28622c1a2..31e636731673a6e52c9f28f9e00207613b8a384a 100644 (file)
                                "parameters": [{
                                        "$ref": "#/components/parameters/ClientId"
                                }]
+                       },
+                       "delete": {
+                               "tags": ["clients"],
+                               "summary": "Delete client",
+                               "description": "Delete client by specific client identifier.",
+                               "responses": {
+                                       "200": {
+                                               "description": "Delete client command output and error code.",
+                                               "content": {
+                                                       "application/json": {
+                                                               "schema": {
+                                                                       "type": "object",
+                                                                       "properties": {
+                                                                               "output": {
+                                                                                       "type": "array",
+                                                                                       "items": {
+                                                                                               "description": "Console output from removing client",
+                                                                                               "type": "string"
+                                                                                       }
+                                                                               },
+                                                                               "error": {
+                                                                                       "type": "integer",
+                                                                                       "description": "Error code",
+                                                                                       "enum": [0, 1, 2, 3, 4, 5, 6, 7, 10, 11, 1000]
+                                                                               }
+                                                                       }
+                                                               }
+                                                       }
+                                               }
+                                       }
+                               },
+                               "parameters": [
+                                       {
+                                               "name": "clientid",
+                                               "in": "path",
+                                               "description": "Client identifier",
+                                               "required":  true,
+                                               "schema": {
+                                                       "type": "integer"
+                                               }
+                                       }
+                               ]
                        }
                },
                "/api/v2/clients/{clientid}/show": {
                                "description": "Delete job by specific Job identifier.",
                                "responses": {
                                        "200": {
-                                               "description": "Job properties",
+                                               "description": "Delete jobid command output and error code.",
                                                "content": {
                                                        "application/json": {
                                                                "schema": {
                                "parameters": [{
                                        "$ref": "#/components/parameters/PoolId"
                                }]
+                       },
+                       "delete": {
+                               "tags": ["pools"],
+                               "summary": "Delete pool",
+                               "description": "Delete pool by specific pool identifier.",
+                               "responses": {
+                                       "200": {
+                                               "description": "Delete pool command output and error code.",
+                                               "content": {
+                                                       "application/json": {
+                                                               "schema": {
+                                                                       "type": "object",
+                                                                       "properties": {
+                                                                               "output": {
+                                                                                       "type": "array",
+                                                                                       "items": {
+                                                                                               "description": "Console output from removing pool",
+                                                                                               "type": "string"
+                                                                                       }
+                                                                               },
+                                                                               "error": {
+                                                                                       "type": "integer",
+                                                                                       "description": "Error code",
+                                                                                       "enum": [0, 1, 2, 3, 4, 5, 6, 7, 11, 40, 1000]
+                                                                               }
+                                                                       }
+                                                               }
+                                                       }
+                                               }
+                                       }
+                               },
+                               "parameters": [
+                                       {
+                                               "name": "poolid",
+                                               "in": "path",
+                                               "description": "Pool identifier",
+                                               "required":  true,
+                                               "schema": {
+                                                       "type": "integer"
+                                               }
+                                       }
+                               ]
                        }
                },
                "/api/v2/pools/{poolid}/volumes": {
                                                }
                                        }
                                ]
+                       },
+                       "delete": {
+                               "tags": ["objects"],
+                               "summary": "Delete object",
+                               "description": "Delete object by specific object identifier.",
+                               "responses": {
+                                       "200": {
+                                               "description": "Delete object command output and error code.",
+                                               "content": {
+                                                       "application/json": {
+                                                               "schema": {
+                                                                       "type": "object",
+                                                                       "properties": {
+                                                                               "output": {
+                                                                                       "type": "array",
+                                                                                       "items": {
+                                                                                               "description": "Console output from removing object",
+                                                                                               "type": "string"
+                                                                                       }
+                                                                               },
+                                                                               "error": {
+                                                                                       "type": "integer",
+                                                                                       "description": "Error code",
+                                                                                       "enum": [0, 1, 2, 3, 4, 5, 6, 7, 11, 500, 1000]
+                                                                               }
+                                                                       }
+                                                               }
+                                                       }
+                                               }
+                                       }
+                               },
+                               "parameters": [
+                                       {
+                                               "name": "objectid",
+                                               "in": "path",
+                                               "description": "Object identifier",
+                                               "required":  true,
+                                               "schema": {
+                                                       "type": "integer"
+                                               }
+                                       }
+                               ]
                        }
                },
                "/api/v2/objects/versions/{objectuuid}": {