Skip to content

Commit 1540516

Browse files
authored
Merge pull request #290 from stackql/feature/provider-docs
docs v2 working
2 parents 9dab9e1 + 9a5a606 commit 1540516

File tree

47 files changed

+864
-770
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+864
-770
lines changed

docs/snowflake-docs/providers/snowflake/account/accounts/index.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -263,33 +263,35 @@ The following methods are available for this resource:
263263
<tr>
264264
<td><a href="#list_accounts"><CopyableCode code="list_accounts" /></a></td>
265265
<td><CopyableCode code="select" /></td>
266-
<td><a href="#parameter-endpoint">endpoint</a></td>
267-
<td><a href="#parameter-like">like</a>, <a href="#parameter-showLimit">showLimit</a>, <a href="#parameter-history">history</a></td>
266+
<td><a href="#parameter-endpoint"><code>endpoint</code></a></td>
267+
<td><a href="#parameter-like"><code>like</code></a>, <a href="#parameter-showLimit"><code>showLimit</code></a>, <a href="#parameter-history"><code>history</code></a></td>
268268
<td>Lists the accessible accounts.</td>
269269
</tr>
270270
<tr>
271271
<td><a href="#create_account"><CopyableCode code="create_account" /></a></td>
272272
<td><CopyableCode code="insert" /></td>
273-
<td><a href="#parameter-endpoint">endpoint</a></td>
273+
<td><a href="#parameter-endpoint"><code>endpoint</code></a></td>
274274
<td></td>
275275
<td>Creates a account. You must provide the full account definition when creating a account.</td>
276276
</tr>
277277
<tr>
278278
<td><a href="#delete_account"><CopyableCode code="delete_account" /></a></td>
279279
<td><CopyableCode code="delete" /></td>
280-
<td><a href="#parameter-name">name</a>, <a href="#parameter-gracePeriodInDays">gracePeriodInDays</a>, <a href="#parameter-endpoint">endpoint</a></td>
281-
<td><a href="#parameter-ifExists">ifExists</a></td>
282-
<td>Deletes the specified account. If you enable the `ifExists` parameter, the operation succeeds even if the account does not exist. Otherwise, a 404 failure is returned if the account does not exist. if the drop is unsuccessful.</td>
280+
<td><a href="#parameter-name"><code>name</code></a>, <a href="#parameter-gracePeriodInDays"><code>gracePeriodInDays</code></a>, <a href="#parameter-endpoint"><code>endpoint</code></a></td>
281+
<td><a href="#parameter-ifExists"><code>ifExists</code></a></td>
282+
<td>Deletes the specified account. If you enable the <code>ifExists</code> parameter, the operation succeeds even if the account does not exist. Otherwise, a 404 failure is returned if the account does not exist. if the drop is unsuccessful.</td>
283283
</tr>
284284
<tr>
285285
<td><a href="#undrop_account"><CopyableCode code="undrop_account" /></a></td>
286286
<td><CopyableCode code="exec" /></td>
287-
<td><a href="#parameter-name">name</a>, <a href="#parameter-endpoint">endpoint</a></td>
287+
<td><a href="#parameter-name"><code>name</code></a>, <a href="#parameter-endpoint"><code>endpoint</code></a></td>
288288
<td></td>
289289
<td>Restores a dropped account that has not yet been permanently deleted (a dropped account that is within its grace period).</td>
290290
</tr>
291291
</tbody>
292-
</table>## Parameters
292+
</table>
293+
294+
## Parameters
293295

294296
Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation.
295297

@@ -315,7 +317,7 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
315317
<tr id="parameter-name">
316318
<td><CopyableCode code="name" /></td>
317319
<td><code>string</code></td>
318-
<td>Identifier (i.e. name) for the resource. (pattern: ^&quot;([^&quot;]|&quot;&quot;)+&quot;|[a-zA-Z_][a-zA-Z0-9_$]*$, example: TEST_NAME)</td>
320+
<td>Identifier (i.e. name) for the resource.</td>
319321
</tr>
320322
<tr id="parameter-history">
321323
<td><CopyableCode code="history" /></td>
@@ -325,17 +327,17 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
325327
<tr id="parameter-ifExists">
326328
<td><CopyableCode code="ifExists" /></td>
327329
<td><code>boolean</code></td>
328-
<td>Query parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist. (example: true, default: false)</td>
330+
<td>Query parameter that specifies how to handle the request for a resource that does not exist: - <code>true</code>: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - <code>false</code>: The endpoint throws an error if the resource doesn't exist.</td>
329331
</tr>
330332
<tr id="parameter-like">
331333
<td><CopyableCode code="like" /></td>
332334
<td><code>string</code></td>
333-
<td>Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. (example: test_%)</td>
335+
<td>Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.</td>
334336
</tr>
335337
<tr id="parameter-showLimit">
336338
<td><CopyableCode code="showLimit" /></td>
337339
<td><code>integer</code></td>
338-
<td>Query parameter to limit the maximum number of rows returned by a command. (example: 10, minimum: 1, maximum: 10000)</td>
340+
<td>Query parameter to limit the maximum number of rows returned by a command.</td>
339341
</tr>
340342
</tbody>
341343
</table>

docs/snowflake-docs/providers/snowflake/alert/alerts/index.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -210,47 +210,49 @@ The following methods are available for this resource:
210210
<tr>
211211
<td><a href="#list_alerts"><CopyableCode code="list_alerts" /></a></td>
212212
<td><CopyableCode code="select" /></td>
213-
<td><a href="#parameter-database_name">database_name</a>, <a href="#parameter-schema_name">schema_name</a>, <a href="#parameter-endpoint">endpoint</a></td>
214-
<td><a href="#parameter-like">like</a>, <a href="#parameter-startsWith">startsWith</a>, <a href="#parameter-showLimit">showLimit</a>, <a href="#parameter-fromName">fromName</a></td>
213+
<td><a href="#parameter-database_name"><code>database_name</code></a>, <a href="#parameter-schema_name"><code>schema_name</code></a>, <a href="#parameter-endpoint"><code>endpoint</code></a></td>
214+
<td><a href="#parameter-like"><code>like</code></a>, <a href="#parameter-startsWith"><code>startsWith</code></a>, <a href="#parameter-showLimit"><code>showLimit</code></a>, <a href="#parameter-fromName"><code>fromName</code></a></td>
215215
<td>List alerts</td>
216216
</tr>
217217
<tr>
218218
<td><a href="#fetch_alert"><CopyableCode code="fetch_alert" /></a></td>
219219
<td><CopyableCode code="select" /></td>
220-
<td><a href="#parameter-database_name">database_name</a>, <a href="#parameter-schema_name">schema_name</a>, <a href="#parameter-name">name</a>, <a href="#parameter-endpoint">endpoint</a></td>
220+
<td><a href="#parameter-database_name"><code>database_name</code></a>, <a href="#parameter-schema_name"><code>schema_name</code></a>, <a href="#parameter-name"><code>name</code></a>, <a href="#parameter-endpoint"><code>endpoint</code></a></td>
221221
<td></td>
222222
<td>Fetch an alert</td>
223223
</tr>
224224
<tr>
225225
<td><a href="#create_alert"><CopyableCode code="create_alert" /></a></td>
226226
<td><CopyableCode code="insert" /></td>
227-
<td><a href="#parameter-database_name">database_name</a>, <a href="#parameter-schema_name">schema_name</a>, <a href="#parameter-endpoint">endpoint</a></td>
228-
<td><a href="#parameter-createMode">createMode</a></td>
227+
<td><a href="#parameter-database_name"><code>database_name</code></a>, <a href="#parameter-schema_name"><code>schema_name</code></a>, <a href="#parameter-endpoint"><code>endpoint</code></a></td>
228+
<td><a href="#parameter-createMode"><code>createMode</code></a></td>
229229
<td>Create an alert</td>
230230
</tr>
231231
<tr>
232232
<td><a href="#delete_alert"><CopyableCode code="delete_alert" /></a></td>
233233
<td><CopyableCode code="delete" /></td>
234-
<td><a href="#parameter-database_name">database_name</a>, <a href="#parameter-schema_name">schema_name</a>, <a href="#parameter-name">name</a>, <a href="#parameter-endpoint">endpoint</a></td>
235-
<td><a href="#parameter-ifExists">ifExists</a></td>
234+
<td><a href="#parameter-database_name"><code>database_name</code></a>, <a href="#parameter-schema_name"><code>schema_name</code></a>, <a href="#parameter-name"><code>name</code></a>, <a href="#parameter-endpoint"><code>endpoint</code></a></td>
235+
<td><a href="#parameter-ifExists"><code>ifExists</code></a></td>
236236
<td>Delete an alert</td>
237237
</tr>
238238
<tr>
239239
<td><a href="#clone_alert"><CopyableCode code="clone_alert" /></a></td>
240240
<td><CopyableCode code="exec" /></td>
241-
<td><a href="#parameter-database_name">database_name</a>, <a href="#parameter-schema_name">schema_name</a>, <a href="#parameter-name">name</a>, <a href="#parameter-targetDatabase">targetDatabase</a>, <a href="#parameter-targetSchema">targetSchema</a>, <a href="#parameter-endpoint">endpoint</a></td>
242-
<td><a href="#parameter-createMode">createMode</a></td>
241+
<td><a href="#parameter-database_name"><code>database_name</code></a>, <a href="#parameter-schema_name"><code>schema_name</code></a>, <a href="#parameter-name"><code>name</code></a>, <a href="#parameter-targetDatabase"><code>targetDatabase</code></a>, <a href="#parameter-targetSchema"><code>targetSchema</code></a>, <a href="#parameter-endpoint"><code>endpoint</code></a></td>
242+
<td><a href="#parameter-createMode"><code>createMode</code></a></td>
243243
<td>Create a new alert by cloning from the specified resource</td>
244244
</tr>
245245
<tr>
246246
<td><a href="#execute_alert"><CopyableCode code="execute_alert" /></a></td>
247247
<td><CopyableCode code="exec" /></td>
248-
<td><a href="#parameter-database_name">database_name</a>, <a href="#parameter-schema_name">schema_name</a>, <a href="#parameter-name">name</a>, <a href="#parameter-endpoint">endpoint</a></td>
248+
<td><a href="#parameter-database_name"><code>database_name</code></a>, <a href="#parameter-schema_name"><code>schema_name</code></a>, <a href="#parameter-name"><code>name</code></a>, <a href="#parameter-endpoint"><code>endpoint</code></a></td>
249249
<td></td>
250250
<td>Execute an alert</td>
251251
</tr>
252252
</tbody>
253-
</table>## Parameters
253+
</table>
254+
255+
## Parameters
254256

255257
Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation.
256258

@@ -266,7 +268,7 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
266268
<tr id="parameter-database_name">
267269
<td><CopyableCode code="database_name" /></td>
268270
<td><code>string</code></td>
269-
<td>Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. (pattern: ^&quot;([^&quot;]|&quot;&quot;)+&quot;|[a-zA-Z_][a-zA-Z0-9_$]*$, example: TEST_NAME)</td>
271+
<td>Identifier (i.e. name) for the database to which the resource belongs. You can use the <code>/api/v2/databases</code> GET request to get a list of available databases.</td>
270272
</tr>
271273
<tr id="parameter-endpoint">
272274
<td><CopyableCode code="endpoint" /></td>
@@ -276,12 +278,12 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
276278
<tr id="parameter-name">
277279
<td><CopyableCode code="name" /></td>
278280
<td><code>string</code></td>
279-
<td>Identifier (i.e. name) for the resource. (pattern: ^&quot;([^&quot;]|&quot;&quot;)+&quot;|[a-zA-Z_][a-zA-Z0-9_$]*$, example: TEST_NAME)</td>
281+
<td>Identifier (i.e. name) for the resource.</td>
280282
</tr>
281283
<tr id="parameter-schema_name">
282284
<td><CopyableCode code="schema_name" /></td>
283285
<td><code>string</code></td>
284-
<td>Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database. (pattern: ^&quot;([^&quot;]|&quot;&quot;)+&quot;|[a-zA-Z_][a-zA-Z0-9_$]*$, example: TEST_NAME)</td>
286+
<td>Identifier (i.e. name) for the schema to which the resource belongs. You can use the <code>/api/v2/databases/&#123;database&#125;/schemas</code> GET request to get a list of available schemas for the specified database.</td>
285287
</tr>
286288
<tr id="parameter-targetDatabase">
287289
<td><CopyableCode code="targetDatabase" /></td>
@@ -296,32 +298,32 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#
296298
<tr id="parameter-createMode">
297299
<td><CopyableCode code="createMode" /></td>
298300
<td><code>string</code></td>
299-
<td>Query parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. (enum: [errorIfExists, orReplace, ifNotExists], example: ifNotExists, default: errorIfExists)</td>
301+
<td>Query parameter allowing support for different modes of resource creation. Possible values include: - <code>errorIfExists</code>: Throws an error if you try to create a resource that already exists. - <code>orReplace</code>: Automatically replaces the existing resource with the current one. - <code>ifNotExists</code>: Creates a new resource when an alter is requested for a non-existent resource.</td>
300302
</tr>
301303
<tr id="parameter-fromName">
302304
<td><CopyableCode code="fromName" /></td>
303305
<td><code>string</code></td>
304-
<td>Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. (example: from_test)</td>
306+
<td>Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.</td>
305307
</tr>
306308
<tr id="parameter-ifExists">
307309
<td><CopyableCode code="ifExists" /></td>
308310
<td><code>boolean</code></td>
309-
<td>Query parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist. (example: true, default: false)</td>
311+
<td>Query parameter that specifies how to handle the request for a resource that does not exist: - <code>true</code>: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - <code>false</code>: The endpoint throws an error if the resource doesn't exist.</td>
310312
</tr>
311313
<tr id="parameter-like">
312314
<td><CopyableCode code="like" /></td>
313315
<td><code>string</code></td>
314-
<td>Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. (example: test_%)</td>
316+
<td>Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.</td>
315317
</tr>
316318
<tr id="parameter-showLimit">
317319
<td><CopyableCode code="showLimit" /></td>
318320
<td><code>integer</code></td>
319-
<td>Query parameter to limit the maximum number of rows returned by a command. (example: 10, minimum: 1, maximum: 10000)</td>
321+
<td>Query parameter to limit the maximum number of rows returned by a command.</td>
320322
</tr>
321323
<tr id="parameter-startsWith">
322324
<td><CopyableCode code="startsWith" /></td>
323325
<td><code>string</code></td>
324-
<td>Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. (example: test)</td>
326+
<td>Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.</td>
325327
</tr>
326328
</tbody>
327329
</table>
@@ -475,7 +477,7 @@ SELECT
475477
476478
- name: createMode
477479
value: string
478-
description: Query parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource. (enum: [errorIfExists, orReplace, ifNotExists], example: ifNotExists, default: errorIfExists)
480+
description: Query parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.
479481
```
480482
</TabItem>
481483
</Tabs>

0 commit comments

Comments
 (0)