Adds an (unlinked) API template (github#470)

* Adds an (unlinked) API template * Add example admonition
jnidzwetzki · Sep 24, 2021 · 7d85806 · 7d85806
1 parent 5d7fa27
commit 7d85806
Showing 1 changed file with 52 additions and 0 deletions.
diff --git a/api/_template.md b/api/_template.md
@@ -0,0 +1,52 @@
+# api_call() <tag type="FIXME" content="FIXME" />
+<!---Single sentence description of the API call-->
+
+<!---Any special notes about the API call-->
+
+<!---For more information about api_call(), see the [FIXME docs][link_ref]-->
+
+<!---
+<highlight type="note"
+Use a highlight for any important information. Choose `note`, `important`, or `warning`.
+</highlight>
+-->
+
+## Required Arguments
+
+|Name|Type|Description|
+|-|-|-|
+|<FIXME>|<FIXME>|<FIXME>|
+
+<!---Any special notes about the required arguments-->
+
+### Optional Arguments
+
+|Name|Type|Description|
+|-|-|-|
+|<FIXME>|<FIXME>|<FIXME>|
+
+<!---Any special notes about the optional arguments-->
+
+## Returns
+
+|Column|Type|Description|
+|-|-|-|
+|<FIXME>|<FIXME>|<FIXME>|
+
+<!---Any special notes about the returns-->
+
+## Sample Usage
+<!---Single sentence description of what this example does-->
+
+``` sql
+<FIXME>
+```
+
+<!---Single sentence description of what this example does-->
+
+``` sql
+<FIXME>
+```
+
+
+[link_ref]: timescaledb/:currentVersion:/how-to-guides/<FIXME>/