aboutsummaryrefslogtreecommitdiffstats
path: root/docs/onap-developer/docs-templates-platform-component-offeredapis.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/onap-developer/docs-templates-platform-component-offeredapis.rst')
-rw-r--r--docs/onap-developer/docs-templates-platform-component-offeredapis.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/onap-developer/docs-templates-platform-component-offeredapis.rst b/docs/onap-developer/docs-templates-platform-component-offeredapis.rst
new file mode 100644
index 0000000000..55e58bd9b3
--- /dev/null
+++ b/docs/onap-developer/docs-templates-platform-component-offeredapis.rst
@@ -0,0 +1,29 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Offered APIs
+============
+List APIs offered. One or more of the following examples may be appropriate.
+
+Example Swagger Displayed with swaggerv2doc directive
+-----------------------------------------------------
+
+.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json
+
+
+Example documenting a REST interface with Sphinx httpdomain directive
+---------------------------------------------------------------------
+
+.. http:get:: path
+
+ For more information see `<https://pythonhosted.org/sphinxcontrib-httpdomain>`_
+
+
+Word Document Converted to RST using Pandocs
+--------------------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide