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