Skip to content

Commit c77d3d4

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 053837a commit c77d3d4

61 files changed

Lines changed: 2936 additions & 1004 deletions

File tree

Some content is hidden

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

oas/api/openapi.yaml

Lines changed: 314 additions & 0 deletions
Large diffs are not rendered by default.

uml/api/Address.puml

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,7 @@ interface BusinessUnitAddressChangedMessage [[BusinessUnitAddressChangedMessage.
354354
type: String
355355
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
356356
address: [[Address.svg Address]]
357+
addressRoles: [[AddressRole.svg List<AddressRole>]]
357358
}
358359
interface BusinessUnitAddressRemovedMessage [[BusinessUnitAddressRemovedMessage.svg]] {
359360
id: String
@@ -368,6 +369,7 @@ interface BusinessUnitAddressRemovedMessage [[BusinessUnitAddressRemovedMessage.
368369
type: String
369370
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
370371
address: [[Address.svg Address]]
372+
addressRoles: [[AddressRole.svg List<AddressRole>]]
371373
}
372374
interface BusinessUnitBillingAddressAddedMessage [[BusinessUnitBillingAddressAddedMessage.svg]] {
373375
id: String
@@ -480,6 +482,7 @@ interface CustomerAddressChangedMessage [[CustomerAddressChangedMessage.svg]] {
480482
type: String
481483
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
482484
address: [[Address.svg Address]]
485+
addressRoles: [[AddressRole.svg List<AddressRole>]]
483486
}
484487
interface CustomerAddressRemovedMessage [[CustomerAddressRemovedMessage.svg]] {
485488
id: String
@@ -494,6 +497,35 @@ interface CustomerAddressRemovedMessage [[CustomerAddressRemovedMessage.svg]] {
494497
type: String
495498
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
496499
address: [[Address.svg Address]]
500+
addressRoles: [[AddressRole.svg List<AddressRole>]]
501+
}
502+
interface CustomerBillingAddressAddedMessage [[CustomerBillingAddressAddedMessage.svg]] {
503+
id: String
504+
version: Long
505+
createdAt: DateTime
506+
lastModifiedAt: DateTime
507+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
508+
createdBy: [[CreatedBy.svg CreatedBy]]
509+
sequenceNumber: Long
510+
resource: [[Reference.svg Reference]]
511+
resourceVersion: Long
512+
type: String
513+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
514+
address: [[Address.svg Address]]
515+
}
516+
interface CustomerBillingAddressRemovedMessage [[CustomerBillingAddressRemovedMessage.svg]] {
517+
id: String
518+
version: Long
519+
createdAt: DateTime
520+
lastModifiedAt: DateTime
521+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
522+
createdBy: [[CreatedBy.svg CreatedBy]]
523+
sequenceNumber: Long
524+
resource: [[Reference.svg Reference]]
525+
resourceVersion: Long
526+
type: String
527+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
528+
address: [[Address.svg Address]]
497529
}
498530
interface CustomerDefaultBillingAddressSetMessage [[CustomerDefaultBillingAddressSetMessage.svg]] {
499531
id: String
@@ -523,6 +555,34 @@ interface CustomerDefaultShippingAddressSetMessage [[CustomerDefaultShippingAddr
523555
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
524556
address: [[Address.svg Address]]
525557
}
558+
interface CustomerShippingAddressAddedMessage [[CustomerShippingAddressAddedMessage.svg]] {
559+
id: String
560+
version: Long
561+
createdAt: DateTime
562+
lastModifiedAt: DateTime
563+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
564+
createdBy: [[CreatedBy.svg CreatedBy]]
565+
sequenceNumber: Long
566+
resource: [[Reference.svg Reference]]
567+
resourceVersion: Long
568+
type: String
569+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
570+
address: [[Address.svg Address]]
571+
}
572+
interface CustomerShippingAddressRemovedMessage [[CustomerShippingAddressRemovedMessage.svg]] {
573+
id: String
574+
version: Long
575+
createdAt: DateTime
576+
lastModifiedAt: DateTime
577+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
578+
createdBy: [[CreatedBy.svg CreatedBy]]
579+
sequenceNumber: Long
580+
resource: [[Reference.svg Reference]]
581+
resourceVersion: Long
582+
type: String
583+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
584+
address: [[Address.svg Address]]
585+
}
526586
interface DeliveryAddressSetMessage [[DeliveryAddressSetMessage.svg]] {
527587
id: String
528588
version: Long
@@ -577,10 +637,12 @@ interface BusinessUnitAddressAddedMessagePayload [[BusinessUnitAddressAddedMessa
577637
interface BusinessUnitAddressChangedMessagePayload [[BusinessUnitAddressChangedMessagePayload.svg]] {
578638
type: String
579639
address: [[Address.svg Address]]
640+
addressRoles: [[AddressRole.svg List<AddressRole>]]
580641
}
581642
interface BusinessUnitAddressRemovedMessagePayload [[BusinessUnitAddressRemovedMessagePayload.svg]] {
582643
type: String
583644
address: [[Address.svg Address]]
645+
addressRoles: [[AddressRole.svg List<AddressRole>]]
584646
}
585647
interface BusinessUnitBillingAddressAddedMessagePayload [[BusinessUnitBillingAddressAddedMessagePayload.svg]] {
586648
type: String
@@ -613,10 +675,20 @@ interface CustomerAddressAddedMessagePayload [[CustomerAddressAddedMessagePayloa
613675
interface CustomerAddressChangedMessagePayload [[CustomerAddressChangedMessagePayload.svg]] {
614676
type: String
615677
address: [[Address.svg Address]]
678+
addressRoles: [[AddressRole.svg List<AddressRole>]]
616679
}
617680
interface CustomerAddressRemovedMessagePayload [[CustomerAddressRemovedMessagePayload.svg]] {
618681
type: String
619682
address: [[Address.svg Address]]
683+
addressRoles: [[AddressRole.svg List<AddressRole>]]
684+
}
685+
interface CustomerBillingAddressAddedMessagePayload [[CustomerBillingAddressAddedMessagePayload.svg]] {
686+
type: String
687+
address: [[Address.svg Address]]
688+
}
689+
interface CustomerBillingAddressRemovedMessagePayload [[CustomerBillingAddressRemovedMessagePayload.svg]] {
690+
type: String
691+
address: [[Address.svg Address]]
620692
}
621693
interface CustomerDefaultBillingAddressSetMessagePayload [[CustomerDefaultBillingAddressSetMessagePayload.svg]] {
622694
type: String
@@ -626,6 +698,14 @@ interface CustomerDefaultShippingAddressSetMessagePayload [[CustomerDefaultShipp
626698
type: String
627699
address: [[Address.svg Address]]
628700
}
701+
interface CustomerShippingAddressAddedMessagePayload [[CustomerShippingAddressAddedMessagePayload.svg]] {
702+
type: String
703+
address: [[Address.svg Address]]
704+
}
705+
interface CustomerShippingAddressRemovedMessagePayload [[CustomerShippingAddressRemovedMessagePayload.svg]] {
706+
type: String
707+
address: [[Address.svg Address]]
708+
}
629709
interface DeliveryAddressSetMessagePayload [[DeliveryAddressSetMessagePayload.svg]] {
630710
type: String
631711
deliveryId: String
@@ -675,8 +755,12 @@ Address --> BusinessUnitShippingAddressRemovedMessage #green;text:green : "addre
675755
Address --> CustomerAddressAddedMessage #green;text:green : "address"
676756
Address --> CustomerAddressChangedMessage #green;text:green : "address"
677757
Address --> CustomerAddressRemovedMessage #green;text:green : "address"
758+
Address --> CustomerBillingAddressAddedMessage #green;text:green : "address"
759+
Address --> CustomerBillingAddressRemovedMessage #green;text:green : "address"
678760
Address --> CustomerDefaultBillingAddressSetMessage #green;text:green : "address"
679761
Address --> CustomerDefaultShippingAddressSetMessage #green;text:green : "address"
762+
Address --> CustomerShippingAddressAddedMessage #green;text:green : "address"
763+
Address --> CustomerShippingAddressRemovedMessage #green;text:green : "address"
680764
Address --> DeliveryAddressSetMessage #green;text:green : "address"
681765
Address --> DeliveryAddressSetMessage #green;text:green : "oldAddress"
682766
Address --> OrderBillingAddressSetMessage #green;text:green : "address"
@@ -695,8 +779,12 @@ Address --> BusinessUnitShippingAddressRemovedMessagePayload #green;text:green :
695779
Address --> CustomerAddressAddedMessagePayload #green;text:green : "address"
696780
Address --> CustomerAddressChangedMessagePayload #green;text:green : "address"
697781
Address --> CustomerAddressRemovedMessagePayload #green;text:green : "address"
782+
Address --> CustomerBillingAddressAddedMessagePayload #green;text:green : "address"
783+
Address --> CustomerBillingAddressRemovedMessagePayload #green;text:green : "address"
698784
Address --> CustomerDefaultBillingAddressSetMessagePayload #green;text:green : "address"
699785
Address --> CustomerDefaultShippingAddressSetMessagePayload #green;text:green : "address"
786+
Address --> CustomerShippingAddressAddedMessagePayload #green;text:green : "address"
787+
Address --> CustomerShippingAddressRemovedMessagePayload #green;text:green : "address"
700788
Address --> DeliveryAddressSetMessagePayload #green;text:green : "address"
701789
Address --> DeliveryAddressSetMessagePayload #green;text:green : "oldAddress"
702790
Address --> OrderBillingAddressSetMessagePayload #green;text:green : "address"

uml/api/AddressRole.puml

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
@startuml
2+
3+
hide methods
4+
enum AddressRole {
5+
SHIPPING
6+
BILLING
7+
}
8+
interface BusinessUnitAddressChangedMessage [[BusinessUnitAddressChangedMessage.svg]] {
9+
id: String
10+
version: Long
11+
createdAt: DateTime
12+
lastModifiedAt: DateTime
13+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
14+
createdBy: [[CreatedBy.svg CreatedBy]]
15+
sequenceNumber: Long
16+
resource: [[Reference.svg Reference]]
17+
resourceVersion: Long
18+
type: String
19+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
20+
address: [[Address.svg Address]]
21+
addressRoles: [[AddressRole.svg List<AddressRole>]]
22+
}
23+
interface BusinessUnitAddressRemovedMessage [[BusinessUnitAddressRemovedMessage.svg]] {
24+
id: String
25+
version: Long
26+
createdAt: DateTime
27+
lastModifiedAt: DateTime
28+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
29+
createdBy: [[CreatedBy.svg CreatedBy]]
30+
sequenceNumber: Long
31+
resource: [[Reference.svg Reference]]
32+
resourceVersion: Long
33+
type: String
34+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
35+
address: [[Address.svg Address]]
36+
addressRoles: [[AddressRole.svg List<AddressRole>]]
37+
}
38+
interface CustomerAddressChangedMessage [[CustomerAddressChangedMessage.svg]] {
39+
id: String
40+
version: Long
41+
createdAt: DateTime
42+
lastModifiedAt: DateTime
43+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
44+
createdBy: [[CreatedBy.svg CreatedBy]]
45+
sequenceNumber: Long
46+
resource: [[Reference.svg Reference]]
47+
resourceVersion: Long
48+
type: String
49+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
50+
address: [[Address.svg Address]]
51+
addressRoles: [[AddressRole.svg List<AddressRole>]]
52+
}
53+
interface CustomerAddressRemovedMessage [[CustomerAddressRemovedMessage.svg]] {
54+
id: String
55+
version: Long
56+
createdAt: DateTime
57+
lastModifiedAt: DateTime
58+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
59+
createdBy: [[CreatedBy.svg CreatedBy]]
60+
sequenceNumber: Long
61+
resource: [[Reference.svg Reference]]
62+
resourceVersion: Long
63+
type: String
64+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
65+
address: [[Address.svg Address]]
66+
addressRoles: [[AddressRole.svg List<AddressRole>]]
67+
}
68+
interface BusinessUnitAddressChangedMessagePayload [[BusinessUnitAddressChangedMessagePayload.svg]] {
69+
type: String
70+
address: [[Address.svg Address]]
71+
addressRoles: [[AddressRole.svg List<AddressRole>]]
72+
}
73+
interface BusinessUnitAddressRemovedMessagePayload [[BusinessUnitAddressRemovedMessagePayload.svg]] {
74+
type: String
75+
address: [[Address.svg Address]]
76+
addressRoles: [[AddressRole.svg List<AddressRole>]]
77+
}
78+
interface CustomerAddressChangedMessagePayload [[CustomerAddressChangedMessagePayload.svg]] {
79+
type: String
80+
address: [[Address.svg Address]]
81+
addressRoles: [[AddressRole.svg List<AddressRole>]]
82+
}
83+
interface CustomerAddressRemovedMessagePayload [[CustomerAddressRemovedMessagePayload.svg]] {
84+
type: String
85+
address: [[Address.svg Address]]
86+
addressRoles: [[AddressRole.svg List<AddressRole>]]
87+
}
88+
AddressRole --> BusinessUnitAddressChangedMessage #green;text:green : "addressRoles"
89+
AddressRole --> BusinessUnitAddressRemovedMessage #green;text:green : "addressRoles"
90+
AddressRole --> CustomerAddressChangedMessage #green;text:green : "addressRoles"
91+
AddressRole --> CustomerAddressRemovedMessage #green;text:green : "addressRoles"
92+
AddressRole --> BusinessUnitAddressChangedMessagePayload #green;text:green : "addressRoles"
93+
AddressRole --> BusinessUnitAddressRemovedMessagePayload #green;text:green : "addressRoles"
94+
AddressRole --> CustomerAddressChangedMessagePayload #green;text:green : "addressRoles"
95+
AddressRole --> CustomerAddressRemovedMessagePayload #green;text:green : "addressRoles"
96+
@enduml

0 commit comments

Comments
 (0)