Skip to content

Commit ce10546

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 48dc5d5 commit ce10546

23 files changed

+1960
-976
lines changed

oas/api/openapi.yaml

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58150,6 +58150,74 @@ components:
5815058150
dateOfBirth:
5815158151
type: "string"
5815258152
format: "date-only"
58153+
CustomerDefaultBillingAddressSetMessage:
58154+
allOf:
58155+
- $ref: '#/components/schemas/Message'
58156+
- type: "object"
58157+
properties:
58158+
id:
58159+
type: "string"
58160+
version:
58161+
type: "integer"
58162+
format: "int64"
58163+
createdAt:
58164+
type: "string"
58165+
format: "datetime"
58166+
lastModifiedAt:
58167+
type: "string"
58168+
format: "datetime"
58169+
lastModifiedBy:
58170+
$ref: '#/components/schemas/LastModifiedBy'
58171+
createdBy:
58172+
$ref: '#/components/schemas/CreatedBy'
58173+
sequenceNumber:
58174+
type: "integer"
58175+
format: "int64"
58176+
resource:
58177+
$ref: '#/components/schemas/Reference'
58178+
resourceVersion:
58179+
type: "integer"
58180+
format: "int64"
58181+
type:
58182+
type: "string"
58183+
resourceUserProvidedIdentifiers:
58184+
$ref: '#/components/schemas/UserProvidedIdentifiers'
58185+
address:
58186+
$ref: '#/components/schemas/Address'
58187+
CustomerDefaultShippingAddressSetMessage:
58188+
allOf:
58189+
- $ref: '#/components/schemas/Message'
58190+
- type: "object"
58191+
properties:
58192+
id:
58193+
type: "string"
58194+
version:
58195+
type: "integer"
58196+
format: "int64"
58197+
createdAt:
58198+
type: "string"
58199+
format: "datetime"
58200+
lastModifiedAt:
58201+
type: "string"
58202+
format: "datetime"
58203+
lastModifiedBy:
58204+
$ref: '#/components/schemas/LastModifiedBy'
58205+
createdBy:
58206+
$ref: '#/components/schemas/CreatedBy'
58207+
sequenceNumber:
58208+
type: "integer"
58209+
format: "int64"
58210+
resource:
58211+
$ref: '#/components/schemas/Reference'
58212+
resourceVersion:
58213+
type: "integer"
58214+
format: "int64"
58215+
type:
58216+
type: "string"
58217+
resourceUserProvidedIdentifiers:
58218+
$ref: '#/components/schemas/UserProvidedIdentifiers'
58219+
address:
58220+
$ref: '#/components/schemas/Address'
5815358221
CustomerDeletedMessage:
5815458222
allOf:
5815558223
- $ref: '#/components/schemas/Message'
@@ -58774,6 +58842,49 @@ components:
5877458842
$ref: '#/components/schemas/UserProvidedIdentifiers'
5877558843
reset:
5877658844
type: "boolean"
58845+
CustomerStoresSetMessage:
58846+
allOf:
58847+
- $ref: '#/components/schemas/Message'
58848+
- type: "object"
58849+
required:
58850+
- oldStores
58851+
- stores
58852+
properties:
58853+
id:
58854+
type: "string"
58855+
version:
58856+
type: "integer"
58857+
format: "int64"
58858+
createdAt:
58859+
type: "string"
58860+
format: "datetime"
58861+
lastModifiedAt:
58862+
type: "string"
58863+
format: "datetime"
58864+
lastModifiedBy:
58865+
$ref: '#/components/schemas/LastModifiedBy'
58866+
createdBy:
58867+
$ref: '#/components/schemas/CreatedBy'
58868+
sequenceNumber:
58869+
type: "integer"
58870+
format: "int64"
58871+
resource:
58872+
$ref: '#/components/schemas/Reference'
58873+
resourceVersion:
58874+
type: "integer"
58875+
format: "int64"
58876+
type:
58877+
type: "string"
58878+
resourceUserProvidedIdentifiers:
58879+
$ref: '#/components/schemas/UserProvidedIdentifiers'
58880+
stores:
58881+
type: "array"
58882+
items:
58883+
$ref: '#/components/schemas/StoreKeyReference'
58884+
oldStores:
58885+
type: "array"
58886+
items:
58887+
$ref: '#/components/schemas/StoreKeyReference'
5877758888
CustomerTitleSetMessage:
5877858889
allOf:
5877958890
- $ref: '#/components/schemas/Message'
@@ -59685,6 +59796,8 @@ components:
5968559796
CustomerCustomTypeRemoved: '#/components/schemas/CustomerCustomTypeRemovedMessage'
5968659797
CustomerCustomTypeSet: '#/components/schemas/CustomerCustomTypeSetMessage'
5968759798
CustomerDateOfBirthSet: '#/components/schemas/CustomerDateOfBirthSetMessage'
59799+
CustomerDefaultBillingAddressSet: '#/components/schemas/CustomerDefaultBillingAddressSetMessage'
59800+
CustomerDefaultShippingAddressSet: '#/components/schemas/CustomerDefaultShippingAddressSetMessage'
5968859801
CustomerDeleted: '#/components/schemas/CustomerDeletedMessage'
5968959802
CustomerEmailChanged: '#/components/schemas/CustomerEmailChangedMessage'
5969059803
CustomerEmailTokenCreated: '#/components/schemas/CustomerEmailTokenCreatedMessage'
@@ -59702,6 +59815,7 @@ components:
5970259815
CustomerLastNameSet: '#/components/schemas/CustomerLastNameSetMessage'
5970359816
CustomerPasswordTokenCreated: '#/components/schemas/CustomerPasswordTokenCreatedMessage'
5970459817
CustomerPasswordUpdated: '#/components/schemas/CustomerPasswordUpdatedMessage'
59818+
CustomerStoresSet: '#/components/schemas/CustomerStoresSetMessage'
5970559819
CustomerTitleSet: '#/components/schemas/CustomerTitleSetMessage'
5970659820
DiscountCodeCreated: '#/components/schemas/DiscountCodeCreatedMessage'
5970759821
DiscountCodeDeleted: '#/components/schemas/DiscountCodeDeletedMessage'
@@ -67957,6 +68071,24 @@ components:
6795768071
dateOfBirth:
6795868072
type: "string"
6795968073
format: "date-only"
68074+
CustomerDefaultBillingAddressSetMessagePayload:
68075+
allOf:
68076+
- $ref: '#/components/schemas/MessagePayload'
68077+
- type: "object"
68078+
properties:
68079+
type:
68080+
type: "string"
68081+
address:
68082+
$ref: '#/components/schemas/Address'
68083+
CustomerDefaultShippingAddressSetMessagePayload:
68084+
allOf:
68085+
- $ref: '#/components/schemas/MessagePayload'
68086+
- type: "object"
68087+
properties:
68088+
type:
68089+
type: "string"
68090+
address:
68091+
$ref: '#/components/schemas/Address'
6796068092
CustomerDeletedMessagePayload:
6796168093
allOf:
6796268094
- $ref: '#/components/schemas/MessagePayload'
@@ -68156,6 +68288,24 @@ components:
6815668288
type: "string"
6815768289
reset:
6815868290
type: "boolean"
68291+
CustomerStoresSetMessagePayload:
68292+
allOf:
68293+
- $ref: '#/components/schemas/MessagePayload'
68294+
- type: "object"
68295+
required:
68296+
- oldStores
68297+
- stores
68298+
properties:
68299+
type:
68300+
type: "string"
68301+
stores:
68302+
type: "array"
68303+
items:
68304+
$ref: '#/components/schemas/StoreKeyReference'
68305+
oldStores:
68306+
type: "array"
68307+
items:
68308+
$ref: '#/components/schemas/StoreKeyReference'
6815968309
CustomerTitleSetMessagePayload:
6816068310
allOf:
6816168311
- $ref: '#/components/schemas/MessagePayload'
@@ -68540,6 +68690,8 @@ components:
6854068690
CustomerCustomTypeRemoved: '#/components/schemas/CustomerCustomTypeRemovedMessagePayload'
6854168691
CustomerCustomTypeSet: '#/components/schemas/CustomerCustomTypeSetMessagePayload'
6854268692
CustomerDateOfBirthSet: '#/components/schemas/CustomerDateOfBirthSetMessagePayload'
68693+
CustomerDefaultBillingAddressSet: '#/components/schemas/CustomerDefaultBillingAddressSetMessagePayload'
68694+
CustomerDefaultShippingAddressSet: '#/components/schemas/CustomerDefaultShippingAddressSetMessagePayload'
6854368695
CustomerDeleted: '#/components/schemas/CustomerDeletedMessagePayload'
6854468696
CustomerEmailChanged: '#/components/schemas/CustomerEmailChangedMessagePayload'
6854568697
CustomerEmailTokenCreated: '#/components/schemas/CustomerEmailTokenCreatedMessagePayload'
@@ -68557,6 +68709,7 @@ components:
6855768709
CustomerLastNameSet: '#/components/schemas/CustomerLastNameSetMessagePayload'
6855868710
CustomerPasswordTokenCreated: '#/components/schemas/CustomerPasswordTokenCreatedMessagePayload'
6855968711
CustomerPasswordUpdated: '#/components/schemas/CustomerPasswordUpdatedMessagePayload'
68712+
CustomerStoresSet: '#/components/schemas/CustomerStoresSetMessagePayload'
6856068713
CustomerTitleSet: '#/components/schemas/CustomerTitleSetMessagePayload'
6856168714
DiscountCodeCreated: '#/components/schemas/DiscountCodeCreatedMessagePayload'
6856268715
DiscountCodeDeleted: '#/components/schemas/DiscountCodeDeletedMessagePayload'

uml/api/Address.puml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,34 @@ interface CustomerAddressRemovedMessage [[CustomerAddressRemovedMessage.svg]] {
495495
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
496496
address: [[Address.svg Address]]
497497
}
498+
interface CustomerDefaultBillingAddressSetMessage [[CustomerDefaultBillingAddressSetMessage.svg]] {
499+
id: String
500+
version: Long
501+
createdAt: DateTime
502+
lastModifiedAt: DateTime
503+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
504+
createdBy: [[CreatedBy.svg CreatedBy]]
505+
sequenceNumber: Long
506+
resource: [[Reference.svg Reference]]
507+
resourceVersion: Long
508+
type: String
509+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
510+
address: [[Address.svg Address]]
511+
}
512+
interface CustomerDefaultShippingAddressSetMessage [[CustomerDefaultShippingAddressSetMessage.svg]] {
513+
id: String
514+
version: Long
515+
createdAt: DateTime
516+
lastModifiedAt: DateTime
517+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
518+
createdBy: [[CreatedBy.svg CreatedBy]]
519+
sequenceNumber: Long
520+
resource: [[Reference.svg Reference]]
521+
resourceVersion: Long
522+
type: String
523+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
524+
address: [[Address.svg Address]]
525+
}
498526
interface DeliveryAddressSetMessage [[DeliveryAddressSetMessage.svg]] {
499527
id: String
500528
version: Long
@@ -590,6 +618,14 @@ interface CustomerAddressRemovedMessagePayload [[CustomerAddressRemovedMessagePa
590618
type: String
591619
address: [[Address.svg Address]]
592620
}
621+
interface CustomerDefaultBillingAddressSetMessagePayload [[CustomerDefaultBillingAddressSetMessagePayload.svg]] {
622+
type: String
623+
address: [[Address.svg Address]]
624+
}
625+
interface CustomerDefaultShippingAddressSetMessagePayload [[CustomerDefaultShippingAddressSetMessagePayload.svg]] {
626+
type: String
627+
address: [[Address.svg Address]]
628+
}
593629
interface DeliveryAddressSetMessagePayload [[DeliveryAddressSetMessagePayload.svg]] {
594630
type: String
595631
deliveryId: String
@@ -639,6 +675,8 @@ Address --> BusinessUnitShippingAddressRemovedMessage #green;text:green : "addre
639675
Address --> CustomerAddressAddedMessage #green;text:green : "address"
640676
Address --> CustomerAddressChangedMessage #green;text:green : "address"
641677
Address --> CustomerAddressRemovedMessage #green;text:green : "address"
678+
Address --> CustomerDefaultBillingAddressSetMessage #green;text:green : "address"
679+
Address --> CustomerDefaultShippingAddressSetMessage #green;text:green : "address"
642680
Address --> DeliveryAddressSetMessage #green;text:green : "address"
643681
Address --> DeliveryAddressSetMessage #green;text:green : "oldAddress"
644682
Address --> OrderBillingAddressSetMessage #green;text:green : "address"
@@ -657,6 +695,8 @@ Address --> BusinessUnitShippingAddressRemovedMessagePayload #green;text:green :
657695
Address --> CustomerAddressAddedMessagePayload #green;text:green : "address"
658696
Address --> CustomerAddressChangedMessagePayload #green;text:green : "address"
659697
Address --> CustomerAddressRemovedMessagePayload #green;text:green : "address"
698+
Address --> CustomerDefaultBillingAddressSetMessagePayload #green;text:green : "address"
699+
Address --> CustomerDefaultShippingAddressSetMessagePayload #green;text:green : "address"
660700
Address --> DeliveryAddressSetMessagePayload #green;text:green : "address"
661701
Address --> DeliveryAddressSetMessagePayload #green;text:green : "oldAddress"
662702
Address --> OrderBillingAddressSetMessagePayload #green;text:green : "address"

uml/api/BaseResource.puml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2049,6 +2049,34 @@ interface CustomerDateOfBirthSetMessage [[CustomerDateOfBirthSetMessage.svg]] {
20492049
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
20502050
dateOfBirth: Date
20512051
}
2052+
interface CustomerDefaultBillingAddressSetMessage [[CustomerDefaultBillingAddressSetMessage.svg]] {
2053+
id: String
2054+
version: Long
2055+
createdAt: DateTime
2056+
lastModifiedAt: DateTime
2057+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
2058+
createdBy: [[CreatedBy.svg CreatedBy]]
2059+
sequenceNumber: Long
2060+
resource: [[Reference.svg Reference]]
2061+
resourceVersion: Long
2062+
type: String
2063+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2064+
address: [[Address.svg Address]]
2065+
}
2066+
interface CustomerDefaultShippingAddressSetMessage [[CustomerDefaultShippingAddressSetMessage.svg]] {
2067+
id: String
2068+
version: Long
2069+
createdAt: DateTime
2070+
lastModifiedAt: DateTime
2071+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
2072+
createdBy: [[CreatedBy.svg CreatedBy]]
2073+
sequenceNumber: Long
2074+
resource: [[Reference.svg Reference]]
2075+
resourceVersion: Long
2076+
type: String
2077+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2078+
address: [[Address.svg Address]]
2079+
}
20522080
interface CustomerDeletedMessage [[CustomerDeletedMessage.svg]] {
20532081
id: String
20542082
version: Long
@@ -2295,6 +2323,21 @@ interface CustomerPasswordUpdatedMessage [[CustomerPasswordUpdatedMessage.svg]]
22952323
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
22962324
reset: Boolean
22972325
}
2326+
interface CustomerStoresSetMessage [[CustomerStoresSetMessage.svg]] {
2327+
id: String
2328+
version: Long
2329+
createdAt: DateTime
2330+
lastModifiedAt: DateTime
2331+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
2332+
createdBy: [[CreatedBy.svg CreatedBy]]
2333+
sequenceNumber: Long
2334+
resource: [[Reference.svg Reference]]
2335+
resourceVersion: Long
2336+
type: String
2337+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2338+
stores: [[StoreKeyReference.svg List<StoreKeyReference>]]
2339+
oldStores: [[StoreKeyReference.svg List<StoreKeyReference>]]
2340+
}
22982341
interface CustomerTitleSetMessage [[CustomerTitleSetMessage.svg]] {
22992342
id: String
23002343
version: Long
@@ -4576,6 +4619,8 @@ BaseResource --> CustomerCustomFieldRemovedMessage #blue;text:blue : "type : Cus
45764619
BaseResource --> CustomerCustomTypeRemovedMessage #blue;text:blue : "type : CustomerCustomTypeRemoved"
45774620
BaseResource --> CustomerCustomTypeSetMessage #blue;text:blue : "type : CustomerCustomTypeSet"
45784621
BaseResource --> CustomerDateOfBirthSetMessage #blue;text:blue : "type : CustomerDateOfBirthSet"
4622+
BaseResource --> CustomerDefaultBillingAddressSetMessage #blue;text:blue : "type : CustomerDefaultBillingAddressSet"
4623+
BaseResource --> CustomerDefaultShippingAddressSetMessage #blue;text:blue : "type : CustomerDefaultShippingAddressSet"
45794624
BaseResource --> CustomerDeletedMessage #blue;text:blue : "type : CustomerDeleted"
45804625
BaseResource --> CustomerEmailChangedMessage #blue;text:blue : "type : CustomerEmailChanged"
45814626
BaseResource --> CustomerEmailTokenCreatedMessage #blue;text:blue : "type : CustomerEmailTokenCreated"
@@ -4593,6 +4638,7 @@ BaseResource --> CustomerGroupSetMessage #blue;text:blue : "type : CustomerGroup
45934638
BaseResource --> CustomerLastNameSetMessage #blue;text:blue : "type : CustomerLastNameSet"
45944639
BaseResource --> CustomerPasswordTokenCreatedMessage #blue;text:blue : "type : CustomerPasswordTokenCreated"
45954640
BaseResource --> CustomerPasswordUpdatedMessage #blue;text:blue : "type : CustomerPasswordUpdated"
4641+
BaseResource --> CustomerStoresSetMessage #blue;text:blue : "type : CustomerStoresSet"
45964642
BaseResource --> CustomerTitleSetMessage #blue;text:blue : "type : CustomerTitleSet"
45974643
BaseResource --> DiscountCodeCreatedMessage #blue;text:blue : "type : DiscountCodeCreated"
45984644
BaseResource --> DiscountCodeDeletedMessage #blue;text:blue : "type : DiscountCodeDeleted"
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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 CustomerDefaultBillingAddressSetMessage [[CustomerDefaultBillingAddressSetMessage.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+
address: [[Address.svg Address]]
24+
}
25+
interface Message [[Message.svg]] {
26+
id: String
27+
version: Long
28+
createdAt: DateTime
29+
lastModifiedAt: DateTime
30+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
31+
createdBy: [[CreatedBy.svg CreatedBy]]
32+
sequenceNumber: Long
33+
resource: [[Reference.svg Reference]]
34+
resourceVersion: Long
35+
type: String
36+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
37+
}
38+
39+
40+
41+
42+
43+
@enduml

0 commit comments

Comments
 (0)