Adding documentation placeholders
[policy/engine.git] / docs / platform / offeredapis.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4
5 Offered APIs
6 ============
7 List APIs offered.   One or more of the following examples may be appropriate.
8
9 Example Swagger Displayed with swaggerv2doc directive
10 -----------------------------------------------------
11
12 .. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json
13
14
15 Example documenting a REST interface with Sphinx httpdomain directive
16 ---------------------------------------------------------------------
17
18 .. http:get:: path
19
20    For more information see `<https://pythonhosted.org/sphinxcontrib-httpdomain>`_
21
22
23 Word Document Converted to RST using Pandocs
24 --------------------------------------------
25
26 .. toctree:: 
27    :maxdepth: 1
28
29    ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide