Skip to content

Commit 36b1b8c

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 39891ab commit 36b1b8c

File tree

75 files changed

+2428
-407
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+2428
-407
lines changed

‎oas/api/openapi.yaml‎

Lines changed: 331 additions & 20 deletions
Large diffs are not rendered by default.

‎uml/api/BaseResource.puml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -749,6 +749,7 @@ interface Subscription [[Subscription.svg]] extends BaseResource {
749749
destination: [[Destination.svg Destination]]
750750
key: String
751751
messages: [[MessageSubscription.svg List<MessageSubscription>]]
752+
events: [[EventSubscription.svg List<EventSubscription>]]
752753
format: [[DeliveryFormat.svg DeliveryFormat]]
753754
status: [[SubscriptionHealthStatus.svg SubscriptionHealthStatus]]
754755
}

‎uml/api/ChangeSubscription.puml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ interface Subscription [[Subscription.svg]] {
2525
destination: [[Destination.svg Destination]]
2626
key: String
2727
messages: [[MessageSubscription.svg List<MessageSubscription>]]
28+
events: [[EventSubscription.svg List<EventSubscription>]]
2829
format: [[DeliveryFormat.svg DeliveryFormat]]
2930
status: [[SubscriptionHealthStatus.svg SubscriptionHealthStatus]]
3031
}
@@ -33,6 +34,7 @@ interface SubscriptionDraft [[SubscriptionDraft.svg]] {
3334
destination: [[Destination.svg Destination]]
3435
key: String
3536
messages: [[MessageSubscription.svg List<MessageSubscription>]]
37+
events: [[EventSubscription.svg List<EventSubscription>]]
3638
format: [[DeliveryFormat.svg DeliveryFormat]]
3739
}
3840
interface SubscriptionSetChangesAction [[SubscriptionSetChangesAction.svg]] {

‎uml/api/CreatedBy.puml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -721,6 +721,7 @@ interface Subscription [[Subscription.svg]] {
721721
destination: [[Destination.svg Destination]]
722722
key: String
723723
messages: [[MessageSubscription.svg List<MessageSubscription>]]
724+
events: [[EventSubscription.svg List<EventSubscription>]]
724725
format: [[DeliveryFormat.svg DeliveryFormat]]
725726
status: [[SubscriptionHealthStatus.svg SubscriptionHealthStatus]]
726727
}

‎uml/api/DeliveryFormat.puml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ interface Subscription [[Subscription.svg]] {
3131
destination: [[Destination.svg Destination]]
3232
key: String
3333
messages: [[MessageSubscription.svg List<MessageSubscription>]]
34+
events: [[EventSubscription.svg List<EventSubscription>]]
3435
format: [[DeliveryFormat.svg DeliveryFormat]]
3536
status: [[SubscriptionHealthStatus.svg SubscriptionHealthStatus]]
3637
}
@@ -39,6 +40,7 @@ interface SubscriptionDraft [[SubscriptionDraft.svg]] {
3940
destination: [[Destination.svg Destination]]
4041
key: String
4142
messages: [[MessageSubscription.svg List<MessageSubscription>]]
43+
events: [[EventSubscription.svg List<EventSubscription>]]
4244
format: [[DeliveryFormat.svg DeliveryFormat]]
4345
}
4446
DeliveryFormat --> CloudEventsFormat #blue;text:blue : "type : CloudEvents"

‎uml/api/DeliveryPayload.puml‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,46 +9,51 @@ legend
99
|<back:blue> </back>| discriminated class |
1010
endlegend
1111
interface DeliveryPayload [[DeliveryPayload.svg]] {
12-
projectKey: String
1312
notificationType: String
14-
resource: [[Reference.svg Reference]]
15-
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
1613
}
1714

1815

16+
interface EventDeliveryPayload [[EventDeliveryPayload.svg]] {
17+
notificationType: String
18+
id: String
19+
type: [[EventType.svg EventType]]
20+
resourceType: String
21+
data: [[Object.svg Object]]
22+
createdAt: DateTime
23+
}
1924
interface MessageDeliveryPayload [[MessageDeliveryPayload.svg]] {
20-
projectKey: String
2125
notificationType: String
22-
resource: [[Reference.svg Reference]]
23-
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2426
id: String
2527
version: Long
28+
projectKey: String
2629
createdAt: DateTime
2730
lastModifiedAt: DateTime
2831
sequenceNumber: Long
2932
resourceVersion: Long
33+
resource: [[Reference.svg Reference]]
34+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
3035
payloadNotIncluded: [[PayloadNotIncluded.svg PayloadNotIncluded]]
3136
}
3237
interface ResourceCreatedDeliveryPayload [[ResourceCreatedDeliveryPayload.svg]] {
33-
projectKey: String
3438
notificationType: String
39+
projectKey: String
3540
resource: [[Reference.svg Reference]]
3641
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
3742
version: Long
3843
modifiedAt: DateTime
3944
}
4045
interface ResourceDeletedDeliveryPayload [[ResourceDeletedDeliveryPayload.svg]] {
41-
projectKey: String
4246
notificationType: String
47+
projectKey: String
4348
resource: [[Reference.svg Reference]]
4449
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
4550
version: Long
4651
modifiedAt: DateTime
4752
dataErasure: Boolean
4853
}
4954
interface ResourceUpdatedDeliveryPayload [[ResourceUpdatedDeliveryPayload.svg]] {
50-
projectKey: String
5155
notificationType: String
56+
projectKey: String
5257
resource: [[Reference.svg Reference]]
5358
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
5459
version: Long
@@ -67,6 +72,7 @@ interface CloudEventsPayload [[CloudEventsPayload.svg]] {
6772
dataref: String
6873
data: [[DeliveryPayload.svg DeliveryPayload]]
6974
}
75+
DeliveryPayload --> EventDeliveryPayload #blue;text:blue : "notificationType : Event"
7076
DeliveryPayload --> MessageDeliveryPayload #blue;text:blue : "notificationType : Message"
7177
DeliveryPayload --> ResourceCreatedDeliveryPayload #blue;text:blue : "notificationType : ResourceCreated"
7278
DeliveryPayload --> ResourceDeletedDeliveryPayload #blue;text:blue : "notificationType : ResourceDeleted"

‎uml/api/Destination.puml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ interface Subscription [[Subscription.svg]] {
7272
destination: [[Destination.svg Destination]]
7373
key: String
7474
messages: [[MessageSubscription.svg List<MessageSubscription>]]
75+
events: [[EventSubscription.svg List<EventSubscription>]]
7576
format: [[DeliveryFormat.svg DeliveryFormat]]
7677
status: [[SubscriptionHealthStatus.svg SubscriptionHealthStatus]]
7778
}
@@ -80,6 +81,7 @@ interface SubscriptionDraft [[SubscriptionDraft.svg]] {
8081
destination: [[Destination.svg Destination]]
8182
key: String
8283
messages: [[MessageSubscription.svg List<MessageSubscription>]]
84+
events: [[EventSubscription.svg List<EventSubscription>]]
8385
format: [[DeliveryFormat.svg DeliveryFormat]]
8486
}
8587
interface SubscriptionChangeDestinationAction [[SubscriptionChangeDestinationAction.svg]] {

‎uml/api/Event.puml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
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 Event [[Event.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+
interface ImportContainerCreatedEvent [[ImportContainerCreatedEvent.svg]] {
22+
id: String
23+
notificationType: String
24+
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
25+
type: [[EventType.svg EventType]]
26+
data: [[ImportContainerCreatedEventData.svg ImportContainerCreatedEventData]]
27+
createdAt: DateTime
28+
}
29+
interface ImportContainerDeletedEvent [[ImportContainerDeletedEvent.svg]] {
30+
id: String
31+
notificationType: String
32+
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
33+
type: [[EventType.svg EventType]]
34+
data: [[ImportContainerDeletedEventData.svg ImportContainerDeletedEventData]]
35+
createdAt: DateTime
36+
}
37+
interface ImportOperationRejectedEvent [[ImportOperationRejectedEvent.svg]] {
38+
id: String
39+
notificationType: String
40+
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
41+
type: [[EventType.svg EventType]]
42+
data: [[ImportOperationRejectedEventData.svg ImportOperationRejectedEventData]]
43+
createdAt: DateTime
44+
}
45+
interface ImportUnresolvedEvent [[ImportUnresolvedEvent.svg]] {
46+
id: String
47+
notificationType: String
48+
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
49+
type: [[EventType.svg EventType]]
50+
data: [[ImportUnresolvedEventData.svg ImportUnresolvedEventData]]
51+
createdAt: DateTime
52+
}
53+
interface ImportValidationFailedEvent [[ImportValidationFailedEvent.svg]] {
54+
id: String
55+
notificationType: String
56+
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
57+
type: [[EventType.svg EventType]]
58+
data: [[ImportValidationFailedEventData.svg ImportValidationFailedEventData]]
59+
createdAt: DateTime
60+
}
61+
interface ImportWaitForMasterVariantEvent [[ImportWaitForMasterVariantEvent.svg]] {
62+
id: String
63+
notificationType: String
64+
resourceType: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
65+
type: [[EventType.svg EventType]]
66+
data: [[ImportWaitForMasterVariantEventData.svg ImportWaitForMasterVariantEventData]]
67+
createdAt: DateTime
68+
}
69+
70+
Event --> ImportContainerCreatedEvent #blue;text:blue : "type : ImportContainerCreated"
71+
Event --> ImportContainerDeletedEvent #blue;text:blue : "type : ImportContainerDeleted"
72+
Event --> ImportOperationRejectedEvent #blue;text:blue : "type : ImportOperationRejected"
73+
Event --> ImportUnresolvedEvent #blue;text:blue : "type : ImportUnresolved"
74+
Event --> ImportValidationFailedEvent #blue;text:blue : "type : ImportValidationFailed"
75+
Event --> ImportWaitForMasterVariantEvent #blue;text:blue : "type : ImportWaitForMasterVariant"
76+
77+
@enduml

‎uml/api/EventDeliveryPayload.puml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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 EventDeliveryPayload [[EventDeliveryPayload.svg]] extends DeliveryPayload {
12+
notificationType: String
13+
id: String
14+
type: [[EventType.svg EventType]]
15+
resourceType: String
16+
data: [[Object.svg Object]]
17+
createdAt: DateTime
18+
}
19+
interface DeliveryPayload [[DeliveryPayload.svg]] {
20+
notificationType: String
21+
}
22+
23+
24+
25+
26+
27+
@enduml

‎uml/api/EventSubscription.puml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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 EventSubscription [[EventSubscription.svg]] {
12+
resourceTypeId: [[EventSubscriptionResourceTypeId.svg EventSubscriptionResourceTypeId]]
13+
types: [[EventType.svg List<EventType>]]
14+
}
15+
16+
17+
18+
interface Subscription [[Subscription.svg]] {
19+
id: String
20+
version: Long
21+
createdAt: DateTime
22+
lastModifiedAt: DateTime
23+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
24+
createdBy: [[CreatedBy.svg CreatedBy]]
25+
changes: [[ChangeSubscription.svg List<ChangeSubscription>]]
26+
destination: [[Destination.svg Destination]]
27+
key: String
28+
messages: [[MessageSubscription.svg List<MessageSubscription>]]
29+
events: [[EventSubscription.svg List<EventSubscription>]]
30+
format: [[DeliveryFormat.svg DeliveryFormat]]
31+
status: [[SubscriptionHealthStatus.svg SubscriptionHealthStatus]]
32+
}
33+
interface SubscriptionDraft [[SubscriptionDraft.svg]] {
34+
changes: [[ChangeSubscription.svg List<ChangeSubscription>]]
35+
destination: [[Destination.svg Destination]]
36+
key: String
37+
messages: [[MessageSubscription.svg List<MessageSubscription>]]
38+
events: [[EventSubscription.svg List<EventSubscription>]]
39+
format: [[DeliveryFormat.svg DeliveryFormat]]
40+
}
41+
interface SubscriptionSetEventsAction [[SubscriptionSetEventsAction.svg]] {
42+
action: String
43+
messages: [[EventSubscription.svg List<EventSubscription>]]
44+
}
45+
46+
EventSubscription --> Subscription #green;text:green : "events"
47+
EventSubscription --> SubscriptionDraft #green;text:green : "events"
48+
EventSubscription --> SubscriptionSetEventsAction #green;text:green : "messages"
49+
@enduml

0 commit comments

Comments
 (0)