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

Feature/doc updates

docs/aws-docs/index.md

@@ -17,6 +17,9 @@ id: aws-doc
 slug: /providers/aws
 
 ---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
 Cloud services from AWS.
 
 :::info Provider Summary (v24.05.00228)
@@ -51,9 +54,9 @@ REGISTRY PULL aws;
 
 The following system environment variables are used for authentication by default:  
 
-- `AWS_ACCESS_KEY_ID` - AWS Access Key ID (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
-- `AWS_SECRET_ACCESS_KEY` - AWS Secret Access Key (see [How to Create AWS Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html))
-- `AWS_SESSION_TOKEN` - [*OPTIONAL:* only required if using `aws sts assume-role`] AWS Session Token (see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html))
+- <CopyableCode code="AWS_ACCESS_KEY_ID" /> - AWS Access Key ID (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
+- <CopyableCode code="AWS_SECRET_ACCESS_KEY" /> - AWS Secret Access Key (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
+- <CopyableCode code="AWS_SESSION_TOKEN" /> - [<i>OPTIONAL:</i> only required if using <CopyableCode code="aws sts assume-role" />] AWS Session Token (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary security credentials in IAM</a>)
 
 These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
 
@@ -85,7 +88,7 @@ stackql.exe shell --auth=$Auth
 
 The following parameter is required for the `aws` provider:  
 
-- `region` - AWS region (e.g. `us-east-1`)
+- <CopyableCode code="region" /> - AWS region (e.g. <code>us-east-1</code>)
 
 This parameter must be supplied to the `WHERE` clause of each `SELECT` statement.
 

docs/firebase-docs/index.md

@@ -13,8 +13,10 @@ custom_edit_url: null
 image: /img/providers/firebase/stackql-firebase-provider-featured-image.png
 id: firebase-doc
 slug: /providers/firebase
-
 ---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
 Application development platform for creating mobile and web applications.  
 
 :::info Provider Summary (v23.03.00121)
@@ -49,24 +51,24 @@ REGISTRY PULL firebase;
 
 
 The following authentication methods are supported:
-- `service_account`
-- `interactive` for running interactive queries from Cloud Shell or other machines where the user is authenticated using `gcloud auth login`
+- <CopyableCode code="service_account" />
+- <CopyableCode code="interactive" /> for running interactive queries from Cloud Shell or other machines where the user is authenticated using <CopyableCode code="gcloud auth login" />
 
 > for more information on creating service accounts and key files, see [Service accounts overview](https://cloud.google.com/iam/docs/service-account-overview).
 
 ### Service Account Environment Variable (default)
 
 The following system environment variable is used by default:  
 
-- `GOOGLE_CREDENTIALS` - contents of the `google` service account key json fileThis variable is sourced at runtime (from the local machine using export GOOGLE_CREDENTIALS=cat creds/my-sa-key.json` for example or as a CI variable/secret).
+- <CopyableCode code="GOOGLE_CREDENTIALS" /> - contents of the <code>google</code> service account key json file.  This variable is sourced at runtime (from the local machine using <cdoe>export GOOGLE_CREDENTIALS=cat creds/my-sa-key.json</code> for example or as a CI variable/secret).
 
 This variable is sourced at runtime (from the local machine using `export GOOGLE_CREDENTIALS=$(cat creds/my-sa-key.json)` for example or as a CI variable/secret).
 
 <details>
 
 <summary>Specifying the service account key file location directly</summary>
 
-You can specify the path to the service account key file without using the default environment variable by using the `--auth` flag of the `stackql` program.  For example:  
+You can specify the path to the service account key file without using the default environment variable by using the <CopyableCode code="--auth" /> flag of the <code>stackql</code> program.  For example:  
 
 ```bash
 AUTH='{ "google": { "type": "service_account",  "credentialsfilepath": "creds/sa-key.json" }}'
@@ -83,7 +85,7 @@ stackql.exe shell --auth=$Auth
 </details>
 
 ### Interactive Authentication
-When you are using Google Cloud Shell or on a machine where you have authenticated using `gcloud auth login`, you can then use the following authentication method:   
+When you are using Google Cloud Shell or on a machine where you have authenticated using <CopyableCode code="gcloud auth login" />, you can then use the following authentication method:   
 
 ```bash
 AUTH='{ "google": { "type": "interactive" }}'
@@ -112,4 +114,4 @@ stackql.exe shell --auth=$Auth
 <a href="/providers/firebase/firebasestorage/">firebasestorage</a><br />
 <a href="/providers/firebase/toolresults/">toolresults</a><br />
 </div>
-</div>
+</div>

docs/firebase-docs/providers/firebase/firebase/android_apps/index.md

@@ -14,35 +14,38 @@ description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure
 custom_edit_url: null
 image: /img/providers/firebase/stackql-firebase-provider-featured-image.png
 ---
-
-
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>android_apps</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>firebase.firebase.android_apps</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="firebase.firebase.android_apps" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `name` | `string` | The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)). |
-| `sha1Hashes` | `array` | The SHA1 certificate hashes for the AndroidApp. |
-| `packageName` | `string` | Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console. |
-| `displayName` | `string` | The user-assigned display name for the `AndroidApp`. |
-| `apiKeyId` | `string` | The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `AndroidApp`. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's [configuration artifact](../../rest/v1beta1/projects.androidApps/getConfig). If `api_key_id` is not set in requests to [`androidApps.Create`](../../rest/v1beta1/projects.androidApps/create), then Firebase automatically associates an `api_key_id` with the `AndroidApp`. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, `api_key_id` cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated `AndroidApp`. We recommend using the [Google Cloud Console](https://console.cloud.google.com/apis/credentials) to manage API keys. |
-| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about `etag` in Google's [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated. |
-| `projectId` | `string` | Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`. |
-| `state` | `string` | Output only. The lifecycle state of the App. |
-| `appId` | `string` | Output only. Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not specified. |
-| `sha256Hashes` | `array` | The SHA256 certificate hashes for the AndroidApp. |
+| <CopyableCode code="name" /> | `string` | The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)). |
+| <CopyableCode code="apiKeyId" /> | `string` | The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `AndroidApp`. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's [configuration artifact](../../rest/v1beta1/projects.androidApps/getConfig). If `api_key_id` is not set in requests to [`androidApps.Create`](../../rest/v1beta1/projects.androidApps/create), then Firebase automatically associates an `api_key_id` with the `AndroidApp`. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, `api_key_id` cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated `AndroidApp`. We recommend using the [Google Cloud Console](https://console.cloud.google.com/apis/credentials) to manage API keys. |
+| <CopyableCode code="appId" /> | `string` | Output only. Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not specified. |
+| <CopyableCode code="displayName" /> | `string` | The user-assigned display name for the `AndroidApp`. |
+| <CopyableCode code="etag" /> | `string` | This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about `etag` in Google's [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated. |
+| <CopyableCode code="packageName" /> | `string` | Immutable. The canonical package name of the Android app as would appear in the Google Play Developer Console. |
+| <CopyableCode code="projectId" /> | `string` | Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`. |
+| <CopyableCode code="sha1Hashes" /> | `array` | The SHA1 certificate hashes for the AndroidApp. |
+| <CopyableCode code="sha256Hashes" /> | `array` | The SHA256 certificate hashes for the AndroidApp. |
+| <CopyableCode code="state" /> | `string` | Output only. The lifecycle state of the App. |
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| `projects_androidApps_get` | `SELECT` | `androidAppsId, projectsId` | Gets the specified AndroidApp. |
-| `projects_androidApps_list` | `SELECT` | `projectsId` | Lists each AndroidApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`. |
-| `projects_androidApps_create` | `INSERT` | `projectsId` | Requests the creation of a new AndroidApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`. |
-| `projects_androidApps_patch` | `EXEC` | `androidAppsId, projectsId` | Updates the attributes of the specified AndroidApp. |
-| `projects_androidApps_remove` | `EXEC` | `androidAppsId, projectsId` | Removes the specified AndroidApp from the FirebaseProject. |
-| `projects_androidApps_undelete` | `EXEC` | `androidAppsId, projectsId` | Restores the specified AndroidApp to the FirebaseProject. |
+| <CopyableCode code="projects_androidApps_get" /> | `SELECT` | <CopyableCode code="androidAppsId, projectsId" /> | Gets the specified AndroidApp. |
+| <CopyableCode code="projects_androidApps_list" /> | `SELECT` | <CopyableCode code="projectsId" /> | Lists each AndroidApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`. |
+| <CopyableCode code="projects_androidApps_create" /> | `INSERT` | <CopyableCode code="projectsId" /> | Requests the creation of a new AndroidApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`. |
+| <CopyableCode code="projects_androidApps_patch" /> | `EXEC` | <CopyableCode code="androidAppsId, projectsId" /> | Updates the attributes of the specified AndroidApp. |
+| <CopyableCode code="projects_androidApps_remove" /> | `EXEC` | <CopyableCode code="androidAppsId, projectsId" /> | Removes the specified AndroidApp from the FirebaseProject. |
+| <CopyableCode code="projects_androidApps_undelete" /> | `EXEC` | <CopyableCode code="androidAppsId, projectsId" /> | Restores the specified AndroidApp to the FirebaseProject. |

docs/firebase-docs/providers/firebase/firebase/android_apps__config/index.md

@@ -14,22 +14,25 @@ description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure
 custom_edit_url: null
 image: /img/providers/firebase/stackql-firebase-provider-featured-image.png
 ---
-
-
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>android_apps__config</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>firebase.firebase.android_apps__config</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="firebase.firebase.android_apps__config" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `configFilename` | `string` | The filename that the configuration artifact for the `AndroidApp` is typically saved as. For example: `google-services.json` |
-| `configFileContents` | `string` | The contents of the JSON configuration file. |
+| <CopyableCode code="configFileContents" /> | `string` | The contents of the JSON configuration file. |
+| <CopyableCode code="configFilename" /> | `string` | The filename that the configuration artifact for the `AndroidApp` is typically saved as. For example: `google-services.json` |
 ## Methods
 | Name | Accessible by | Required Params |
 |:-----|:--------------|:----------------|
-| `projects_androidApps_getConfig` | `SELECT` | `androidAppsId, projectsId` |
+| <CopyableCode code="projects_androidApps_getConfig" /> | `SELECT` | <CopyableCode code="androidAppsId, projectsId" /> |

docs/firebase-docs/providers/firebase/firebase/available_locations/index.md

@@ -14,22 +14,25 @@ description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure
 custom_edit_url: null
 image: /img/providers/firebase/stackql-firebase-provider-featured-image.png
 ---
-
-
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>available_locations</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>firebase.firebase.available_locations</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="firebase.firebase.available_locations" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `nextPageToken` | `string` | If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results and all available locations have been listed. This token can be used in a subsequent call to `ListAvailableLocations` to find more locations. Page tokens are short-lived and should not be persisted. |
-| `locations` | `array` | One page of results from a call to `ListAvailableLocations`. |
+| <CopyableCode code="locations" /> | `array` | One page of results from a call to `ListAvailableLocations`. |
+| <CopyableCode code="nextPageToken" /> | `string` | If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results and all available locations have been listed. This token can be used in a subsequent call to `ListAvailableLocations` to find more locations. Page tokens are short-lived and should not be persisted. |
 ## Methods
 | Name | Accessible by | Required Params |
 |:-----|:--------------|:----------------|
-| `projects_availableLocations_list` | `SELECT` | `projectsId` |
+| <CopyableCode code="projects_availableLocations_list" /> | `SELECT` | <CopyableCode code="projectsId" /> |

docs/firebase-docs/providers/firebase/firebase/available_projects/index.md

@@ -14,22 +14,25 @@ description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure
 custom_edit_url: null
 image: /img/providers/firebase/stackql-firebase-provider-featured-image.png
 ---
-
-
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>available_projects</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>firebase.firebase.available_projects</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="firebase.firebase.available_projects" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `nextPageToken` | `string` | If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent calls to `ListAvailableProjects` to find the next group of Projects. Page tokens are short-lived and should not be persisted. |
-| `projectInfo` | `array` | The list of GCP `Projects` which can have Firebase resources added to them. |
+| <CopyableCode code="nextPageToken" /> | `string` | If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent calls to `ListAvailableProjects` to find the next group of Projects. Page tokens are short-lived and should not be persisted. |
+| <CopyableCode code="projectInfo" /> | `array` | The list of GCP `Projects` which can have Firebase resources added to them. |
 ## Methods
 | Name | Accessible by | Required Params |
 |:-----|:--------------|:----------------|
-| `availableProjects_list` | `SELECT` |  |
+| <CopyableCode code="availableProjects_list" /> | `SELECT` |  |