diff options
| author |   Gregory Glover <gg2147@att.com> | 2017-10-10 12:18:00 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2017-10-10 12:18:00 +0000 |
| commit | 1f6cac44fa61db99bc530ca6513bfdccf3cc23e5 (patch) | |
| tree | aee05acd1b05789f1a34498a988d931eb53a5658 /docs/templates/sections/offeredapis.rst | |
| parent | f07646fc4b449d2e0fb14303c48f50b9e0c7d8e1 (diff) | |
| parent | 7134cba7aa509a5ee7628244c52979e02807d252 (diff) | |
Merge "Improve templates and add references in guides"
Diffstat (limited to 'docs/templates/sections/offeredapis.rst')
| -rw-r--r-- | docs/templates/sections/offeredapis.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/templates/sections/offeredapis.rst b/docs/templates/sections/offeredapis.rst new file mode 100644 index 000000000..b1b8f41e8 --- /dev/null +++ b/docs/templates/sections/offeredapis.rst @@ -0,0 +1,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 |