Skip to content

Commit c920e1d

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent e259461 commit c920e1d

File tree

2 files changed

+38
-13
lines changed

2 files changed

+38
-13
lines changed

bruno/api/Project/Carts/ByProjectKeyCartsHead.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
meta {
2-
name: Check carts are existing
2+
name: Check if a Cart exists by Query Predicate
33
type: http
44
seq: 16
55
}

oas/api/openapi.yaml

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1538,7 +1538,7 @@ paths:
15381538
- "manage_orders:{projectKey}"
15391539
operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsPost
15401540
description: |-
1541-
Creates a [Cart](ctp:api:type:Cart) in the [BusinessUnit](ctp:api:type:BusinessUnit) referenced by `businessUnitKey`. As such, the `businessUnit` field on [CartDraft](ctp:api:type:CartDraft) is ignored for this request.
1541+
Creates a Cart in the [BusinessUnit](ctp:api:type:BusinessUnit) referenced by `businessUnitKey`. As such, the `businessUnit` field on [CartDraft](ctp:api:type:CartDraft) is ignored for this request.
15421542
Creating a Cart can fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the referenced [ShippingMethod](ctp:api:type:ShippingMethod) in the [CartDraft](ctp:api:type:CartDraft) has a predicate that does not match the Cart.
15431543

15441544
Specific Error Codes:
@@ -5774,6 +5774,8 @@ paths:
57745774
- oauth_2_0:
57755775
- "view_orders:{projectKey}"
57765776
operationId: ByProjectKeyCartsGet
5777+
description: |-
5778+
Retrieves all Carts in the Project.
57775779
parameters:
57785780
- name: expand
57795781
in: query
@@ -5866,7 +5868,7 @@ paths:
58665868
- "view_orders:{projectKey}"
58675869
operationId: ByProjectKeyCartsHead
58685870
description: |-
5869-
Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate, or a `404 Not Found` otherwise.
5871+
Checks if one or more Carts exist for the provided query predicate. Returns a `200 OK` status if any Carts match the query predicate, or a `404 Not Found` otherwise.
58705872
parameters:
58715873
- name: where
58725874
in: query
@@ -5902,6 +5904,8 @@ paths:
59025904
- "manage_orders:{projectKey}"
59035905
operationId: ByProjectKeyCartsPost
59045906
description: |-
5907+
Creates a Cart in the Project.
5908+
59055909
If the referenced [ShippingMethod](ctp:api:type:ShippingMethod) in the [CartDraft](ctp:api:type:CartDraft) has a predicate that does not match, or if the Shipping Method is not active, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
59065910

59075911
Specific Error Codes:
@@ -6009,7 +6013,7 @@ paths:
60096013
- "view_orders:{projectKey}"
60106014
operationId: ByProjectKeyCartsCustomerIdByCustomerIdHead
60116015
description: |-
6012-
Checks if a Cart of a Customer exists. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
6016+
Checks if a Cart exists for a Customer. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
60136017
responses:
60146018
"200":
60156019
description: |-
@@ -6047,6 +6051,7 @@ paths:
60476051
- "view_orders:{projectKey}"
60486052
operationId: ByProjectKeyCartsKeyByKeyGet
60496053
description: |-
6054+
Retrieves a Cart with the provided `key`.
60506055
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action.
60516056
parameters:
60526057
- name: expand
@@ -6087,7 +6092,7 @@ paths:
60876092
- "view_orders:{projectKey}"
60886093
operationId: ByProjectKeyCartsKeyByKeyHead
60896094
description: |-
6090-
Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
6095+
Checks if a Cart exists for the provided `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
60916096
responses:
60926097
"200":
60936098
description: |-
@@ -6112,6 +6117,8 @@ paths:
61126117
- oauth_2_0:
61136118
- "manage_orders:{projectKey}"
61146119
operationId: ByProjectKeyCartsKeyByKeyPost
6120+
description: |-
6121+
Updates a Cart in the Project using one or more [update actions](/../projects/carts#update-actions).
61156122
parameters:
61166123
- name: expand
61176124
in: query
@@ -6158,6 +6165,8 @@ paths:
61586165
- oauth_2_0:
61596166
- "manage_orders:{projectKey}"
61606167
operationId: ByProjectKeyCartsKeyByKeyDelete
6168+
description: |-
6169+
Deletes a Cart in the Project.
61616170
parameters:
61626171
- name: dataErasure
61636172
x-annotation-default: false
@@ -6279,6 +6288,7 @@ paths:
62796288
- "view_orders:{projectKey}"
62806289
operationId: ByProjectKeyCartsByIDGet
62816290
description: |-
6291+
Retrieves a Cart with the provided `id`.
62826292
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action.
62836293
parameters:
62846294
- name: expand
@@ -6319,7 +6329,7 @@ paths:
63196329
- "view_orders:{projectKey}"
63206330
operationId: ByProjectKeyCartsByIDHead
63216331
description: |-
6322-
Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
6332+
Checks if a Cart exists for the provided `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
63236333
responses:
63246334
"200":
63256335
description: |-
@@ -6344,6 +6354,8 @@ paths:
63446354
- oauth_2_0:
63456355
- "manage_orders:{projectKey}"
63466356
operationId: ByProjectKeyCartsByIDPost
6357+
description: |-
6358+
Updates a Cart in the Project using one or more [update actions](/../projects/carts#update-actions).
63476359
parameters:
63486360
- name: expand
63496361
in: query
@@ -6390,6 +6402,8 @@ paths:
63906402
- oauth_2_0:
63916403
- "manage_orders:{projectKey}"
63926404
operationId: ByProjectKeyCartsByIDDelete
6405+
description: |-
6406+
Deletes a Cart in the Project.
63936407
parameters:
63946408
- name: dataErasure
63956409
x-annotation-default: false
@@ -11803,7 +11817,7 @@ paths:
1180311817
- "view_orders:{projectKey}:{storeKey}"
1180411818
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsGet
1180511819
description: |-
11806-
Queries Carts in a specific [Store](ctp:api:type:Store).
11820+
Retrieves all Carts in a [Store](ctp:api:type:Store).
1180711821
parameters:
1180811822
- name: expand
1180911823
in: query
@@ -11897,7 +11911,7 @@ paths:
1189711911
- "view_orders:{projectKey}:{storeKey}"
1189811912
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsHead
1189911913
description: |-
11900-
Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
11914+
Checks if one or more Carts exist for the provided query predicate in a [Store](ctp:api:type:Store). Returns a `200 OK` status if any Carts match the query predicate or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
1190111915
parameters:
1190211916
- name: where
1190311917
in: query
@@ -11934,7 +11948,7 @@ paths:
1193411948
- "manage_orders:{projectKey}:{storeKey}"
1193511949
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsPost
1193611950
description: |-
11937-
Creates a [Cart](ctp:api:type:Cart) in the [Store](ctp:api:type:Store) specified by `storeKey`.
11951+
Creates a Cart in a [Store](ctp:api:type:Store).
1193811952

1193911953
If the referenced [ShippingMethod](ctp:api:type:ShippingMethod) in the [CartDraft](ctp:api:type:CartDraft) has a predicate that does not match, or if the Shipping Method is not active, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
1194011954

@@ -12053,7 +12067,7 @@ paths:
1205312067
- "view_orders:{projectKey}:{storeKey}"
1205412068
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdHead
1205512069
description: |-
12056-
Checks if a Cart of a Customer exists. Returns a `200 OK` status if the Cart exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
12070+
Checks if one or more Carts exist for a Customer in a [Store](ctp:api:type:Store). Returns a `200 OK` status if the Cart exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
1205712071
responses:
1205812072
"200":
1205912073
description: |-
@@ -12097,6 +12111,8 @@ paths:
1209712111
- "view_orders:{projectKey}:{storeKey}"
1209812112
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyGet
1209912113
description: |-
12114+
Retrieves a Cart with the provided `key` in a [Store](ctp:api:type:Store).
12115+
1210012116
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1210112117

1210212118
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action.
@@ -12140,7 +12156,7 @@ paths:
1214012156
- "view_orders:{projectKey}:{storeKey}"
1214112157
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyHead
1214212158
description: |-
12143-
Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
12159+
Checks if a Cart exists for the provided `key` in a [Store](ctp:api:type:Store). Returns a `200 OK` status if the Cart exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
1214412160
responses:
1214512161
"200":
1214612162
description: |-
@@ -12167,6 +12183,8 @@ paths:
1216712183
- "manage_orders:{projectKey}:{storeKey}"
1216812184
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyPost
1216912185
description: |-
12186+
Updates a Cart in a [Store](ctp:api:type:Store) using one or more [update actions](/../projects/carts#update-actions).
12187+
1217012188
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1217112189
parameters:
1217212190
- name: expand
@@ -12216,6 +12234,8 @@ paths:
1221612234
- "manage_orders:{projectKey}:{storeKey}"
1221712235
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyDelete
1221812236
description: |-
12237+
Deletes a Cart in a [Store](ctp:api:type:Store).
12238+
1221912239
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1222012240
parameters:
1222112241
- name: dataErasure
@@ -12350,6 +12370,8 @@ paths:
1235012370
- "view_orders:{projectKey}:{storeKey}"
1235112371
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsByIDGet
1235212372
description: |-
12373+
Retrieves a Cart with the provided `id` in a [Store](ctp:api:type:Store).
12374+
1235312375
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1235412376

1235512377
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action.
@@ -12393,7 +12415,7 @@ paths:
1239312415
- "view_orders:{projectKey}:{storeKey}"
1239412416
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsByIDHead
1239512417
description: |-
12396-
Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
12418+
Checks if a Cart exists for the provided `id` in a Store. Returns a `200 OK` status if the Cart exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
1239712419
responses:
1239812420
"200":
1239912421
description: |-
@@ -12420,7 +12442,8 @@ paths:
1242012442
- "manage_orders:{projectKey}:{storeKey}"
1242112443
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsByIDPost
1242212444
description: |-
12423-
Updates a [Cart](ctp:api:type:Cart) in the [Store](ctp:api:type:Store) specified by `storeKey`.
12445+
Updates a Cart in a [Store](ctp:api:type:Store) using one or more [update actions](/../projects/carts#update-actions).
12446+
1242412447
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1242512448
parameters:
1242612449
- name: expand
@@ -12470,6 +12493,8 @@ paths:
1247012493
- "manage_orders:{projectKey}:{storeKey}"
1247112494
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsByIDDelete
1247212495
description: |-
12496+
Deletes a Cart in a [Store](ctp:api:type:Store).
12497+
1247312498
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1247412499
parameters:
1247512500
- name: dataErasure

0 commit comments

Comments
 (0)