This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
Add order and checkout order endpoint documentation #11157
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hsingyuc
added
the
focus: documentation
hsingyuc
requested review from
a team and
senadir
and removed request for
a team
13 tasks
|
The release ZIP for this PR is accessible via: Script Dependencies ReportThere is no changed script dependency between this branch and trunk. This comment was automatically generated by the TypeScript Errors Report
🎉 🎉 This PR does not introduce new TS errors. |
|
Size Change: 0 B Total Size: 1.48 MB ℹ️ View Unchanged
|
nielslange
suggested changes
Oct 10, 2023
There was a problem hiding this comment.
Thanks for working on this, @hsingyuc. While I haven't done a full review yet, I already wanted to share a few things I noticed.
nielslange
suggested changes
Oct 10, 2023
nielslange
suggested changes
Oct 10, 2023
There was a problem hiding this comment.
I found one more thing to adjust and while looking at src/StoreApi/docs/order.md, I was wondering if we should flip the sections Responses and Get Order? That way, the example on how to get the order is visible immediately. What are your thoughts on that, @hsingyuc?
src/StoreApi/README.md
Outdated
| | [`Checkout`](docs/checkout.md) | `GET`, `POST` | [`/wc/store/v1/checkout`](docs/checkout.md) | | ||
| | [`Checkout`](docs/checkout.md) | `GET`, `POST` | [`/wc/store/v1/checkout`](docs/checkout.md) | ||
| | [`Checkout order`](docs/checkout-order.md) | `POST` | [`/wc/store/v1/checkout`](docs/checkout-order.md) | | ||
| | [`Order`](docs/order.md) | `GET` | [`/wc/store/v1/order`](docs/order.md) |
There was a problem hiding this comment.
Suggested change
| | [`Order`](docs/order.md) | `GET` | [`/wc/store/v1/order`](docs/order.md) | |
| | [`Order`](docs/order.md) | `GET` | [`/wc/store/v1/order/:id`](docs/order.md) |
I noticed that for the order endpoint, the path parameter :id is also missing. Similar to the checkout order endpoint, we should mention that path parameter here.
There was a problem hiding this comment.
@nielslange Good catch! Updated all the above comments here d8c1eee. Thank you!
There was a problem hiding this comment.
I was wondering if we should flip the sections Responses and Get Order? That way, the example on how to get the order is visible immediately.
I updated this part, but I want to mention that I followed the cart endpoint. Should we also update the cart endpoint?
There was a problem hiding this comment.
@nielslange Good catch! Updated all the above comments here d8c1eee. Thank you!
Thank you for addressing all the suggestions so promptly, @hsingyuc.
There was a problem hiding this comment.
[...] I want to mention that I followed the cart endpoint. Should we also update the cart endpoint?
Good catch, @hsingyuc. If you can update the cart endpoint, that'd be helpful.
Additionally, I observed a duplicate TOC in src/StoreApi/docs/checkout.md. Though unrelated to your PR, it'd be great if you could address that too.
However, since these suggestions aren't directly related to your current PR, I've approved it. You can merge now or make my recommended changes first, if possible.
There was a problem hiding this comment.
Updated cart endpoint doc here a6ea7a2
hsingyuc
force-pushed
the
add/order-endpoint-docs
branch
from
ffda7ef
to
d8c1eee
Compare
nielslange
approved these changes
Oct 11, 2023
There was a problem hiding this comment.
Thanks for working on this and applying the suggestions, @hsingyuc. While I left some feedback in #11157 (comment), I'm approving this PR. 🙌
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Fixes #
Why
Adds documentation for the order and checkout order endpoints since the feature flag is being removed.
Testing Instructions
Please consider any edge cases this change may have, and also other areas of the product this may impact.
Screenshots or screencast
WooCommerce Visibility
Required:
Checklist
Required:
[type]label or a[skip-changelog]label.Conditional:
[skip-changelog]label is not present).Changelog