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

Feature/doc updates

docs/digitalocean-docs/index.md

@@ -13,8 +13,10 @@ 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)
@@ -49,7 +51,7 @@ REGISTRY PULL digitalocean;
 
 The following system environment variables are used for authentication by default:  
 
-- `DIGITALOCEAN_ACCESS_TOKEN` - DigitalOcean API token (see [How to Create a Personal Access Token](https://docs.digitalocean.com/reference/api/create-personal-access-token/))
+- <CopyableCode code="DIGITALOCEAN_ACCESS_TOKEN" /> - DigitalOcean API token (see [How to Create a Personal Access Token](https://docs.digitalocean.com/reference/api/create-personal-access-token/))
 
 These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
 
@@ -109,4 +111,4 @@ stackql.exe shell --auth=$Auth
 <a href="/providers/digitalocean/uptime/">uptime</a><br />
 <a href="/providers/digitalocean/vpcs/">vpcs</a><br />
 </div>
-</div>
+</div>

docs/digitalocean-docs/providers/digitalocean/account/account/index.md

@@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic 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';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>account</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>digitalocean.account.account</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="digitalocean.account.account" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `email` | `string` | The email address used by the current user to register for DigitalOcean. |
-| `email_verified` | `boolean` | If true, the user has verified their account via email. False otherwise. |
-| `floating_ip_limit` | `integer` | The total number of Floating IPs the current user or team may have. |
-| `status` | `string` | This value is one of "active", "warning" or "locked". |
-| `status_message` | `string` | A human-readable message giving more details about the status of the account. |
-| `team` | `object` | When authorized in a team context, includes information about the current team. |
-| `uuid` | `string` | The unique universal identifier for the current user. |
-| `droplet_limit` | `integer` | The total number of Droplets current user or team may have active at one time. |
+| <CopyableCode code="droplet_limit" /> | `integer` | The total number of Droplets current user or team may have active at one time. |
+| <CopyableCode code="email" /> | `string` | The email address used by the current user to register for DigitalOcean. |
+| <CopyableCode code="email_verified" /> | `boolean` | If true, the user has verified their account via email. False otherwise. |
+| <CopyableCode code="floating_ip_limit" /> | `integer` | The total number of Floating IPs the current user or team may have. |
+| <CopyableCode code="status" /> | `string` | This value is one of "active", "warning" or "locked". |
+| <CopyableCode code="status_message" /> | `string` | A human-readable message giving more details about the status of the account. |
+| <CopyableCode code="team" /> | `object` | When authorized in a team context, includes information about the current team. |
+| <CopyableCode code="uuid" /> | `string` | The unique universal identifier for the current user. |
 ## Methods
 | Name | Accessible by | Required Params |
 |:-----|:--------------|:----------------|
-| `get` | `SELECT` |  |
-| `_get` | `EXEC` |  |
+| <CopyableCode code="get" /> | `SELECT` |  |
+| <CopyableCode code="_get" /> | `EXEC` |  |

docs/digitalocean-docs/providers/digitalocean/account/index.md

@@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL
 custom_edit_url: null
 image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
 ---
+
 Account  
 
 :::info Service Summary

docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md

@@ -14,32 +14,35 @@ description: Query, deploy and manage Sumologic 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';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>actions</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>digitalocean.actions.actions</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="digitalocean.actions.actions" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `id` | `integer` | A unique numeric ID that can be used to identify and reference an action. |
-| `resource_id` | `integer` | A unique identifier for the resource that the action is associated with. |
-| `completed_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. |
-| `status` | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". |
-| `started_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. |
-| `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. |
-| `region` | `object` |  |
-| `region_slug` | `string` | A human-readable string that is used as a unique identifier for each region. |
-| `resource_type` | `string` | The type of resource that the action is associated with. |
+| <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. |
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| `get` | `SELECT` | `action_id` | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. |
-| `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. |
-| `_get` | `EXEC` | `action_id` | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. |
-| `_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="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. |

docs/digitalocean-docs/providers/digitalocean/actions/index.md

@@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL
 custom_edit_url: null
 image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png
 ---
+
 Actions  
 
 :::info Service Summary

docs/digitalocean-docs/providers/digitalocean/apps/alerts/index.md

@@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic 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';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>alerts</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>digitalocean.apps.alerts</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="digitalocean.apps.alerts" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype |
 |:-----|:---------|
-| `id` | `string` |
-| `slack_webhooks` | `array` |
-| `spec` | `object` |
-| `component_name` | `string` |
-| `emails` | `array` |
-| `phase` | `string` |
-| `progress` | `object` |
+| <CopyableCode code="id" /> | `string` |
+| <CopyableCode code="component_name" /> | `string` |
+| <CopyableCode code="emails" /> | `array` |
+| <CopyableCode code="phase" /> | `string` |
+| <CopyableCode code="progress" /> | `object` |
+| <CopyableCode code="slack_webhooks" /> | `array` |
+| <CopyableCode code="spec" /> | `object` |
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| `list_alerts` | `SELECT` | `app_id` | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. |
-| `_list_alerts` | `EXEC` | `app_id` | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. |
-| `assign_alertDestinations` | `EXEC` | `alert_id, app_id` | Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app. |
+| <CopyableCode code="list_alerts" /> | `SELECT` | <CopyableCode code="app_id" /> | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. |
+| <CopyableCode code="_list_alerts" /> | `EXEC` | <CopyableCode code="app_id" /> | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. |
+| <CopyableCode code="assign_alertDestinations" /> | `EXEC` | <CopyableCode code="alert_id, app_id" /> | Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app. |

docs/digitalocean-docs/providers/digitalocean/apps/apps/index.md

@@ -14,45 +14,48 @@ description: Query, deploy and manage Sumologic 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';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>apps</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>digitalocean.apps.apps</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="digitalocean.apps.apps" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `id` | `string` |  |
-| `project_id` | `string` |  |
-| `pending_deployment` | `object` | The most recent pending deployment. For CreateApp and UpdateApp transactions this is guaranteed to reflect the associated deployment. |
-| `domains` | `array` |  |
-| `live_domain` | `string` |  |
-| `last_deployment_created_at` | `string` |  |
-| `tier_slug` | `string` |  |
-| `region` | `object` |  |
-| `pinned_deployment` | `object` | The deployment that the app is pinned to. |
-| `created_at` | `string` |  |
-| `active_deployment` | `object` |  |
-| `in_progress_deployment` | `object` |  |
-| `default_ingress` | `string` |  |
-| `owner_uuid` | `string` |  |
-| `live_url_base` | `string` |  |
-| `updated_at` | `string` |  |
-| `live_url` | `string` |  |
-| `spec` | `object` | The desired configuration of an application. |
+| <CopyableCode code="id" /> | `string` |  |
+| <CopyableCode code="active_deployment" /> | `object` |  |
+| <CopyableCode code="created_at" /> | `string` |  |
+| <CopyableCode code="default_ingress" /> | `string` |  |
+| <CopyableCode code="domains" /> | `array` |  |
+| <CopyableCode code="in_progress_deployment" /> | `object` |  |
+| <CopyableCode code="last_deployment_created_at" /> | `string` |  |
+| <CopyableCode code="live_domain" /> | `string` |  |
+| <CopyableCode code="live_url" /> | `string` |  |
+| <CopyableCode code="live_url_base" /> | `string` |  |
+| <CopyableCode code="owner_uuid" /> | `string` |  |
+| <CopyableCode code="pending_deployment" /> | `object` | The most recent pending deployment. For CreateApp and UpdateApp transactions this is guaranteed to reflect the associated deployment. |
+| <CopyableCode code="pinned_deployment" /> | `object` | The deployment that the app is pinned to. |
+| <CopyableCode code="project_id" /> | `string` |  |
+| <CopyableCode code="region" /> | `object` |  |
+| <CopyableCode code="spec" /> | `object` | The desired configuration of an application. |
+| <CopyableCode code="tier_slug" /> | `string` |  |
+| <CopyableCode code="updated_at" /> | `string` |  |
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| `get` | `SELECT` | `id` | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. |
-| `list` | `SELECT` |  | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. |
-| `create` | `INSERT` | `data__spec` | Create a new app by submitting an app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). |
-| `delete` | `DELETE` | `id` | Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time. |
-| `_get` | `EXEC` | `id` | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. |
-| `_list` | `EXEC` |  | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. |
-| `update` | `EXEC` | `id, data__spec` | Update an existing app by submitting a new app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). |
-| `validate_appSpec` | `EXEC` | `data__spec` | To propose and validate a spec for a new or existing app, send a POST request to the `/v2/apps/propose` endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app. |
+| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="id" /> | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. |
+| <CopyableCode code="list" /> | `SELECT` |  | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. |
+| <CopyableCode code="create" /> | `INSERT` | <CopyableCode code="data__spec" /> | Create a new app by submitting an app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). |
+| <CopyableCode code="delete" /> | `DELETE` | <CopyableCode code="id" /> | Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time. |
+| <CopyableCode code="_get" /> | `EXEC` | <CopyableCode code="id" /> | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. |
+| <CopyableCode code="_list" /> | `EXEC` |  | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. |
+| <CopyableCode code="update" /> | `EXEC` | <CopyableCode code="id, data__spec" /> | Update an existing app by submitting a new app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). |
+| <CopyableCode code="validate_appSpec" /> | `EXEC` | <CopyableCode code="data__spec" /> | To propose and validate a spec for a new or existing app, send a POST request to the `/v2/apps/propose` endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app. |