Skip to content

Commit f222748

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent e9a38f3 commit f222748

21 files changed

+344
-310
lines changed

‎oas/api/openapi.yaml‎

Lines changed: 41 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -79073,20 +79073,29 @@ components:
7907379073
type:
7907479074
type: "string"
7907579075
DeliveryPayload:
79076-
type: "object"
79077-
discriminator:
79078-
propertyName: notificationType
79079-
mapping:
79080-
Event: '#/components/schemas/EventDeliveryPayload'
79081-
Message: '#/components/schemas/MessageDeliveryPayload'
79082-
ResourceCreated: '#/components/schemas/ResourceCreatedDeliveryPayload'
79083-
ResourceDeleted: '#/components/schemas/ResourceDeletedDeliveryPayload'
79084-
ResourceUpdated: '#/components/schemas/ResourceUpdatedDeliveryPayload'
79085-
required:
79086-
- notificationType
79087-
properties:
79088-
notificationType:
79089-
type: "string"
79076+
allOf:
79077+
- $ref: '#/components/schemas/SubscriptionNotification'
79078+
- type: "object"
79079+
discriminator:
79080+
propertyName: notificationType
79081+
mapping:
79082+
Message: '#/components/schemas/MessageDeliveryPayload'
79083+
ResourceCreated: '#/components/schemas/ResourceCreatedDeliveryPayload'
79084+
ResourceDeleted: '#/components/schemas/ResourceDeletedDeliveryPayload'
79085+
ResourceUpdated: '#/components/schemas/ResourceUpdatedDeliveryPayload'
79086+
required:
79087+
- notificationType
79088+
- projectKey
79089+
- resource
79090+
properties:
79091+
notificationType:
79092+
type: "string"
79093+
projectKey:
79094+
type: "string"
79095+
resource:
79096+
$ref: '#/components/schemas/Reference'
79097+
resourceUserProvidedIdentifiers:
79098+
$ref: '#/components/schemas/UserProvidedIdentifiers'
7909079099
Destination:
7909179100
type: "object"
7909279101
discriminator:
@@ -79124,7 +79133,7 @@ components:
7912479133
type: "string"
7912579134
EventDeliveryPayload:
7912679135
allOf:
79127-
- $ref: '#/components/schemas/DeliveryPayload'
79136+
- $ref: '#/components/schemas/SubscriptionNotification'
7912879137
- type: "object"
7912979138
required:
7913079139
- createdAt
@@ -79214,21 +79223,23 @@ components:
7921479223
- createdAt
7921579224
- id
7921679225
- lastModifiedAt
79217-
- projectKey
79218-
- resource
7921979226
- resourceVersion
7922079227
- sequenceNumber
7922179228
- version
7922279229
properties:
7922379230
notificationType:
7922479231
type: "string"
79232+
projectKey:
79233+
type: "string"
79234+
resource:
79235+
$ref: '#/components/schemas/Reference'
79236+
resourceUserProvidedIdentifiers:
79237+
$ref: '#/components/schemas/UserProvidedIdentifiers'
7922579238
id:
7922679239
type: "string"
7922779240
version:
7922879241
type: "integer"
7922979242
format: "int64"
79230-
projectKey:
79231-
type: "string"
7923279243
createdAt:
7923379244
type: "string"
7923479245
format: "datetime"
@@ -79241,10 +79252,6 @@ components:
7924179252
resourceVersion:
7924279253
type: "integer"
7924379254
format: "int64"
79244-
resource:
79245-
$ref: '#/components/schemas/Reference'
79246-
resourceUserProvidedIdentifiers:
79247-
$ref: '#/components/schemas/UserProvidedIdentifiers'
7924879255
payloadNotIncluded:
7924979256
$ref: '#/components/schemas/PayloadNotIncluded'
7925079257
MessageSubscription:
@@ -79340,8 +79347,6 @@ components:
7934079347
- type: "object"
7934179348
required:
7934279349
- modifiedAt
79343-
- projectKey
79344-
- resource
7934579350
- version
7934679351
properties:
7934779352
notificationType:
@@ -79364,8 +79369,6 @@ components:
7936479369
- type: "object"
7936579370
required:
7936679371
- modifiedAt
79367-
- projectKey
79368-
- resource
7936979372
- version
7937079373
properties:
7937179374
notificationType:
@@ -79391,8 +79394,6 @@ components:
7939179394
required:
7939279395
- modifiedAt
7939379396
- oldVersion
79394-
- projectKey
79395-
- resource
7939679397
- version
7939779398
properties:
7939879399
notificationType:
@@ -79556,6 +79557,17 @@ components:
7955679557
change to [Healthy](ctp:api:type:SubscriptionHealthStatus). To return your subscriptions
7955779558
to a [Healthy](ctp:api:type:SubscriptionHealthStatus) status, contact the [Composable
7955879559
Commerce support team](https://support.commercetools.com/)."
79560+
SubscriptionNotification:
79561+
type: "object"
79562+
discriminator:
79563+
propertyName: notificationType
79564+
mapping:
79565+
Event: '#/components/schemas/EventDeliveryPayload'
79566+
required:
79567+
- notificationType
79568+
properties:
79569+
notificationType:
79570+
type: "string"
7955979571
SubscriptionPagedQueryResponse:
7956079572
type: "object"
7956179573
required:

‎uml/api/DeliveryPayload.puml‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,27 @@ legend
88
|<back:green> </back>| property reference |
99
|<back:blue> </back>| discriminated class |
1010
endlegend
11-
interface DeliveryPayload [[DeliveryPayload.svg]] {
11+
interface DeliveryPayload [[DeliveryPayload.svg]] extends SubscriptionNotification {
1212
notificationType: String
13+
projectKey: String
14+
resource: [[Reference.svg Reference]]
15+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
1316
}
14-
15-
16-
interface EventDeliveryPayload [[EventDeliveryPayload.svg]] {
17+
interface SubscriptionNotification [[SubscriptionNotification.svg]] {
1718
notificationType: String
18-
id: String
19-
type: [[EventType.svg EventType]]
20-
resourceType: String
21-
data: [[Object.svg Object]]
22-
createdAt: DateTime
2319
}
20+
2421
interface MessageDeliveryPayload [[MessageDeliveryPayload.svg]] {
2522
notificationType: String
23+
projectKey: String
24+
resource: [[Reference.svg Reference]]
25+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2626
id: String
2727
version: Long
28-
projectKey: String
2928
createdAt: DateTime
3029
lastModifiedAt: DateTime
3130
sequenceNumber: Long
3231
resourceVersion: Long
33-
resource: [[Reference.svg Reference]]
34-
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
3532
payloadNotIncluded: [[PayloadNotIncluded.svg PayloadNotIncluded]]
3633
}
3734
interface ResourceCreatedDeliveryPayload [[ResourceCreatedDeliveryPayload.svg]] {
@@ -72,7 +69,6 @@ interface CloudEventsPayload [[CloudEventsPayload.svg]] {
7269
dataref: String
7370
data: [[DeliveryPayload.svg DeliveryPayload]]
7471
}
75-
DeliveryPayload --> EventDeliveryPayload #blue;text:blue : "notificationType : Event"
7672
DeliveryPayload --> MessageDeliveryPayload #blue;text:blue : "notificationType : Message"
7773
DeliveryPayload --> ResourceCreatedDeliveryPayload #blue;text:blue : "notificationType : ResourceCreated"
7874
DeliveryPayload --> ResourceDeletedDeliveryPayload #blue;text:blue : "notificationType : ResourceDeleted"

‎uml/api/EventDeliveryPayload.puml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ legend
88
|<back:green> </back>| property reference |
99
|<back:blue> </back>| discriminated class |
1010
endlegend
11-
interface EventDeliveryPayload [[EventDeliveryPayload.svg]] extends DeliveryPayload {
11+
interface EventDeliveryPayload [[EventDeliveryPayload.svg]] extends SubscriptionNotification {
1212
notificationType: String
1313
id: String
1414
type: [[EventType.svg EventType]]
1515
resourceType: String
1616
data: [[Object.svg Object]]
1717
createdAt: DateTime
1818
}
19-
interface DeliveryPayload [[DeliveryPayload.svg]] {
19+
interface SubscriptionNotification [[SubscriptionNotification.svg]] {
2020
notificationType: String
2121
}
2222

‎uml/api/MessageDeliveryPayload.puml‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,22 @@ legend
1010
endlegend
1111
interface MessageDeliveryPayload [[MessageDeliveryPayload.svg]] extends DeliveryPayload {
1212
notificationType: String
13+
projectKey: String
14+
resource: [[Reference.svg Reference]]
15+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
1316
id: String
1417
version: Long
15-
projectKey: String
1618
createdAt: DateTime
1719
lastModifiedAt: DateTime
1820
sequenceNumber: Long
1921
resourceVersion: Long
20-
resource: [[Reference.svg Reference]]
21-
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2222
payloadNotIncluded: [[PayloadNotIncluded.svg PayloadNotIncluded]]
2323
}
2424
interface DeliveryPayload [[DeliveryPayload.svg]] {
2525
notificationType: String
26+
projectKey: String
27+
resource: [[Reference.svg Reference]]
28+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2629
}
2730

2831

‎uml/api/PayloadNotIncluded.puml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ interface PayloadNotIncluded [[PayloadNotIncluded.svg]] {
1717

1818
interface MessageDeliveryPayload [[MessageDeliveryPayload.svg]] {
1919
notificationType: String
20+
projectKey: String
21+
resource: [[Reference.svg Reference]]
22+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2023
id: String
2124
version: Long
22-
projectKey: String
2325
createdAt: DateTime
2426
lastModifiedAt: DateTime
2527
sequenceNumber: Long
2628
resourceVersion: Long
27-
resource: [[Reference.svg Reference]]
28-
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2929
payloadNotIncluded: [[PayloadNotIncluded.svg PayloadNotIncluded]]
3030
}
3131

‎uml/api/Reference.puml‎

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -344,44 +344,11 @@ interface ReviewStateTransitionMessagePayload [[ReviewStateTransitionMessagePayl
344344
target: [[Reference.svg Reference]]
345345
force: Boolean
346346
}
347-
interface MessageDeliveryPayload [[MessageDeliveryPayload.svg]] {
348-
notificationType: String
349-
id: String
350-
version: Long
351-
projectKey: String
352-
createdAt: DateTime
353-
lastModifiedAt: DateTime
354-
sequenceNumber: Long
355-
resourceVersion: Long
356-
resource: [[Reference.svg Reference]]
357-
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
358-
payloadNotIncluded: [[PayloadNotIncluded.svg PayloadNotIncluded]]
359-
}
360-
interface ResourceCreatedDeliveryPayload [[ResourceCreatedDeliveryPayload.svg]] {
361-
notificationType: String
362-
projectKey: String
363-
resource: [[Reference.svg Reference]]
364-
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
365-
version: Long
366-
modifiedAt: DateTime
367-
}
368-
interface ResourceDeletedDeliveryPayload [[ResourceDeletedDeliveryPayload.svg]] {
369-
notificationType: String
370-
projectKey: String
371-
resource: [[Reference.svg Reference]]
372-
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
373-
version: Long
374-
modifiedAt: DateTime
375-
dataErasure: Boolean
376-
}
377-
interface ResourceUpdatedDeliveryPayload [[ResourceUpdatedDeliveryPayload.svg]] {
347+
interface DeliveryPayload [[DeliveryPayload.svg]] {
378348
notificationType: String
379349
projectKey: String
380350
resource: [[Reference.svg Reference]]
381351
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
382-
version: Long
383-
oldVersion: Long
384-
modifiedAt: DateTime
385352
}
386353
Reference --> AssociateRoleReference #blue;text:blue : "typeId : associate-role"
387354
Reference --> AttributeGroupReference #blue;text:blue : "typeId : attribute-group"
@@ -432,8 +399,5 @@ Reference --> ReviewRatingSetMessage #green;text:green : "target"
432399
Reference --> ReviewStateTransitionMessage #green;text:green : "target"
433400
Reference --> ReviewRatingSetMessagePayload #green;text:green : "target"
434401
Reference --> ReviewStateTransitionMessagePayload #green;text:green : "target"
435-
Reference --> MessageDeliveryPayload #green;text:green : "resource"
436-
Reference --> ResourceCreatedDeliveryPayload #green;text:green : "resource"
437-
Reference --> ResourceDeletedDeliveryPayload #green;text:green : "resource"
438-
Reference --> ResourceUpdatedDeliveryPayload #green;text:green : "resource"
402+
Reference --> DeliveryPayload #green;text:green : "resource"
439403
@enduml

‎uml/api/ResourceCreatedDeliveryPayload.puml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ interface ResourceCreatedDeliveryPayload [[ResourceCreatedDeliveryPayload.svg]]
1818
}
1919
interface DeliveryPayload [[DeliveryPayload.svg]] {
2020
notificationType: String
21+
projectKey: String
22+
resource: [[Reference.svg Reference]]
23+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2124
}
2225

2326

‎uml/api/ResourceDeletedDeliveryPayload.puml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ interface ResourceDeletedDeliveryPayload [[ResourceDeletedDeliveryPayload.svg]]
1919
}
2020
interface DeliveryPayload [[DeliveryPayload.svg]] {
2121
notificationType: String
22+
projectKey: String
23+
resource: [[Reference.svg Reference]]
24+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2225
}
2326

2427

‎uml/api/ResourceUpdatedDeliveryPayload.puml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ interface ResourceUpdatedDeliveryPayload [[ResourceUpdatedDeliveryPayload.svg]]
1919
}
2020
interface DeliveryPayload [[DeliveryPayload.svg]] {
2121
notificationType: String
22+
projectKey: String
23+
resource: [[Reference.svg Reference]]
24+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2225
}
2326

2427

0 commit comments

Comments
 (0)