summaryrefslogtreecommitdiffstats
path: root/docs/templates/sections/offeredapis.rst
blob: b1b8f41e885ff4969d9dd185a61fd1647d792fdb (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
.. 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