(no ticket): [revise] query param include should accept comma separat…

…ed list of values (#1527)
bigcommerce · Dec 15, 2023 · 0a2de47 · 0a2de47
1 parent 4c360dc
commit 0a2de47
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 43 deletions.
diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml
@@ -302,17 +302,20 @@ paths:
               * modifiers
               * options
               * videos
+          explode: false
           schema:
-            type: string
-            enum:
-              - variants
-              - images
-              - custom_fields
-              - bulk_pricing_rules
-              - primary_image
-              - modifiers
-              - options
-              - videos
+            type: array
+            items:
+              type: string
+              enum:
+                - variants
+                - images
+                - custom_fields
+                - bulk_pricing_rules
+                - primary_image
+                - modifiers
+                - options
+                - videos
         - name: include_fields
           in: query
           description: 'Fields to include, in a comma-separated list. The ID and the specified fields will be returned.'
@@ -1348,17 +1351,20 @@ paths:
         - name: include
           in: query
           description: 'Sub-resources to include on a product, in a comma-separated list. If `options` or `modifiers` is used, results are limited to 10 per page.'
+          explode: false
           schema:
-            type: string
-            enum:
-              - variants
-              - images
-              - custom_fields
-              - bulk_pricing_rules
-              - primary_image
-              - modifiers
-              - options
-              - videos
+            type: array
+            items:
+              type: string
+              enum: 
+                - variants
+                - images
+                - custom_fields
+                - bulk_pricing_rules
+                - primary_image
+                - modifiers
+                - options
+                - videos
         - name: include_fields
           in: query
           description: 'Fields to include, in a comma-separated list. The ID and the specified fields will be returned.'

diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml
@@ -171,13 +171,18 @@ paths:
              * `segment_ids`- segments the customer belongs to (Beta)
 
              `include=addresses,storecredit,attributes,formfields,shopper_profile_id,segment_ids`
+          explode: false
           schema:
-            type: string
-            enum:
-              - addresses
-              - storecredit
-              - attributes
-              - formfields
+            type: array
+            items:
+              type: string
+              enum:
+                - addresses
+                - storecredit
+                - attributes
+                - formfields
+                - shopper_profile_id
+                - segment_ids
         - in: query
           name: sort
           description: 'Sort items by date_created, date_modified, or last_name:* `date_created:asc` - date created, ascending* `date_created:desc` - date created, descending* `last_name:asc` - last name, ascending* `last_name:desc` - last name, descending * `date_modified:asc` - date modified, ascending* `date_modified:desc`- date modified, descending  Example: `sort=last_name:asc`'

diff --git a/reference/orders.sf.yml b/reference/orders.sf.yml
@@ -47,16 +47,19 @@ paths:
         - name: include
           in: query
           description: Sub-resources to include in an Order, in a comma-separated list. The ID and the specified fields will be returned.
+          explode: false
           schema:
-            type: string
-            enum:
-              - lineItems
-              - billingAddress
-              - coupons
-              - currency
-              - taxes
-              - payments
-              - consignments
+            type: array
+            items:
+              type: string
+              enum:
+                - lineItems
+                - billingAddress
+                - coupons
+                - currency
+                - taxes
+                - payments
+                - consignments
       responses:
         '200':
           description: ''

diff --git a/reference/price_lists.v3.yml b/reference/price_lists.v3.yml
@@ -849,11 +849,14 @@ paths:
           in: query
           description: |
             Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored.
+          explode: false
           schema:
-            type: string
-            enum:
-              - bulk_pricing_tiers
-              - sku
+            type: array
+            items:
+              type: string
+              enum:
+                - bulk_pricing_tiers
+                - sku
         - name: price
           in: query
           description: |
@@ -1927,11 +1930,14 @@ paths:
           description: |
             Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored.
             Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored.
+          explode: false
           schema:
-            type: string
-            enum:
-              - bulk_pricing_tiers
-              - sku
+            type: array
+            items:
+              type: string
+              enum:
+                - bulk_pricing_tiers
+                - sku
       responses:
         '200':
           description: ''