Updated API from documentation release

commercetools · Aug 30, 2024 · 4f63a94 · 4f63a94
1 parent 94cd722
commit 4f63a94
Show file tree

Hide file tree

Showing 5 changed files with 87 additions and 31 deletions.
diff --git a/api-specs/api/resources/in-store.raml b/api-specs/api/resources/in-store.raml
@@ -35,6 +35,7 @@ uriParameters:
           application/json:
             example: !include ../examples/carts.example.json
   head:
+    displayName: Check if Cart exists in Store by Query Predicate
     securedBy:
       [
         oauth_2_0:
@@ -115,6 +116,7 @@ uriParameters:
             application/json:
               example: !include ../examples/cart.example.json
     head:
+      displayName: Check if Cart exists in Store by Customer ID
       securedBy:
         [
           oauth_2_0:
@@ -157,6 +159,7 @@ uriParameters:
             application/json:
               example: !include ../examples/cart.example.json
     head:
+      displayName: Check if Cart exists in Store by Key
       securedBy:
         [
           oauth_2_0:
@@ -280,6 +283,7 @@ uriParameters:
             application/json:
               example: !include ../examples/cart.example.json
     head:
+      displayName: Check if Cart exists in Store by ID
       securedBy:
         [
           oauth_2_0:
@@ -371,6 +375,7 @@ uriParameters:
           application/json:
             example: !include ../examples/orders.example.json
   head:
+    displayName: Check if Order exists in Store by Query Predicate
     securedBy:
       [
         oauth_2_0:
@@ -431,7 +436,7 @@ uriParameters:
     type: base
     displayName: Order from Quote
     post:
-      displayName: Create an Order from a Quote
+      displayName: Create Order in Store from Quote
       description: |
         Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message.
 
@@ -495,6 +500,7 @@ uriParameters:
             application/json:
               example: !include ../examples/order.example.json
     head:
+      displayName: Check if Order exists in Store by OrderNumber
       securedBy:
         [
           oauth_2_0:
@@ -582,6 +588,7 @@ uriParameters:
             application/json:
               example: !include ../examples/order.example.json
     head:
+      displayName: Check if My Order exists in Store by ID
       securedBy:
         [
           oauth_2_0:
@@ -677,7 +684,7 @@ uriParameters:
             application/json:
               example: !include ../examples/carts.example.json
     head:
-      displayName: Check if Cart exists in Store by Query Predicate
+      displayName: Check if My Cart exists in Store by Query Predicate
       securedBy:
         [
           oauth_2_0:
@@ -770,7 +777,7 @@ uriParameters:
               application/json:
                 example: !include ../examples/cart.example.json
       head:
-        displayName: Check if Cart exists in Store by ID
+        displayName: Check if My Cart exists in Store by ID
         securedBy:
           [
             oauth_2_0:
@@ -879,7 +886,7 @@ uriParameters:
             application/json:
               example: !include ../examples/orders.example.json
     head:
-      displayName: Check if Order exists in Store by Query Predicate
+      displayName: Check if My Order exists in Store by Query Predicate
       securedBy:
         [
           oauth_2_0:
@@ -987,7 +994,7 @@ uriParameters:
               application/json:
                 example: !include ../examples/order.example.json
       head:
-        displayName: Check if Order exists in Store by ID
+        displayName: Check if My Order exists in Store by ID
         securedBy:
           [
             oauth_2_0:
@@ -1047,6 +1054,7 @@ uriParameters:
               type: Cart
               example: !include ../examples/cart.example.json
     head:
+      displayName: Check if active Cart exists in Store
       securedBy:
         [
           oauth_2_0:
@@ -1115,7 +1123,7 @@ uriParameters:
             application/json:
               example: !include ../examples/shopping-lists.example.json
     head:
-      displayName: Check if ShoppingList exists by Query Predicate
+      displayName: Check if My ShoppingList exists in Store by Query Predicate
       securedBy:
         [
           oauth_2_0:
@@ -1219,7 +1227,7 @@ uriParameters:
               application/json:
                 example: !include ../examples/shopping-list.example.json
       head:
-        displayName: Check if ShoppingList exists by Key
+        displayName: Check if My ShoppingList exists in Store by Key
         securedBy:
           [
             oauth_2_0:
@@ -1360,7 +1368,7 @@ uriParameters:
               application/json:
                 example: !include ../examples/shopping-list.example.json
       head:
-        displayName: Check if ShoppingList exists by ID
+        displayName: Check if My ShoppingList exists in Store by ID
         securedBy:
           [
             oauth_2_0:
@@ -2169,7 +2177,7 @@ uriParameters:
   description: |
     shopping-lists e.g. for wishlist support
   get:
-    displayName: Get ShoppingLists in Store
+    displayName: Query ShoppingLists in Store
     securedBy:
       [
         oauth_2_0:
@@ -2193,6 +2201,7 @@ uriParameters:
           application/json:
             example: !include ../examples/shopping-lists.example.json
   head:
+    displayName: Check if ShoppingList exists in Store by Query Predicate
     securedBy:
       [
         oauth_2_0:
@@ -2209,7 +2218,7 @@ uriParameters:
       where?:
         type: QueryPredicate[]
   post:
-    displayName: Create ShoppingLists in Store
+    displayName: Create ShoppingList in Store
     securedBy:
       [
         oauth_2_0:
@@ -2272,6 +2281,7 @@ uriParameters:
             application/json:
               example: !include ../examples/shopping-list.example.json
     head:
+      displayName: Check if ShoppingList exists in Store by Key
       securedBy:
         [
           oauth_2_0:
@@ -2378,6 +2388,7 @@ uriParameters:
             application/json:
               example: !include ../examples/shopping-list.example.json
     head:
+      displayName: Check if ShoppingList exists in Store by Query Predicate
       securedBy:
         [
           oauth_2_0:
@@ -3143,7 +3154,7 @@ uriParameters:
   (createable): QuoteRequestDraft
   description: A request for a Quote holds product variants and can be ordered.
   get:
-    displayName: Get QuoteRequest in Store by ID
+    displayName: Query QuoteRequests in Store
     securedBy:
       [
         oauth_2_0:
@@ -3161,7 +3172,7 @@ uriParameters:
           application/json:
             example: !include ../examples/quote-requests.example.json
   head:
-    displayName: Check if QuoteRequest exists in Store
+    displayName: Check if QuoteRequest exists in Store by Query Predicate
     securedBy:
       [
         oauth_2_0:
@@ -3372,6 +3383,7 @@ uriParameters:
   (createable): StagedQuoteDraft
   description: A staged quote holds the negotiation between the [Buyer](/../api/quotes-overview#buyer) and the [Seller](/../api/quotes-overview#seller).
   get:
+    displayName: Query StagedQuotes in Store
     securedBy:
       [
         oauth_2_0:
@@ -3389,6 +3401,7 @@ uriParameters:
           application/json:
             example: !include ../examples/staged-quotes.example.json
   head:
+    displayName: Check if StagedQuote exists in Store by Query Predicate
     securedBy:
       [
         oauth_2_0:
@@ -3405,6 +3418,7 @@ uriParameters:
       where?:
         type: QueryPredicate[]
   post:
+    displayName: Create StagedQuote in Store
     securedBy:
       [
         oauth_2_0:
@@ -3432,6 +3446,7 @@ uriParameters:
         resourceType: StagedQuote
         resourceUpdateType: StagedQuoteUpdate
     get:
+      displayName: Get StagedQuote in Store by Key
       securedBy:
         [
           oauth_2_0:
@@ -3449,6 +3464,7 @@ uriParameters:
             application/json:
               example: !include ../examples/staged-quote.example.json
     head:
+      displayName: Check if StagedQuote exists in Store by Key
       securedBy:
         [
           oauth_2_0:
@@ -3462,6 +3478,7 @@ uriParameters:
         ]
       description: Checks if a StagedQuote exists for a given `key`. Returns a `200 OK` status if the StagedQuote exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
     post:
+      displayName: Update StagedQuote in Store by Key
       securedBy:
         [
           oauth_2_0:
@@ -3482,6 +3499,7 @@ uriParameters:
             application/json:
               example: !include ../examples/staged-quote.example.json
     delete:
+      displayName: Delete StagedQuote in Store by Key
       is:
         - dataErasure
       securedBy:
@@ -3508,6 +3526,7 @@ uriParameters:
         resourceType: StagedQuote
         resourceUpdateType: StagedQuoteUpdate
     get:
+      displayName: Get StagedQuote in Store by ID
       securedBy:
         [
           oauth_2_0:
@@ -3525,6 +3544,7 @@ uriParameters:
             application/json:
               example: !include ../examples/staged-quote.example.json
     head:
+      displayName: Check if StagedQuote exists in Store by ID
       securedBy:
         [
           oauth_2_0:
@@ -3538,6 +3558,7 @@ uriParameters:
         ]
       description: Checks if a StagedQuote exists for a given `id`. Returns a `200 OK` status if the StagedQuote exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
     post:
+      displayName: Update StagedQuote in Store by ID
       securedBy:
         [
           oauth_2_0:
@@ -3558,6 +3579,7 @@ uriParameters:
             application/json:
               example: !include ../examples/staged-quote.example.json
     delete:
+      displayName: Delete StagedQuote in Store by ID
       is:
         - dataErasure
       securedBy:
@@ -3589,6 +3611,7 @@ uriParameters:
   (createable): QuoteDraft
   description: A quote holds the negotiated offer.
   get:
+    displayName: Query Quotes in Store
     securedBy:
       [
         oauth_2_0:
@@ -3606,6 +3629,7 @@ uriParameters:
           application/json:
             example: !include ../examples/quotes.example.json
   head:
+    displayName: Check if Quote exists in Store by Query Predicate
     securedBy:
       [
         oauth_2_0:
@@ -3622,6 +3646,7 @@ uriParameters:
       where?:
         type: QueryPredicate[]
   post:
+    displayName: Create Quote in Store
     securedBy:
       [
         oauth_2_0:
@@ -3649,6 +3674,7 @@ uriParameters:
         resourceType: Quote
         resourceUpdateType: QuoteUpdate
     get:
+      displayName: Get Quote in Store by Key
       securedBy:
         [
           oauth_2_0:
@@ -3666,6 +3692,7 @@ uriParameters:
             application/json:
               example: !include ../examples/quote.example.json
     head:
+      displayName: Check if Quote exists in Store by Key
       securedBy:
         [
           oauth_2_0:
@@ -3679,6 +3706,7 @@ uriParameters:
         ]
       description: Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
     post:
+      displayName: Update Quote in Store by Key
       securedBy:
         [
           oauth_2_0:
@@ -3699,6 +3727,7 @@ uriParameters:
             application/json:
               example: !include ../examples/quote.example.json
     delete:
+      displayName: Delete Quote in Store by Key
       is:
         - dataErasure
       securedBy:
@@ -3725,6 +3754,7 @@ uriParameters:
         resourceType: Quote
         resourceUpdateType: QuoteUpdate
     get:
+      displayName: Get Quote in Store by ID
       securedBy:
         [
           oauth_2_0:
@@ -3742,6 +3772,7 @@ uriParameters:
             application/json:
               example: !include ../examples/quote.example.json
     head:
+      displayName: Check if Quote exists in Store by ID
       securedBy:
         [
           oauth_2_0:
@@ -3755,6 +3786,7 @@ uriParameters:
         ]
       description: Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
     post:
+      displayName: Update Quote in Store by ID
       securedBy:
         [
           oauth_2_0:
@@ -3775,6 +3807,7 @@ uriParameters:
             application/json:
               example: !include ../examples/quote.example.json
     delete:
+      displayName: Delete Quote in Store by ID
       is:
         - dataErasure
       securedBy: