summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml
diff options
context:
space:
mode:
authorRene Robert <rene.robert@orange.com>2018-03-28 09:55:53 +0000
committerRene Robert <rene.robert@orange.com>2018-03-28 09:55:53 +0000
commit7afe844fb9f4171697ff5b82b86b2161ffbf2a78 (patch)
tree53be0e7b7608ce8cc76e8cd86525adcc54ca65f9 /docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml
parent96edbb638b5a3cac22ca17d2cc6537f57a688bd4 (diff)
add API documentations
Issue-ID: EXTAPI-40 Change-Id: If700a2e2700f7c19e22c8f5d11ddf425eb0075a5 Signed-off-by: Rene Robert <rene.robert@orange.com>
Diffstat (limited to 'docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml')
-rw-r--r--docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml110
1 files changed, 110 insertions, 0 deletions
diff --git a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml
new file mode 100644
index 0000000..8483238
--- /dev/null
+++ b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml
@@ -0,0 +1,110 @@
+@startuml
+
+enum LifecycleStatusValues {
+ NOT_CERTIFIED_CHECKOUT
+ NOT_CERTIFIED_CHECKIN
+ READY_FOR_CERTIFICATION
+ CERTIFICATION_IN_PROGRESS
+ CERTIFIED
+}
+enum DistributionStatus {
+ DISTRIBUTION_NOT_APPROVED
+ DISTRIBUTION_APPROVED
+ DISTRIBUTED
+ DISTRIBUTION_REJECTED
+}
+
+class ErrorRepresentation {
+ code:int
+ reason:string
+ message:string
+ status:string
+ referenceErrror:string
+ @type:string
+ @schemaLocation:string
+}
+
+class TimePeriod {
+ startDateTime:dateTime
+ endDateTime:dateTime
+}
+
+class RelatedPartyRef {
+ id:string
+ role:string
+ name:string
+}
+
+class ServiceSpecification {
+ id:string
+ href:string
+ name:string
+ description:string
+ @type:string
+ @schemaLocation:string
+ @baseType:string
+ invariantUUID:string
+ toscaModelURL:string
+ toscaResourceName:string
+ category:string
+ subcategory:string
+ version:string
+}
+ ServiceSpecification --> "0-1" DistributionStatus : distributionStatus
+ ServiceSpecification --> "0-1" LifecycleStatusValues : lifecycleStatus
+ ServiceSpecification --> "0-1" TargetServiceSchemaRef : targetServiceSchema
+ ServiceSpecification --> "0-*" Attachment : attachment
+ ServiceSpecification --> "0-*" RelatedPartyRef : relatedParty
+ ServiceSpecification --> "0-*" ResourceSpecificationRef : resourceSpecification
+ ServiceSpecification --> "0-*" ServiceSpecCharacteristic : serviceSpecCharacteristic
+
+class ServiceSpecCharacteristic {
+ name:string
+ description:string
+ valueType:string
+ @type:string
+ @schemaLocation:string
+ required:boolean
+ status:string
+}
+ ServiceSpecCharacteristic --> "0-*" ServiceSpecCharacteristicValue : serviceSpecCharacteristicValue
+
+class Attachment {
+ id:string
+ name:string
+ description:string
+ @type:string
+ artifactLabel:string
+ artifactGroupType:string
+ artifactTimeout:string
+ artifactChecksum:string
+ artifactVersion:string
+ generatedFromUUID:string
+ url:string
+ mimeType:string
+}
+
+class ServiceSpecCharacteristicValue {
+ valueType:string
+ isDefault:boolean
+ value:string
+}
+
+class ResourceSpecificationRef {
+ id:string
+ version:string
+ name:string
+ @type:string
+ resourceInstanceName:string
+ resourceInvariantUUID:string
+ resourceType:string
+ modelCustomizationName:string
+ modelCustomizationId:string
+}
+
+class TargetServiceSchemaRef {
+ @type:string
+ @schemaLocation:string
+}
+
+@enduml \ No newline at end of file