summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis.rst
blob: ec96ae6371526ead3e50d0f0181307c86f3e0caf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.


Offered APIs
==============


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