summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2018-11-15 22:12:37 +0000
committerEric Debeau <eric.debeau@orange.com>2018-11-15 22:13:35 +0000
commit16eb684cb8cafa1b55daf54c520a26c6d87fc39d (patch)
tree7f3cbafc64b2689679b19d81bc04535cfd12b471 /docs
parentcbfcc8c459d504cd93c17d6d576ef1bf100c62b1 (diff)
Correct offered API
Remove note Add link to download swagger.json Issue-ID: MUSIC-191 Change-Id: I8121f3809004058824d0f050618567a7308e7c8b Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/offeredapis.rst15
1 files changed, 7 insertions, 8 deletions
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index 3dcc7962..a9a59650 100644
--- a/docs/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -1,16 +1,15 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
+This document describes the MUSIC (Multi-site State Coordination Service) API
+To view API documentation in the interactive swagger UI download the following
+and paste into the swagger tool here: https://editor.swagger.io
+
+:download:`swagger.json <swagger.json>`
.. swaggerv2doc:: swagger.json