Skip to content

Commit 9d5ebc6

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 68fb22e commit 9d5ebc6

17 files changed

+1280
-940
lines changed

oas/api/openapi.yaml

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60290,6 +60290,7 @@ components:
6029060290
InventoryEntryDeleted: '#/components/schemas/InventoryEntryDeletedMessage'
6029160291
InventoryEntryQuantitySet: '#/components/schemas/InventoryEntryQuantitySetMessage'
6029260292
OrderPaymentAdded: '#/components/schemas/OrderPaymentAddedMessage'
60293+
OrderPaymentRemoved: '#/components/schemas/OrderPaymentRemovedMessage'
6029360294
PaymentCreated: '#/components/schemas/PaymentCreatedMessage'
6029460295
PaymentInteractionAdded: '#/components/schemas/PaymentInteractionAddedMessage'
6029560296
PaymentInterfaceIdSet: '#/components/schemas/PaymentInterfaceIdSetMessage'
@@ -61573,7 +61574,7 @@ components:
6157361574
- $ref: '#/components/schemas/Message'
6157461575
- type: "object"
6157561576
required:
61576-
- payment
61577+
- paymentRef
6157761578
properties:
6157861579
id:
6157961580
type: "string"
@@ -61602,8 +61603,47 @@ components:
6160261603
type: "string"
6160361604
resourceUserProvidedIdentifiers:
6160461605
$ref: '#/components/schemas/UserProvidedIdentifiers'
61605-
payment:
61606+
paymentRef:
6160661607
$ref: '#/components/schemas/PaymentReference'
61608+
OrderPaymentRemovedMessage:
61609+
allOf:
61610+
- $ref: '#/components/schemas/Message'
61611+
- type: "object"
61612+
required:
61613+
- paymentRef
61614+
- removedPaymentInfo
61615+
properties:
61616+
id:
61617+
type: "string"
61618+
version:
61619+
type: "integer"
61620+
format: "int64"
61621+
createdAt:
61622+
type: "string"
61623+
format: "datetime"
61624+
lastModifiedAt:
61625+
type: "string"
61626+
format: "datetime"
61627+
lastModifiedBy:
61628+
$ref: '#/components/schemas/LastModifiedBy'
61629+
createdBy:
61630+
$ref: '#/components/schemas/CreatedBy'
61631+
sequenceNumber:
61632+
type: "integer"
61633+
format: "int64"
61634+
resource:
61635+
$ref: '#/components/schemas/Reference'
61636+
resourceVersion:
61637+
type: "integer"
61638+
format: "int64"
61639+
type:
61640+
type: "string"
61641+
resourceUserProvidedIdentifiers:
61642+
$ref: '#/components/schemas/UserProvidedIdentifiers'
61643+
paymentRef:
61644+
$ref: '#/components/schemas/PaymentReference'
61645+
removedPaymentInfo:
61646+
type: "boolean"
6160761647
OrderPaymentStateChangedMessage:
6160861648
allOf:
6160961649
- $ref: '#/components/schemas/OrderMessage'
@@ -69301,6 +69341,7 @@ components:
6930169341
InventoryEntryDeleted: '#/components/schemas/InventoryEntryDeletedMessagePayload'
6930269342
InventoryEntryQuantitySet: '#/components/schemas/InventoryEntryQuantitySetMessagePayload'
6930369343
OrderPaymentAdded: '#/components/schemas/OrderPaymentAddedMessagePayload'
69344+
OrderPaymentRemoved: '#/components/schemas/OrderPaymentRemovedMessagePayload'
6930469345
PaymentCreated: '#/components/schemas/PaymentCreatedMessagePayload'
6930569346
PaymentInteractionAdded: '#/components/schemas/PaymentInteractionAddedMessagePayload'
6930669347
PaymentInterfaceIdSet: '#/components/schemas/PaymentInterfaceIdSetMessagePayload'
@@ -69833,12 +69874,26 @@ components:
6983369874
- $ref: '#/components/schemas/MessagePayload'
6983469875
- type: "object"
6983569876
required:
69836-
- payment
69877+
- paymentRef
6983769878
properties:
6983869879
type:
6983969880
type: "string"
69840-
payment:
69881+
paymentRef:
6984169882
$ref: '#/components/schemas/PaymentReference'
69883+
OrderPaymentRemovedMessagePayload:
69884+
allOf:
69885+
- $ref: '#/components/schemas/MessagePayload'
69886+
- type: "object"
69887+
required:
69888+
- paymentRef
69889+
- removedPaymentInfo
69890+
properties:
69891+
type:
69892+
type: "string"
69893+
paymentRef:
69894+
$ref: '#/components/schemas/PaymentReference'
69895+
removedPaymentInfo:
69896+
type: "boolean"
6984269897
OrderPaymentStateChangedMessagePayload:
6984369898
allOf:
6984469899
- $ref: '#/components/schemas/OrderMessagePayload'

uml/api/BaseResource.puml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2581,7 +2581,22 @@ interface OrderPaymentAddedMessage [[OrderPaymentAddedMessage.svg]] {
25812581
resourceVersion: Long
25822582
type: String
25832583
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2584-
payment: [[PaymentReference.svg PaymentReference]]
2584+
paymentRef: [[PaymentReference.svg PaymentReference]]
2585+
}
2586+
interface OrderPaymentRemovedMessage [[OrderPaymentRemovedMessage.svg]] {
2587+
id: String
2588+
version: Long
2589+
createdAt: DateTime
2590+
lastModifiedAt: DateTime
2591+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
2592+
createdBy: [[CreatedBy.svg CreatedBy]]
2593+
sequenceNumber: Long
2594+
resource: [[Reference.svg Reference]]
2595+
resourceVersion: Long
2596+
type: String
2597+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2598+
paymentRef: [[PaymentReference.svg PaymentReference]]
2599+
removedPaymentInfo: Boolean
25852600
}
25862601
interface PaymentCreatedMessage [[PaymentCreatedMessage.svg]] {
25872602
id: String
@@ -4732,6 +4747,7 @@ BaseResource --> InventoryEntryCreatedMessage #blue;text:blue : "type : Inventor
47324747
BaseResource --> InventoryEntryDeletedMessage #blue;text:blue : "type : InventoryEntryDeleted"
47334748
BaseResource --> InventoryEntryQuantitySetMessage #blue;text:blue : "type : InventoryEntryQuantitySet"
47344749
BaseResource --> OrderPaymentAddedMessage #blue;text:blue : "type : OrderPaymentAdded"
4750+
BaseResource --> OrderPaymentRemovedMessage #blue;text:blue : "type : OrderPaymentRemoved"
47354751
BaseResource --> PaymentCreatedMessage #blue;text:blue : "type : PaymentCreated"
47364752
BaseResource --> PaymentInteractionAddedMessage #blue;text:blue : "type : PaymentInteractionAdded"
47374753
BaseResource --> PaymentInterfaceIdSetMessage #blue;text:blue : "type : PaymentInterfaceIdSet"

uml/api/Message.puml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2266,7 +2266,22 @@ interface OrderPaymentAddedMessage [[OrderPaymentAddedMessage.svg]] {
22662266
resourceVersion: Long
22672267
type: String
22682268
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2269-
payment: [[PaymentReference.svg PaymentReference]]
2269+
paymentRef: [[PaymentReference.svg PaymentReference]]
2270+
}
2271+
interface OrderPaymentRemovedMessage [[OrderPaymentRemovedMessage.svg]] {
2272+
id: String
2273+
version: Long
2274+
createdAt: DateTime
2275+
lastModifiedAt: DateTime
2276+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
2277+
createdBy: [[CreatedBy.svg CreatedBy]]
2278+
sequenceNumber: Long
2279+
resource: [[Reference.svg Reference]]
2280+
resourceVersion: Long
2281+
type: String
2282+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2283+
paymentRef: [[PaymentReference.svg PaymentReference]]
2284+
removedPaymentInfo: Boolean
22702285
}
22712286
interface OrderPaymentStateChangedMessage [[OrderPaymentStateChangedMessage.svg]] {
22722287
id: String
@@ -4741,6 +4756,7 @@ Message --> OrderLineItemDiscountSetMessage #blue;text:blue : "type : OrderLineI
47414756
Message --> OrderLineItemDistributionChannelSetMessage #blue;text:blue : "type : OrderLineItemDistributionChannelSet"
47424757
Message --> OrderLineItemRemovedMessage #blue;text:blue : "type : OrderLineItemRemoved"
47434758
Message --> OrderPaymentAddedMessage #blue;text:blue : "type : OrderPaymentAdded"
4759+
Message --> OrderPaymentRemovedMessage #blue;text:blue : "type : OrderPaymentRemoved"
47444760
Message --> OrderPaymentStateChangedMessage #blue;text:blue : "type : OrderPaymentStateChanged"
47454761
Message --> OrderPurchaseOrderNumberSetMessage #blue;text:blue : "type : OrderPurchaseOrderNumberSet"
47464762
Message --> OrderReturnShipmentStateChangedMessage #blue;text:blue : "type : OrderReturnShipmentStateChanged"

uml/api/MessagePayload.puml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -741,7 +741,12 @@ interface OrderLineItemRemovedMessagePayload [[OrderLineItemRemovedMessagePayloa
741741
}
742742
interface OrderPaymentAddedMessagePayload [[OrderPaymentAddedMessagePayload.svg]] {
743743
type: String
744-
payment: [[PaymentReference.svg PaymentReference]]
744+
paymentRef: [[PaymentReference.svg PaymentReference]]
745+
}
746+
interface OrderPaymentRemovedMessagePayload [[OrderPaymentRemovedMessagePayload.svg]] {
747+
type: String
748+
paymentRef: [[PaymentReference.svg PaymentReference]]
749+
removedPaymentInfo: Boolean
745750
}
746751
interface OrderPaymentStateChangedMessagePayload [[OrderPaymentStateChangedMessagePayload.svg]] {
747752
type: String
@@ -1708,6 +1713,7 @@ MessagePayload --> OrderLineItemDiscountSetMessagePayload #blue;text:blue : "typ
17081713
MessagePayload --> OrderLineItemDistributionChannelSetMessagePayload #blue;text:blue : "type : OrderLineItemDistributionChannelSet"
17091714
MessagePayload --> OrderLineItemRemovedMessagePayload #blue;text:blue : "type : OrderLineItemRemoved"
17101715
MessagePayload --> OrderPaymentAddedMessagePayload #blue;text:blue : "type : OrderPaymentAdded"
1716+
MessagePayload --> OrderPaymentRemovedMessagePayload #blue;text:blue : "type : OrderPaymentRemoved"
17111717
MessagePayload --> OrderPaymentStateChangedMessagePayload #blue;text:blue : "type : OrderPaymentStateChanged"
17121718
MessagePayload --> OrderPurchaseOrderNumberSetMessagePayload #blue;text:blue : "type : OrderPurchaseOrderNumberSet"
17131719
MessagePayload --> OrderReturnShipmentStateChangedMessagePayload #blue;text:blue : "type : OrderReturnShipmentStateChanged"

uml/api/OrderPaymentAddedMessage.puml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ interface OrderPaymentAddedMessage [[OrderPaymentAddedMessage.svg]] extends Mess
2020
resourceVersion: Long
2121
type: String
2222
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
23-
payment: [[PaymentReference.svg PaymentReference]]
23+
paymentRef: [[PaymentReference.svg PaymentReference]]
2424
}
2525
interface Message [[Message.svg]] {
2626
id: String

uml/api/OrderPaymentAddedMessagePayload.puml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ legend
1010
endlegend
1111
interface OrderPaymentAddedMessagePayload [[OrderPaymentAddedMessagePayload.svg]] extends MessagePayload {
1212
type: String
13-
payment: [[PaymentReference.svg PaymentReference]]
13+
paymentRef: [[PaymentReference.svg PaymentReference]]
1414
}
1515
interface MessagePayload [[MessagePayload.svg]] {
1616
type: String
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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 OrderPaymentRemovedMessage [[OrderPaymentRemovedMessage.svg]] extends Message {
12+
id: String
13+
version: Long
14+
createdAt: DateTime
15+
lastModifiedAt: DateTime
16+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
17+
createdBy: [[CreatedBy.svg CreatedBy]]
18+
sequenceNumber: Long
19+
resource: [[Reference.svg Reference]]
20+
resourceVersion: Long
21+
type: String
22+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
23+
paymentRef: [[PaymentReference.svg PaymentReference]]
24+
removedPaymentInfo: Boolean
25+
}
26+
interface Message [[Message.svg]] {
27+
id: String
28+
version: Long
29+
createdAt: DateTime
30+
lastModifiedAt: DateTime
31+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
32+
createdBy: [[CreatedBy.svg CreatedBy]]
33+
sequenceNumber: Long
34+
resource: [[Reference.svg Reference]]
35+
resourceVersion: Long
36+
type: String
37+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
38+
}
39+
40+
41+
42+
43+
44+
@enduml
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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 OrderPaymentRemovedMessagePayload [[OrderPaymentRemovedMessagePayload.svg]] extends MessagePayload {
12+
type: String
13+
paymentRef: [[PaymentReference.svg PaymentReference]]
14+
removedPaymentInfo: Boolean
15+
}
16+
interface MessagePayload [[MessagePayload.svg]] {
17+
type: String
18+
}
19+
20+
21+
22+
23+
24+
@enduml

uml/api/PaymentReference.puml

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,38 @@ interface OrderPaymentAddedMessage [[OrderPaymentAddedMessage.svg]] {
4747
resourceVersion: Long
4848
type: String
4949
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
50-
payment: [[PaymentReference.svg PaymentReference]]
50+
paymentRef: [[PaymentReference.svg PaymentReference]]
51+
}
52+
interface OrderPaymentRemovedMessage [[OrderPaymentRemovedMessage.svg]] {
53+
id: String
54+
version: Long
55+
createdAt: DateTime
56+
lastModifiedAt: DateTime
57+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
58+
createdBy: [[CreatedBy.svg CreatedBy]]
59+
sequenceNumber: Long
60+
resource: [[Reference.svg Reference]]
61+
resourceVersion: Long
62+
type: String
63+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
64+
paymentRef: [[PaymentReference.svg PaymentReference]]
65+
removedPaymentInfo: Boolean
5166
}
5267
interface OrderPaymentAddedMessagePayload [[OrderPaymentAddedMessagePayload.svg]] {
5368
type: String
54-
payment: [[PaymentReference.svg PaymentReference]]
69+
paymentRef: [[PaymentReference.svg PaymentReference]]
70+
}
71+
interface OrderPaymentRemovedMessagePayload [[OrderPaymentRemovedMessagePayload.svg]] {
72+
type: String
73+
paymentRef: [[PaymentReference.svg PaymentReference]]
74+
removedPaymentInfo: Boolean
5575
}
5676

5777
PaymentReference --> CheckoutMessageOrderPayloadBaseData #green;text:green : "payments"
5878
PaymentReference --> PaymentInfo #green;text:green : "payments"
5979
PaymentReference --> CheckoutMessagePaymentsPayloadBaseData #green;text:green : "payment"
60-
PaymentReference --> OrderPaymentAddedMessage #green;text:green : "payment"
61-
PaymentReference --> OrderPaymentAddedMessagePayload #green;text:green : "payment"
80+
PaymentReference --> OrderPaymentAddedMessage #green;text:green : "paymentRef"
81+
PaymentReference --> OrderPaymentRemovedMessage #green;text:green : "paymentRef"
82+
PaymentReference --> OrderPaymentAddedMessagePayload #green;text:green : "paymentRef"
83+
PaymentReference --> OrderPaymentRemovedMessagePayload #green;text:green : "paymentRef"
6284
@enduml

0 commit comments

Comments
 (0)