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>

4 files changed, 63 insertions, 81 deletions

diff --git a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml
index a7ecc66..2c08be7 100644
--- a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml
+++ b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml
@@ -1,17 +1,5 @@
-/' 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 stateValues {
-   feasibilityChecked
-   designed
-   reserved
-   inactive
-   active
-   terminated
-}
 
 class ErrorRepresentation {
    code:int
@@ -28,12 +16,12 @@ class Service {
    href:string
    name:string
    type:string
+   state:string
    hasStarted:boolean
    @type:string
    @baseType:string
    @schemaLocation:string
 }
-   Service --> "0-1" stateValues : state
    Service --> "0-1" ServiceSpecificationRef : serviceSpecification
    Service --> "0-*" ServiceCharacteristic : characteristic
    Service --> "0-*" SupportingResource : supportingResource
diff --git a/docs/offeredapis/serviceInventory/asciiDoc.adoc b/docs/offeredapis/serviceInventory/asciiDoc.adoc
index 548a6a9..e34ec44 100644
--- a/docs/offeredapis/serviceInventory/asciiDoc.adoc
+++ b/docs/offeredapis/serviceInventory/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 ServiceInventory
 
 
@@ -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/5an735gnX0/swagger.json[Swagger UI]
+https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/swagger.json[Swagger UI]
 
 
-https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5an735gnX0/plantuml&noCache=304710.0[plant UML UI]
+https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/plantuml&noCache=137264.0[plant UML UI]
 
 serviceInventory API designed for ONAP Beijing Release.
 This API is build from TMF open API18.0 (applying TMF Guideline 3.0)
@@ -24,13 +18,13 @@ only operation GET (by id & 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
 * Service
 
 
-=== Consumes
-
-* `application/json;charset=utf-8`
-
-
 === Produces
 
 * `application/json;charset=utf-8`
@@ -140,6 +129,11 @@ List of supported error codes:
 |===
 
 
+===== Produces
+
+* `application/json;charset=utf-8`
+
+
 [[_serviceget]]
 ==== Retrieve a service
 ....
@@ -222,6 +216,11 @@ List of supported error codes:
 |===
 
 
+===== Produces
+
+* `application/json;charset=utf-8`
+
+
 [[_definitions]]
 == Definitions
 
@@ -353,7 +352,7 @@ __optional__||< <<_relatedpartyref,RelatedPartyRef>> > array
 |**serviceSpecification** +
 __optional__||<<_servicespecificationref,ServiceSpecificationRef>>
 |**state** +
-__optional__||<<_statevalues,stateValues>>
+__optional__|State of the service. Not managed in Beijing release|string
 |**supportingResource** +
 __optional__||< <<_supportingresource,SupportingResource>> > array
 |**type** +
@@ -460,8 +459,3 @@ __optional__|Not managed in Beijing release.|string
 __optional__|Not managed in Beijing release.|string
 |===
 
-
-[[_statevalues]]
-=== stateValues
-__Type__ : enum (feasibilityChecked, designed, reserved, inactive, active, terminated)
-
diff --git a/docs/offeredapis/serviceInventory/documentation.html b/docs/offeredapis/serviceInventory/documentation.html
index a55605a..f7fb115 100644
--- a/docs/offeredapis/serviceInventory/documentation.html
+++ b/docs/offeredapis/serviceInventory/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>
@@ -463,7 +457,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <li><a href="#_servicespecificationref">ServiceSpecificationRef</a></li>
 <li><a href="#_supportingresource">SupportingResource</a></li>
 <li><a href="#_value">Value</a></li>
-<li><a href="#_statevalues">stateValues</a></li>
 </ul>
 </li>
 </ul>
@@ -474,6 +467,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/5ymwb6l1dR/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/5ymwb6l1dR/plantuml&amp;noCache=137264.0">plant UML UI</a></p>
+</div>
 <div class="paragraph">
 <p>serviceInventory API designed for ONAP Beijing Release.
 This API is build from TMF open API18.0 (applying TMF Guideline 3.0)
@@ -483,14 +483,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 +505,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>
@@ -687,6 +677,16 @@ fields attribute may be used to filter retrieved attribute(s) for each service</
 </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="_serviceget">Retrieve a service</h4>
@@ -837,6 +837,16 @@ Attribute selection is enabled for all first level attributes.</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>
@@ -1156,8 +1166,8 @@ Not managed in Beijing release</p></td>
 <tr>
 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</strong><br>
 <em>optional</em></p></td>
-<td class="tableblock halign-left valign-middle"></td>
-<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_statevalues">stateValues</a></p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">State of the service. Not managed in Beijing release</p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>supportingResource</strong><br>
@@ -1410,18 +1420,12 @@ Not managed in Beijing release.</p>
 </tbody>
 </table>
 </div>
-<div class="sect2">
-<h3 id="_statevalues">stateValues</h3>
-<div class="paragraph">
-<p><em>Type</em> : enum (feasibilityChecked, designed, reserved, inactive, active, terminated)</p>
-</div>
-</div>
 </div>
 </div>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2018-03-22 09:31:41 UTC
+Last updated 2018-09-12 13:43:17 +00:00
 </div>
 </div>
 </body>
diff --git a/docs/offeredapis/serviceInventory/markDown.md b/docs/offeredapis/serviceInventory/markDown.md
index 223c13b..c65263b 100644
--- a/docs/offeredapis/serviceInventory/markDown.md
+++ b/docs/offeredapis/serviceInventory/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 ServiceInventory
 
 
@@ -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/5an735gnX0/swagger.json)
+[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/swagger.json)
 
 
-[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5an735gnX0/plantuml&noCache=304710.0)
+[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/plantuml&noCache=137264.0)
 
 serviceInventory API designed for ONAP Beijing Release.
 This API is build from TMF open API18.0 (applying TMF Guideline 3.0)
@@ -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
 * Service
 
 
-### Consumes
-
-* `application/json;charset=utf-8`
-
-
 ### Produces
 
 * `application/json;charset=utf-8`
@@ -93,6 +84,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="serviceget"></a>
 #### Retrieve a service
 ```
@@ -133,6 +129,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
 
@@ -219,7 +220,7 @@ Instantiated service (service_instance) in AAI
 |**name**  <br>*optional*|Name of the service - Valued with service-instance-name|string|
 |**relatedParty**  <br>*optional*||< [RelatedPartyRef](#relatedpartyref) > array|
 |**serviceSpecification**  <br>*optional*||[ServiceSpecificationRef](#servicespecificationref)|
-|**state**  <br>*optional*||[stateValues](#statevalues)|
+|**state**  <br>*optional*|State of the service. Not managed in Beijing release|string|
 |**supportingResource**  <br>*optional*||< [SupportingResource](#supportingresource) > array|
 |**type**  <br>*optional*|Service type - valued with 'service-instance'|string|
 
@@ -284,8 +285,3 @@ Not managed in Beijing release.
 |**@type**  <br>*optional*|Not managed in Beijing release.|string|
 |**serviceCharacteristicValue**  <br>*optional*|Not managed in Beijing release.|string|
 
-
-<a name="statevalues"></a>
-### stateValues
-*Type* : enum (feasibilityChecked, designed, reserved, inactive, active, terminated)
-