catocli 3.0.10__py3-none-any.whl → 3.0.12__py3-none-any.whl

models/query.socketPortMetrics.json

@@ -1070,6 +1070,42 @@
             },
             "varName": "accountID"
         },
+        "from": {
+            "defaultValue": null,
+            "description": null,
+            "id_str": "records___from",
+            "name": "from",
+            "path": "records.from",
+            "requestStr": "$from:Int ",
+            "required": false,
+            "responseStr": "from:$from ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Int",
+                "non_null": false
+            },
+            "varName": "from"
+        },
+        "limit": {
+            "defaultValue": null,
+            "description": null,
+            "id_str": "records___limit",
+            "name": "limit",
+            "path": "records.limit",
+            "requestStr": "$limit:Int ",
+            "required": false,
+            "responseStr": "limit:$limit ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Int",
+                "non_null": false
+            },
+            "varName": "limit"
+        },
         "socketPortMetricsDimension": {
             "defaultValue": null,
             "description": null,
@@ -2962,6 +2998,8 @@
         "non_null": false
     },
     "variablesPayload": {
+        "from": 1,
+        "limit": 1,
         "socketPortMetricsDimension": {
             "fieldName": "account_id"
         },

models/query.socketPortMetricsTimeSeries.json

@@ -844,6 +844,43 @@
             },
             "varName": "accountID"
         },
+        "buckets": {
+            "defaultValue": null,
+            "description": null,
+            "id_str": "timeseries___buckets",
+            "name": "buckets",
+            "path": "timeseries.buckets",
+            "requestStr": "$buckets:Int! ",
+            "required": true,
+            "responseStr": "buckets:$buckets ",
+            "type": {
+                "kind": [
+                    "NON_NULL",
+                    "SCALAR"
+                ],
+                "name": "Int",
+                "non_null": false
+            },
+            "varName": "buckets"
+        },
+        "perSecond": {
+            "defaultValue": "true",
+            "description": "whether to normalize the data into per second (i.e. divide by granularity)",
+            "id_str": "data___perSecond",
+            "name": "perSecond",
+            "path": "data.perSecond",
+            "requestStr": "$perSecond:Boolean ",
+            "required": false,
+            "responseStr": "perSecond:$perSecond ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "perSecond"
+        },
         "socketPortMetricsDimension": {
             "defaultValue": null,
             "description": null,
@@ -1642,6 +1679,42 @@
                 "non_null": false
             },
             "varName": "timeFrame"
+        },
+        "useDefaultSizeBucket": {
+            "defaultValue": "false",
+            "description": "In case we want to have the default size bucket (from properties)",
+            "id_str": "data___useDefaultSizeBucket",
+            "name": "useDefaultSizeBucket",
+            "path": "data.useDefaultSizeBucket",
+            "requestStr": "$useDefaultSizeBucket:Boolean ",
+            "required": false,
+            "responseStr": "useDefaultSizeBucket:$useDefaultSizeBucket ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "useDefaultSizeBucket"
+        },
+        "withMissingData": {
+            "defaultValue": "false",
+            "description": "If false, the data field will be set to '0' for buckets with no reported data. Otherwise it will be set to -1",
+            "id_str": "data___withMissingData",
+            "name": "withMissingData",
+            "path": "data.withMissingData",
+            "requestStr": "$withMissingData:Boolean ",
+            "required": false,
+            "responseStr": "withMissingData:$withMissingData ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "withMissingData"
         }
     },
     "path": "query.socketPortMetricsTimeSeries",
@@ -2241,6 +2314,8 @@
         "non_null": false
     },
     "variablesPayload": {
+        "buckets": 1,
+        "perSecond": true,
         "socketPortMetricsDimension": {
             "fieldName": "account_id"
         },
@@ -2257,6 +2332,8 @@
             "fieldName": "account_id",
             "trend": true
         },
-        "timeFrame": "example_value"
+        "timeFrame": "example_value",
+        "useDefaultSizeBucket": true,
+        "withMissingData": true
     }
 }

schema/catolib.py

@@ -15,13 +15,14 @@ import concurrent.futures
 import threading
 from functools import lru_cache
 import traceback
+import re
 
 # Import shared utilities
 from catocli.Utils.graphql_utils import (
     loadJSON,
     renderCamelCase,
     generateGraphqlPayload as shared_generateGraphqlPayload,
-    renderArgsAndFields as shared_renderArgsAndFields,
+    renderArgsAndFields,
     postProcessBareComplexFields
 )
 
@@ -93,6 +94,41 @@ def openFile(fileName, readMode="rt"):
         # print('[ERROR] File path "'+fileName+'" in csv not found, or script unable to read.')
         exit()
 
+def extract_comments_from_example_file(file_content):
+    """
+    Extract comments from example markdown file.
+    Returns both markdown headers and comments inside bash code blocks, deduplicated.
+    """
+    comments = []
+    lines = file_content.split('\n')
+    in_bash_block = False
+    seen_comments = set()
+    
+    for line in lines:
+        # Check for markdown headers (lines starting with #)
+        if line.strip().startswith('# ') and not in_bash_block:
+            comment = line.strip()
+            if comment not in seen_comments:
+                comments.append(comment)
+                seen_comments.add(comment)
+        
+        # Check for bash code block start/end
+        if line.strip() == '```bash':
+            in_bash_block = True
+            continue
+        elif line.strip() == '```':
+            in_bash_block = False
+            continue
+        
+        # Extract comments inside bash blocks
+        if in_bash_block and line.strip().startswith('# '):
+            comment = line.strip()
+            if comment not in seen_comments:
+                comments.append(comment)
+                seen_comments.add(comment)
+    
+    return comments
+
 ############ parsing schema - THREADED VERSION ############
 
 def parseSchema(schema):
@@ -229,20 +265,47 @@ def processOperation(operationType, operationName):
             arg = parsedOperation["args"][argName]
             parsedOperation["operationArgs"][arg["varName"]] = arg
         
-        # Also include child operation arguments in operationArgs (avoid duplicates)
-        if "childOperations" in parsedOperation:
-            for childOpName, childOp in parsedOperation["childOperations"].items():
-                if "args" in childOp:
-                    for childArgName, childArg in childOp["args"].items():
-                        if "varName" in childArg and childArg["varName"] not in parsedOperation["operationArgs"]:
-                            parsedOperation["operationArgs"][childArg["varName"]] = childArg
+        # Include child operation arguments and field arguments in operationArgs for README generation
+        # This is needed so that README generation shows all arguments including:
+        # 1. Child operation arguments like storyInput (for query.xdr.stories)
+        # 2. Field arguments like siteIDs and userIDs (for query.accountSnapshot)
+        def addAllOperationArgs(data, operationArgs):
+            """Recursively add child operation arguments and field arguments to operationArgs"""
+            if isinstance(data, dict):
+                # Handle child operations (like in query.xdr.stories)
+                if "childOperations" in data:
+                    for childName, childOp in data["childOperations"].items():
+                        if isinstance(childOp, dict) and "args" in childOp:
+                            for argName, arg in childOp["args"].items():
+                                # Use the arg's varName as the key to match how main args are stored
+                                operationArgs[arg["varName"]] = arg
+                        # Recursively process nested child operations
+                        addAllOperationArgs(childOp, operationArgs)
+                
+                # Handle field arguments (like siteIDs in sites field, userIDs in users field)
+                # Add null checks to prevent AttributeError
+                if ("type" in data and 
+                    "definition" in data["type"] and 
+                    "fields" in data["type"]["definition"] and 
+                    data["type"]["definition"]["fields"] is not None):
+                    
+                    for fieldName, field in data["type"]["definition"]["fields"].items():
+                        if isinstance(field, dict) and "args" in field:
+                            for argName, arg in field["args"].items():
+                                # Use the arg's varName as the key to match how main args are stored
+                                operationArgs[arg["varName"]] = arg
+                        # Recursively process nested fields
+                        addAllOperationArgs(field, operationArgs)
+        
+        # Add child operation arguments and field arguments to operationArgs
+        addAllOperationArgs(parsedOperation, parsedOperation["operationArgs"])
         
         parsedOperation["variablesPayload"] = generateExampleVariables(parsedOperation)
         
         # Write files with thread-safe locking
         writeFile("../models/"+operationName+".json", json.dumps(parsedOperation, indent=4, sort_keys=True))
         
-        payload = generateGraphqlPayload(parsedOperation["variablesPayload"], parsedOperation, operationName)
+        payload = shared_generateGraphqlPayload(parsedOperation["variablesPayload"], parsedOperation, operationName, renderArgsAndFields)
         writeFile("../queryPayloads/"+operationName+".json", json.dumps(payload, indent=4, sort_keys=True))
         writeFile("../queryPayloads/"+operationName+".txt", payload["query"])
         
@@ -1059,10 +1122,25 @@ catocli {operationCmd} '{example_json_pretty}'
                 example_file_path = f"examples/{operationPath}.md"
                 try:
                     example_content = openFile(example_file_path)
+                    
+                    # Extract comments from the example file
+                    comments = extract_comments_from_example_file(example_content)
+                    
+                    # Add comments as a summary section if any comments were found
+                    comments_section = ""
+                    if comments:
+                        comments_section = "### Additional Examples\n"
+                        for comment in comments:
+                            # Remove the leading # and clean up the comment
+                            clean_comment = comment.lstrip('# ').strip()
+                            if clean_comment:  # Only add non-empty comments
+                                comments_section += f"- {clean_comment}\n"
+                        comments_section += "\n"
+                    
                     # Add the example content with proper formatting
                     readmeStr += f"""
 ## Advanced Usage
-{example_content}
+{comments_section}{example_content}
 
 """
                 except:
@@ -1314,31 +1392,8 @@ def generateExampleVariables(operation):
         del variablesObj["accountId"]
     return variablesObj
 
-def renderArgsAndFields(responseArgStr, variablesObj, curOperation, definition, indent, dynamic_operation_args=None, operation_name=None):
-    """Wrapper function to use the shared renderArgsAndFields with proper signature"""
-    # Handle variable argument signatures for backward compatibility
-    if operation_name is None:
-        operation_name = curOperation.get('name', 'unknown_operation')
-    
-    return shared_renderArgsAndFields(
-        responseArgStr, 
-        variablesObj, 
-        curOperation, 
-        definition, 
-        operation_name,
-        indent, 
-        dynamic_operation_args,
-        None  # custom_client
-    )
-
-def generateGraphqlPayload(variables_obj, operation, operation_name):
-    """Wrapper function to use the shared generateGraphqlPayload with renderArgsAndFields"""
-    return shared_generateGraphqlPayload(
-        variables_obj,
-        operation,
-        operation_name,
-        renderArgsAndFields  # Pass our local wrapper function
-    )
+# Local renderArgsAndFields wrapper removed - now using shared function directly
+
 
 def parseNestedArgFields(fieldObj):
     """Parse nested argument fields with realistic examples"""
@@ -1551,7 +1606,7 @@ def renderSubParser(subParser, parentParserPath):
     {subParserPath}_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
     {subParserPath}_parser.set_defaults(func=createRequest,operation_name='{operation_path}')
 """
-                            # Add -f flag for CSV-supported operations
+            # Add -f flag for CSV-supported operations
             if supports_csv:
                 cliDriverStr += f"""
     {subParserPath}_parser.add_argument('-f', '--format', choices=['json', 'csv'], default='json', help='Output format (default: json)')
@@ -1612,10 +1667,25 @@ catocli {subOperationCmd} '{example_json_pretty}'
             example_file_path = f"examples/{subOperationPath}.md"
             try:
                 example_content = openFile(example_file_path)
+                
+                # Extract comments from the example file
+                comments = extract_comments_from_example_file(example_content)
+                
+                # Add comments as a summary section if any comments were found
+                comments_section = ""
+                if comments:
+                    comments_section = "### Additional Examples\n"
+                    for comment in comments:
+                        # Remove the leading # and clean up the comment
+                        clean_comment = comment.lstrip('# ').strip()
+                        if clean_comment:  # Only add non-empty comments
+                            comments_section += f"- {clean_comment}\n"
+                    comments_section += "\n"
+                
                 # Add the example content with proper formatting
                 readmeStr += f"""
 ## Advanced Usage
-{example_content}
+{comments_section}{example_content}
 
 """
             except: