Skip to content

docs(orders): DEVDOCS-6330 [REST Storefront] [Orders] Add missing values for "include" query param #881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(orders): DEVDOCS-6330 [REST Storefront] [Orders] Add missing values for "include" query param #881

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions reference/orders.sf.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,22 @@ paths:
type: string
enum:
- lineItems
- lineItems.physicalItems
- lineItems.physicalItems.socialMedia
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

socialMedia attribute also not defined in ItemPhysical

- lineItems.physicalItems.options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like options attribute is not definied in the ItemPhysical 🤔

- lineItems.physicalItems.categories
Comment on lines +58 to +61
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- lineItems.physicalItems
- lineItems.physicalItems.socialMedia
- lineItems.physicalItems.options
- lineItems.physicalItems.categories
- lineItems.physicalItems
- lineItems.physicalItems.giftWrapping
- lineItems.physicalItems.socialMedia
- lineItems.physicalItems.options
- lineItems.physicalItems.categories

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't include gift wrapping as that is always included by default. So adding the parameter wont have an effect

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably out of scope of this PR: should we also update the schema for the "ItemPhysical.categories" :

docs/reference/orders.sf.yml

Lines 339 to 344 in b874b60

categories:
type: array
description: Categories the item belongs to.
items:
type: object
properties: {}

- lineItems.digitalItems
- lineItems.digitalItems.socialMedia
- lineItems.digitalItems.options
- lineItems.digitalItems.categories
- lineItems.giftCertificates
- billingAddress
- coupons
- currency
- taxes
- payments
- consignments
- fees
responses:
'200':
description: ''
Expand Down