Skip to content

Commit 4f44e52

Browse files
committed
Updated API from documentation release
1 parent 998e6d8 commit 4f44e52

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+237
-237
lines changed

api-specs/api/api.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ resourceTypes:
212212
head:
213213
displayName: Check if Project exists
214214
securedBy: [oauth_2_0: { scopes: ['view_project_settings:{projectKey}'] }]
215-
description: Checks if a Project exists for a given `projectKey`. Returns a `200 OK` status if the Project exists or a `404 Not Found` otherwise.
215+
description: Checks if a Project exists for a given `projectKey`. Returns a `200` status if the Project exists, or a `404` status otherwise.
216216
responses:
217217
200:
218218
post:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ get:
1818
head:
1919
displayName: Check if ApiClient exists by Query Predicate
2020
securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
21-
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.
21+
description: Checks if an API Client exists for the provided query predicate. Returns a `200` status if any API Clients match the query predicate, or a `404` status otherwise.
2222
queryParameters:
2323
where?:
2424
type: QueryPredicate[]
@@ -58,7 +58,7 @@ post:
5858
head:
5959
displayName: Check if ApiClient exists by ID
6060
securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
61-
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.
61+
description: Checks if an API Client exists with the provided `id`. Returns a `200` status if the API Client exists, or a `404` status otherwise.
6262
delete:
6363
displayName: Delete ApiClient by ID
6464
securedBy: [oauth_2_0: { scopes: ['manage_api_clients:{projectKey}'] }]

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ type: base
2828
head:
2929
displayName: Check if BusinessUnit exists by Query Predicate as Associate
3030
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
31-
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.
31+
description: Checks if one or more BusinessUnits exist for the provided query predicate. Returns a `200` status if any BusinessUnits match the query predicate, or a `404` status otherwise.
3232
queryParameters:
3333
where?:
3434
type: QueryPredicate[]
@@ -61,7 +61,7 @@ type: base
6161
head:
6262
displayName: Check if BusinessUnit exists by Key as Associate
6363
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
64-
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.
64+
description: Checks if a BusinessUnit exists with the provided `key`. Returns a `200` status if the BusinessUnit exists, or a `404` status otherwise.
6565
post:
6666
displayName: Update BusinessUnit by Key as Associate
6767
securedBy:
@@ -92,7 +92,7 @@ type: base
9292
head:
9393
displayName: Check if BusinessUnit exists by ID as Associate
9494
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
95-
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.
95+
description: Checks if a BusinessUnit exists with the provided `id`. Returns a `200` status if the BusinessUnit exists, or a `404` status otherwise.
9696
post:
9797
displayName: Update BusinessUnit by ID as Associate
9898
securedBy:
@@ -265,7 +265,7 @@ type: base
265265
head:
266266
displayName: Check if Cart exists in BusinessUnit by Query Predicate as Associate
267267
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
268-
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.
268+
description: Checks if one or more Carts exist for the provided query predicate. Returns a `200` status if any Carts match the query predicate, or a `404` status otherwise.
269269
queryParameters:
270270
where?:
271271
type: QueryPredicate[]
@@ -311,7 +311,7 @@ type: base
311311
head:
312312
displayName: Check if Cart exists in BusinessUnit by Key as Associate
313313
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
314-
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.
314+
description: Checks if a Cart exists with the provided `key`. Returns a `200` status if the Cart exists, or a `404` status otherwise.
315315
post:
316316
displayName: Update Cart in BusinessUnit by Key as Associate
317317
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -356,7 +356,7 @@ type: base
356356
head:
357357
displayName: Check if Cart exists in BusinessUnit by ID as Associate
358358
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
359-
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.
359+
description: Checks if a Cart exists with the provided `id`. Returns a `200` status if the Cart exists, or a `404` status otherwise.
360360
post:
361361
displayName: Update Cart in BusinessUnit by ID as Associate
362362
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -439,7 +439,7 @@ type: base
439439
displayName: Check if ShoppingList exists in BusinessUnit by Query Predicate as Associate
440440
securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
441441
description: |
442-
Checks if one or more ShoppingLists exist for the provided query predicate in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` if any ShoppingLists match the query predicate; otherwise, returns [Not Found](/../api/errors#404-not-found).
442+
Checks if one or more ShoppingLists exist for the provided query predicate in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200` status if any ShoppingLists match the query predicate, or a `404` status otherwise.
443443
queryParameters:
444444
where?:
445445
type: QueryPredicate[]
@@ -493,7 +493,7 @@ type: base
493493
securedBy:
494494
[oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
495495
description: |
496-
Checks if a ShoppingList exists with the provided `key` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` if the ShoppingList exists; otherwise, returns [Not Found](/../api/errors#404-not-found).
496+
Checks if a ShoppingList exists with the provided `key` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200` status if the ShoppingList exists, or a `404` status otherwise.
497497
post:
498498
displayName: Update ShoppingList in BusinessUnit by Key as Associate
499499
securedBy:
@@ -567,7 +567,7 @@ type: base
567567
securedBy:
568568
[oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
569569
description: |
570-
Checks if a ShoppingList exists with the provided `id` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` if the ShoppingList exists; otherwise, returns [Not Found](/../api/errors#404-not-found).
570+
Checks if a ShoppingList exists with the provided `id` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200` status if the ShoppingList exists, or a `404` status otherwise.
571571
post:
572572
displayName: Update ShoppingList in BusinessUnit by ID as Associate
573573
securedBy:
@@ -633,7 +633,7 @@ type: base
633633
head:
634634
displayName: Check if Order exists in BusinessUnit by Query Predicate as Associate
635635
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
636-
description: Checks if one or more Orders exist with provided query predicate in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` status if any Orders match the query predicate, or a `404 Not Found` otherwise.
636+
description: Checks if one or more Orders exist with provided query predicate in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200` status if any Orders match the query predicate, or a `404` status otherwise.
637637
queryParameters:
638638
where?:
639639
type: QueryPredicate[]
@@ -715,7 +715,7 @@ type: base
715715
head:
716716
displayName: Check if Order exists in BusinessUnit by OrderNumber as Associate
717717
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
718-
description: Checks if an Order exists with the provided `orderNumber` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
718+
description: Checks if an Order exists with the provided `orderNumber` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200` status if the Order exists, or a `404` status otherwise.
719719
post:
720720
displayName: Update Order in BusinessUnit by OrderNumber as Associate
721721
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -751,7 +751,7 @@ type: base
751751
head:
752752
displayName: Check if Order exists in BusinessUnit by ID as Associate
753753
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
754-
description: Checks if an Order exists with the provided `id` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
754+
description: Checks if an Order exists with the provided `id` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200` status if the Order exists, or a `404` status otherwise.
755755
post:
756756
displayName: Update Order in BusinessUnit by ID as Associate
757757
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -789,7 +789,7 @@ type: base
789789
head:
790790
displayName: Check if Quote exists in BusinessUnit by Query Predicate as Associate
791791
securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
792-
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.
792+
description: Checks if one or more Quotes exist for the provided query predicate. Returns a `200` status if any Quotes match the query predicate, or a `404` status otherwise.
793793
queryParameters:
794794
where?:
795795
type: QueryPredicate[]
@@ -813,7 +813,7 @@ type: base
813813
head:
814814
displayName: Check if Quote exists in BusinessUnit by Key as Associate
815815
securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
816-
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.
816+
description: Checks if a Quote exists with the provided `key`. Returns a `200` status if the Quote exists, or a `404` status otherwise.
817817
post:
818818
displayName: Update Quote in BusinessUnit by Key as Associate
819819
securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
@@ -847,7 +847,7 @@ type: base
847847
head:
848848
displayName: Check if Quote exists in BusinessUnit by ID as Associate
849849
securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
850-
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.
850+
description: Checks if a Quote exists with the provided `id`. Returns a `200` status if the Quote exists, or a `404` status otherwise.
851851
post:
852852
displayName: Update Quote in BusinessUnit by ID as Associate
853853
securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
@@ -883,7 +883,7 @@ type: base
883883
head:
884884
displayName: Check if QuoteRequest exists in BusinessUnit by Query Predicate as Associate
885885
securedBy: [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
886-
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.
886+
description: Checks if one or more QuoteRequests exist for the provided query predicate. Returns a `200` status if any QuoteRequests match the query predicate, or a `404` status otherwise.
887887
queryParameters:
888888
where?:
889889
type: QueryPredicate[]
@@ -924,7 +924,7 @@ type: base
924924
displayName: Check if QuoteRequest exists in BusinessUnit by Key as Associate
925925
securedBy:
926926
[oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
927-
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.
927+
description: Checks if a QuoteRequest exists with the provided `key`. Returns a `200` status if the QuoteRequest exists, or a `404` status otherwise.
928928
post:
929929
displayName: Update QuoteRequest in BusinessUnit by Key as Associate
930930
securedBy:
@@ -961,7 +961,7 @@ type: base
961961
displayName: Check if QuoteRequest exists in BusinessUnit by ID as Associate
962962
securedBy:
963963
[oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
964-
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.
964+
description: Checks if a QuoteRequest exists with the provided `id`. Returns a `200` status if the QuoteRequest exists, or a `404` status otherwise.
965965
post:
966966
displayName: Update QuoteRequest in BusinessUnit by ID as Associate
967967
securedBy:

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ get:
2020
head:
2121
displayName: Check if AssociateRole exists by Query Predicate
2222
securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
23-
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.
23+
description: Checks if one or more AssociateRoles exist for the provided query predicate. Returns a `200` status if any AssociateRole match the query predicate, or a `404` status otherwise.
2424
queryParameters:
2525
where?:
2626
type: QueryPredicate[]
@@ -55,7 +55,7 @@ post:
5555
head:
5656
displayName: Check if AssociateRole exists by Key
5757
securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
58-
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.
58+
description: Checks if an AssociateRole exists with the provided `key`. Returns a `200` status if the AssociateRole exists, or a `404` status otherwise.
5959
post:
6060
displayName: Update AssociateRole by Key
6161
securedBy: [oauth_2_0: { scopes: ['manage_associate_roles:{projectKey}'] }]
@@ -95,7 +95,7 @@ post:
9595
head:
9696
displayName: Check if AssociateRole exists by ID
9797
securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
98-
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.
98+
description: Checks if an AssociateRole exists with the provided `id`. Returns a `200` status if the AssociateRole exists, or a `404` status otherwise.
9999
post:
100100
displayName: Update AssociateRole by ID
101101
securedBy: [oauth_2_0: { scopes: ['manage_associate_roles:{projectKey}'] }]

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ get:
2020
head:
2121
displayName: Check if AttributeGroup exists by Query Predicate
2222
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
23-
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.
23+
description: Checks if one or more AttributeGroups exist for the provided query predicate. Returns `200` status if any AttributeGroups match the query predicate, or a `404` status otherwise.
2424
queryParameters:
2525
where?:
2626
type: QueryPredicate[]
@@ -58,7 +58,7 @@ post:
5858
head:
5959
displayName: Check if AttributeGroup exists by Key
6060
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
61-
description: Checks if an AttributeGroup exists with the provided `key`. Returns `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.
61+
description: Checks if an AttributeGroup exists with the provided `key`. Returns `200` status if the AttributeGroup exists, or a `404` status otherwise.
6262
post:
6363
displayName: Update AttributeGroup by Key
6464
securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
@@ -96,7 +96,7 @@ post:
9696
head:
9797
displayName: Check if AttributeGroup exists by ID
9898
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
99-
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.
99+
description: Checks if an AttributeGroup exists with the provided `id`. Returns a `200` status if the AttributeGroup exists, or a `404` status otherwise.
100100
post:
101101
displayName: Update AttributeGroup by ID
102102
securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ get:
2020
head:
2121
displayName: Check if BusinessUnit exists by Query Predicate
2222
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
23-
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.
23+
description: Checks if one or more BusinessUnits exist for the provided query predicate. Returns a `200` status if any BusinessUnits match the query predicate, or a `404` status otherwise.
2424
queryParameters:
2525
where?:
2626
type: QueryPredicate[]
@@ -53,7 +53,7 @@ post:
5353
head:
5454
displayName: Check if BusinessUnit exists by Key
5555
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
56-
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.
56+
description: Checks if a BusinessUnit exists with the provided `key`. Returns a `200` status if the BusinessUnit exists, or a `404` status otherwise.
5757
post:
5858
displayName: Update BusinessUnit by Key
5959
securedBy: [oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
@@ -91,7 +91,7 @@ post:
9191
head:
9292
displayName: Check if BusinessUnit exists by ID
9393
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
94-
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.
94+
description: Checks if a BusinessUnit exists with the provided `id`. Returns a `200` status if the BusinessUnit exists, or a `404` status otherwise.
9595
post:
9696
displayName: Update BusinessUnit by ID
9797
securedBy: [oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]

0 commit comments

Comments
 (0)