Skip to content

Commit 05e3fa7

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 12c8607 commit 05e3fa7

38 files changed

+1862
-1254
lines changed

bruno/api/Project/Discount-groups/ByProjectKeyDiscountGroupsPost.bru

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ body:json {
1919
"description" : {
2020
"en" : "10% discount on all items in cart"
2121
},
22-
"sortOrder" : "0.01"
22+
"sortOrder" : "0.01",
23+
"isActive" : true
2324
}
2425
}
2526

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
meta {
2+
name: SetIsActive
3+
type: http
4+
seq: 776
5+
}
6+
7+
post {
8+
url: {{apiUrl}}/{{project-key}}/discount-groups/{{discount-group-id}}
9+
body: json
10+
auth: inherit
11+
}
12+
13+
body:json {
14+
{
15+
"version": {{discount-group-version}},
16+
"actions": [
17+
{
18+
"action" : "setIsActive",
19+
"isActive" : false
20+
}
21+
]
22+
}
23+
}
24+
25+
query {
26+
~expand:
27+
}
28+
29+
script:post-response {
30+
var data = res.body;
31+
if(res.status == 200 || res.status == 201) {
32+
if(data.results && data.results[0] && data.results[0].id && data.results[0].version){
33+
bru.setEnvVar("discount-group-id", data.results[0].id);
34+
bru.setEnvVar("discount-group-version", data.results[0].version);
35+
}
36+
if(data.results && data.results[0] && data.results[0].key){
37+
bru.setEnvVar("discount-group-key", data.results[0].key);
38+
}
39+
if(data.version){
40+
bru.setEnvVar("discount-group-version", data.version);
41+
}
42+
if(data.id){
43+
bru.setEnvVar("discount-group-id", data.id);
44+
}
45+
if(data.key){
46+
bru.setEnvVar("discount-group-key", data.key);
47+
}
48+
49+
}
50+
}
51+
52+
assert {
53+
res.status: in [200, 201]
54+
}

bruno/api/Project/Discount-groups/Update actions/SetKey.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
meta {
22
name: SetKey
33
type: http
4-
seq: 776
4+
seq: 777
55
}
66

77
post {

bruno/api/Project/Discount-groups/Update actions/SetName.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
meta {
22
name: SetName
33
type: http
4-
seq: 777
4+
seq: 778
55
}
66

77
post {

bruno/api/Project/Discount-groups/Update actions/SetSortOrder.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
meta {
22
name: SetSortOrder
33
type: http
4-
seq: 778
4+
seq: 779
55
}
66

77
post {

oas/api/openapi.yaml

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10796,6 +10796,8 @@ paths:
1079610796
description: |-
1079710797
Creates a DiscountGroup in the Project.
1079810798
This request generates the [DiscountGroupCreated](ctp:api:type:DiscountGroupCreatedMessage) Message.
10799+
10800+
If the [limit](/../api/limits#discount-groups) for active Discount Groups has been reached, a [MaxDiscountGroupsReached](ctp:api:type:MaxDiscountGroupsReachedError) error is returned.
1079910801
parameters:
1080010802
- name: expand
1080110803
in: query
@@ -49237,6 +49239,7 @@ components:
4923749239
required:
4923849240
- createdAt
4923949241
- id
49242+
- isActive
4924049243
- key
4924149244
- lastModifiedAt
4924249245
- sortOrder
@@ -49261,6 +49264,8 @@ components:
4926149264
$ref: '#/components/schemas/LocalizedString'
4926249265
sortOrder:
4926349266
type: "string"
49267+
isActive:
49268+
type: "boolean"
4926449269
lastModifiedBy:
4926549270
$ref: '#/components/schemas/LastModifiedBy'
4926649271
createdBy:
@@ -49279,6 +49284,8 @@ components:
4927949284
$ref: '#/components/schemas/LocalizedString'
4928049285
sortOrder:
4928149286
type: "string"
49287+
isActive:
49288+
type: "boolean"
4928249289
DiscountGroupPagedQueryResponse:
4928349290
type: "object"
4928449291
required:
@@ -49346,6 +49353,7 @@ components:
4934649353
propertyName: action
4934749354
mapping:
4934849355
setDescription: '#/components/schemas/DiscountGroupSetDescriptionAction'
49356+
setIsActive: '#/components/schemas/DiscountGroupSetIsActiveAction'
4934949357
setKey: '#/components/schemas/DiscountGroupSetKeyAction'
4935049358
setName: '#/components/schemas/DiscountGroupSetNameAction'
4935149359
setSortOrder: '#/components/schemas/DiscountGroupSetSortOrderAction'
@@ -49363,6 +49371,17 @@ components:
4936349371
type: "string"
4936449372
description:
4936549373
$ref: '#/components/schemas/LocalizedString'
49374+
DiscountGroupSetIsActiveAction:
49375+
allOf:
49376+
- $ref: '#/components/schemas/DiscountGroupUpdateAction'
49377+
- type: "object"
49378+
required:
49379+
- isActive
49380+
properties:
49381+
action:
49382+
type: "string"
49383+
isActive:
49384+
type: "boolean"
4936649385
DiscountGroupSetKeyAction:
4936749386
allOf:
4936849387
- $ref: '#/components/schemas/DiscountGroupUpdateAction'
@@ -49946,6 +49965,7 @@ components:
4994649965
LockedField: '#/components/schemas/LockedFieldError'
4994749966
MatchingPriceNotFound: '#/components/schemas/MatchingPriceNotFoundError'
4994849967
MaxCartDiscountsReached: '#/components/schemas/MaxCartDiscountsReachedError'
49968+
MaxDiscountGroupsReached: '#/components/schemas/MaxDiscountGroupsReachedError'
4994949969
MaxResourceLimitExceeded: '#/components/schemas/MaxResourceLimitExceededError'
4995049970
MaxStoreReferencesReached: '#/components/schemas/MaxStoreReferencesReachedError'
4995149971
MissingRoleOnChannel: '#/components/schemas/MissingRoleOnChannelError'
@@ -50424,6 +50444,20 @@ components:
5042450444
type: "string"
5042550445
additionalProperties:
5042650446
type: "string"
50447+
MaxDiscountGroupsReachedError:
50448+
allOf:
50449+
- $ref: '#/components/schemas/ErrorObject'
50450+
- type: "object"
50451+
required:
50452+
- code
50453+
- message
50454+
properties:
50455+
code:
50456+
type: "string"
50457+
message:
50458+
type: "string"
50459+
additionalProperties:
50460+
type: "string"
5042750461
MaxResourceLimitExceededError:
5042850462
allOf:
5042950463
- $ref: '#/components/schemas/ErrorObject'
@@ -51414,6 +51448,7 @@ components:
5141451448
LockedField: '#/components/schemas/GraphQLLockedFieldError'
5141551449
MatchingPriceNotFound: '#/components/schemas/GraphQLMatchingPriceNotFoundError'
5141651450
MaxCartDiscountsReached: '#/components/schemas/GraphQLMaxCartDiscountsReachedError'
51451+
MaxDiscountGroupsReached: '#/components/schemas/GraphQLMaxDiscountGroupsReachedError'
5141751452
MaxResourceLimitExceeded: '#/components/schemas/GraphQLMaxResourceLimitExceededError'
5141851453
MaxStoreReferencesReached: '#/components/schemas/GraphQLMaxStoreReferencesReachedError'
5141951454
MissingRoleOnChannel: '#/components/schemas/GraphQLMissingRoleOnChannelError'
@@ -51786,6 +51821,17 @@ components:
5178651821
type: "string"
5178751822
additionalProperties:
5178851823
type: "string"
51824+
GraphQLMaxDiscountGroupsReachedError:
51825+
allOf:
51826+
- $ref: '#/components/schemas/GraphQLErrorObject'
51827+
- type: "object"
51828+
required:
51829+
- code
51830+
properties:
51831+
code:
51832+
type: "string"
51833+
additionalProperties:
51834+
type: "string"
5178951835
GraphQLMaxResourceLimitExceededError:
5179051836
allOf:
5179151837
- $ref: '#/components/schemas/GraphQLErrorObject'
@@ -59565,6 +59611,42 @@ components:
5956559611
type: "string"
5956659612
resourceUserProvidedIdentifiers:
5956759613
$ref: '#/components/schemas/UserProvidedIdentifiers'
59614+
DiscountGroupIsActiveSetMessage:
59615+
allOf:
59616+
- $ref: '#/components/schemas/Message'
59617+
- type: "object"
59618+
properties:
59619+
id:
59620+
type: "string"
59621+
version:
59622+
type: "integer"
59623+
format: "int64"
59624+
createdAt:
59625+
type: "string"
59626+
format: "datetime"
59627+
lastModifiedAt:
59628+
type: "string"
59629+
format: "datetime"
59630+
lastModifiedBy:
59631+
$ref: '#/components/schemas/LastModifiedBy'
59632+
createdBy:
59633+
$ref: '#/components/schemas/CreatedBy'
59634+
sequenceNumber:
59635+
type: "integer"
59636+
format: "int64"
59637+
resource:
59638+
$ref: '#/components/schemas/Reference'
59639+
resourceVersion:
59640+
type: "integer"
59641+
format: "int64"
59642+
type:
59643+
type: "string"
59644+
resourceUserProvidedIdentifiers:
59645+
$ref: '#/components/schemas/UserProvidedIdentifiers'
59646+
isActive:
59647+
type: "boolean"
59648+
oldIsActive:
59649+
type: "boolean"
5956859650
DiscountGroupKeySetMessage:
5956959651
allOf:
5957059652
- $ref: '#/components/schemas/Message'
@@ -59926,6 +60008,7 @@ components:
5992660008
DiscountCodeKeySet: '#/components/schemas/DiscountCodeKeySetMessage'
5992760009
DiscountGroupCreated: '#/components/schemas/DiscountGroupCreatedMessage'
5992860010
DiscountGroupDeleted: '#/components/schemas/DiscountGroupDeletedMessage'
60011+
DiscountGroupIsActiveSet: '#/components/schemas/DiscountGroupIsActiveSetMessage'
5992960012
DiscountGroupKeySet: '#/components/schemas/DiscountGroupKeySetMessage'
5993060013
DiscountGroupSortOrderSet: '#/components/schemas/DiscountGroupSortOrderSetMessage'
5993160014
InventoryEntryCreated: '#/components/schemas/InventoryEntryCreatedMessage'
@@ -68611,6 +68694,17 @@ components:
6861168694
properties:
6861268695
type:
6861368696
type: "string"
68697+
DiscountGroupIsActiveSetMessagePayload:
68698+
allOf:
68699+
- $ref: '#/components/schemas/MessagePayload'
68700+
- type: "object"
68701+
properties:
68702+
type:
68703+
type: "string"
68704+
isActive:
68705+
type: "boolean"
68706+
oldIsActive:
68707+
type: "boolean"
6861468708
DiscountGroupKeySetMessagePayload:
6861568709
allOf:
6861668710
- $ref: '#/components/schemas/MessagePayload'
@@ -68820,6 +68914,7 @@ components:
6882068914
DiscountCodeKeySet: '#/components/schemas/DiscountCodeKeySetMessagePayload'
6882168915
DiscountGroupCreated: '#/components/schemas/DiscountGroupCreatedMessagePayload'
6882268916
DiscountGroupDeleted: '#/components/schemas/DiscountGroupDeletedMessagePayload'
68917+
DiscountGroupIsActiveSet: '#/components/schemas/DiscountGroupIsActiveSetMessagePayload'
6882368918
DiscountGroupKeySet: '#/components/schemas/DiscountGroupKeySetMessagePayload'
6882468919
DiscountGroupSortOrderSet: '#/components/schemas/DiscountGroupSortOrderSetMessagePayload'
6882568920
InventoryEntryCreated: '#/components/schemas/InventoryEntryCreatedMessagePayload'

uml/api/BaseResource.puml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,7 @@ interface DiscountGroup [[DiscountGroup.svg]] extends BaseResource {
270270
key: String
271271
description: [[LocalizedString.svg LocalizedString]]
272272
sortOrder: String
273+
isActive: Boolean
273274
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
274275
createdBy: [[CreatedBy.svg CreatedBy]]
275276
}
@@ -2421,6 +2422,21 @@ interface DiscountGroupDeletedMessage [[DiscountGroupDeletedMessage.svg]] {
24212422
type: String
24222423
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
24232424
}
2425+
interface DiscountGroupIsActiveSetMessage [[DiscountGroupIsActiveSetMessage.svg]] {
2426+
id: String
2427+
version: Long
2428+
createdAt: DateTime
2429+
lastModifiedAt: DateTime
2430+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
2431+
createdBy: [[CreatedBy.svg CreatedBy]]
2432+
sequenceNumber: Long
2433+
resource: [[Reference.svg Reference]]
2434+
resourceVersion: Long
2435+
type: String
2436+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
2437+
isActive: Boolean
2438+
oldIsActive: Boolean
2439+
}
24242440
interface DiscountGroupKeySetMessage [[DiscountGroupKeySetMessage.svg]] {
24252441
id: String
24262442
version: Long
@@ -4645,6 +4661,7 @@ BaseResource --> DiscountCodeDeletedMessage #blue;text:blue : "type : DiscountCo
46454661
BaseResource --> DiscountCodeKeySetMessage #blue;text:blue : "type : DiscountCodeKeySet"
46464662
BaseResource --> DiscountGroupCreatedMessage #blue;text:blue : "type : DiscountGroupCreated"
46474663
BaseResource --> DiscountGroupDeletedMessage #blue;text:blue : "type : DiscountGroupDeleted"
4664+
BaseResource --> DiscountGroupIsActiveSetMessage #blue;text:blue : "type : DiscountGroupIsActiveSet"
46484665
BaseResource --> DiscountGroupKeySetMessage #blue;text:blue : "type : DiscountGroupKeySet"
46494666
BaseResource --> DiscountGroupSortOrderSetMessage #blue;text:blue : "type : DiscountGroupSortOrderSet"
46504667
BaseResource --> Division #blue;text:blue : "unitType : Division"

uml/api/CreatedBy.puml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,7 @@ interface DiscountGroup [[DiscountGroup.svg]] {
308308
key: String
309309
description: [[LocalizedString.svg LocalizedString]]
310310
sortOrder: String
311+
isActive: Boolean
311312
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
312313
createdBy: [[CreatedBy.svg CreatedBy]]
313314
}

uml/api/DiscountGroup.puml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ interface DiscountGroup [[DiscountGroup.svg]] extends BaseResource {
1717
key: String
1818
description: [[LocalizedString.svg LocalizedString]]
1919
sortOrder: String
20+
isActive: Boolean
2021
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
2122
createdBy: [[CreatedBy.svg CreatedBy]]
2223
}

uml/api/DiscountGroupDraft.puml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ interface DiscountGroupDraft [[DiscountGroupDraft.svg]] {
1313
key: String
1414
description: [[LocalizedString.svg LocalizedString]]
1515
sortOrder: String
16+
isActive: Boolean
1617
}
1718

1819

0 commit comments

Comments
 (0)