Updated API from documentation release

Author: ct-sdks[bot]

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

@@ -2623,10 +2623,10 @@ uriParameters:
         maximum: 10000
       withTotal:
         type: boolean
-        default: true
+        default: false
         required: false
         description: |
-          By default, the response does not include the `total` field. Set to `true` to get the [total](/../api/general-concepts#total) number of query results included.
+          Controls the calculation of the [total](/../api/general-concepts#total) number of query results. Set to `true` to get the [total](/general-concepts#total) number of query results. This may impact query performance.
     responses:
       200:
         body:
@@ -2928,10 +2928,10 @@ uriParameters:
         maximum: 10000
       withTotal:
         type: boolean
-        default: true
+        default: false
         required: false
         description: |
-          By default, the response does not include the `total` field. Set to `true` to get the [total](/../api/general-concepts#total) number of query results included.
+          Controls the calculation of the [total](/../api/general-concepts#total) number of query results. Set to `true` to get the [total](/general-concepts#total) number of query results. This may impact query performance.
     responses:
       200:
         body:

api-specs/api/resources/product-selections.raml

@@ -83,6 +83,12 @@ post:
       queryParameters:
         where?:
           type: QueryPredicate[]
+        withTotal:
+          type: boolean
+          default: false
+          required: false
+          description: |
+            Controls the calculation of the [total](/../api/general-concepts#total) number of query results. Set to `true` to get the [total](/general-concepts#total) number of query results. This may impact query performance.
       securedBy:
         [oauth_2_0: { scopes: ['view_product_selections:{projectKey}'] }]
       is:
@@ -139,6 +145,12 @@ post:
       queryParameters:
         where?:
           type: QueryPredicate[]
+        withTotal:
+          type: boolean
+          default: false
+          required: false
+          description: |
+            Controls the calculation of the [total](/../api/general-concepts#total) number of query results. Set to `true` to get the [total](/general-concepts#total) number of query results. This may impact query performance.
       securedBy:
         [oauth_2_0: { scopes: ['view_product_selections:{projectKey}'] }]
       is:

api-specs/api/resources/product-tailoring.raml

@@ -16,6 +16,13 @@ get:
       body:
         application/json:
           example: !include ../examples/product-tailoring-list.example.json
+  queryParameters:
+    withTotal:
+      type: boolean
+      default: false
+      required: false
+      description: |
+        Controls the calculation of the [total](/../api/general-concepts#total) number of query results. Set to `true` to get the [total](/general-concepts#total) number of query results. This may impact query performance.
 head:
   securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
   description: Checks if a ProductTailoring exists for a given Query Predicate. Returns a `200 OK` status if any ProductTailoring match the Query Predicate or a `404 Not Found` otherwise.

api-specs/api/resources/products.raml

@@ -121,6 +121,13 @@ post:
     get:
       securedBy:
         [oauth_2_0: { scopes: ['view_product_selections:{projectKey}'] }]
+      queryParameters:
+        withTotal:
+          type: boolean
+          default: false
+          required: false
+          description: |
+            Controls the calculation of the [total](/../api/general-concepts#total) number of query results. Set to `true` to get the [total](/general-concepts#total) number of query results. This may impact query performance.
       responses:
         200:
           body:
@@ -247,6 +254,13 @@ post:
     get:
       securedBy:
         [oauth_2_0: { scopes: ['view_product_selections:{projectKey}'] }]
+      queryParameters:
+        withTotal:
+          type: boolean
+          default: false
+          required: false
+          description: |
+            Controls the calculation of the [total](/../api/general-concepts#total) number of query results. Set to `true` to get the [total](/general-concepts#total) number of query results. This may impact query performance.
       responses:
         200:
           body:

api-specs/api/types/product-selection/AssignedProductSelectionPagedQueryResponse.raml

@@ -30,10 +30,9 @@ properties:
     format: int64
     description: |
       Total number of results matching the query.
-      This number is an estimation that is not [strongly consistent](/general-concepts#strong-consistency).
-      Unlike other endpoints, the Product Selection endpoint does not return this field by default.
-      To get `total`, pass the query parameter `withTotal` set to `true`.
-      When the results are filtered with a [Query Predicate](/predicates/query), `total` is subject to a [limit](/limits#queries).
+      Present only when the `withTotal` query parameter is set to `true`.
+      This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
+      When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
   results:
     type: AssignedProductSelection[]
     description: |-

api-specs/api/types/product-selection/ProductSelectionPagedQueryResponse.raml

@@ -31,8 +31,8 @@ properties:
     description: |
       Total number of results matching the query.
       This number is an estimation that is not [strongly consistent](/general-concepts#strong-consistency).
-      Unlike other endpoints, the Product Selection endpoint does not return this field by default.
-      To get `total`, pass the query parameter `withTotal` set to `true`.
+      This field is returned by default.
+      For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
       When the results are filtered with a [Query Predicate](/predicates/query), `total` is subject to a [limit](/limits#queries).
   results:
     type: ProductSelection[]

api-specs/api/types/product-selection/ProductSelectionProductPagedQueryResponse.raml

@@ -31,10 +31,9 @@ properties:
     format: int64
     description: |
       Total number of results matching the query.
-      This number is an estimation that is not [strongly consistent](/general-concepts#strong-consistency).
-      Unlike other endpoints, the Product Selection endpoint does not return this field by default.
-      To get `total`, pass the query parameter `withTotal` set to `true`.
-      When the results are filtered with a [Query Predicate](/predicates/query), `total` is subject to a [limit](/limits#queries).
+      Present only when the `withTotal` query parameter is set to `true`.
+      This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
+      When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
   results:
     type: AssignedProductReference[]
     description: |-

api-specs/api/types/product-selection/ProductsInStorePagedQueryResponse.raml

@@ -30,10 +30,9 @@ properties:
     format: int64
     description: |
       Total number of results matching the query.
-      This number is an estimation that is not [strongly consistent](/general-concepts#strong-consistency).
-      Unlike other endpoints, the Product Selection endpoint does not return this field by default.
-      To get `total`, pass the query parameter `withTotal` set to `true`.
-      When the results are filtered with a [Query Predicate](/predicates/query), `total` is subject to a [limit](/limits#queries).
+      Present only when the `withTotal` query parameter is set to `true`.
+      This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
+      When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
   results:
     type: ProductSelectionAssignment[]
     description: ProductSelectionAssignments matching the query.

api-specs/api/types/product-tailoring/ProductTailoringPagedQueryResponse.raml

@@ -31,9 +31,8 @@ properties:
     format: int64
     description: |
       Total number of results matching the query.
+      Present only when the `withTotal` query parameter is set to `true`.
       This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
-      This field is returned by default.
-      For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
       When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
   results:
     type: ProductTailoring[]