Add API Documentation for Casablanca
[externalapi/nbi.git] / docs / offeredapis / serviceCatalog / documentation.html
index c81c1d8..94b011f 100644 (file)
@@ -1,8 +1,3 @@
-<!--
-This work is licensed under a Creative Commons Attribution 4.0 International License.
-http://creativecommons.org/licenses/by/4.0
-Copyright 2018 Orange
--->
 <!DOCTYPE html>
 <html lang="en">
 <head>
@@ -442,7 +437,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <li><a href="#_version_information">Version information</a></li>
 <li><a href="#_uri_scheme">URI scheme</a></li>
 <li><a href="#_tags">Tags</a></li>
-<li><a href="#_consumes">Consumes</a></li>
 <li><a href="#_produces">Produces</a></li>
 </ul>
 </li>
@@ -474,6 +468,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <h2 id="_overview">Overview</h2>
 <div class="sectionbody">
 <div class="sect2">
+<h3 id="_api_url">Api URL</h3>
+<div class="paragraph">
+<p><a href="https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json">Swagger UI</a></p>
+</div>
+<div class="paragraph">
+<p><a href="https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&amp;src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&amp;noCache=995303.0">plant UML UI</a></p>
+</div>
 <div class="paragraph">
 <p>serviceCatalog API designed for ONAP Beijing Release.
 This API is build from TMF open API17.5.
@@ -483,14 +484,14 @@ Only operation GET (by id &amp; byList) for resource serviceSpecification is ava
 <div class="sect2">
 <h3 id="_version_information">Version information</h3>
 <div class="paragraph">
-<p><em>Version</em> : 1.0.0_inProgress</p>
+<p><em>Version</em> : 3.0.0_inProgress</p>
 </div>
 </div>
 <div class="sect2">
 <h3 id="_uri_scheme">URI scheme</h3>
 <div class="paragraph">
 <p><em>Host</em> : serverRoot<br>
-<em>BasePath</em> : /nbi/api/v1<br>
+<em>BasePath</em> : /nbi/api/v3<br>
 <em>Schemes</em> : HTTPS</p>
 </div>
 </div>
@@ -505,16 +506,6 @@ Only operation GET (by id &amp; byList) for resource serviceSpecification is ava
 </div>
 </div>
 <div class="sect2">
-<h3 id="_consumes">Consumes</h3>
-<div class="ulist">
-<ul>
-<li>
-<p><code>application/json;charset=utf-8</code></p>
-</li>
-</ul>
-</div>
-</div>
-<div class="sect2">
 <h3 id="_produces">Produces</h3>
 <div class="ulist">
 <ul>
@@ -680,6 +671,16 @@ Fields attribute could be used to filter attributes retrieved</p>
 </tbody>
 </table>
 </div>
+<div class="sect4">
+<h5 id="_produces_2">Produces</h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code>application/json;charset=utf-8</code></p>
+</li>
+</ul>
+</div>
+</div>
 </div>
 <div class="sect3">
 <h4 id="_servicespecificationget">Retrieve a service specification</h4>
@@ -821,6 +822,16 @@ Fields attribute could be used to filter attributes retrieved</p>
 </tbody>
 </table>
 </div>
+<div class="sect4">
+<h5 id="_produces_3">Produces</h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code>application/json;charset=utf-8</code></p>
+</li>
+</ul>
+</div>
+</div>
 </div>
 </div>
 </div>
@@ -1471,7 +1482,7 @@ Please note that this attribute is managed in TMF - in future release we&#8217;l
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2018-03-21 17:15:23 UTC
+Last updated 2018-09-12 13:43:40 +00:00
 </div>
 </div>
 </body>