Skip to content

Commit 275ce2c

Browse files
committed
Updated API from documentation release
1 parent a8d8174 commit 275ce2c

File tree

5 files changed

+128
-94
lines changed

5 files changed

+128
-94
lines changed

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

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,7 @@ type: base
402402
shopping-lists e.g. for wishlist support
403403
get:
404404
displayName: Query ShoppingLists in BusinessUnit
405+
description: Retrieves all ShoppingLists in a [BusinessUnit](ctp:api:type:BusinessUnit).
405406
securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
406407
queryParameters:
407408
expand:
@@ -418,7 +419,7 @@ type: base
418419
displayName: Check if ShoppingList exists in BusinessUnit by Query Predicate
419420
securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
420421
description: |
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.
422+
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).
422423
queryParameters:
423424
where?:
424425
type: QueryPredicate[]
@@ -460,6 +461,7 @@ type: base
460461
type: Expansion[]
461462
required: false
462463
description: |
464+
Retrieves a ShoppingList with the provided `key` in a [BusinessUnit](ctp:api:type:BusinessUnit).
463465
If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
464466
responses:
465467
200:
@@ -471,7 +473,7 @@ type: base
471473
securedBy:
472474
[oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
473475
description: |
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.
476+
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).
475477
post:
476478
displayName: Update ShoppingList in BusinessUnit by Key
477479
securedBy:
@@ -483,7 +485,8 @@ type: base
483485
type: Expansion[]
484486
required: false
485487
description: |
486-
If the Shopping List exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
488+
Updates a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/shoppingLists#update-actions).
489+
If the ShoppingList exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
487490
body:
488491
application/json:
489492
example: !include ../examples/shopping-list-update.example.json
@@ -505,6 +508,8 @@ type: base
505508
type: Expansion[]
506509
required: false
507510
description: |
511+
Deletes a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit).
512+
508513
If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
509514
responses:
510515
200:
@@ -529,6 +534,8 @@ type: base
529534
type: Expansion[]
530535
required: false
531536
description: |
537+
Retrieves a ShoppingList with the provided `key` in a [BusinessUnit](ctp:api:type:BusinessUnit).
538+
532539
If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
533540
responses:
534541
200:
@@ -540,7 +547,7 @@ type: base
540547
securedBy:
541548
[oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
542549
description: |
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.
550+
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).
544551
post:
545552
displayName: Update ShoppingList in BusinessUnit by ID
546553
securedBy:
@@ -555,6 +562,7 @@ type: base
555562
application/json:
556563
example: !include ../examples/shopping-list-update.example.json
557564
description: |
565+
Updates a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/shoppingLists#update-actions).
558566
If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
559567
responses:
560568
200:
@@ -574,6 +582,8 @@ type: base
574582
type: Expansion[]
575583
required: false
576584
description: |
585+
Deletes a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit).
586+
577587
If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
578588
responses:
579589
200:

0 commit comments

Comments
 (0)