Skip to content

Commit 2ab2b56

Browse files
committed
Updated API from documentation release
1 parent bb9d1c5 commit 2ab2b56

39 files changed

+170
-170
lines changed

api-specs/api/resources/api-clients.raml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ get:
1616
example: !include ../examples/api-clients.example.json
1717
head:
1818
securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
19-
description: Checks if an API Client exists for a given Query Predicate. Returns a `200 OK` status if any API Clients match the Query Predicate or a `404 Not Found` otherwise.
19+
description: Checks if an API Client exists for the provided query predicate. Returns a `200 OK` status if any API Clients match the query predicate, or a `404 Not Found` otherwise.
2020
queryParameters:
2121
where?:
2222
type: QueryPredicate[]
@@ -54,7 +54,7 @@ post:
5454
type: ApiClient
5555
head:
5656
securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
57-
description: Checks if an API Client exists for a given `id`. Returns a `200 OK` status if the API Client exists or a `404 Not Found` otherwise.
57+
description: Checks if an API Client exists with the provided `id`. Returns a `200 OK` status if the API Client exists or a `404 Not Found` otherwise.
5858
delete:
5959
securedBy: [oauth_2_0: { scopes: ['manage_api_clients:{projectKey}'] }]
6060
displayName: Delete ApiClient by ID

api-specs/api/resources/as-associate.raml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ type: base
2727
example: !include ../examples/business-units.example.json
2828
head:
2929
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
30-
description: Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise.
30+
description: Checks if one or more BusinessUnits exist for the provided query predicate. Returns a `200 OK` status if any BusinessUnits match the query predicate, or a `404 Not Found` otherwise.
3131
queryParameters:
3232
where?:
3333
type: QueryPredicate[]
@@ -57,7 +57,7 @@ type: base
5757
example: !include ../examples/business-unit.example.json
5858
head:
5959
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
60-
description: Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
60+
description: Checks if a BusinessUnit exists with the provided `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
6161
post:
6262
securedBy:
6363
[oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
@@ -85,7 +85,7 @@ type: base
8585
example: !include ../examples/business-unit.example.json
8686
head:
8787
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
88-
description: Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
88+
description: Checks if a BusinessUnit exists with the provided `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
8989
post:
9090
securedBy:
9191
[oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
@@ -247,7 +247,7 @@ type: base
247247
example: !include ../examples/b2b-carts.example.json
248248
head:
249249
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
250-
description: 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.
250+
description: 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.
251251
queryParameters:
252252
where?:
253253
type: QueryPredicate[]
@@ -292,7 +292,7 @@ type: base
292292
example: !include ../examples/b2b-cart.example.json
293293
head:
294294
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
295-
description: Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
295+
description: Checks if a Cart exists with the provided `key`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
296296
post:
297297
displayName: Update cart by key in business unit
298298
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -336,7 +336,7 @@ type: base
336336
example: !include ../examples/b2b-cart.example.json
337337
head:
338338
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
339-
description: Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
339+
description: Checks if a Cart exists with the provided `id`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
340340
post:
341341
displayName: Update cart by id in business unit
342342
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -418,7 +418,7 @@ type: base
418418
displayName: Check if ShoppingList exists in BusinessUnit by Query Predicate
419419
securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
420420
description: |
421-
Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` if any ShoppingLists match the Query Predicate; otherwise, returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
421+
Checks if one or more ShoppingLists exist for the provided query predicate. Returns a `200 OK` if any ShoppingLists match the Query Predicate; otherwise, returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
422422
queryParameters:
423423
where?:
424424
type: QueryPredicate[]
@@ -471,7 +471,7 @@ type: base
471471
securedBy:
472472
[oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
473473
description: |
474-
Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` if the ShoppingList exists; otherwise, returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
474+
Checks if a ShoppingList exists with the provided `key`. Returns a `200 OK` if the ShoppingList exists; otherwise, returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
475475
post:
476476
displayName: Update ShoppingList in BusinessUnit by Key
477477
securedBy:
@@ -540,7 +540,7 @@ type: base
540540
securedBy:
541541
[oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
542542
description: |
543-
Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` if the ShoppingList exists; otherwise, returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
543+
Checks if a ShoppingList exists with the provided `id`. Returns a `200 OK` if the ShoppingList exists; otherwise, returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
544544
post:
545545
displayName: Update ShoppingList in BusinessUnit by ID
546546
securedBy:
@@ -601,7 +601,7 @@ type: base
601601
example: !include ../examples/orders.example.json
602602
head:
603603
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
604-
description: Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise.
604+
description: Checks if one or more Orders exist for the provided query predicate. Returns a `200 OK` status if any Orders match the query predicate, or a `404 Not Found` otherwise.
605605
queryParameters:
606606
where?:
607607
type: QueryPredicate[]
@@ -713,7 +713,7 @@ type: base
713713
example: !include ../examples/order.example.json
714714
head:
715715
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
716-
description: Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
716+
description: Checks if an Order exists with the provided `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
717717
post:
718718
displayName: Update order by id in business unit
719719
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -748,7 +748,7 @@ type: base
748748
example: !include ../examples/quotes.example.json
749749
head:
750750
securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
751-
description: Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise.
751+
description: Checks if one or more Quotes exist for the provided query predicate. Returns a `200 OK` status if any Quotes match the query predicate, or a `404 Not Found` otherwise.
752752
queryParameters:
753753
where?:
754754
type: QueryPredicate[]
@@ -770,7 +770,7 @@ type: base
770770
example: !include ../examples/quote.example.json
771771
head:
772772
securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
773-
description: Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.
773+
description: Checks if a Quote exists with the provided `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.
774774
post:
775775
securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
776776
description: |
@@ -801,7 +801,7 @@ type: base
801801
example: !include ../examples/quote.example.json
802802
head:
803803
securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
804-
description: Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.
804+
description: Checks if a Quote exists with the provided `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise.
805805
post:
806806
securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
807807
description: |
@@ -834,7 +834,7 @@ type: base
834834
example: !include ../examples/quote-requests.example.json
835835
head:
836836
securedBy: [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
837-
description: Checks if a QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise.
837+
description: Checks if one or more QuoteRequests exist for the provided query predicate. Returns a `200 OK` status if any QuoteRequests match the query predicate, or a `404 Not Found` otherwise.
838838
queryParameters:
839839
where?:
840840
type: QueryPredicate[]
@@ -872,7 +872,7 @@ type: base
872872
head:
873873
securedBy:
874874
[oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
875-
description: Checks if a QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.
875+
description: Checks if a QuoteRequest exists with the provided `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.
876876
post:
877877
securedBy:
878878
[oauth_2_0: { scopes: ['manage_quote_requests:{projectKey}'] }]
@@ -906,7 +906,7 @@ type: base
906906
head:
907907
securedBy:
908908
[oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
909-
description: Checks if a QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.
909+
description: Checks if a QuoteRequest exists with the provided `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise.
910910
post:
911911
securedBy:
912912
[oauth_2_0: { scopes: ['manage_quote_requests:{projectKey}'] }]

api-specs/api/resources/associate-roles.raml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ get:
1818
example: !include ../examples/associate-roles.example.json
1919
head:
2020
securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
21-
description: Checks if an AssociateRole exists for a given Query Predicate. Returns a `200 OK` status if any AssociateRole match the Query Predicate or a `404 Not Found` otherwise.
21+
description: Checks if one or more AssociateRoles exist for the provided query predicate. Returns a `200 OK` status if any AssociateRole match the query predicate, or a `404 Not Found` otherwise.
2222
queryParameters:
2323
where?:
2424
type: QueryPredicate[]
@@ -50,7 +50,7 @@ post:
5050
example: !include ../examples/associate-role.example.json
5151
head:
5252
securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
53-
description: Checks if an AssociateRole exists for a given `key`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.
53+
description: Checks if an AssociateRole exists with the provided `key`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.
5454
post:
5555
securedBy: [oauth_2_0: { scopes: ['manage_associate_roles:{projectKey}'] }]
5656
body:
@@ -86,7 +86,7 @@ post:
8686
example: !include ../examples/associate-role.example.json
8787
head:
8888
securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
89-
description: Checks if an AssociateRole exists for a given `id`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.
89+
description: Checks if an AssociateRole exists with the provided `id`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.
9090
post:
9191
securedBy: [oauth_2_0: { scopes: ['manage_associate_roles:{projectKey}'] }]
9292
body:

api-specs/api/resources/attribute-groups.raml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ get:
1818
example: !include ../examples/AttributeGroup/AttributeGroups.json
1919
head:
2020
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
21-
description: Checks if an AttributeGroup exists for a given Query Predicate. Returns `200 OK` status if any AttributeGroups match the Query Predicate or a `404 Not Found` otherwise.
21+
description: Checks if one or more AttributeGroups exist for the provided query predicate. Returns `200 OK` status if any AttributeGroups match the query predicate, or a `404 Not Found` otherwise.
2222
queryParameters:
2323
where?:
2424
type: QueryPredicate[]
@@ -53,7 +53,7 @@ post:
5353
example: !include ../examples/AttributeGroup/AttributeGroup.json
5454
head:
5555
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
56-
description: Checks if an AttributeGroup exists for a given `key`. Returns `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.
56+
description: Checks if an AttributeGroup exists with the provided `key`. Returns `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.
5757
post:
5858
securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
5959
body:
@@ -87,7 +87,7 @@ post:
8787
example: !include ../examples/AttributeGroup/AttributeGroup.json
8888
head:
8989
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
90-
description: Checks if an AttributeGroup exists for a given `id`. Returns a `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.
90+
description: Checks if an AttributeGroup exists with the provided `id`. Returns a `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.
9191
post:
9292
securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
9393
body:

api-specs/api/resources/business-units.raml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ get:
1818
example: !include ../examples/business-units.example.json
1919
head:
2020
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
21-
description: Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise.
21+
description: Checks if one or more BusinessUnits exist for the provided query predicate. Returns a `200 OK` status if any BusinessUnits match the query predicate, or a `404 Not Found` otherwise.
2222
queryParameters:
2323
where?:
2424
type: QueryPredicate[]
@@ -48,7 +48,7 @@ post:
4848
example: !include ../examples/business-unit.example.json
4949
head:
5050
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
51-
description: Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
51+
description: Checks if a BusinessUnit exists with the provided `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
5252
post:
5353
securedBy: [oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
5454
body:
@@ -82,7 +82,7 @@ post:
8282
example: !include ../examples/business-unit.example.json
8383
head:
8484
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
85-
description: Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
85+
description: Checks if a BusinessUnit exists with the provided `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
8686
post:
8787
securedBy: [oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
8888
body:

api-specs/api/resources/cart-discounts.raml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ head:
3434
['view_orders:{projectKey}', 'view_cart_discounts:{projectKey}'],
3535
},
3636
]
37-
description: Checks if a CartDiscount exists for a given Query Predicate. Returns a `200 OK` status if any CartDiscounts match the Query Predicate, or a `404 Not Found` otherwise.
37+
description: Checks if one or more CartDiscounts exist for the provided query predicate. Returns a `200 OK` status if any CartDiscounts match the query predicate, or a `404 Not Found` otherwise.
3838
queryParameters:
3939
where?:
4040
type: QueryPredicate[]
@@ -89,7 +89,7 @@ post:
8989
['view_orders:{projectKey}', 'view_cart_discounts:{projectKey}'],
9090
},
9191
]
92-
description: Checks if a CartDiscount exists for a given `key`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.
92+
description: Checks if a CartDiscount exists with the provided `key`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.
9393
post:
9494
securedBy:
9595
[
@@ -158,7 +158,7 @@ post:
158158
['view_orders:{projectKey}', 'view_cart_discounts:{projectKey}'],
159159
},
160160
]
161-
description: Checks if a CartDiscount exists for a given `id`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.
161+
description: Checks if a CartDiscount exists with the provided `id`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise.
162162
post:
163163
securedBy:
164164
[

api-specs/api/resources/carts.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ post:
112112
example: !include ../examples/cart.example.json
113113
head:
114114
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
115-
description: Checks if a Cart exists for the provided `key`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
115+
description: Checks if a Cart exists with the provided `key`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
116116
post:
117117
description: Updates a Cart in the Project using one or more [update actions](/../api/projects/carts#update-actions).
118118
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]

0 commit comments

Comments
 (0)