summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/serviceCatalog/markDown.md
diff options
context:
space:
mode:
authorromaingimbert <romain.gimbert@orange.com>2018-09-14 14:52:20 +0200
committerromaingimbert <romain.gimbert@orange.com>2018-09-14 14:52:20 +0200
commit8f141d17f3ea7720df479f4ae51b5a2e169548cb (patch)
tree4d309f3d24202153d6ad50dfa41c2d8ee99b70c2 /docs/offeredapis/serviceCatalog/markDown.md
parent956d451af5e5ad5b5f0bbca34c5462455cc6d0ad (diff)
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>
Diffstat (limited to 'docs/offeredapis/serviceCatalog/markDown.md')
-rw-r--r--docs/offeredapis/serviceCatalog/markDown.md27
1 files changed, 14 insertions, 13 deletions
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