Add API Documentation for Casablanca

-update docs -update version related code -change properties MSB Change-Id: I7fb2a257ec035c53e93666d7571a2c74a0624524 Issue-ID: EXTAPI-141 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
author: romaingimbert <romain.gimbert@orange.com> 2018-09-14 14:52:20 +0200
committer: romaingimbert <romain.gimbert@orange.com> 2018-09-14 14:52:20 +0200
commit: 8f141d17f3ea7720df479f4ae51b5a2e169548cb (patch)
tree: 4d309f3d24202153d6ad50dfa41c2d8ee99b70c2 /docs/offeredapis/serviceCatalog
parent: 956d451af5e5ad5b5f0bbca34c5462455cc6d0ad (diff)
4 files changed, 58 insertions, 51 deletions
diff --git a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml
index 96e8164..8483238 100644
--- a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml
+++ b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml
@@ -1,7 +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'/
-
 @startuml
 
 enum LifecycleStatusValues {
diff --git a/docs/offeredapis/serviceCatalog/asciiDoc.adoc b/docs/offeredapis/serviceCatalog/asciiDoc.adoc
index c5185bd..9ce1396 100644
--- a/docs/offeredapis/serviceCatalog/asciiDoc.adoc
+++ b/docs/offeredapis/serviceCatalog/asciiDoc.adoc
@@ -1,9 +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
-////
-
 = API ServiceCatalog
 
 
@@ -12,10 +6,10 @@ Copyright 2018 Orange
 
 === Api URL
 
-https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/N3ma89X1x0/swagger.json[Swagger UI]
+https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json[Swagger UI]
 
 
-https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/N3ma89X1x0/plantuml&noCache=797767.0[plant UML UI]
+https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&noCache=995303.0[plant UML UI]
 
 serviceCatalog API designed for ONAP Beijing Release.
 This API is build from TMF open API17.5.
@@ -24,13 +18,13 @@ Only operation GET (by id &amp; byList) for resource serviceSpecification is ava
 
 === Version information
 [%hardbreaks]
-__Version__ : 1.0.0_inProgress
+__Version__ : 3.0.0_inProgress
 
 
 === URI scheme
 [%hardbreaks]
 __Host__ : serverRoot
-__BasePath__ : /nbi/api/v1
+__BasePath__ : /nbi/api/v3
 __Schemes__ : HTTPS
 
 
@@ -39,11 +33,6 @@ __Schemes__ : HTTPS
 * ServiceSpecification
 
 
-=== Consumes
-
-* `application/json;charset=utf-8`
-
-
 === Produces
 
 * `application/json;charset=utf-8`
@@ -136,6 +125,11 @@ List of supported error codes:
 |===
 
 
+===== Produces
+
+* `application/json;charset=utf-8`
+
+
 [[_servicespecificationget]]
 ==== Retrieve a service specification
 ....
@@ -213,6 +207,11 @@ List of supported error codes:
 |===
 
 
+===== Produces
+
+* `application/json;charset=utf-8`
+
+
 [[_definitions]]
 == Definitions
 
diff --git a/docs/offeredapis/serviceCatalog/documentation.html b/docs/offeredapis/serviceCatalog/documentation.html
index c81c1d8..94b011f 100644
--- a/docs/offeredapis/serviceCatalog/documentation.html
+++ b/docs/offeredapis/serviceCatalog/documentation.html
@@ -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>
diff --git a/docs/offeredapis/serviceCatalog/markDown.md b/docs/offeredapis/serviceCatalog/markDown.md
index 22d062e..7f1a02d 100644
--- a/docs/offeredapis/serviceCatalog/markDown.md
+++ b/docs/offeredapis/serviceCatalog/markDown.md
@@ -1,7 +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
-
 # API ServiceCatalog
 
 
@@ -10,10 +6,10 @@
 
 ### Api URL
 
-[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/N3ma89X1x0/swagger.json)
+[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json)
 
 
-[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/N3ma89X1x0/plantuml&noCache=797767.0)
+[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&noCache=995303.0)
 
 serviceCatalog API designed for ONAP Beijing Release.
 This API is build from TMF open API17.5. 
@@ -21,12 +17,12 @@ Only operation GET (by id & byList) for resource serviceSpecification is availab
 
 
 ### Version information
-*Version* : 1.0.0_inProgress
+*Version* : 3.0.0_inProgress
 
 
 ### URI scheme
 *Host* : serverRoot  
-*BasePath* : /nbi/api/v1  
+*BasePath* : /nbi/api/v3
 *Schemes* : HTTPS
 
 
@@ -35,11 +31,6 @@ Only operation GET (by id & byList) for resource serviceSpecification is availab
 * ServiceSpecification
 
 
-### Consumes
-
-* `application/json;charset=utf-8`
-
-
 ### Produces
 
 * `application/json;charset=utf-8`
@@ -91,6 +82,11 @@ HTTP Response 422 Unprocessable entity
 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 
 
+##### Produces
+
+* `application/json;charset=utf-8`
+
+
 <a name="servicespecificationget"></a>
 #### Retrieve a service specification
 ```
@@ -128,6 +124,11 @@ HTTP Response 422 Unprocessable entity
 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 
 
+##### Produces
+
+* `application/json;charset=utf-8`
+
+
 <a name="definitions"></a>
 ## Definitions
author	romaingimbert <romain.gimbert@orange.com>	2018-09-14 14:52:20 +0200
committer	romaingimbert <romain.gimbert@orange.com>	2018-09-14 14:52:20 +0200
commit	8f141d17f3ea7720df479f4ae51b5a2e169548cb (patch)
tree	4d309f3d24202153d6ad50dfa41c2d8ee99b70c2 /docs/offeredapis/serviceCatalog
parent	956d451af5e5ad5b5f0bbca34c5462455cc6d0ad (diff)