Updated API from documentation release

Author: ct-sdks[bot]

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

@@ -780,6 +780,7 @@ type: base
       description: A quote holds the negotiated offer.
       get:
         displayName: Query Quotes in BusinessUnit as Associate
+        description: Retrieves all Quotes in a BusinessUnit.
         securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
         responses:
           200:
@@ -788,8 +789,8 @@ type: base
                 example: !include ../examples/quotes.example.json
       head:
         displayName: Check if Quote exists in BusinessUnit by Query Predicate as Associate
+        description: Checks if one or more Quotes exist for the provided query predicate in a BusinessUnit. Returns a `200 OK` status if any Quotes match the query predicate, or a [Not Found](/../api/errors#404-not-found) error otherwise.
         securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
-        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.
         queryParameters:
           where?:
             type: QueryPredicate[]
@@ -802,23 +803,25 @@ type: base
             resourceUpdateType: QuoteUpdate
         get:
           displayName: Get Quote in BusinessUnit by Key as Associate
-          securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
           description: |
+            Retrieves a Quote with the provided `key` in a BusinessUnit.
             If the Quote 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.
+          securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
           responses:
             200:
               body:
                 application/json:
                   example: !include ../examples/quote.example.json
         head:
           displayName: Check if Quote exists in BusinessUnit by Key as Associate
+          description: Checks if a Quote exists with the provided `key` in a BusinessUnit. Returns a `200 OK` status if the Quote exists, or a [Not Found](/../api/errors#404-not-found) error otherwise.
           securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
-          description: Checks if a Quote exists with the provided `key`. Returns a `200` status if the Quote exists, or a `404` status otherwise.
         post:
           displayName: Update Quote in BusinessUnit by Key as Associate
-          securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
           description: |
+            Updates a Quote in a BusinessUnit using one or more [update actions](/../api/projects/quotes#update-actions).
             If the Quote 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.
+          securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
           body:
             application/json:
               example: !include ../examples/quote-update.example.json
@@ -836,23 +839,25 @@ type: base
             resourceUpdateType: QuoteUpdate
         get:
           displayName: Get Quote in BusinessUnit by ID as Associate
-          securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
           description: |
+            Retrieves a Quote with the provided `id` in a BusinessUnit.
             If the Quote 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.
+          securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
           responses:
             200:
               body:
                 application/json:
                   example: !include ../examples/quote.example.json
         head:
           displayName: Check if Quote exists in BusinessUnit by ID as Associate
+          description: Checks if a Quote exists with the provided `id` in a BusinessUnit. Returns a `200 OK` status if the Quote exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
           securedBy: [oauth_2_0: { scopes: ['view_quotes:{projectKey}'] }]
-          description: Checks if a Quote exists with the provided `id`. Returns a `200` status if the Quote exists, or a `404` status otherwise.
         post:
           displayName: Update Quote in BusinessUnit by ID as Associate
-          securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
           description: |
+            Updates a Quote in a BusinessUnit using one or more [update actions](/../api/projects/quotes#update-actions).
             If the Quote 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.
+          securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }]
           body:
             application/json:
               example: !include ../examples/quote-update.example.json
@@ -874,6 +879,7 @@ type: base
       (createable): QuoteRequestDraft
       get:
         displayName: Query QuoteRequests in BusinessUnit as Associate
+        description: Retrieves all QuoteRequests in a BusinessUnit.
         securedBy: [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
         responses:
           200:
@@ -882,18 +888,18 @@ type: base
                 example: !include ../examples/quote-requests.example.json
       head:
         displayName: Check if QuoteRequest exists in BusinessUnit by Query Predicate as Associate
+        description: Checks if one or more QuoteRequests exist for the provided query predicate in a BusinessUnit. Returns a `200 OK` status if any QuoteRequests match the query predicate, or a [Not Found](/../api/errors#404-not-found) error otherwise.
         securedBy: [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
-        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.
         queryParameters:
           where?:
             type: QueryPredicate[]
       post:
         displayName: Create QuoteRequest in BusinessUnit as Associate
+        description: |
+          Creates a QuoteRequest in a BusinessUnit.
+          Creating QuoteRequest fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Cart does not reference the same BusinessUnit as the `businessUnitKey` path parameter.
         securedBy:
           [oauth_2_0: { scopes: ['manage_quote_requests:{projectKey}'] }]
-        description:
-          Creates a QuoteRequest in a [BusinessUnit](ctp:api:type:BusinessUnit).
-          Creating QuoteRequest fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Cart does not reference the same BusinessUnit as the `businessUnitKey` path parameter.
         body:
           application/json:
             example: !include ../examples/quote-request-create.example.json
@@ -911,26 +917,28 @@ type: base
             resourceUpdateType: QuoteRequestUpdate
         get:
           displayName: Get QuoteRequest in BusinessUnit by Key as Associate
-          securedBy:
-            [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
           description: |
+            Retrieves a QuoteRequest with the provided `key` in a BusinessUnit.
             If the QuoteRequest 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.
+          securedBy:
+            [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
           responses:
             200:
               body:
                 application/json:
                   example: !include ../examples/quote-request.example.json
         head:
           displayName: Check if QuoteRequest exists in BusinessUnit by Key as Associate
+          description: Checks if a QuoteRequest exists with the provided `key` in a BusinessUnit. Returns a `200 OK` status if the QuoteRequest exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
           securedBy:
             [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
-          description: Checks if a QuoteRequest exists with the provided `key`. Returns a `200` status if the QuoteRequest exists, or a `404` status otherwise.
         post:
           displayName: Update QuoteRequest in BusinessUnit by Key as Associate
-          securedBy:
-            [oauth_2_0: { scopes: ['manage_quote_requests:{projectKey}'] }]
           description: |
+            Updates a QuoteRequest in a BusinessUnit using one or more [update actions](/../api/projects/quote-requests#update-actions).
             If the QuoteRequest 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.
+          securedBy:
+            [oauth_2_0: { scopes: ['manage_quote_requests:{projectKey}'] }]
           body:
             application/json:
               example: !include ../examples/quote-request-update.example.json
@@ -948,26 +956,28 @@ type: base
             resourceUpdateType: QuoteRequestUpdate
         get:
           displayName: Get QuoteRequest in BusinessUnit by ID as Associate
-          securedBy:
-            [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
           description: |
+            Retrieves a QuoteRequest with the provided `id` in a BusinessUnit.
             If the QuoteRequest 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.
+          securedBy:
+            [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
           responses:
             200:
               body:
                 application/json:
                   example: !include ../examples/quote-request.example.json
         head:
           displayName: Check if QuoteRequest exists in BusinessUnit by ID as Associate
+          description: Checks if a QuoteRequest exists with the provided `id` in a BusinessUnit. Returns a `200 OK` status if the QuoteRequest exists or a [Not Found](/../api/errors#404-not-found) error otherwise.
           securedBy:
             [oauth_2_0: { scopes: ['view_quote_requests:{projectKey}'] }]
-          description: Checks if a QuoteRequest exists with the provided `id`. Returns a `200` status if the QuoteRequest exists, or a `404` status otherwise.
         post:
           displayName: Update QuoteRequest in BusinessUnit by ID as Associate
-          securedBy:
-            [oauth_2_0: { scopes: ['manage_quote_requests:{projectKey}'] }]
           description: |
+            Updates a QuoteRequest in a BusinessUnit using one or more [update actions](/../api/projects/quote-requests#update-actions).
             If the QuoteRequest 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.
+          securedBy:
+            [oauth_2_0: { scopes: ['manage_quote_requests:{projectKey}'] }]
           body:
             application/json:
               example: !include ../examples/quote-request-update.example.json

api-specs/api/resources/in-store/quote-requests-in-store.raml

@@ -11,6 +11,7 @@ type:
 description: A request for a Quote holds product variants and can be ordered.
 get:
   displayName: Query QuoteRequests in Store
+  description: Retrieves QuoteRequests in a [Store](ctp:api:type:Store).
   securedBy:
     [
       oauth_2_0:
@@ -40,13 +41,13 @@ head:
             ],
         },
     ]
-  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.
+  description: Checks if one or more QuoteRequests exist for the provided query predicate in a [Store](ctp:api:type:Store). Returns a `200` status if any QuoteRequests match the query predicate, or a `404` status otherwise.
   queryParameters:
     where?:
       type: QueryPredicate[]
 post:
   displayName: Create QuoteRequest in Store
-  description: |
+  description: Creates a QuoteRequest in a [Store](ctp:api:type:Store).
   securedBy:
     [
       oauth_2_0:
@@ -75,6 +76,7 @@ post:
       resourceUpdateType: QuoteRequestUpdate
   get:
     displayName: Get QuoteRequest in Store by Key
+    description: Retrieves a QuoteRequest with the provided `key` in a [Store](ctp:api:type:Store).
     securedBy:
       [
         oauth_2_0:
@@ -93,6 +95,7 @@ post:
             example: !include ../../examples/quote-request.example.json
   head:
     displayName: Check if QuoteRequest exists in Store by Key
+    description: Checks if a QuoteRequest exists with the provided `key` in a [Store](ctp:api:type:Store). Returns a `200` status if the QuoteRequest exists, or a `404` status otherwise.
     securedBy:
       [
         oauth_2_0:
@@ -104,9 +107,9 @@ post:
               ],
           },
       ]
-    description: Checks if a QuoteRequest exists with the provided `key`. Returns a `200` status if the QuoteRequest exists, or a `404` status otherwise.
   post:
     displayName: Update QuoteRequest in Store by Key
+    description: Updates a QuoteRequest in a [Store](ctp:api:type:Store).
     securedBy:
       [
         oauth_2_0:
@@ -128,6 +131,7 @@ post:
             example: !include ../../examples/quote-request-update-response.example.json
   delete:
     displayName: Delete QuoteRequest in Store by Key
+    description: Deletes a QuoteRequest in a [Store](ctp:api:type:Store).
     is:
       - dataErasure
     securedBy:
@@ -155,6 +159,7 @@ post:
       resourceUpdateType: QuoteRequestUpdate
   get:
     displayName: Get QuoteRequest in Store by ID
+    description: Retrieves a QuoteRequest with the provided `id` in a [Store](ctp:api:type:Store).
     securedBy:
       [
         oauth_2_0:
@@ -173,6 +178,7 @@ post:
             example: !include ../../examples/quote-request.example.json
   head:
     displayName: Check if QuoteRequest exists in Store by ID
+    description: Checks if a QuoteRequest exists with the provided `id` in a [Store](ctp:api:type:Store). Returns a `200` status if the QuoteRequest exists, or a `404` status otherwise.
     securedBy:
       [
         oauth_2_0:
@@ -184,9 +190,9 @@ post:
               ],
           },
       ]
-    description: Checks if a QuoteRequest exists with the provided `id`. Returns a `200` status if the QuoteRequest exists, or a `404` status otherwise.
   post:
     displayName: Update QuoteRequest in Store by ID
+    description: Updates a QuoteRequest in a [Store](ctp:api:type:Store).
     securedBy:
       [
         oauth_2_0:
@@ -208,6 +214,7 @@ post:
             example: !include ../../examples/quote-request-update-response.example.json
   delete:
     displayName: Delete QuoteRequest in Store by ID
+    description: Deletes a QuoteRequest in a [Store](ctp:api:type:Store).
     is:
       - dataErasure
     securedBy:

api-specs/api/resources/in-store/quotes-in-store.raml

@@ -11,6 +11,7 @@ type:
 description: A quote holds the negotiated offer.
 get:
   displayName: Query Quotes in Store
+  description: Retrieves Quotes in a [Store](ctp:api:type:Store).
   securedBy:
     [
       oauth_2_0:
@@ -34,12 +35,13 @@ head:
             ['view_quotes:{projectKey}', 'view_quotes:{projectKey}:{storeKey}'],
         },
     ]
-  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.
+  description: Checks if one or more Quotes exist for the provided query predicate in a [Store](ctp:api:type:Store). Returns a `200` status if any Quotes match the query predicate, or a `404` status otherwise.
   queryParameters:
     where?:
       type: QueryPredicate[]
 post:
   displayName: Create Quote in Store
+  description: Creates a Quote in a [Store](ctp:api:type:Store).
   securedBy:
     [
       oauth_2_0:
@@ -68,6 +70,7 @@ post:
       resourceUpdateType: QuoteUpdate
   get:
     displayName: Get Quote in Store by Key
+    description: Retrieves a Quote with the provided `key` in a [Store](ctp:api:type:Store).
     securedBy:
       [
         oauth_2_0:
@@ -86,6 +89,7 @@ post:
             example: !include ../../examples/quote.example.json
   head:
     displayName: Check if Quote exists in Store by Key
+    description: Checks if a Quote exists with the provided `key` in a [Store](ctp:api:type:Store). Returns a `200` status if the Quote exists, or a `404` status otherwise.
     securedBy:
       [
         oauth_2_0:
@@ -97,9 +101,9 @@ post:
               ],
           },
       ]
-    description: Checks if a Quote exists with the provided `key`. Returns a `200` status if the Quote exists, or a `404` status otherwise.
   post:
     displayName: Update Quote in Store by Key
+    description: Updates a Quote in a [Store](ctp:api:type:Store).
     securedBy:
       [
         oauth_2_0:
@@ -121,6 +125,7 @@ post:
             example: !include ../../examples/quote.example.json
   delete:
     displayName: Delete Quote in Store by Key
+    description: Deletes a Quote in a [Store](ctp:api:type:Store).
     is:
       - dataErasure
     securedBy:
@@ -148,6 +153,7 @@ post:
       resourceUpdateType: QuoteUpdate
   get:
     displayName: Get Quote in Store by ID
+    description: Retrieves a Quote with the provided `id` in a [Store](ctp:api:type:Store).
     securedBy:
       [
         oauth_2_0:
@@ -166,6 +172,7 @@ post:
             example: !include ../../examples/quote.example.json
   head:
     displayName: Check if Quote exists in Store by ID
+    description: Checks if a Quote exists with the provided `id` in a [Store](ctp:api:type:Store). Returns a `200` status if the Quote exists, or a `404` status otherwise.
     securedBy:
       [
         oauth_2_0:
@@ -177,9 +184,9 @@ post:
               ],
           },
       ]
-    description: Checks if a Quote exists with the provided `id`. Returns a `200` status if the Quote exists, or a `404` status otherwise.
   post:
     displayName: Update Quote in Store by ID
+    description: Updates a Quote in a [Store](ctp:api:type:Store).
     securedBy:
       [
         oauth_2_0:
@@ -201,6 +208,7 @@ post:
             example: !include ../../examples/quote.example.json
   delete:
     displayName: Delete Quote in Store by ID
+    description: Deletes a Quote in a [Store](ctp:api:type:Store).
     is:
       - dataErasure
     securedBy: