Merge pull request #217 from stackql/feature/doc-updates

digitalocean update
stackql · Nov 15, 2024 · e3087ff · e3087ff
2 parents 0d7b391 + 88843b8
commit e3087ff
Show file tree

Hide file tree

Showing 228 changed files with 11,309 additions and 3,469 deletions.
diff --git a/docs/digitalocean-docs/index.md b/docs/digitalocean-docs/index.md
@@ -1,81 +1,80 @@
----
-title: digitalocean
-hide_title: false
-hide_table_of_contents: false
-keywords:
-  - digitalocean
-  - stackql
-  - infrastructure-as-code
-  - configuration-as-data
-  - cloud inventory
-description: Query, deploy and manage Sumologic resources using SQL
-custom_edit_url: null
-image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
-id: digitalocean-doc
-slug: /providers/digitalocean
----
-
-import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
-
-Cloud computing services and Infrastructure as a Service (IaaS).  
-
-:::info Provider Summary (v23.04.00139)
+---
+title: digitalocean
+hide_title: false
+hide_table_of_contents: false
+keywords:
+  - digitalocean
+  - stackql
+  - infrastructure-as-code
+  - configuration-as-data
+  - cloud inventory
+description: Query, deploy and manage Digital Ocean resources using SQL
+custom_edit_url: null
+image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
+id: digitalocean-doc
+slug: /providers/digitalocean
+
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+DigitalOcean for managing cloud servers, databases, networking, and storage in a simplified, developer-friendly environment.
+
+
+:::info Provider Summary
 
 <div class="row">
 <div class="providerDocColumn">
-<span>total services:&nbsp;<b>28</b></span><br />
-<span>total methods:&nbsp;<b>408</b></span><br />
-</div>
-<div class="providerDocColumn">
-<span>total resources:&nbsp;<b>104</b></span><br />
-<span>total selectable resources:&nbsp;<b>93</b></span><br />
+<span>total services:&nbsp;<b>29</b></span><br />
+<span>total resources:&nbsp;<b>179</b></span><br />
 </div>
 </div>
 
 :::
 
-See also:   
-[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe)  [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
-* * * 
-
-## Installation
-
-To pull the latest version of the `digitalocean` provider, run the following command:  
-
-```bash
-REGISTRY PULL digitalocean;
-```
-> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).  
-
-## Authentication
-
-The following system environment variables are used for authentication by default:  
-
-- <CopyableCode code="DIGITALOCEAN_ACCESS_TOKEN" /> - DigitalOcean API token (see <a href="https://docs.digitalocean.com/reference/api/create-personal-access-token/">How to Create a Personal Access Token</a>)
-
-These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
+See also:   
+[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe)  [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
+* * * 
+
+## Installation
+
+To pull the latest version of the `digitalocean` provider, run the following command:  
+
+```bash
+REGISTRY PULL digitalocean;
+```
+> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).  
+
+## Authentication
+
+The following system environment variables are used for authentication by default:  
+
+- <CopyableCode code="DIGITALOCEAN_ACCESS_TOKEN" /> - DigitalOcean API token (see <a href="https://docs.digitalocean.com/reference/api/create-personal-access-token/">How to Create a Personal Access Token</a>)
+
+These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
+
+<details>
+
+<summary>Using different environment variables</summary>
+
+To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program.  For example:  
+
+```bash
+
+AUTH='{ "digitalocean": { "type": "bearer",  "credentialsenvvar": "YOUR_DIGITALOCEAN_TOKEN_VAR" }}'
+stackql shell --auth="${AUTH}"
+
+```
+or using PowerShell:  
+
+```powershell
+
+$Auth = "{ 'digitalocean': { 'type': 'bearer',  'credentialsenvvar': 'YOUR_DIGITALOCEAN_TOKEN_VAR' }}"
+stackql.exe shell --auth=$Auth
+
+```
+</details>
 
-<details>
-
-<summary>Using different environment variables</summary>
-
-To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program.  For example:  
-
-```bash
-
-AUTH='{ "digitalocean": { "type": "bearer",  "credentialsenvvar": "YOUR_DIGITALOCEAN_TOKEN_VAR" }}'
-stackql shell --auth="${AUTH}"
-
-```
-or using PowerShell:  
-
-```powershell
-
-$Auth = "{ 'digitalocean': { 'type': 'bearer',  'credentialsenvvar': 'YOUR_DIGITALOCEAN_TOKEN_VAR' }}"
-stackql.exe shell --auth=$Auth
-
-```
-</details>
 
 ## Services
 <div class="row">
@@ -94,9 +93,9 @@ stackql.exe shell --auth=$Auth
 <a href="/providers/digitalocean/firewalls/">firewalls</a><br />
 <a href="/providers/digitalocean/floating_ips/">floating_ips</a><br />
 <a href="/providers/digitalocean/functions/">functions</a><br />
+<a href="/providers/digitalocean/images/">images</a><br />
 </div>
 <div class="providerDocColumn">
-<a href="/providers/digitalocean/images/">images</a><br />
 <a href="/providers/digitalocean/kubernetes/">kubernetes</a><br />
 <a href="/providers/digitalocean/load_balancers/">load_balancers</a><br />
 <a href="/providers/digitalocean/monitoring/">monitoring</a><br />
@@ -109,6 +108,7 @@ stackql.exe shell --auth=$Auth
 <a href="/providers/digitalocean/ssh_keys/">ssh_keys</a><br />
 <a href="/providers/digitalocean/tags/">tags</a><br />
 <a href="/providers/digitalocean/uptime/">uptime</a><br />
+<a href="/providers/digitalocean/vpc_peerings/">vpc_peerings</a><br />
 <a href="/providers/digitalocean/vpcs/">vpcs</a><br />
 </div>
 </div>
diff --git a/docs/digitalocean-docs/providers/digitalocean/account/account/index.md b/docs/digitalocean-docs/providers/digitalocean/account/account/index.md
diff --git a/docs/digitalocean-docs/providers/digitalocean/account/accounts/index.md b/docs/digitalocean-docs/providers/digitalocean/account/accounts/index.md
@@ -0,0 +1,50 @@
+---
+title: accounts
+hide_title: false
+hide_table_of_contents: false
+keywords:
+  - accounts
+  - account
+  - digitalocean
+  - infrastructure-as-code
+  - configuration-as-data
+  - cloud inventory
+description: Query, deploy and manage digitalocean resources using SQL
+custom_edit_url: null
+image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Creates, updates, deletes, gets or lists a <code>accounts</code> resource.
+
+## Overview
+<table><tbody>
+<tr><td><b>Name</b></td><td><code>accounts</code></td></tr>
+<tr><td><b>Type</b></td><td>Resource</td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="digitalocean.account.accounts" /></td></tr>
+</tbody></table>
+
+## Fields
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| <CopyableCode code="column_anon" /> | `` |  |
+
+## Methods
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| <CopyableCode code="account_get" /> | `SELECT` | <CopyableCode code="" /> | To show information about the current user account, send a GET request to `/v2/account`. |
+
+## `SELECT` examples
+
+To show information about the current user account, send a GET request to `/v2/account`.
+
+
+```sql
+SELECT
+column_anon
+FROM digitalocean.account.accounts
+;
+```
diff --git a/docs/digitalocean-docs/providers/digitalocean/account/index.md b/docs/digitalocean-docs/providers/digitalocean/account/index.md
@@ -9,39 +9,29 @@ keywords:
   - infrastructure-as-code
   - configuration-as-data
   - cloud inventory
-description: Query, deploy and manage Sumologic resources using SQL
+description: Query, deploy and manage digitalocean resources using SQL
 custom_edit_url: null
 image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
 ---
 
-Account  
-    
+account service documentation.
+
 :::info Service Summary
 
 <div class="row">
 <div class="providerDocColumn">
 <span>total resources:&nbsp;<b>1</b></span><br />
-<span>total selectable resources:&nbsp;<b>1</b></span><br />
-<span>total methods:&nbsp;<b>2</b></span><br />
 </div>
 </div>
 
 :::
 
-## Overview
-<table><tbody>
-<tr><td><b>Name</b></td><td><code>digitalocean.account</code></td></tr>
-<tr><td><b>Type</b></td><td>Service</td></tr>
-<tr><td><b>Title</b></td><td>DigitalOcean API - Account</td></tr>
-<tr><td><b>Description</b></td><td>Account</td></tr>
-<tr><td><b>Id</b></td><td><code>account:v23.04.00139</code></td></tr>
-</tbody></table>
-
 ## Resources
 <div class="row">
 <div class="providerDocColumn">
-<a href="/providers/digitalocean/account/account/">account</a><br />
+<a href="/providers/digitalocean/account/accounts/">accounts</a>
 </div>
 <div class="providerDocColumn">
+
 </div>
-</div>
+</div>
diff --git a/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md
@@ -5,20 +5,20 @@ hide_table_of_contents: false
 keywords:
   - actions
   - actions
-  - digitalocean    
-  - stackql
+  - digitalocean
   - infrastructure-as-code
   - configuration-as-data
   - cloud inventory
-description: Query, deploy and manage Sumologic resources using SQL
+description: Query, deploy and manage digitalocean resources using SQL
 custom_edit_url: null
 image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
 ---
 
 import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
-
-
+Creates, updates, deletes, gets or lists a <code>actions</code> resource.
 
 ## Overview
 <table><tbody>
@@ -30,19 +30,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| <CopyableCode code="id" /> | `integer` | A unique numeric ID that can be used to identify and reference an action. |
-| <CopyableCode code="completed_at" /> | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. |
-| <CopyableCode code="region" /> | `object` |  |
-| <CopyableCode code="region_slug" /> | `string` | A human-readable string that is used as a unique identifier for each region. |
-| <CopyableCode code="resource_id" /> | `integer` | A unique identifier for the resource that the action is associated with. |
-| <CopyableCode code="resource_type" /> | `string` | The type of resource that the action is associated with. |
-| <CopyableCode code="started_at" /> | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. |
-| <CopyableCode code="status" /> | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". |
-| <CopyableCode code="type" /> | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. |
+| <CopyableCode code="column_anon" /> | `` |  |
+
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="action_id" /> | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. |
-| <CopyableCode code="list" /> | `SELECT` |  | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. |
-| <CopyableCode code="_get" /> | `EXEC` | <CopyableCode code="action_id" /> | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. |
-| <CopyableCode code="_list" /> | `EXEC` |  | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. |
+| <CopyableCode code="actions_get" /> | `SELECT` | <CopyableCode code="action_id" /> | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. |
+| <CopyableCode code="actions_list" /> | `SELECT` | <CopyableCode code="" /> | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. |
+
+## `SELECT` examples
+
+This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.
+
+
+```sql
+SELECT
+column_anon
+FROM digitalocean.actions.actions
+;
+```