Skip to content

Commit 9d92b9d

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 09f7ffe commit 9d92b9d

File tree

6 files changed

+76
-38
lines changed

6 files changed

+76
-38
lines changed

bruno/api/Project/In-store/Shipping-methods/Matching-cart/ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
meta {
2-
name: Get matching ShippingMethods for a Cart in Store
2+
name: Get matching ShippingMethods for a Cart in a Store
33
type: http
44
seq: 740
55
}

bruno/api/Project/Shipping-methods/Matching-cart-location/ByProjectKeyShippingMethodsMatchingCartLocationGet.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
meta {
2-
name: Get ShippingMethods for a Cart and Location
2+
name: Get matching ShippingMethods for a Cart and Location
33
type: http
44
seq: 452
55
}

bruno/api/Project/Shipping-methods/Matching-cart/ByProjectKeyShippingMethodsMatchingCartGet.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
meta {
2-
name: Get ShippingMethods for a Cart
2+
name: Get matching ShippingMethods for a Cart
33
type: http
44
seq: 450
55
}

bruno/api/Project/Shipping-methods/Matching-location/ByProjectKeyShippingMethodsMatchingLocationGet.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
meta {
2-
name: Get ShippingMethods for a Location
2+
name: Get matching ShippingMethods for a Location
33
type: http
44
seq: 456
55
}

bruno/api/Project/Shipping-methods/Matching-orderedit/ByProjectKeyShippingMethodsMatchingOrdereditGet.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
meta {
2-
name: Get ShippingMethods for an Order Edit
2+
name: Get matching ShippingMethods for an OrderEdit
33
type: http
44
seq: 454
55
}

oas/api/openapi.yaml

Lines changed: 71 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -19556,7 +19556,7 @@ paths:
1955619556
$ref: '#/components/responses/errorable_503'
1955719557
/{projectKey}/in-store/key={storeKey}/shipping-methods/matching-cart:
1955819558
description: |-
19559-
Get ShippingMethods for a cart in a store
19559+
Get matching ShippingMethods for a Cart in a Store
1956019560
parameters:
1956119561
- name: projectKey
1956219562
in: path
@@ -19579,9 +19579,10 @@ paths:
1957919579
- "manage_my_orders:{projectKey}:{storeKey}"
1958019580
operationId: ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
1958119581
description: |-
19582-
Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store).
19583-
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
19584-
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
19582+
Retrieves the active ShippingMethods that can ship to the shipping address of the provided Cart in a [Store](ctp:api:type:Store).
19583+
19584+
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
19585+
1958519586
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
1958619587
parameters:
1958719588
- name: cartId
@@ -19634,7 +19635,7 @@ paths:
1963419635
- "manage_my_orders:{projectKey}:{storeKey}"
1963519636
operationId: ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartHead
1963619637
description: |-
19637-
Checks if an active ShippingMethod that can ship to the shipping address of the given Cart exists in the given [Store](ctp:api:type:Store). Returns a `200` status if the ShippingMethod exists, or a `404` status otherwise.
19638+
Checks if an active ShippingMethod that can ship to the shipping address of the provided Cart exists in a [Store](ctp:api:type:Store). Returns a `200 OK` status if the ShippingMethod exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
1963819639
parameters:
1963919640
- name: cartId
1964019641
in: query
@@ -34600,6 +34601,8 @@ paths:
3460034601
- "view_shipping_methods:{projectKey}"
3460134602
- "manage_my_orders:{projectKey}"
3460234603
operationId: ByProjectKeyShippingMethodsGet
34604+
description: |-
34605+
Retrieves all ShippingMethods in the Project.
3460334606
parameters:
3460434607
- name: expand
3460534608
in: query
@@ -34694,7 +34697,7 @@ paths:
3469434697
- "manage_my_orders:{projectKey}"
3469534698
operationId: ByProjectKeyShippingMethodsHead
3469634699
description: |-
34697-
Checks if one or more ShippingMethods exist for the provided query predicate. Returns a `200` status if any ShippingMethods match the query predicate, or a `404` status otherwise.
34700+
Checks if one or more ShippingMethods exist for the provided query predicate. Returns a `200 OK` status if any ShippingMethods match the query predicate or a [Not Found](/../api/errors#404-not-found) error otherwise.
3469834701
parameters:
3469934702
- name: where
3470034703
in: query
@@ -34730,6 +34733,8 @@ paths:
3473034733
- "manage_orders:{projectKey}"
3473134734
- "manage_shipping_methods:{projectKey}"
3473234735
operationId: ByProjectKeyShippingMethodsPost
34736+
description: |-
34737+
Creates a ShippingMethod in the Project.
3473334738
parameters:
3473434739
- name: expand
3473534740
in: query
@@ -34788,6 +34793,8 @@ paths:
3478834793
- "view_shipping_methods:{projectKey}"
3478934794
- "manage_my_orders:{projectKey}"
3479034795
operationId: ByProjectKeyShippingMethodsKeyByKeyGet
34796+
description: |-
34797+
Retrieves a ShippingMethod with the provided `key`.
3479134798
parameters:
3479234799
- name: expand
3479334800
in: query
@@ -34829,7 +34836,7 @@ paths:
3482934836
- "manage_my_orders:{projectKey}"
3483034837
operationId: ByProjectKeyShippingMethodsKeyByKeyHead
3483134838
description: |-
34832-
Checks if a ShippingMethod exists with the provided `key`. Returns a `200` status if the ShippingMethod exists, or a `404` status otherwise.
34839+
Checks if a ShippingMethod exists with the provided `key`. Returns a `200 OK` status if the ShippingMethod exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
3483334840
responses:
3483434841
"200":
3483534842
description: |-
@@ -34855,6 +34862,8 @@ paths:
3485534862
- "manage_orders:{projectKey}"
3485634863
- "manage_shipping_methods:{projectKey}"
3485734864
operationId: ByProjectKeyShippingMethodsKeyByKeyPost
34865+
description: |-
34866+
Updates a ShippingMethod in the Project using one or more [update actions](/../api/projects/shippingMethods#update-actions).
3485834867
parameters:
3485934868
- name: expand
3486034869
in: query
@@ -34902,6 +34911,8 @@ paths:
3490234911
- "manage_orders:{projectKey}"
3490334912
- "manage_shipping_methods:{projectKey}"
3490434913
operationId: ByProjectKeyShippingMethodsKeyByKeyDelete
34914+
description: |-
34915+
Deletes a ShippingMethod in the Project.
3490534916
parameters:
3490634917
- name: version
3490734918
in: query
@@ -34947,7 +34958,7 @@ paths:
3494734958
$ref: '#/components/responses/errorable_503'
3494834959
/{projectKey}/shipping-methods/matching-cart:
3494934960
description: |-
34950-
Get ShippingMethods for a Cart
34961+
Get matching ShippingMethods for a Cart
3495134962
parameters:
3495234963
- name: projectKey
3495334964
in: path
@@ -34962,9 +34973,10 @@ paths:
3496234973
- "manage_my_orders:{projectKey}"
3496334974
operationId: ByProjectKeyShippingMethodsMatchingCartGet
3496434975
description: |-
34965-
Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart.
34966-
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
34967-
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
34976+
Retrieves the active ShippingMethods that can ship to the shipping address of the provided Cart.
34977+
34978+
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
34979+
3496834980
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
3496934981
parameters:
3497034982
- name: cartId
@@ -35014,7 +35026,7 @@ paths:
3501435026
- "manage_my_orders:{projectKey}"
3501535027
operationId: ByProjectKeyShippingMethodsMatchingCartHead
3501635028
description: |-
35017-
Checks if an active ShippingMethod exists for the given Cart. If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array. Returns a `200` status if the ShippingMethod exists, or a `404` status otherwise.
35029+
Checks if an active ShippingMethod exists for the provided Cart. Returns a `200 OK` status if the ShippingMethod exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
3501835030
parameters:
3501935031
- name: cartId
3502035032
in: query
@@ -35044,7 +35056,7 @@ paths:
3504435056
content: {}
3504535057
/{projectKey}/shipping-methods/matching-cart-location:
3504635058
description: |-
35047-
Get ShippingMethods for a Cart and Location
35059+
Get matching ShippingMethods for a Cart and Location
3504835060
parameters:
3504935061
- name: projectKey
3505035062
in: path
@@ -35059,10 +35071,11 @@ paths:
3505935071
- "manage_my_orders:{projectKey}"
3506035072
operationId: ByProjectKeyShippingMethodsMatchingCartLocationGet
3506135073
description: |-
35062-
Retrieves the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location)
35063-
with a `predicate` that matches the given Cart.
35064-
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
35065-
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
35074+
Retrieves the active ShippingMethods that can ship to the provided [Location](ctp:api:type:Location)
35075+
with a `predicate` that matches the provided Cart.
35076+
35077+
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
35078+
3506635079
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
3506735080
parameters:
3506835081
- name: country
@@ -35126,7 +35139,7 @@ paths:
3512635139
- "manage_my_orders:{projectKey}"
3512735140
operationId: ByProjectKeyShippingMethodsMatchingCartLocationHead
3512835141
description: |-
35129-
Checks if an active ShippingMethod that can ship to the given [Location](ctp:api:type:Location) exists for the given Cart. Returns a `200` status if the ShippingMethod exists, or a `404` status otherwise.
35142+
Checks if an active ShippingMethod that can ship to the provided [Location](ctp:api:type:Location) exists for the provided Cart. Returns a `200 OK` status if the ShippingMethod exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
3513035143
parameters:
3513135144
- name: country
3513235145
in: query
@@ -35170,7 +35183,7 @@ paths:
3517035183
content: {}
3517135184
/{projectKey}/shipping-methods/matching-location:
3517235185
description: |-
35173-
Get ShippingMethods for a Location
35186+
Get matching ShippingMethods for a Location
3517435187
parameters:
3517535188
- name: projectKey
3517635189
in: path
@@ -35185,12 +35198,15 @@ paths:
3518535198
- "manage_my_orders:{projectKey}"
3518635199
operationId: ByProjectKeyShippingMethodsMatchingLocationGet
3518735200
description: |-
35188-
Retrieves the active ShippingMethods that can ship to the given [Location](/projects/zones#location).
35189-
ShippingMethods that have a `predicate` defined are automatically disqualified.
35190-
If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency.
35191-
Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`.
35192-
If the `currency` parameter is given, exactly one ShippingRate will contain it.
35193-
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
35201+
Retrieves the active ShippingMethods that can ship to the provided [Location](/projects/zones#location).
35202+
35203+
The following applies:
35204+
35205+
- ShippingMethods that have a `predicate` defined are automatically disqualified.
35206+
- If the `currency` parameter is provided, then the ShippingMethods must also have a rate defined in the specified currency.
35207+
- Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`.
35208+
- If the `currency` parameter is provided, exactly one ShippingRate will contain it.
35209+
- If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
3519435210
parameters:
3519535211
- name: country
3519635212
in: query
@@ -35262,7 +35278,7 @@ paths:
3526235278
- "manage_my_orders:{projectKey}"
3526335279
operationId: ByProjectKeyShippingMethodsMatchingLocationHead
3526435280
description: |-
35265-
Checks if an active ShippingMethod that can ship to the given [Location](ctp:api:type:Location) exists. Returns a `200` status if the ShippingMethod exists, or a `404` status otherwise.
35281+
Checks if an active ShippingMethod that can ship to the provided [Location](ctp:api:type:Location) exists. Returns a `200 OK` status if the ShippingMethod exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
3526635282
parameters:
3526735283
- name: country
3526835284
in: query
@@ -35306,7 +35322,7 @@ paths:
3530635322
content: {}
3530735323
/{projectKey}/shipping-methods/matching-orderedit:
3530835324
description: |-
35309-
Get ShippingMethods for an Order Edit
35325+
Get matching ShippingMethods for an OrderEdit
3531035326
parameters:
3531135327
- name: projectKey
3531235328
in: path
@@ -35320,8 +35336,10 @@ paths:
3532035336
- "view_shipping_methods:{projectKey}"
3532135337
operationId: ByProjectKeyShippingMethodsMatchingOrdereditGet
3532235338
description: |-
35323-
Retrieves the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location) for an [OrderEdit](ctp:api:type:OrderEdit).
35339+
Retrieves the active ShippingMethods that can ship to the provided [Location](ctp:api:type:Location) for an [OrderEdit](ctp:api:type:OrderEdit).
35340+
3532435341
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
35342+
3532535343
If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned.
3532635344
parameters:
3532735345
- name: orderEditId
@@ -35375,7 +35393,7 @@ paths:
3537535393
- "view_shipping_methods:{projectKey}"
3537635394
operationId: ByProjectKeyShippingMethodsMatchingOrdereditHead
3537735395
description: |-
35378-
Checks if an active ShippingMethod that can ship to the given [Location](ctp:api:type:Location) exists for the given [OrderEdit](ctp:api:type:OrderEdit). Returns a `200` status if the ShippingMethod exists, or a `404` status otherwise.
35396+
Checks if an active ShippingMethod that can ship to the provided [Location](ctp:api:type:Location) exists for the provided [OrderEdit](ctp:api:type:OrderEdit). Returns a `200 OK` status if the ShippingMethod exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
3537935397
parameters:
3538035398
- name: orderEditId
3538135399
in: query
@@ -35436,6 +35454,8 @@ paths:
3543635454
- "view_shipping_methods:{projectKey}"
3543735455
- "manage_my_orders:{projectKey}"
3543835456
operationId: ByProjectKeyShippingMethodsByIDGet
35457+
description: |-
35458+
Retrieves a ShippingMethod with the provided `id`.
3543935459
parameters:
3544035460
- name: expand
3544135461
in: query
@@ -35477,7 +35497,7 @@ paths:
3547735497
- "manage_my_orders:{projectKey}"
3547835498
operationId: ByProjectKeyShippingMethodsByIDHead
3547935499
description: |-
35480-
Checks if a ShippingMethod exists with the provided `id`. Returns a `200` status if the ShippingMethod exists, or a `404` status otherwise.
35500+
Checks if a ShippingMethod exists with the provided `id`. Returns a `200 OK` status if the ShippingMethod exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
3548135501
responses:
3548235502
"200":
3548335503
description: |-
@@ -35503,6 +35523,8 @@ paths:
3550335523
- "manage_orders:{projectKey}"
3550435524
- "manage_shipping_methods:{projectKey}"
3550535525
operationId: ByProjectKeyShippingMethodsByIDPost
35526+
description: |-
35527+
Updates a ShippingMethod in the Project using one or more [update actions](/../api/projects/shippingMethods#update-actions).
3550635528
parameters:
3550735529
- name: expand
3550835530
in: query
@@ -35550,6 +35572,8 @@ paths:
3555035572
- "manage_orders:{projectKey}"
3555135573
- "manage_shipping_methods:{projectKey}"
3555235574
operationId: ByProjectKeyShippingMethodsByIDDelete
35575+
description: |-
35576+
Deletes a ShippingMethod in the Project.
3555335577
parameters:
3555435578
- name: version
3555535579
in: query
@@ -39791,6 +39815,8 @@ paths:
3979139815
- oauth_2_0:
3979239816
- "view_orders:{projectKey}"
3979339817
operationId: ByProjectKeyZonesGet
39818+
description: |-
39819+
Retrieves all Zones in the Project.
3979439820
parameters:
3979539821
- name: expand
3979639822
in: query
@@ -39883,7 +39909,7 @@ paths:
3988339909
- "view_orders:{projectKey}"
3988439910
operationId: ByProjectKeyZonesHead
3988539911
description: |-
39886-
Checks if one or more Zones exist for the provided query predicate. Returns a `200` status if any Zones match the query predicate, or a `404` status otherwise.
39912+
Checks if one or more Zones exist for the provided query predicate. Returns a `200 OK` status if any Zones match the query predicate, or a [Not Found](/../api/errors#404-not-found) error otherwise.
3988739913
parameters:
3988839914
- name: where
3988939915
in: query
@@ -39918,6 +39944,8 @@ paths:
3991839944
- oauth_2_0:
3991939945
- "manage_orders:{projectKey}"
3992039946
operationId: ByProjectKeyZonesPost
39947+
description: |-
39948+
Creates a Zone in the Project.
3992139949
parameters:
3992239950
- name: expand
3992339951
in: query
@@ -39974,6 +40002,8 @@ paths:
3997440002
- oauth_2_0:
3997540003
- "view_orders:{projectKey}"
3997640004
operationId: ByProjectKeyZonesKeyByKeyGet
40005+
description: |-
40006+
Retrieves a Zone with the provided `key`.
3997740007
parameters:
3997840008
- name: expand
3997940009
in: query
@@ -40013,7 +40043,7 @@ paths:
4001340043
- "view_orders:{projectKey}"
4001440044
operationId: ByProjectKeyZonesKeyByKeyHead
4001540045
description: |-
40016-
Checks if a Zone exists with the provided `key`. Returns a `200` status if the Zone exists, or a `404` status otherwise.
40046+
Checks if a Zone exists with the provided `key`. Returns a `200 OK` status if the Zone exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
4001740047
responses:
4001840048
"200":
4001940049
description: |-
@@ -40038,6 +40068,8 @@ paths:
4003840068
- oauth_2_0:
4003940069
- "manage_orders:{projectKey}"
4004040070
operationId: ByProjectKeyZonesKeyByKeyPost
40071+
description: |-
40072+
Updates a Zone in the Project using one or more [update actions](/../api/projects/zones#update-actions).
4004140073
parameters:
4004240074
- name: expand
4004340075
in: query
@@ -40084,6 +40116,8 @@ paths:
4008440116
- oauth_2_0:
4008540117
- "manage_orders:{projectKey}"
4008640118
operationId: ByProjectKeyZonesKeyByKeyDelete
40119+
description: |-
40120+
Deletes a Zone in the Project.
4008740121
parameters:
4008840122
- name: version
4008940123
in: query
@@ -40144,6 +40178,8 @@ paths:
4014440178
- oauth_2_0:
4014540179
- "view_orders:{projectKey}"
4014640180
operationId: ByProjectKeyZonesByIDGet
40181+
description: |-
40182+
Retrieves a Zone with the provided `id`.
4014740183
parameters:
4014840184
- name: expand
4014940185
in: query
@@ -40183,7 +40219,7 @@ paths:
4018340219
- "view_orders:{projectKey}"
4018440220
operationId: ByProjectKeyZonesByIDHead
4018540221
description: |-
40186-
Checks if a Zone exists with the provided `id`. Returns a `200` status if the Zone exists, or a `404` status otherwise.
40222+
Checks if a Zone exists with the provided `id`. Returns a `200 OK` status if the Zone exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
4018740223
responses:
4018840224
"200":
4018940225
description: |-
@@ -40254,6 +40290,8 @@ paths:
4025440290
- oauth_2_0:
4025540291
- "manage_orders:{projectKey}"
4025640292
operationId: ByProjectKeyZonesByIDDelete
40293+
description: |-
40294+
Deletes a Zone in the Project.
4025740295
parameters:
4025840296
- name: version
4025940297
in: query

0 commit comments

Comments
 (0)