Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

(no ticket): [revise] query param include should accept comma separated list of values #1527

Merged
merged 2 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 26 additions & 20 deletions reference/catalog/products_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.'
Expand Down Expand Up @@ -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.'
Expand Down
17 changes: 11 additions & 6 deletions reference/customers.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
slsriehl marked this conversation as resolved.
Show resolved Hide resolved
- 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`'
Expand Down
21 changes: 12 additions & 9 deletions reference/orders.sf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: ''
Expand Down
22 changes: 14 additions & 8 deletions reference/price_lists.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down Expand Up @@ -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: ''
Expand Down
Loading