]> git.ipfire.org Git - thirdparty/bacula.git/commitdiff
baculum: Add client ls command to openapi file
authorMarcin Haba <marcin.haba@bacula.pl>
Mon, 22 Apr 2019 07:43:59 +0000 (09:43 +0200)
committerMarcin Haba <marcin.haba@bacula.pl>
Mon, 22 Apr 2019 07:43:59 +0000 (09:43 +0200)
gui/baculum/protected/API/openapi_baculum.json

index 4d0772d5ce0703e700296303b418beb5061763e8..4d09c54d0b952637a15726e4bdca78e1158f0c19 100644 (file)
                                }]
                        }
                },
+               "/api/v1/clients/{clientid}/ls": {
+                       "get": {
+                               "tags": ["clients"],
+                               "summary": "List Client files/directories",
+                               "description": "Get list Client files/directories for specific path",
+                               "responses": {
+                                       "200": {
+                                               "description": "Client list files/directories output",
+                                               "content": {
+                                                       "application/json": {
+                                                               "schema": {
+                                                                       "type": "object",
+                                                                       "properties": {
+                                                                               "output": {
+                                                                                       "type": "array",
+                                                                                       "items": {
+                                                                                               "type": "string",
+                                                                                               "description": "Client files/directories list output"
+                                                                                       }
+                                                                               },
+                                                                               "error": {
+                                                                                       "type": "integer",
+                                                                                       "description": "Error code",
+                                                                                       "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 1000]
+                                                                               }
+                                                                       }
+                                                               }
+                                                       }
+                                               }
+                                       }
+                               },
+                               "parameters": [
+                                       {
+                                               "$ref": "#/components/parameters/ClientId"
+                                       },
+                                       {
+                                               "name": "path",
+                                               "in": "query",
+                                               "required": true,
+                                               "description": "Path on Client",
+                                               "schema": {
+                                                       "type": "string",
+                                                       "pattern": "[p{L}p{N}p{Z}[]()-+/:.#~_,{}!']{1,10000}"
+                                               }
+                                       }
+                               ]
+                       }
+               },
                "/api/v1/clients/show": {
                        "get": {
                                "tags": ["clients"],