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

Feature/doc updates

docs/godaddy-docs/index.md

@@ -13,8 +13,10 @@ custom_edit_url: null
 image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png
 id: godaddy-doc
 slug: /providers/godaddy
-
 ---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
 Domain registration and web hosting services.  
 
 :::info Provider Summary (v23.12.00190)
@@ -49,7 +51,7 @@ REGISTRY PULL godaddy;
 
 The following system environment variables are used for authentication by default:  
 
-- `GODADDY_API_KEY` - Godaddy API key (see [Creating a Godaddy API Key](https://developer.godaddy.com/keys))
+- <CopyableCode code="GODADDY_API_KEY" /> - Godaddy API key (see [Creating a Godaddy API Key](https://developer.godaddy.com/keys))
 
 These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
 

docs/godaddy-docs/providers/godaddy/abuse/index.md

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

docs/godaddy-docs/providers/godaddy/abuse/tickets/index.md

@@ -14,32 +14,35 @@ description: Query, deploy and manage GoDaddy resources using SQL
 custom_edit_url: null
 image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png
 ---
-
-
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>tickets</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>godaddy.abuse.tickets</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="godaddy.abuse.tickets" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `closed` | `boolean` | Is this abuse ticket closed? |
-| `closedAt` | `string` | The date the abuse ticket was closed |
-| `createdAt` | `string` | The date the abuse ticket was created |
-| `domainIp` | `string` | The domain or IP the suspected abuse was reported against |
-| `reporter` | `string` | The shopper id of the person who reported the suspected abuse |
-| `source` | `string` | The single URL or IP the suspected abuse was reported against |
-| `target` | `string` | The company the suspected abuse is targeting |
-| `ticketId` | `string` | Abuse ticket ID |
-| `type` | `string` | The type of abuse being reported |
+| <CopyableCode code="closed" /> | `boolean` | Is this abuse ticket closed? |
+| <CopyableCode code="closedAt" /> | `string` | The date the abuse ticket was closed |
+| <CopyableCode code="createdAt" /> | `string` | The date the abuse ticket was created |
+| <CopyableCode code="domainIp" /> | `string` | The domain or IP the suspected abuse was reported against |
+| <CopyableCode code="reporter" /> | `string` | The shopper id of the person who reported the suspected abuse |
+| <CopyableCode code="source" /> | `string` | The single URL or IP the suspected abuse was reported against |
+| <CopyableCode code="target" /> | `string` | The company the suspected abuse is targeting |
+| <CopyableCode code="ticketId" /> | `string` | Abuse ticket ID |
+| <CopyableCode code="type" /> | `string` | The type of abuse being reported |
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| `get_ticket_info` | `SELECT` | `ticket_id` | Return the abuse ticket data for a given ticket id |
-| `get_tickets` | `SELECT` |  | List all abuse tickets ids that match user provided filters |
-| `create_ticket` | `INSERT` |  | Create a new abuse ticket |
-| `_get_tickets` | `EXEC` |  | List all abuse tickets ids that match user provided filters |
+| <CopyableCode code="get_ticket_info" /> | `SELECT` | <CopyableCode code="ticket_id" /> | Return the abuse ticket data for a given ticket id |
+| <CopyableCode code="get_tickets" /> | `SELECT` |  | List all abuse tickets ids that match user provided filters |
+| <CopyableCode code="create_ticket" /> | `INSERT` |  | Create a new abuse ticket |
+| <CopyableCode code="_get_tickets" /> | `EXEC` |  | List all abuse tickets ids that match user provided filters |

docs/godaddy-docs/providers/godaddy/aftermarket/index.md

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

docs/godaddy-docs/providers/godaddy/aftermarket/listings/index.md

@@ -14,20 +14,23 @@ description: Query, deploy and manage GoDaddy resources using SQL
 custom_edit_url: null
 image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png
 ---
-
-
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>listings</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>godaddy.aftermarket.listings</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="godaddy.aftermarket.listings" /></td></tr>
 </tbody></table>
 
 ## Fields
 `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command  
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| `delete_listings` | `DELETE` | `domains` | Remove listings from GoDaddy Auction |
-| `add_expiry_listings` | `EXEC` |  | Add expiry listings into GoDaddy Auction |
+| <CopyableCode code="delete_listings" /> | `DELETE` | <CopyableCode code="domains" /> | Remove listings from GoDaddy Auction |
+| <CopyableCode code="add_expiry_listings" /> | `EXEC` |  | Add expiry listings into GoDaddy Auction |

docs/godaddy-docs/providers/godaddy/agreements/agreements/index.md

@@ -14,24 +14,27 @@ description: Query, deploy and manage GoDaddy resources using SQL
 custom_edit_url: null
 image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png
 ---
-
-
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>agreements</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>godaddy.agreements.agreements</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="godaddy.agreements.agreements" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `agreementKey` | `string` | Unique identifier for the legal agreement |
-| `content` | `string` | Contents of the legal agreement, suitable for embedding |
-| `title` | `string` | Title of the legal agreement |
-| `url` | `string` | URL to a page containing the legal agreement |
+| <CopyableCode code="agreementKey" /> | `string` | Unique identifier for the legal agreement |
+| <CopyableCode code="content" /> | `string` | Contents of the legal agreement, suitable for embedding |
+| <CopyableCode code="title" /> | `string` | Title of the legal agreement |
+| <CopyableCode code="url" /> | `string` | URL to a page containing the legal agreement |
 ## Methods
 | Name | Accessible by | Required Params |
 |:-----|:--------------|:----------------|
-| `get` | `SELECT` | `keys` |
+| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="keys" /> |

docs/godaddy-docs/providers/godaddy/agreements/index.md

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

docs/godaddy-docs/providers/godaddy/certificates/actions/index.md

@@ -14,22 +14,25 @@ description: Query, deploy and manage GoDaddy resources using SQL
 custom_edit_url: null
 image: /img/providers/godaddy/stackql-godaddy-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>godaddy.certificates.actions</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="godaddy.certificates.actions" /></td></tr>
 </tbody></table>
 
 ## Fields
 | Name | Datatype | Description |
 |:-----|:---------|:------------|
-| `createdAt` | `string` | Date action created |
-| `type` | `string` |  |
+| <CopyableCode code="createdAt" /> | `string` | Date action created |
+| <CopyableCode code="type" /> | `string` |  |
 ## Methods
 | Name | Accessible by | Required Params |
 |:-----|:--------------|:----------------|
-| `certificate_action_retrieve` | `SELECT` | `certificate_id` |
+| <CopyableCode code="certificate_action_retrieve" /> | `SELECT` | <CopyableCode code="certificate_id" /> |

docs/godaddy-docs/providers/godaddy/certificates/callback/index.md

@@ -14,20 +14,23 @@ description: Query, deploy and manage GoDaddy resources using SQL
 custom_edit_url: null
 image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png
 ---
-
-
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+
+
 
 ## Overview
 <table><tbody>
 <tr><td><b>Name</b></td><td><code>callback</code></td></tr>
 <tr><td><b>Type</b></td><td>Resource</td></tr>
-<tr><td><b>Id</b></td><td><code>godaddy.certificates.callback</code></td></tr>
+<tr><td><b>Id</b></td><td><CopyableCode code="godaddy.certificates.callback" /></td></tr>
 </tbody></table>
 
 ## Fields
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| `certificate_callback_get` | `SELECT` | `certificate_id` | This method is used to retrieve the registered callback url for a certificate. |
-| `certificate_callback_delete` | `DELETE` | `certificate_id` | Unregister the callback for a particular certificate. |
-| `certificate_callback_replace` | `EXEC` | `callbackUrl, certificate_id` | This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action.  Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration. |
+| <CopyableCode code="certificate_callback_get" /> | `SELECT` | <CopyableCode code="certificate_id" /> | This method is used to retrieve the registered callback url for a certificate. |
+| <CopyableCode code="certificate_callback_delete" /> | `DELETE` | <CopyableCode code="certificate_id" /> | Unregister the callback for a particular certificate. |
+| <CopyableCode code="certificate_callback_replace" /> | `EXEC` | <CopyableCode code="callbackUrl, certificate_id" /> | This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action.  Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration. |