Skip to content
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.

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

DEVDOCS-6104: Clarify the meaning of version field in the request/response of cart/checkout API #498

Merged
merged 9 commits into from
Sep 6, 2024

Conversation

davidchin
Copy link
Contributor

@davidchin davidchin commented Sep 5, 2024

DEVDOCS-6104

What changed?

  • Clarify the meaning of version field in the request/response of cart/checkout API so developers know what it can be used for.

Release notes draft

N/A

ping @bigcommerce/team-checkout

animesh1987
animesh1987 previously approved these changes Sep 5, 2024
Copy link
Collaborator

@bc-traciporter bc-traciporter left a comment

Choose a reason for hiding this comment

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

Hi @Lucki2501 I made some editorial updates. I removed passive voice. Let me know if you think the changes are okay or if they change the meaning.

reference/carts.sf.yml Outdated Show resolved Hide resolved
reference/carts.v3.yml Outdated Show resolved Hide resolved
reference/checkouts.sf.yml Outdated Show resolved Hide resolved
reference/checkouts.v3.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@bc-shawnwang bc-shawnwang left a comment

Choose a reason for hiding this comment

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

it's good on the words itself, I'm just wondering if there is the way to extract this general field and every place just refer it.

@davidchin
Copy link
Contributor Author

@bc-shawnwang Yeah I agree, I also notice there's a lot of duplication. I'll leave it to the dev-docs team to restructure the yaml files.

@bc-traciporter
Copy link
Collaborator

bc-traciporter commented Sep 6, 2024

Thank you @bc-shawnwang, @valentindellangela and @animesh1987 . I would like to close this PR for now and think about how to better restructure this file to remove the duplication. I wasn't able to figure out how to do it quickly. I will need to think about it.

reference/carts.sf.yml Outdated Show resolved Hide resolved
@bc-andreadao
Copy link
Collaborator

@bc-traciporter My PR 468 restructures the storefront checkout yml file, so that endpoint would be taken cared of

@bc-traciporter
Copy link
Collaborator

@bc-traciporter My PR 468 restructures the storefront checkout yml file, so that endpoint would be taken cared of

Awesome @bc-andreadao

@bc-traciporter bc-traciporter merged commit 690c0d3 into main Sep 6, 2024
3 checks passed
@bc-traciporter bc-traciporter deleted the clarify_version branch September 6, 2024 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants