96e8164c446ad2de36c07f2f0cca6ec7c78dc372
[externalapi/nbi.git] / docs / offeredapis / serviceCatalog / apiServiceCatalog.plantuml
1 /' This work is licensed under a Creative Commons Attribution 4.0 International License.
2    http://creativecommons.org/licenses/by/4.0
3    Copyright 2018 Orange'/
4
5 @startuml
6
7 enum LifecycleStatusValues {
8    NOT_CERTIFIED_CHECKOUT
9    NOT_CERTIFIED_CHECKIN
10    READY_FOR_CERTIFICATION
11    CERTIFICATION_IN_PROGRESS
12    CERTIFIED
13 }
14 enum DistributionStatus {
15    DISTRIBUTION_NOT_APPROVED
16    DISTRIBUTION_APPROVED
17    DISTRIBUTED
18    DISTRIBUTION_REJECTED
19 }
20
21 class ErrorRepresentation {
22    code:int
23    reason:string
24    message:string
25    status:string
26    referenceErrror:string
27    @type:string
28    @schemaLocation:string
29 }
30
31 class TimePeriod {
32    startDateTime:dateTime
33    endDateTime:dateTime
34 }
35
36 class RelatedPartyRef {
37    id:string
38    role:string
39    name:string
40 }
41
42 class ServiceSpecification {
43    id:string
44    href:string
45    name:string
46    description:string
47    @type:string
48    @schemaLocation:string
49    @baseType:string
50    invariantUUID:string
51    toscaModelURL:string
52    toscaResourceName:string
53    category:string
54    subcategory:string
55    version:string
56 }
57    ServiceSpecification --> "0-1" DistributionStatus : distributionStatus
58    ServiceSpecification --> "0-1" LifecycleStatusValues : lifecycleStatus
59    ServiceSpecification --> "0-1" TargetServiceSchemaRef : targetServiceSchema
60    ServiceSpecification --> "0-*" Attachment : attachment
61    ServiceSpecification --> "0-*" RelatedPartyRef : relatedParty
62    ServiceSpecification --> "0-*" ResourceSpecificationRef : resourceSpecification
63    ServiceSpecification --> "0-*" ServiceSpecCharacteristic : serviceSpecCharacteristic
64
65 class ServiceSpecCharacteristic {
66    name:string
67    description:string
68    valueType:string
69    @type:string
70    @schemaLocation:string
71    required:boolean
72    status:string
73 }
74    ServiceSpecCharacteristic --> "0-*" ServiceSpecCharacteristicValue : serviceSpecCharacteristicValue
75
76 class Attachment {
77    id:string
78    name:string
79    description:string
80    @type:string
81    artifactLabel:string
82    artifactGroupType:string
83    artifactTimeout:string
84    artifactChecksum:string
85    artifactVersion:string
86    generatedFromUUID:string
87    url:string
88    mimeType:string
89 }
90
91 class ServiceSpecCharacteristicValue {
92    valueType:string
93    isDefault:boolean
94    value:string
95 }
96
97 class ResourceSpecificationRef {
98    id:string
99    version:string
100    name:string
101    @type:string
102    resourceInstanceName:string
103    resourceInvariantUUID:string
104    resourceType:string
105    modelCustomizationName:string
106    modelCustomizationId:string
107 }
108
109 class TargetServiceSchemaRef {
110    @type:string
111    @schemaLocation:string
112 }
113
114 @enduml