Add help page

Author: lgarber-akamai

linodecli/baked/request.py

@@ -132,7 +132,7 @@ def _parse_request_model(
     prefix: Optional[str] = None,
     parent: Optional[str] = None,
     depth: int = 0,
-    option_path: Optional[List[str]] = None,
+    option_path: List[str] = None,
 ) -> List[OpenAPIRequestArg]:
     """
     Parses an OpenAPI schema into a list of OpenAPIRequest objects
@@ -148,10 +148,31 @@ def _parse_request_model(
     :returns: The flattened request model, as a list
     :rtype: list[OpenAPIRequestArg]
     """
+
+    if option_path is None:
+        option_path = []
+
     args = []
 
+    if isinstance(schema, dict):
+        schema = Schema(schema["path"], schema, schema._root)
+
+    for i, entry in enumerate(schema.oneOf or []):
+        if isinstance(entry, dict):
+            entry = Schema(schema.path + ["oneOf", i + 1], entry, schema._root)
+
+        args += _parse_request_model(
+            entry,
+            prefix=prefix,
+            parent=parent,
+            depth=depth,
+            option_path=option_path + [entry.title],
+        )
+
+    if schema.oneOf is not None:
+        return args
+
     properties, required = _aggregate_schema_properties(schema)
-    print(properties, required)
 
     if properties is None:
         return args
@@ -173,6 +194,7 @@ def _parse_request_model(
                 # NOTE: We do not increment the depth because dicts do not have
                 # parent arguments.
                 depth=depth,
+                option_path=option_path,
             )
 
         # Handle arrays of objects that not marked as JSON
@@ -205,6 +227,7 @@ def _parse_request_model(
                 prefix=pref,
                 parent=pref,
                 depth=depth + 1,
+                option_path=option_path,
             )
         else:
             args.append(

linodecli/help_pages.py

@@ -6,7 +6,7 @@
 import sys
 import textwrap
 from collections import defaultdict
-from typing import Dict, List, Optional
+from typing import Dict, List, Optional, Tuple
 
 from rich import box
 from rich import print as rprint
@@ -264,32 +264,42 @@ def _help_action_print_body_args(
     console.print(f"[bold]Arguments{f' ({title})' if title else ''}:[/]")
 
     for group in _help_group_arguments(args):
-        for arg in group:
-            metadata = []
+        for option in _help_group_options(group):
+            if option[0] is not None:
+                # If this is an option with an explicit title,
+                # display it here
+                console.print(
+                    Padding.indent(f"[bold underline]{option[0]}[/]:", 4),
+                )
 
-            if op.method in {"post", "put"} and arg.required:
-                metadata.append("required")
+            for arg in option[1]:
+                metadata = []
 
-            if arg.format == "json":
-                metadata.append("JSON")
+                if op.method in {"post", "put"} and arg.required:
+                    metadata.append("required")
 
-            if arg.nullable:
-                metadata.append("nullable")
+                if arg.format == "json":
+                    metadata.append("JSON")
 
-            if arg.is_parent:
-                metadata.append("conflicts with children")
+                if arg.nullable:
+                    metadata.append("nullable")
 
-            prefix = f" ({', '.join(metadata)})" if len(metadata) > 0 else ""
+                if arg.is_parent:
+                    metadata.append("conflicts with children")
 
-            arg_text = Text.from_markup(
-                f"[bold green]--{arg.path}[/][bold]{prefix}:[/] {arg.description_rich}"
-            )
+                prefix = (
+                    f" ({', '.join(metadata)})" if len(metadata) > 0 else ""
+                )
 
-            console.print(
-                Padding.indent(arg_text, (arg.depth * 2) + 2),
-            )
+                arg_text = Text.from_markup(
+                    f"[bold green]--{arg.path}[/][bold]{prefix}:[/] {arg.description_rich}"
+                )
 
-        console.print()
+                console.print(
+                    Padding.indent(arg_text, (arg.depth * 2) + 2),
+                )
+
+            console.print()
 
 
 def _help_group_arguments(
@@ -346,3 +356,15 @@ def _help_group_arguments(
     result += groups
 
     return result
+
+
+def _help_group_options(
+    args: List[OpenAPIRequestArg],
+) -> List[Tuple[Optional[str], List[OpenAPIRequestArg]]]:
+    groups = defaultdict(list)
+
+    for arg in args:
+        group_key = " - ".join(arg.option_path) if arg.option_path else None
+        groups[group_key].append(arg)
+
+    return sorted(groups.items(), key=lambda v: v[0] or "")