Fix description of get all protocols return

mcneilco · Oct 22, 2024 · 4f843f3 · 4f843f3
1 parent d11ac5b
commit 4f843f3
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/acasclient/acasclient.py b/acasclient/acasclient.py
@@ -979,14 +979,23 @@ def get_protocol_by_code(self, protocol_code):
         return resp.json()
 
     def get_all_protocols(self):
-        """Get all protocols
+        """Get all protocol code stubs
 
         Get an array of all protocols
 
         Args:
             None
 
-        Returns: Returns an array of protocols
+        list of dict: Returns an array of protocol stubs in the format:
+            [
+                {
+                    'id': int,
+                    'code': str,
+                    'name': str,
+                    'ignored': str
+                },
+                ...
+            ]
         """
         resp = self.session.get("{}/api/protocolCodes"
                                 .format(self.url))