minor refactor generators

Extracting organize_spec() method to ensure consistency between snippets and library generation.

Author: TKIPisalegacycipher

generator/common.py

@@ -0,0 +1,36 @@
+def organize_spec(paths, scopes):
+    operations = list()  # list of operation IDs
+    for path, methods in paths.items():
+        # method is the HTTP action, e.g., get, put, etc.
+        for method in methods:
+            # endpoint is the method for that specific path
+            endpoint = paths[path][method]
+
+            # the endpoint has tags
+            tags = endpoint["tags"]
+
+            # the endpoint has an operationId
+            operation = endpoint["operationId"]
+
+            # add the operation ID to the list
+            operations.append(operation)
+
+            # The endpoint has a scope defined by the first tag
+            # There are a handful of operations that are currently mistagged
+            # This helps ensure they are scoped to the correct module
+            if len(tags) > 2:
+                match tags[2]:
+                    case 'spaces':
+                        scope = 'spaces'
+                    case _:
+                        scope = tags[0]
+            else:
+                scope = tags[0]
+
+            # Needs documentation
+            if path not in scopes[scope]:
+                scopes[scope][path] = {method: endpoint}
+            # Needs documentation
+            else:
+                scopes[scope][path][method] = endpoint
+    return operations, scopes

generator/generate_library.py

@@ -6,6 +6,8 @@
 import jinja2
 import requests
 
+import common as common
+
 READ_ME = """
 === PREREQUISITES ===
 Include the jinja2 files in same directory as this script, and install Python requests
@@ -308,40 +310,7 @@ def generate_library(spec: dict, version_number: str, api_version_number: str, i
             fp.write(contents)
 
     # Organize data from OpenAPI specification
-    operations = list()  # list of operation IDs
-    for path, methods in paths.items():
-        # method is the HTTP action, e.g. get, put, etc.
-        for method in methods:
-            # endpoint is the method for that specific path
-            endpoint = paths[path][method]
-
-            # the endpoint has tags
-            tags = endpoint["tags"]
-
-            # the endpoint has an operationId
-            operation = endpoint["operationId"]
-
-            # add the operation ID to the list
-            operations.append(operation)
-
-            # the endpoint has a scope defined by the first tag
-            # There are a handful of operations that are currently mistagged
-            # This helps ensure they are scoped to the correct module
-            if len(tags) > 2:
-                match tags[2]:
-                    case 'spaces':
-                        scope = 'spaces'
-                    case _:
-                        scope = tags[0]
-            else:
-                scope = tags[0]
-
-            # Needs documentation
-            if path not in scopes[scope]:
-                scopes[scope][path] = {method: endpoint}
-            # Needs documentation
-            else:
-                scopes[scope][path][method] = endpoint
+    operations, scopes = common.organize_spec(paths, scopes)
 
     # Inform the user how many operations were found
     print(f"Total of {len(operations)} endpoints found from OpenAPI spec...")

generator/generate_snippets.py

@@ -3,6 +3,7 @@
 
 import requests
 from jinja2 import Template
+import common as common
 
 CALL_TEMPLATE = Template(
     """import meraki
@@ -12,7 +13,7 @@
 # In your own code, use an environment variable as shown under the Usage section
 # @ https://github.com/meraki/dashboard-api-python/
 
-API_KEY = '75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6'
+API_KEY = 'your-key-here'
 
 dashboard = meraki.DashboardAPI(API_KEY)
 {{ parameter_assignments }}
@@ -194,6 +195,8 @@ def main():
         "licensing",
         "secureConnect",
         "wirelessController",
+        "campusGateway",
+        "spaces"
     ]
     # legacy scopes = ['organizations', 'networks', 'devices',
     #           'appliance', 'camera', 'cellularGateway', 'insight', 'sm', 'switch', 'wireless']
@@ -202,19 +205,8 @@ def main():
     # Scopes used when generating the library will depend on the provided version of the API spec.
     scopes = {tag["name"]: {} for tag in tags if tag["name"] in supported_scopes}
 
-    # Organize data
-    operations = []
-    for path, methods in paths.items():
-        for method in methods:
-            endpoint = paths[path][method]
-            tags = endpoint["tags"]
-            operation = endpoint["operationId"]
-            operations.append(operation)
-            scope = tags[0]
-            if path not in scopes[scope]:
-                scopes[scope][path] = {method: endpoint}
-            else:
-                scopes[scope][path][method] = endpoint
+    # Organize data from OpenAPI specification
+    operations, scopes = common.organize_spec(paths, scopes)
 
     # Generate API libraries
     for scope in scopes:
@@ -299,9 +291,9 @@ def main():
                             parameters_text += f"{param_name}, "
                         for k, v in optional.items():
                             if k == "total_pages" and v == "all":
-                                parameters_text += f"total_pages='all'"
+                                parameters_text += "total_pages='all'"
                             elif k == "total_pages" and v == 1:
-                                parameters_text += f"total_pages=1"
+                                parameters_text += "total_pages=1"
                             elif type(v) == str:
                                 parameters_text += f"\n    {k}='{v}', "
                             else: