diff options
| author |   Almog Laktivi <al942u@att.com> | 2017-11-16 12:51:21 +0200 |
|---|---|---|
| committer | Almog Laktivi <al942u@att.com> | 2017-11-16 12:51:35 +0200 |
| commit | 0ca827db0fd2cee74377c844175c0df0037f4ac2 (patch) | |
| tree | 74d2068aecc804317855d594ad30d443eb180925 /docs/offeredapis.rst | |
| parent | d3169add2377f8ab1d883cf2e9e3b3f7e9b5eeb9 (diff) | |
Add documentation files for vvp platform
Change-Id: Ided90e8738a1b8818fa4e460e4362e0d3bdb6b06
Issue-ID: VVP-30
Signed-off-by: Almog Laktivi <al942u@att.com>
Diffstat (limited to 'docs/offeredapis.rst')
| -rwxr-xr-x | docs/offeredapis.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst new file mode 100755 index 0000000..2b733d5 --- /dev/null +++ b/docs/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
|