Skip to content

Commit 1b994c8

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 317da98 commit 1b994c8

33 files changed

+235
-134
lines changed

oas/api/openapi.yaml

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49368,6 +49368,29 @@ components:
4936849368
type: "string"
4936949369
additionalProperties:
4937049370
type: "string"
49371+
BaseEvent:
49372+
type: "object"
49373+
required:
49374+
- createdAt
49375+
- data
49376+
- id
49377+
- notificationType
49378+
- resourceType
49379+
- type
49380+
properties:
49381+
id:
49382+
type: "string"
49383+
notificationType:
49384+
type: "string"
49385+
resourceType:
49386+
$ref: '#/components/schemas/EventSubscriptionResourceTypeId'
49387+
type:
49388+
$ref: '#/components/schemas/EventType'
49389+
data:
49390+
type: "object"
49391+
createdAt:
49392+
type: "string"
49393+
format: "datetime"
4937149394
Event:
4937249395
type: "object"
4937349396
discriminator:
@@ -49381,7 +49404,6 @@ components:
4938149404
ImportWaitForMasterVariant: '#/components/schemas/ImportWaitForMasterVariantEvent'
4938249405
required:
4938349406
- createdAt
49384-
- data
4938549407
- id
4938649408
- notificationType
4938749409
- resourceType
@@ -49395,8 +49417,6 @@ components:
4939549417
$ref: '#/components/schemas/EventSubscriptionResourceTypeId'
4939649418
type:
4939749419
$ref: '#/components/schemas/EventType'
49398-
data:
49399-
type: "object"
4940049420
createdAt:
4940149421
type: "string"
4940249422
format: "datetime"
@@ -49416,11 +49436,11 @@ components:
4941649436
$ref: '#/components/schemas/EventSubscriptionResourceTypeId'
4941749437
type:
4941849438
$ref: '#/components/schemas/EventType'
49419-
data:
49420-
$ref: '#/components/schemas/ImportContainerCreatedEventData'
4942149439
createdAt:
4942249440
type: "string"
4942349441
format: "datetime"
49442+
data:
49443+
$ref: '#/components/schemas/ImportContainerCreatedEventData'
4942449444
ImportContainerCreatedEventData:
4942549445
type: "object"
4942649446
required:
@@ -49456,11 +49476,11 @@ components:
4945649476
$ref: '#/components/schemas/EventSubscriptionResourceTypeId'
4945749477
type:
4945849478
$ref: '#/components/schemas/EventType'
49459-
data:
49460-
$ref: '#/components/schemas/ImportContainerDeletedEventData'
4946149479
createdAt:
4946249480
type: "string"
4946349481
format: "datetime"
49482+
data:
49483+
$ref: '#/components/schemas/ImportContainerDeletedEventData'
4946449484
ImportContainerDeletedEventData:
4946549485
type: "object"
4946649486
required:
@@ -49488,11 +49508,11 @@ components:
4948849508
$ref: '#/components/schemas/EventSubscriptionResourceTypeId'
4948949509
type:
4949049510
$ref: '#/components/schemas/EventType'
49491-
data:
49492-
$ref: '#/components/schemas/ImportOperationRejectedEventData'
4949349511
createdAt:
4949449512
type: "string"
4949549513
format: "datetime"
49514+
data:
49515+
$ref: '#/components/schemas/ImportOperationRejectedEventData'
4949649516
ImportOperationRejectedEventData:
4949749517
type: "object"
4949849518
required:
@@ -49516,11 +49536,11 @@ components:
4951649536
$ref: '#/components/schemas/EventSubscriptionResourceTypeId'
4951749537
type:
4951849538
$ref: '#/components/schemas/EventType'
49519-
data:
49520-
$ref: '#/components/schemas/ImportUnresolvedEventData'
4952149539
createdAt:
4952249540
type: "string"
4952349541
format: "datetime"
49542+
data:
49543+
$ref: '#/components/schemas/ImportUnresolvedEventData'
4952449544
ImportUnresolvedEventData:
4952549545
type: "object"
4952649546
required:
@@ -49551,11 +49571,11 @@ components:
4955149571
$ref: '#/components/schemas/EventSubscriptionResourceTypeId'
4955249572
type:
4955349573
$ref: '#/components/schemas/EventType'
49554-
data:
49555-
$ref: '#/components/schemas/ImportValidationFailedEventData'
4955649574
createdAt:
4955749575
type: "string"
4955849576
format: "datetime"
49577+
data:
49578+
$ref: '#/components/schemas/ImportValidationFailedEventData'
4955949579
ImportValidationFailedEventData:
4956049580
type: "object"
4956149581
required:
@@ -49586,11 +49606,11 @@ components:
4958649606
$ref: '#/components/schemas/EventSubscriptionResourceTypeId'
4958749607
type:
4958849608
$ref: '#/components/schemas/EventType'
49589-
data:
49590-
$ref: '#/components/schemas/ImportWaitForMasterVariantEventData'
4959149609
createdAt:
4959249610
type: "string"
4959349611
format: "datetime"
49612+
data:
49613+
$ref: '#/components/schemas/ImportWaitForMasterVariantEventData'
4959449614
ImportWaitForMasterVariantEventData:
4959549615
type: "object"
4959649616
required:

uml/api/BaseEvent.puml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
@startuml
2+
3+
hide empty fields
4+
hide empty methods
5+
legend
6+
|= |= line |
7+
|<back:black> </back>| inheritance |
8+
|<back:green> </back>| property reference |
9+
|<back:blue> </back>| discriminated class |
10+
endlegend
11+
interface BaseEvent [[BaseEvent.svg]] {
12+
id: String
13+
notificationType: String
14+
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
15+
type: [[EventType.svg EventType]]
16+
data: [[Object.svg Object]]
17+
createdAt: DateTime
18+
}
19+
20+
21+
22+
23+
24+
25+
@enduml

uml/api/Event.puml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ interface Event [[Event.svg]] {
1313
notificationType: String
1414
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
1515
type: [[EventType.svg EventType]]
16-
data: [[Object.svg Object]]
1716
createdAt: DateTime
1817
}
1918

@@ -23,48 +22,48 @@ interface ImportContainerCreatedEvent [[ImportContainerCreatedEvent.svg]] {
2322
notificationType: String
2423
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
2524
type: [[EventType.svg EventType]]
26-
data: [[ImportContainerCreatedEventData.svg ImportContainerCreatedEventData]]
2725
createdAt: DateTime
26+
data: [[ImportContainerCreatedEventData.svg ImportContainerCreatedEventData]]
2827
}
2928
interface ImportContainerDeletedEvent [[ImportContainerDeletedEvent.svg]] {
3029
id: String
3130
notificationType: String
3231
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
3332
type: [[EventType.svg EventType]]
34-
data: [[ImportContainerDeletedEventData.svg ImportContainerDeletedEventData]]
3533
createdAt: DateTime
34+
data: [[ImportContainerDeletedEventData.svg ImportContainerDeletedEventData]]
3635
}
3736
interface ImportOperationRejectedEvent [[ImportOperationRejectedEvent.svg]] {
3837
id: String
3938
notificationType: String
4039
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
4140
type: [[EventType.svg EventType]]
42-
data: [[ImportOperationRejectedEventData.svg ImportOperationRejectedEventData]]
4341
createdAt: DateTime
42+
data: [[ImportOperationRejectedEventData.svg ImportOperationRejectedEventData]]
4443
}
4544
interface ImportUnresolvedEvent [[ImportUnresolvedEvent.svg]] {
4645
id: String
4746
notificationType: String
4847
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
4948
type: [[EventType.svg EventType]]
50-
data: [[ImportUnresolvedEventData.svg ImportUnresolvedEventData]]
5149
createdAt: DateTime
50+
data: [[ImportUnresolvedEventData.svg ImportUnresolvedEventData]]
5251
}
5352
interface ImportValidationFailedEvent [[ImportValidationFailedEvent.svg]] {
5453
id: String
5554
notificationType: String
5655
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
5756
type: [[EventType.svg EventType]]
58-
data: [[ImportValidationFailedEventData.svg ImportValidationFailedEventData]]
5957
createdAt: DateTime
58+
data: [[ImportValidationFailedEventData.svg ImportValidationFailedEventData]]
6059
}
6160
interface ImportWaitForMasterVariantEvent [[ImportWaitForMasterVariantEvent.svg]] {
6261
id: String
6362
notificationType: String
6463
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
6564
type: [[EventType.svg EventType]]
66-
data: [[ImportWaitForMasterVariantEventData.svg ImportWaitForMasterVariantEventData]]
6765
createdAt: DateTime
66+
data: [[ImportWaitForMasterVariantEventData.svg ImportWaitForMasterVariantEventData]]
6867
}
6968

7069
Event --> ImportContainerCreatedEvent #blue;text:blue : "type : ImportContainerCreated"

uml/api/EventSubscriptionResourceTypeId.puml

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,74 @@ hide methods
44
enum EventSubscriptionResourceTypeId {
55
IMPORT_API
66
}
7-
interface Event [[Event.svg]] {
7+
interface BaseEvent [[BaseEvent.svg]] {
88
id: String
99
notificationType: String
1010
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
1111
type: [[EventType.svg EventType]]
1212
data: [[Object.svg Object]]
1313
createdAt: DateTime
1414
}
15+
interface Event [[Event.svg]] {
16+
id: String
17+
notificationType: String
18+
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
19+
type: [[EventType.svg EventType]]
20+
createdAt: DateTime
21+
}
1522
interface ImportContainerCreatedEvent [[ImportContainerCreatedEvent.svg]] {
1623
id: String
1724
notificationType: String
1825
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
1926
type: [[EventType.svg EventType]]
20-
data: [[ImportContainerCreatedEventData.svg ImportContainerCreatedEventData]]
2127
createdAt: DateTime
28+
data: [[ImportContainerCreatedEventData.svg ImportContainerCreatedEventData]]
2229
}
2330
interface ImportContainerDeletedEvent [[ImportContainerDeletedEvent.svg]] {
2431
id: String
2532
notificationType: String
2633
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
2734
type: [[EventType.svg EventType]]
28-
data: [[ImportContainerDeletedEventData.svg ImportContainerDeletedEventData]]
2935
createdAt: DateTime
36+
data: [[ImportContainerDeletedEventData.svg ImportContainerDeletedEventData]]
3037
}
3138
interface ImportOperationRejectedEvent [[ImportOperationRejectedEvent.svg]] {
3239
id: String
3340
notificationType: String
3441
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
3542
type: [[EventType.svg EventType]]
36-
data: [[ImportOperationRejectedEventData.svg ImportOperationRejectedEventData]]
3743
createdAt: DateTime
44+
data: [[ImportOperationRejectedEventData.svg ImportOperationRejectedEventData]]
3845
}
3946
interface ImportUnresolvedEvent [[ImportUnresolvedEvent.svg]] {
4047
id: String
4148
notificationType: String
4249
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
4350
type: [[EventType.svg EventType]]
44-
data: [[ImportUnresolvedEventData.svg ImportUnresolvedEventData]]
4551
createdAt: DateTime
52+
data: [[ImportUnresolvedEventData.svg ImportUnresolvedEventData]]
4653
}
4754
interface ImportValidationFailedEvent [[ImportValidationFailedEvent.svg]] {
4855
id: String
4956
notificationType: String
5057
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
5158
type: [[EventType.svg EventType]]
52-
data: [[ImportValidationFailedEventData.svg ImportValidationFailedEventData]]
5359
createdAt: DateTime
60+
data: [[ImportValidationFailedEventData.svg ImportValidationFailedEventData]]
5461
}
5562
interface ImportWaitForMasterVariantEvent [[ImportWaitForMasterVariantEvent.svg]] {
5663
id: String
5764
notificationType: String
5865
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
5966
type: [[EventType.svg EventType]]
60-
data: [[ImportWaitForMasterVariantEventData.svg ImportWaitForMasterVariantEventData]]
6167
createdAt: DateTime
68+
data: [[ImportWaitForMasterVariantEventData.svg ImportWaitForMasterVariantEventData]]
6269
}
6370
interface EventSubscription [[EventSubscription.svg]] {
6471
resourceTypeId: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
6572
types: [[EventType.svg List<EventType>]]
6673
}
74+
EventSubscriptionResourceTypeId --> BaseEvent #green;text:green : "resourceType"
6775
EventSubscriptionResourceTypeId --> Event #green;text:green : "resourceType"
6876
EventSubscriptionResourceTypeId --> ImportContainerCreatedEvent #green;text:green : "resourceType"
6977
EventSubscriptionResourceTypeId --> ImportContainerDeletedEvent #green;text:green : "resourceType"

uml/api/EventType.puml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,21 @@ enum EventType {
99
IMPORT_VALIDATION_FAILED
1010
IMPORT_WAIT_FOR_MASTER_VARIANT
1111
}
12-
interface Event [[Event.svg]] {
12+
interface BaseEvent [[BaseEvent.svg]] {
1313
id: String
1414
notificationType: String
1515
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
1616
type: [[EventType.svg EventType]]
1717
data: [[Object.svg Object]]
1818
createdAt: DateTime
1919
}
20+
interface Event [[Event.svg]] {
21+
id: String
22+
notificationType: String
23+
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
24+
type: [[EventType.svg EventType]]
25+
createdAt: DateTime
26+
}
2027
interface EventDeliveryPayload [[EventDeliveryPayload.svg]] {
2128
notificationType: String
2229
id: String
@@ -29,6 +36,7 @@ interface EventSubscription [[EventSubscription.svg]] {
2936
resourceTypeId: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
3037
types: [[EventType.svg List<EventType>]]
3138
}
39+
EventType --> BaseEvent #green;text:green : "type"
3240
EventType --> Event #green;text:green : "type"
3341
EventType --> EventDeliveryPayload #green;text:green : "type"
3442
EventType --> EventSubscription #green;text:green : "types"

uml/api/ImportContainerCreatedEvent.puml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,14 @@ interface ImportContainerCreatedEvent [[ImportContainerCreatedEvent.svg]] extend
1313
notificationType: String
1414
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
1515
type: [[EventType.svg EventType]]
16-
data: [[ImportContainerCreatedEventData.svg ImportContainerCreatedEventData]]
1716
createdAt: DateTime
17+
data: [[ImportContainerCreatedEventData.svg ImportContainerCreatedEventData]]
1818
}
1919
interface Event [[Event.svg]] {
2020
id: String
2121
notificationType: String
2222
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
2323
type: [[EventType.svg EventType]]
24-
data: [[Object.svg Object]]
2524
createdAt: DateTime
2625
}
2726

uml/api/ImportContainerCreatedEventData.puml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ interface ImportContainerCreatedEvent [[ImportContainerCreatedEvent.svg]] {
2222
notificationType: String
2323
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
2424
type: [[EventType.svg EventType]]
25-
data: [[ImportContainerCreatedEventData.svg ImportContainerCreatedEventData]]
2625
createdAt: DateTime
26+
data: [[ImportContainerCreatedEventData.svg ImportContainerCreatedEventData]]
2727
}
2828

2929
ImportContainerCreatedEventData --> ImportContainerCreatedEvent #green;text:green : "data"

uml/api/ImportContainerDeletedEvent.puml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,14 @@ interface ImportContainerDeletedEvent [[ImportContainerDeletedEvent.svg]] extend
1313
notificationType: String
1414
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
1515
type: [[EventType.svg EventType]]
16-
data: [[ImportContainerDeletedEventData.svg ImportContainerDeletedEventData]]
1716
createdAt: DateTime
17+
data: [[ImportContainerDeletedEventData.svg ImportContainerDeletedEventData]]
1818
}
1919
interface Event [[Event.svg]] {
2020
id: String
2121
notificationType: String
2222
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
2323
type: [[EventType.svg EventType]]
24-
data: [[Object.svg Object]]
2524
createdAt: DateTime
2625
}
2726

uml/api/ImportContainerDeletedEventData.puml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ interface ImportContainerDeletedEvent [[ImportContainerDeletedEvent.svg]] {
2020
notificationType: String
2121
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
2222
type: [[EventType.svg EventType]]
23-
data: [[ImportContainerDeletedEventData.svg ImportContainerDeletedEventData]]
2423
createdAt: DateTime
24+
data: [[ImportContainerDeletedEventData.svg ImportContainerDeletedEventData]]
2525
}
2626

2727
ImportContainerDeletedEventData --> ImportContainerDeletedEvent #green;text:green : "data"

0 commit comments

Comments
 (0)