chore: add changes to documentation

CloudNetService · Dec 20, 2024 · c36ff7c · c36ff7c
1 parent 1bdf788
commit c36ff7c
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/cloudnet-rest-module/src/main/resources/documentation/swagger.yaml b/cloudnet-rest-module/src/main/resources/documentation/swagger.yaml
@@ -681,6 +681,14 @@ paths:
             The ticket secret used for authentication purposes. Can be omitted if jwt authentication is used.
           schema:
             type: string
+        - name: threshold
+          in: query
+          required: false
+          description: |
+            The log level threshold. Only log entries with the same or higher log level will be sent.
+            The lowest level possible is the configured log level of the node itself.
+          schema:
+            $ref: '#/components/schemas/LogLevel'
       summary: Live console
       description: |
         Upgrades the connection to a web socket connection and sends all new
@@ -689,6 +697,9 @@ paths:
         One of the following scopes is needed to execute the request:
           - `cloudnet_rest:node_read`
           - `cloudnet_rest:node_live_console`
+        
+        Sending commands to the console using the websocket is only allowed if the following scope is set:
+          - `cloudnet_rest:node_send_commands`
       responses:
         '101':
           description: Switching the protocol to a websocket
@@ -4662,6 +4673,16 @@ components:
           examples:
             - CloudNet-Bridge
             - CloudNet-Signs
+    LogLevel:
+      type: string
+      enum:
+        - ALL
+        - TRACE
+        - DEBUG
+        - INFO
+        - WARN
+        - ERROR
+        - OFF
     CloudNetVersion:
       type: object
       properties: