Improve output formatting; add result fields

Author: lgarber-akamai

docs/static/overlay.css

@@ -22,52 +22,65 @@ td {
     width: 150px !important;
 }
 
-
 /*
 Custom formatting for actions
 */
-
 .action-subheading {
     margin-bottom: 4px !important;
+    font-weight: 700 !important;
 }
 
 .action-subheading-description {
     font-size: 90% !important;
     margin-bottom: 12px !important;
 }
 
-.action-argument-section-header {
+.action-section-header {
     color: #606060 !important;
     font-weight: 700 !important;
     padding-top: 10px !important;
     margin-bottom: 12px !important;
     font-size: 95% !important;
 }
 
-.action-argument-required {
-    color: #CD5C5C !important;
-    font-weight: bolder !important;
+.action-table-field-name,
+.action-table-field-optional,
+.action-table-field-required,
+.action-table-field-type {
+    font-size: 85% !important;
+    font-family: SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace !important;
+}
+
+.action-table-field-required {
+    color: #E74C3C !important;
 }
 
 /*
 Formatting for generated tables
 */
 
-/* Prevent word wrapping on `Name` fields */
+/* Prevent word wrapping on `Name` and `Example` fields */
 .action-argument-section-table > tbody tr > td:nth-child(1) *,
 .action-parameter-table > tbody tr > td:nth-child(1) *,
-.action-filterable-field-table > tbody tr > td:nth-child(1) * {
+.action-filterable-field-table > tbody tr > td:nth-child(1) *,
+.action-attribute-section-table > tbody tr > td:nth-child(1) *,
+.action-attribute-section-table > tbody tr > td:nth-child(3) * {
     word-wrap: unset !important;
     white-space: nowrap !important;
 }
 
-/* Center-align `Required` and `Type` columns */
+/* Center-align `Required`, and `Type` columns */
 .action-argument-section-table > tbody tr > td:nth-child(2),
 .action-argument-section-table > thead tr > th:nth-child(2),
 .action-argument-section-table > tbody tr > td:nth-child(3),
 .action-argument-section-table > thead tr > th:nth-child(3),
+
+.action-attribute-section-table > tbody tr > td:nth-child(2),
+.action-attribute-section-table > thead tr > th:nth-child(2),
+
 .action-parameter-table > tbody tr > td:nth-child(2),
 .action-parameter-table > thead tr > th:nth-child(2),
+
 .action-filterable-field-table > tbody tr > td:nth-child(2),
 .action-filterable-field-table > thead tr > th:nth-child(2) {
     text-align: center !important;

linodecli/baked/request.py

@@ -105,6 +105,9 @@ def __init__(
         #: Whether null is an acceptable value for this attribute
         self.nullable = schema.nullable
 
+        #: An example value for this attribute
+        self.example = schema.example
+
         # handle the type for list values if this is an array
         if self.datatype == "array" and schema.items:
             self.item_type = schema.items.type

linodecli/baked/response.py

@@ -2,6 +2,8 @@
 Converting the processed OpenAPI Responses into something the CLI can work with
 """
 
+from typing import Any, Dict
+
 from openapi3.paths import MediaType
 
 from linodecli.baked.parsing import process_arg_description
@@ -80,11 +82,17 @@ def __init__(self, name, schema, prefix=None, nested_list_depth=0):
         #: How we should associate values of this attribute to output colors
         self.color_map = schema.extensions.get("linode-cli-color")
 
+        #: An example value for this attribute.
+        self.example = schema.example
+
         #: The type for items in this attribute, if this attribute is a list
         self.item_type = None
         if schema.type == "array":
             self.item_type = schema.items.type
 
+            if schema.items.example:
+                self.example = schema.items.example
+
     @property
     def path(self):
         """
@@ -288,3 +296,62 @@ def _fix_nested_list(self, json):
                     cobj[path_parts[0]] = item
                     result.append(cobj)
         return result
+
+    def construct_sample(self) -> Dict[str, Any]:
+        """
+        Reconstructs a sample API response from this response object.
+
+        :returns: The reconstructed API response sample.
+        """
+        result = {}
+
+        # TODO: Make this whole function less bad
+        normal_attrs = iter(
+            attr for attr in self.attrs if attr.datatype != "array"
+        )
+        array_attrs = sorted(
+            iter(attr for attr in self.attrs if attr.datatype == "array"),
+            key=lambda attr: attr.path,
+        )
+
+        # First, create any necessary structures for list and object values
+        for attr in array_attrs:
+            segments = attr.path.split(".")
+
+            current = result
+            for segment in segments[:-1]:
+                if segment not in current:
+                    current[segment] = {}
+
+                current = current[segment]
+
+            current[segments[-1]] = []
+            if attr.example:
+                current[segments[-1]] = (
+                    attr.example
+                    if isinstance(attr.example, list)
+                    else [attr.example]
+                )
+
+        # Second, populate the rest of the attributes
+        for attr in normal_attrs:
+            if attr.example is None:
+                continue
+
+            segments = attr.path.split(".")
+
+            current = result
+            for segment in segments[:-1]:
+                if segment not in current:
+                    current[segment] = {}
+
+                current = current[segment]
+
+                if isinstance(current, list):
+                    if len(current) < 1:
+                        current.append({})
+                    current = current[0]
+
+            current[segments[-1]] = attr.example
+
+        return result