Update Swagger files
[externalapi/nbi.git] / docs / offeredapis / api_serviceInventory / api.plantuml
1 @startuml
2
3 enum eventType {
4    ServiceCreationNotification
5    ServiceAttributeValueChangeNotification
6    ServiceRemoveNotification
7 }
8
9 class ErrorRepresentation {
10    code:int
11    reason:string
12    message:string
13    status:string
14    referenceError:string
15    @type:string
16    @schemaLocation:string
17 }
18
19 class Service {
20    id:string
21    href:string
22    name:string
23    type:string
24    state:string
25    @type:string
26    @baseType:string
27    @schemaLocation:string
28 }
29    Service --> "0-1" ServiceSpecificationRef : serviceSpecification
30    Service --> "0-*" ServiceCharacteristic : characteristic
31    Service --> "0-*" SupportingResource : supportingResource
32    Service --> "0-*" RelatedPartyRef : relatedParty
33
34 class ServiceSpecificationRef {
35    id:string
36    href:string
37    name:string
38    version:string
39    @referredType:string
40    @schemaLocation:string
41    invariantUUID:string
42 }
43
44 class ServiceCharacteristic {
45    name:string
46    valueType:string
47 }
48    ServiceCharacteristic --> "0-1" Value : value
49
50 class SupportingResource {
51    id:string
52    href:string
53    role:string
54    name:string
55    @referredType:string
56    @schemaLocation:string
57    status:string
58    modelInvariantId:string
59    modelVersionId:string
60    modelCustomisationId:string
61 }
62
63 class RelatedPartyRef {
64    id:string
65    href:string
66    role:string
67    @referredType:string
68 }
69
70 class Value {
71    @type:string
72    @schemaLocation:string
73    serviceCharacteristicValue:string
74 }
75
76 class ListRelatedPartyRef {
77    id:string
78    role:string
79 }
80
81 class ListServiceSpecificationRef {
82    id:string
83    name:string
84 }
85
86 class ListService {
87    id:string
88    name:string
89 }
90    ListService --> "0-1" ListServiceSpecificationRef : serviceSpecification
91    ListService --> "0-1" ListRelatedPartyRef : relatedParty
92
93 class ServiceInventoryEvent {
94    id:string
95    href:string
96    name:string
97    type:string
98    state:string
99 }
100    ServiceInventoryEvent --> "1-1" RelatedPartyRef : relatedParty
101
102 class Notification {
103    eventId:string
104    eventDate:dateTime
105 }
106    Notification --> "1-1" eventType : eventType
107    Notification --> "1-1" ServiceInventoryEvent : event
108
109 @enduml