summaryrefslogtreecommitdiffstats
path: root/docs/sections/offeredapis.rst
diff options
context:
space:
mode:
authorLusheng Ji <lji@research.att.com>2017-10-10 18:12:22 +0000
committerLusheng Ji <lji@research.att.com>2017-10-10 18:12:34 +0000
commit72c4fbaceb680b3b34e177ccca11efe18de599f5 (patch)
treefefdb90f97f0e8d43772d77ea48f6f98a7c4945b /docs/sections/offeredapis.rst
parentc8d7ad73740989d2aa5d5cab41dcc7e0c960f0fa (diff)
Draft docs
Issue-Id: DCAEGEN2-109 Change-Id: I85513ed5b34c0f60b8b0924b2016bbb3224beb9c Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat (limited to 'docs/sections/offeredapis.rst')
-rw-r--r--docs/sections/offeredapis.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst
new file mode 100644
index 00000000..b1b8f41e
--- /dev/null
+++ b/docs/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