Requested changes

seamapi · Aug 1, 2024 · 2fdefda · 2fdefda
1 parent de20b68
commit 2fdefda
Show file tree

Hide file tree

Showing 3 changed files with 131 additions and 83 deletions.
diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md
@@ -14,10 +14,7 @@ To filter the list of returned access control systems by a specific connected ac
 `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the 
 response includes all access control systems connected to your workspace.
 
-## Request 
-Not enough data 
-
-### Request Body Parameters
+### Request and Response
 
 <table>
   <thead>
@@ -36,62 +33,88 @@ Not enough data
   </tbody>
 </table>
 
-### Sample Request
-
-{% tabs %}
-    {% tab title="JavaScript" %}
-    ```javascript
-    await seam.acs.systems.list({&quot;connected_account_id&quot;:&quot;8d7e0b3a-b889-49a7-9164-4b71a0506a33&quot;})
-    ```
-    {% endtab %}
-    {% tab title="Python" %}
-    ```python
-    seam.acs.systems.list(connected_account_id&#x3D;&quot;8d7e0b3a-b889-49a7-9164-4b71a0506a33&quot;)
-    ```
-    {% endtab %}
-    {% tab title="PHP" %}
-    ```php
-    $seam-&gt;acs-&gt;systems-&gt;list(connected_account_id:&quot;8d7e0b3a-b889-49a7-9164-4b71a0506a33&quot;)
-    ```
-    {% endtab %}
-{% endtabs %} 
-
-## Response
-
-OK
-
-### Response Properties
 
 <table>
   <thead>
     <tr>
-      <th width='310'>Property</th>
+      <th width="310">Property</th>
       <th>Description</th>
     </tr>
   </thead>
   <tbody>
       <tr>
-        <td colspan='2'>No properties available.</td>
+        <td><code>acs_system_id</code></td>
+        <td>ID of the access control system</td>
+      </tr>
+      <tr>
+        <td><code>name</code></td>
+        <td>Name of the access control system</td>
+      </tr>
+      <tr>
+        <td><code>workspace_id</code></td>
+        <td>ID of the workspace that contains the access control system</td>
+      </tr>
+      <tr>
+        <td><code>created_at</code></td>
+        <td>Date and time at which the access control system was created</td>
+      </tr>
+      <tr>
+        <td><code>external_type</code></td>
+        <td>Brand-specific terminology for the access control system type</td>
+      </tr>
+      <tr>
+        <td><code>external_type_display_name</code></td>
+        <td>Display name that corresponds to the brand-specific terminology for the access control system type</td>
+      </tr>
+      <tr>
+        <td><code>connected_account_ids</code></td>
+        <td>Array of connected account IDs associated with the access control system</td>
+      </tr>
+      <tr>
+        <td><code>image_url</code></td>
+        <td>URL for the image that represents the access control system</td>
+      </tr>
+      <tr>
+        <td><code>image_alt_text</code></td>
+        <td>Alternative text for the access control system image</td>
       </tr>
   </tbody>
 </table>
 
-### Sample Response
+## Samples
 
 {% tabs %}
-    {% tab title="JavaScript" %} 
-    ```javascript
-    void
-    ```
+    {% tab title="JavaScript" %}
+  ### Request
+  ```javascript
+  await seam.acs.systems.list({&quot;connected_account_id&quot;:&quot;8d7e0b3a-b889-49a7-9164-4b71a0506a33&quot;})
+  ```
+
+  ### Response
+  ```javascript
+  void
+  ```
     {% endtab %}
-    {% tab title="Python" %} 
-    ```python
-    None
-    ```
+    {% tab title="Python" %}
+  ### Request
+  ```python
+  seam.acs.systems.list(connected_account_id&#x3D;&quot;8d7e0b3a-b889-49a7-9164-4b71a0506a33&quot;)
+  ```
+
+  ### Response
+  ```python
+  None
+  ```
     {% endtab %}
-    {% tab title="PHP" %} 
-    ```php
-    void
-    ```
+    {% tab title="PHP" %}
+  ### Request
+  ```php
+  $seam-&gt;acs-&gt;systems-&gt;list(connected_account_id:&quot;8d7e0b3a-b889-49a7-9164-4b71a0506a33&quot;)
+  ```
+
+  ### Response
+  ```php
+  void
+  ```
     {% endtab %}
 {% endtabs %}
diff --git a/src/layouts/api-reference.hbs b/src/layouts/api-reference.hbs
@@ -6,10 +6,7 @@ description: "{{{description}}}"
 
 {{{description}}}
 
-## Request 
-Not enough data 
-
-### Request Body Parameters
+### Request and Response
 
 <table>
   <thead>
@@ -36,36 +33,11 @@ Not enough data
   </tbody>
 </table>
 
-### Sample Request
-
-{% tabs %}
-{{#each codeSamples}}
-  {{#each this.code}}
-    {% tab title="{{this.title}}" %}
-    ```{{@key}}
-    {{this.request}}
-    ```
-    {% endtab %}
-  {{/each}}
-{{else}}
-  {% tab title="No samples available" %} 
-    ```
-    No sample requests available.
-    ```
-  {% endtab %}
-{{/each}}
-{% endtabs %} 
-
-## Response
-
-{{{response.description}}}
-
-### Response Properties
 
 <table>
   <thead>
     <tr>
-      <th width='310'>Property</th>
+      <th width="310">Property</th>
       <th>Description</th>
     </tr>
   </thead>
@@ -77,27 +49,33 @@ Not enough data
       </tr>
     {{else}}
       <tr>
-        <td colspan='2'>No properties available.</td>
+        <td colspan="2">No properties available.</td>
       </tr>
     {{/each}}
   </tbody>
 </table>
 
-### Sample Response
+## Samples
 
 {% tabs %}
 {{#each codeSamples}}
   {{#each this.code}}
-    {% tab title="{{this.title}}" %} 
-    ```{{@key}}
-    {{this.response}}
-    ```
+    {% tab title="{{this.title}}" %}
+  ### Request
+  ```{{@key}}
+  {{this.request}}
+  ```
+
+  ### Response
+  ```{{@key}}
+  {{this.response}}
+  ```
     {% endtab %}
   {{/each}}
 {{else}}
   {% tab title="No samples available" %} 
-  ``` 
-  No sample responses available. 
+  ```
+  No sample requests available.
   ```
   {% endtab %}
 {{/each}}

diff --git a/src/lib/context.ts b/src/lib/context.ts
@@ -17,6 +17,10 @@ interface TemplateContext {
   }
   response?: {
     description?: string
+    properties?: Array<{
+      name: string
+      description: string
+    }>
   }
   codeSamples?: Array<{
     title: string
@@ -48,7 +52,50 @@ export function setFileContext(file: Partial<TemplateContext>): void {
     }
 
     file.response = {
-      description: file.endpoint.response?.description ?? '',
+      description:
+        file.endpoint.response?.description ??
+        'Returns an `acs_systems` array, in which each returned `acs_system` contains the following properties:',
+      properties: [
+        {
+          name: 'acs_system_id',
+          description: 'ID of the access control system',
+        },
+        { name: 'name', description: 'Name of the access control system' },
+        {
+          name: 'workspace_id',
+          description:
+            'ID of the workspace that contains the access control system',
+        },
+        {
+          name: 'created_at',
+          description:
+            'Date and time at which the access control system was created',
+        },
+        {
+          name: 'external_type',
+          description:
+            'Brand-specific terminology for the access control system type',
+        },
+        {
+          name: 'external_type_display_name',
+          description:
+            'Display name that corresponds to the brand-specific terminology for the access control system type',
+        },
+        {
+          name: 'connected_account_ids',
+          description:
+            'Array of connected account IDs associated with the access control system',
+        },
+        {
+          name: 'image_url',
+          description:
+            'URL for the image that represents the access control system',
+        },
+        {
+          name: 'image_alt_text',
+          description: 'Alternative text for the access control system image',
+        },
+      ],
     }
 
     file.codeSamples =