add API documentations

Issue-ID: EXTAPI-40

Change-Id: If700a2e2700f7c19e22c8f5d11ddf425eb0075a5
Signed-off-by: Rene Robert <rene.robert@orange.com>

1 files changed, 97 insertions, 0 deletions

diff --git a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml
new file mode 100644
index 0000000..447f3fe
--- /dev/null
+++ b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml
@@ -0,0 +1,97 @@
+@startuml
+
+enum stateValues {
+   feasibilityChecked
+   designed
+   reserved
+   inactive
+   active
+   terminated
+}
+
+class ErrorRepresentation {
+   code:int
+   reason:string
+   message:string
+   status:string
+   referenceError:string
+   @type:string
+   @schemaLocation:string
+}
+
+class Service {
+   id:string
+   href:string
+   name:string
+   type: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
+   Service --> "0-*" RelatedPartyRef : relatedParty
+
+class ServiceSpecificationRef {
+   id:string
+   href:string
+   name:string
+   version:string
+   @referredType:string
+   @schemaLocation:string
+   invariantUUID:string
+}
+
+class ServiceCharacteristic {
+   name:string
+   valueType:string
+}
+   ServiceCharacteristic --> "0-1" Value : value
+
+class SupportingResource {
+   id:string
+   href:string
+   role:string
+   name:string
+   @referredType:string
+   @schemaLocation:string
+   status:string
+   modelInvariantId:string
+   modelVersionId:string
+   modelCustomisationId:string
+}
+
+class RelatedPartyRef {
+   id:string
+   href:string
+   role:string
+   @referredType:string
+}
+
+class Value {
+   @type:string
+   @schemaLocation:string
+   serviceCharacteristicValue:string
+}
+
+class ListRelatedPartyRef {
+   id:string
+   role:string
+}
+
+class ListServiceSpecificationRef {
+   id:string
+   name:string
+}
+
+class ListService {
+   id:string
+   name:string
+}
+   ListService --> "0-1" ListServiceSpecificationRef : serviceSpecification
+   ListService --> "0-1" ListRelatedPartyRef : relatedParty
+
+@enduml
\ No newline at end of file