doc/rest-api: Refresh swagger YAML

Signed-off-by: Lucas Bremgartner <[email protected]>
lxc · Nov 28, 2024 · a65c5b9 · a65c5b9
1 parent 270cba3
commit a65c5b9
Showing 1 changed file with 16 additions and 3 deletions.
diff --git a/doc/rest-api.yaml b/doc/rest-api.yaml
@@ -9297,19 +9297,32 @@ paths:
             tags:
                 - instances
         get:
-            description: Gets the console log for the instance.
+            description: |-
+                Gets the console output for the instance either as text log or as vga
+                screendump.
             operationId: instance_console_get
             parameters:
                 - description: Project name
                   example: default
                   in: query
                   name: project
                   type: string
+                - default: log
+                  description: Console type
+                  enum:
+                    - log
+                    - vga
+                  example: vga
+                  in: query
+                  name: type
+                  type: string
             produces:
                 - application/json
             responses:
                 "200":
-                    description: Raw console log
+                    description: |
+                        Console output either as raw console log or as vga screendump in PNG
+                        format depending on the `type` parameter provided with the request.
                 "400":
                     $ref: '#/responses/BadRequest'
                 "403":
@@ -9318,7 +9331,7 @@ paths:
                     $ref: '#/responses/NotFound'
                 "500":
                     $ref: '#/responses/InternalServerError'
-            summary: Get console log
+            summary: Get console output
             tags:
                 - instances
         post: