Improve templates and add references in guides

[doc.git] / docs / templates / sections / offeredapis.rst

diff --git a/docs/templates/sections/offeredapis.rst b/docs/templates/sections/offeredapis.rst
new file mode 100644 (file)
index 0000000..b1b8f41
--- /dev/null
+++ b/docs/templates/sections/offeredapis.rst
@@ -0,0 +1,26 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Offered APIs
+============
+
+.. note::
+   * This section is used to describe the external interfaces offered by a software component
+   
+   * This section is typically: provided for a  platform-component and sdk; and 
+     referenced in developer guides and api reference manuals.
+   
+   * This note must be removed after content has been added.
+
+
+
+Here are several examples:
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   apiexample/swaggerv2doc.rst
+   apiexample/swagger2markup.rst
+   apiexample/worddoc2rst.rst
+   apiexample/httpdomain.rst