docs: 📝 Adds the new Relationships array to the /tables route

Author: kiwicopple

docs/index.html

@@ -191,6 +191,30 @@
 
               </ul>
 
+          </li>
+        
+          <li>
+            <a href="#api-type-definitions" class="toc-h1 toc-link" data-title="API Type Definitions">API Type Definitions</a>
+            
+              <ul class="toc-list-h2">
+                
+                  <li>
+                    <a href="#schemas-schema" class="toc-h2 toc-link" data-title="">Schemas.Schema</a>
+                    
+                  </li>
+                
+                  <li>
+                    <a href="#tables-table" class="toc-h2 toc-link" data-title="">Tables.Table</a>
+                    
+                  </li>
+                
+                  <li>
+                    <a href="#tables-relationship" class="toc-h2 toc-link" data-title="">Tables.Relationship</a>
+                    
+                  </li>
+                
+              </ul>
+            
           </li>
 
 		</ul>
@@ -313,26 +337,15 @@ <h2 id="getschemas">getSchemas</h2>
 </code></pre>
 <p><code>GET /schemas</code></p>
 <p><em>Get all schemas</em></p>
+<h3 id="returns">Returns</h3>
+<p><code>{Array}</code> <a href="#schemas-schema">Schemas.Schema</a></p>
 <blockquote>
 <p>Parameters:</p>
 </blockquote>
 <pre class="highlight tab tab-javascript"><code><span class="hljs-comment">/**
  * <span class="hljs-doctag">@param <span class="hljs-type">{boolean}</span> </span>[includeSystemSchemas=false] - Return system schemas as well as user schemas
  */</span>
 </code></pre>
-<blockquote>
-<p>Returns: Schemas.Schema[]</p>
-</blockquote>
-<pre class="highlight tab tab-javascript"><code>{
- <span class="hljs-attr">catalog_name</span>: string
- <span class="hljs-attr">name</span>: string
- <span class="hljs-attr">owner</span>: string
- <span class="hljs-attr">default_character_set_catalog</span>: string
- <span class="hljs-attr">default_character_set_schema</span>: string
- <span class="hljs-attr">default_character_set_name</span>: string
- <span class="hljs-attr">sql_path</span>: string
-}
-</code></pre>
 <h1 id="pg-api-tables">Tables</h1>
 <p>View and manage your Postgres tables.</p>
 <h2 id="gettables">getTables</h2>
@@ -353,6 +366,15 @@ <h2 id="gettables">getTables</h2>
 </code></pre>
 <p><code>GET /tables</code></p>
 <p><em>Get all tables</em></p>
+<h3 id="returns-2">Returns</h3>
+<p><code>{Array}</code> <a href="#tables-table">Tables.Table</a></p>
+<blockquote>
+<p>Parameters:</p>
+</blockquote>
+<pre class="highlight tab tab-javascript"><code><span class="hljs-comment">/**
+ * <span class="hljs-doctag">@param <span class="hljs-type">{boolean}</span> </span>[includeSystemSchemas=false] - Return system schemas as well as user schemas
+ */</span>
+</code></pre>
 <h1 id="pg-api-schemas">Types</h1>
 <p>View and manage your Postgres types.</p>
 <h2 id="gettypes">getTypes</h2>
@@ -450,6 +472,44 @@ <h2 id="getversion">getVersion</h2>
 </code></pre>
 <p><code>GET /config/version</code></p>
 <p>Get your Postgres version information.</p>
+<h1 id="api-type-definitions">API Type Definitions</h1>
+<h2 id="schemas-schema">Schemas.Schema</h2>
+<pre class="highlight tab tab-typescript"><code>{
+  catalog_name: <span class="hljs-built_in">string</span>
+  name: <span class="hljs-built_in">string</span>
+  owner: <span class="hljs-built_in">string</span>
+  default_character_set_catalog: <span class="hljs-built_in">string</span>
+  default_character_set_schema: <span class="hljs-built_in">string</span>
+  default_character_set_name: <span class="hljs-built_in">string</span>
+  sql_path: <span class="hljs-built_in">string</span>
+}
+</code></pre>
+<h2 id="tables-table">Tables.Table</h2>
+<pre class="highlight tab tab-typescript"><code>{
+  table_id: <span class="hljs-built_in">string</span>
+  catalog: <span class="hljs-built_in">string</span>
+  schema: <span class="hljs-built_in">string</span>
+  name: <span class="hljs-built_in">string</span>
+  is_insertable_into: <span class="hljs-built_in">boolean</span>
+  is_typed: <span class="hljs-built_in">boolean</span>
+  bytes: <span class="hljs-built_in">number</span>
+  size: <span class="hljs-built_in">string</span>
+  relationships: Tables.Relationship[]
+}
+</code></pre>
+<h2 id="tables-relationship">Tables.Relationship</h2>
+<pre class="highlight tab tab-typescript"><code>{
+  source_table_id: <span class="hljs-built_in">string</span>
+  source_schema: <span class="hljs-built_in">string</span>
+  source_table_name: <span class="hljs-built_in">string</span>
+  source_column_name: <span class="hljs-built_in">string</span>
+  target_table_id: <span class="hljs-built_in">string</span>
+  target_table_schema: <span class="hljs-built_in">string</span>
+  target_table_name: <span class="hljs-built_in">string</span>
+  target_column_name: <span class="hljs-built_in">string</span>
+  constraint_name: <span class="hljs-built_in">string</span>
+}
+</code></pre>
 <!-- Renderer: Shins v2.5.0 -->
 <!-- Generator: Widdershins v4.0.1 -->
       </div>

docs/source/index.html.md

@@ -149,26 +149,17 @@ const data = await fetch('http://localhost:1337/schemas', {
 
 *Get all schemas*
 
+### Returns 
+
+`{Array}` [Schemas.Schema](#schemas-schema)
+
 > Parameters:
 ```javascript
 /**
  * @param {boolean} [includeSystemSchemas=false] - Return system schemas as well as user schemas
  */
  ```
- > Returns: Schemas.Schema[]
- ```javascript
-{
-  catalog_name: string
-  name: string
-  owner: string
-  default_character_set_catalog: string
-  default_character_set_schema: string
-  default_character_set_name: string
-  sql_path: string
-}
-```
-
-
+ 
 
 
 
@@ -202,7 +193,16 @@ const data = await fetch('http://localhost:1337/tables', {
 
 *Get all tables*
 
+### Returns 
+
+`{Array}` [Tables.Table](#tables-table)
 
+> Parameters:
+```javascript
+/**
+ * @param {boolean} [includeSystemSchemas=false] - Return system schemas as well as user schemas
+ */
+ ```
 
 
 
@@ -350,3 +350,53 @@ Get your Postgres version information.
 
 
 
+
+# API Type Definitions
+
+
+## Schemas.Schema
+
+```typescript
+{
+  catalog_name: string
+  name: string
+  owner: string
+  default_character_set_catalog: string
+  default_character_set_schema: string
+  default_character_set_name: string
+  sql_path: string
+}
+```
+
+## Tables.Table
+
+```typescript
+{
+  table_id: string
+  catalog: string
+  schema: string
+  name: string
+  is_insertable_into: boolean
+  is_typed: boolean
+  bytes: number
+  size: string
+  relationships: Tables.Relationship[]
+}
+```
+
+## Tables.Relationship
+
+```typescript
+{
+  source_table_id: string
+  source_schema: string
+  source_table_name: string
+  source_column_name: string
+  target_table_id: string
+  target_table_schema: string
+  target_table_name: string
+  target_column_name: string
+  constraint_name: string
+}
+```
+

src/lib/interfaces/tables.ts

@@ -9,7 +9,7 @@ export namespace Tables {
     is_typed: boolean
     bytes: number
     size: string
-    relationships: Relationship[]
+    relationships: Tables.Relationship[]
   }
 
   export interface Relationship {