Skip to content

Commit db6e939

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 503a690 commit db6e939

25 files changed

+293
-42
lines changed

oas/api/openapi.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80990,6 +80990,24 @@ components:
8099080990
x-annotation-enumDescriptions:
8099180991
Activated: "indicates that the Customer Search feature is fully operational."
8099280992
Deactivated: "indicates that the Customer Search feature is currently not active."
80993+
DiscountCombinationMode:
80994+
type: "string"
80995+
enum:
80996+
- BestDeal
80997+
- Stacking
80998+
x-annotation-package: "Project"
80999+
x-annotation-enumDescriptions:
81000+
BestDeal: "Either Product Discounts or Cart Discounts are chosen based on best deal
81001+
for the customer. Only one type applies per Cart."
81002+
Stacking: "Product Discounts and Cart Discounts are both applied to the Cart, potentially
81003+
increasing the total discount."
81004+
DiscountsConfiguration:
81005+
type: "object"
81006+
required:
81007+
- discountCombinationMode
81008+
properties:
81009+
discountCombinationMode:
81010+
$ref: '#/components/schemas/DiscountCombinationMode'
8099381011
ExternalOAuth:
8099481012
type: "object"
8099581013
required:
@@ -81028,6 +81046,7 @@ components:
8102881046
- countries
8102981047
- createdAt
8103081048
- currencies
81049+
- discounts
8103181050
- key
8103281051
- languages
8103381052
- messages
@@ -81072,6 +81091,8 @@ components:
8107281091
$ref: '#/components/schemas/SearchIndexingConfiguration'
8107381092
businessUnits:
8107481093
$ref: '#/components/schemas/BusinessUnitConfiguration'
81094+
discounts:
81095+
$ref: '#/components/schemas/DiscountsConfiguration'
8107581096
ProjectUpdate:
8107681097
type: "object"
8107781098
required:
@@ -81107,6 +81128,7 @@ components:
8110781128
changeShoppingListsConfiguration: '#/components/schemas/ProjectChangeShoppingListsConfigurationAction'
8110881129
changeTaxRoundingMode: '#/components/schemas/ProjectChangeTaxRoundingModeAction'
8110981130
setMyBusinessUnitAssociateRoleOnCreation: '#/components/schemas/ProjectSetBusinessUnitAssociateRoleOnCreationAction'
81131+
setDiscountsConfiguration: '#/components/schemas/ProjectSetDiscountsConfigurationAction'
8111081132
setExternalOAuth: '#/components/schemas/ProjectSetExternalOAuthAction'
8111181133
setShippingRateInputType: '#/components/schemas/ProjectSetShippingRateInputTypeAction'
8111281134
required:
@@ -81365,6 +81387,17 @@ components:
8136581387
type: "string"
8136681388
associateRole:
8136781389
$ref: '#/components/schemas/AssociateRoleResourceIdentifier'
81390+
ProjectSetDiscountsConfigurationAction:
81391+
allOf:
81392+
- $ref: '#/components/schemas/ProjectUpdateAction'
81393+
- type: "object"
81394+
required:
81395+
- discountsConfiguration
81396+
properties:
81397+
action:
81398+
type: "string"
81399+
discountsConfiguration:
81400+
$ref: '#/components/schemas/DiscountsConfiguration'
8136881401
ProjectSetExternalOAuthAction:
8136981402
allOf:
8137081403
- $ref: '#/components/schemas/ProjectUpdateAction'

uml/api/BusinessUnitConfiguration.puml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ interface Project [[Project.svg]] {
3131
externalOAuth: [[ExternalOAuth.svg ExternalOAuth]]
3232
searchIndexing: [[SearchIndexingConfiguration.svg SearchIndexingConfiguration]]
3333
businessUnits: [[BusinessUnitConfiguration.svg BusinessUnitConfiguration]]
34+
discounts: [[DiscountsConfiguration.svg DiscountsConfiguration]]
3435
}
3536

3637
BusinessUnitConfiguration --> Project #green;text:green : "businessUnits"

uml/api/CartsConfiguration.puml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ interface Project [[Project.svg]] {
3333
externalOAuth: [[ExternalOAuth.svg ExternalOAuth]]
3434
searchIndexing: [[SearchIndexingConfiguration.svg SearchIndexingConfiguration]]
3535
businessUnits: [[BusinessUnitConfiguration.svg BusinessUnitConfiguration]]
36+
discounts: [[DiscountsConfiguration.svg DiscountsConfiguration]]
3637
}
3738
interface ProjectChangeCartsConfigurationAction [[ProjectChangeCartsConfigurationAction.svg]] {
3839
action: String
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
@startuml
2+
3+
hide methods
4+
enum DiscountCombinationMode {
5+
BEST_DEAL
6+
STACKING
7+
}
8+
interface DiscountsConfiguration [[DiscountsConfiguration.svg]] {
9+
discountCombinationMode: [[DiscountCombinationMode.svg DiscountCombinationMode]]
10+
}
11+
DiscountCombinationMode --> DiscountsConfiguration #green;text:green : "discountCombinationMode"
12+
@enduml
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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 DiscountsConfiguration [[DiscountsConfiguration.svg]] {
12+
discountCombinationMode: [[DiscountCombinationMode.svg DiscountCombinationMode]]
13+
}
14+
15+
16+
17+
interface Project [[Project.svg]] {
18+
version: Long
19+
key: String
20+
name: String
21+
countries: [[String.svg List<String>]]
22+
currencies: [[String.svg List<String>]]
23+
languages: [[String.svg List<String>]]
24+
createdAt: DateTime
25+
trialUntil: String
26+
messages: [[MessagesConfiguration.svg MessagesConfiguration]]
27+
carts: [[CartsConfiguration.svg CartsConfiguration]]
28+
shoppingLists: [[ShoppingListsConfiguration.svg ShoppingListsConfiguration]]
29+
shippingRateInputType: [[ShippingRateInputType.svg ShippingRateInputType]]
30+
externalOAuth: [[ExternalOAuth.svg ExternalOAuth]]
31+
searchIndexing: [[SearchIndexingConfiguration.svg SearchIndexingConfiguration]]
32+
businessUnits: [[BusinessUnitConfiguration.svg BusinessUnitConfiguration]]
33+
discounts: [[DiscountsConfiguration.svg DiscountsConfiguration]]
34+
}
35+
interface ProjectSetDiscountsConfigurationAction [[ProjectSetDiscountsConfigurationAction.svg]] {
36+
action: String
37+
discountsConfiguration: [[DiscountsConfiguration.svg DiscountsConfiguration]]
38+
}
39+
40+
DiscountsConfiguration --> Project #green;text:green : "discounts"
41+
DiscountsConfiguration --> ProjectSetDiscountsConfigurationAction #green;text:green : "discountsConfiguration"
42+
@enduml

uml/api/ExternalOAuth.puml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ interface Project [[Project.svg]] {
3131
externalOAuth: [[ExternalOAuth.svg ExternalOAuth]]
3232
searchIndexing: [[SearchIndexingConfiguration.svg SearchIndexingConfiguration]]
3333
businessUnits: [[BusinessUnitConfiguration.svg BusinessUnitConfiguration]]
34+
discounts: [[DiscountsConfiguration.svg DiscountsConfiguration]]
3435
}
3536
interface ProjectSetExternalOAuthAction [[ProjectSetExternalOAuthAction.svg]] {
3637
action: String

uml/api/MessagesConfiguration.puml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ interface Project [[Project.svg]] {
3131
externalOAuth: [[ExternalOAuth.svg ExternalOAuth]]
3232
searchIndexing: [[SearchIndexingConfiguration.svg SearchIndexingConfiguration]]
3333
businessUnits: [[BusinessUnitConfiguration.svg BusinessUnitConfiguration]]
34+
discounts: [[DiscountsConfiguration.svg DiscountsConfiguration]]
3435
}
3536

3637
MessagesConfiguration --> Project #green;text:green : "messages"

uml/api/Project.puml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ interface Project [[Project.svg]] {
2424
externalOAuth: [[ExternalOAuth.svg ExternalOAuth]]
2525
searchIndexing: [[SearchIndexingConfiguration.svg SearchIndexingConfiguration]]
2626
businessUnits: [[BusinessUnitConfiguration.svg BusinessUnitConfiguration]]
27+
discounts: [[DiscountsConfiguration.svg DiscountsConfiguration]]
2728
}
2829

2930

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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 ProjectSetDiscountsConfigurationAction [[ProjectSetDiscountsConfigurationAction.svg]] extends ProjectUpdateAction {
12+
action: String
13+
discountsConfiguration: [[DiscountsConfiguration.svg DiscountsConfiguration]]
14+
}
15+
interface ProjectUpdateAction [[ProjectUpdateAction.svg]] {
16+
action: String
17+
}
18+
19+
20+
21+
22+
23+
@enduml

uml/api/ProjectUpdateAction.puml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ interface ProjectSetBusinessUnitAssociateRoleOnCreationAction [[ProjectSetBusine
8282
action: String
8383
associateRole: [[AssociateRoleResourceIdentifier.svg AssociateRoleResourceIdentifier]]
8484
}
85+
interface ProjectSetDiscountsConfigurationAction [[ProjectSetDiscountsConfigurationAction.svg]] {
86+
action: String
87+
discountsConfiguration: [[DiscountsConfiguration.svg DiscountsConfiguration]]
88+
}
8589
interface ProjectSetExternalOAuthAction [[ProjectSetExternalOAuthAction.svg]] {
8690
action: String
8791
externalOAuth: [[ExternalOAuth.svg ExternalOAuth]]
@@ -111,6 +115,7 @@ ProjectUpdateAction --> ProjectChangeProductSearchIndexingEnabledAction #blue;te
111115
ProjectUpdateAction --> ProjectChangeShoppingListsConfigurationAction #blue;text:blue : "action : changeShoppingListsConfiguration"
112116
ProjectUpdateAction --> ProjectChangeTaxRoundingModeAction #blue;text:blue : "action : changeTaxRoundingMode"
113117
ProjectUpdateAction --> ProjectSetBusinessUnitAssociateRoleOnCreationAction #blue;text:blue : "action : setMyBusinessUnitAssociateRoleOnCreation"
118+
ProjectUpdateAction --> ProjectSetDiscountsConfigurationAction #blue;text:blue : "action : setDiscountsConfiguration"
114119
ProjectUpdateAction --> ProjectSetExternalOAuthAction #blue;text:blue : "action : setExternalOAuth"
115120
ProjectUpdateAction --> ProjectSetShippingRateInputTypeAction #blue;text:blue : "action : setShippingRateInputType"
116121
ProjectUpdateAction --> ProjectUpdate #green;text:green : "actions"

0 commit comments

Comments
 (0)