Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/docs/contributing/api-critical-flows.md

62 lines
5.6 KiB
Markdown
Raw Permalink Normal View History

add graymatter to docs
2023-11-29 18:48:05 +00:00
---
Further adjustment of post titles, menu titles, and tags (#43685) * Adjusting post_titles, menu_titles, and tags for docs folder Adjusting the post_titles, menu_titles, and tags for document files in the docs folder * Update removing-product-product-category-or-shop-from-the-url.md * Update classic-theme-developer-handbook.md * further adjustments and casing * Move HPOS/CLI contents into README --------- Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
2024-01-16 19:29:00 +00:00
post_title: Critical flows within the WooCommerce Core API
Update docs manifest (#43718) Update manifest + fix duplicated key
2024-01-17 13:36:31 +00:00
menu_title: API critical flows
Rename "Contributing" category + tag files (#43675) * Tag contributor docs * Update contributing category name * Update manifest * Fix unicode issues
2024-01-16 00:09:52 +00:00
tags: reference
add graymatter to docs
2023-11-29 18:48:05 +00:00
---
Add API Critical Flows to /docs (#40762) * Created md file for API Critical Flows * Added Shipping section * Moved api-critical-flows.md to docs/contributing folder
2023-10-23 21:00:59 +00:00
In our documentation, we've pinpointed the essential user flows within the WooCommerce Core API. These flows serve as
the compass for our testing initiatives, aiding us in concentrating our efforts where they matter most. They also
provide invaluable insights into assessing the ramifications of modifications and determining issue priorities.
It's important to note that these flows remain dynamic, evolving in lockstep with the platform. They regularly undergo
updates, additions, and re-prioritization to stay aligned with the evolving needs of our system.
Rename "Contributing" category + tag files (#43675) * Tag contributor docs * Update contributing category name * Update manifest * Fix unicode issues
2024-01-16 00:09:52 +00:00
## Products
Add API Critical Flows to /docs (#40762) * Created md file for API Critical Flows * Added Shipping section * Moved api-critical-flows.md to docs/contributing folder
2023-10-23 21:00:59 +00:00
| Route | Flow name | Endpoint | Test File |
|----------|----------------------------|--------------------------------|-------------------------------------------------------------|
| Products | Can view all products | `/wp-json/wc/v3/products` | `tests/api-core-tests/tests/products/product-list.test.js` |
| Products | Can search products | `/wp-json/wc/v3/products` | `tests/api-core-tests/tests/products/product-list.test.js` |
| Products | Can add a simple product | `/wp-json/wc/v3/products` | `tests/api-core-tests/tests/products/products-crud.test.js` |
| Products | Can add a variable product | `/wp-json/wc/v3/products` | `tests/api-core-tests/tests/products/products-crud.test.js` |
| Products | Can add a virtual product | `/wp-json/wc/v3/products` | `tests/api-core-tests/tests/products/products-crud.test.js` |
| Products | Can view a single product | `/wp-json/wc/v3/products/{id}` | `tests/api-core-tests/tests/products/products-crud.test.js` |
| Products | Can update a product | `/wp-json/wc/v3/products/{id}` | `tests/api-core-tests/tests/products/products-crud.test.js` |
| Products | Can delete a product | `/wp-json/wc/v3/products/{id}` | `tests/api-core-tests/tests/products/products-crud.test.js` |
Rename "Contributing" category + tag files (#43675) * Tag contributor docs * Update contributing category name * Update manifest * Fix unicode issues
2024-01-16 00:09:52 +00:00
## Orders
Add API Critical Flows to /docs (#40762) * Created md file for API Critical Flows * Added Shipping section * Moved api-critical-flows.md to docs/contributing folder
2023-10-23 21:00:59 +00:00
| Route | Flow name | Endpoints | Test File |
|--------|------------------------------------------------------------------|------------------------------|-----------------------------------------------------------|
| Orders | Can create an order | `/wp-json/wc/v3/orders` | `tests/api-core-tests/tests/orders/orders-crud.test.js` |
| Orders | Can view a single order | `/wp-json/wc/v3/orders/{id}` | `tests/api-core-tests/tests/orders/orders-crud.test.js` |
| Orders | Can update an order | `/wp-json/wc/v3/orders/{id}` | `tests/api-core-tests/tests/orders/orders-crud.test.js` |
| Orders | Can delete an order | `/wp-json/wc/v3/orders/{id}` | `tests/api-core-tests/tests/orders/orders-crud.test.js` |
| Orders | Can view all orders | `/wp-json/wc/v3/orders` | `tests/api-core-tests/tests/orders/orders.test.js` |
| Orders | Can search orders | `/wp-json/wc/v3/orders` | `tests/api-core-tests/tests/orders/order-search.test.js` |
Remove manually found unicode characters in docs (#43677) * Remove manually found unicode characters Non-regular spaces, quotes, dashes * Fix linting * fix more linting issues * Fix more linting * fix enable-hpos.md linting * Update docs manifest
2024-01-16 00:42:12 +00:00
| Orders | Can add new Order complex - multiple product types & tax classes | `/wp-json/wc/v3/orders` | `tests/api-core-tests/tests/orders/order-complex.test.js` |
Add API Critical Flows to /docs (#40762) * Created md file for API Critical Flows * Added Shipping section * Moved api-critical-flows.md to docs/contributing folder
2023-10-23 21:00:59 +00:00
Rename "Contributing" category + tag files (#43675) * Tag contributor docs * Update contributing category name * Update manifest * Fix unicode issues
2024-01-16 00:09:52 +00:00
## Refunds
Add API Critical Flows to /docs (#40762) * Created md file for API Critical Flows * Added Shipping section * Moved api-critical-flows.md to docs/contributing folder
2023-10-23 21:00:59 +00:00
| Route | Flow name | Endpoints | Test File |
|---------|---------------------|--------------------------------------|-----------------------------------------------------|
| Refunds | Can refund an order | `/wp-json/wc/v3/orders/{id}/refunds` | `tests/api-core-tests/tests/refunds/refund.test.js` |
Rename "Contributing" category + tag files (#43675) * Tag contributor docs * Update contributing category name * Update manifest * Fix unicode issues
2024-01-16 00:09:52 +00:00
## Coupons
Add API Critical Flows to /docs (#40762) * Created md file for API Critical Flows * Added Shipping section * Moved api-critical-flows.md to docs/contributing folder
2023-10-23 21:00:59 +00:00
| Route | Flow name | Endpoints | Test File |
|---------|---------------------------|--------------------------------------|------------------------------------------------------|
| Coupons | Can create a coupon | `/wp-json/wc/v3/coupons` | `tests/api-core-tests/tests/coupons/coupons.test.js` |
| Coupons | Can update a coupon | `/wp-json/wc/v3/coupons/{id}` | `tests/api-core-tests/tests/coupons/coupons.test.js` |
| Coupons | Can delete a coupon | `/wp-json/wc/v3/coupons/{id}` | `tests/api-core-tests/tests/coupons/coupons.test.js` |
| Coupons | Can add a coupon to order | `/wp-json/wc/v3/orders/{id}/coupons` | `tests/api-core-tests/tests/coupons/coupons.test.js` |
Rename "Contributing" category + tag files (#43675) * Tag contributor docs * Update contributing category name * Update manifest * Fix unicode issues
2024-01-16 00:09:52 +00:00
## Shipping
Add API Critical Flows to /docs (#40762) * Created md file for API Critical Flows * Added Shipping section * Moved api-critical-flows.md to docs/contributing folder
2023-10-23 21:00:59 +00:00
| Route | Flow name | Endpoints | Test File |
|------------------|-----------------------------------------------|----------------------------------------------|--------------------------------------------------------------|
| Shipping zones | Can create shipping zones | `/wp-json/wc/v3/shipping/zones` | `tests/api-core-tests/tests/shipping/shipping-zones.test.js` |
| Shipping methods | Can create shipping method to a shipping zone | `/wp-json/wc/v3/shipping/zones/{id}/methods` | n/a |
| Shipping classes | Can create a product shipping class | `/wp-json/wc/v3/products/shipping_classes` | `tests/api-core-tests/tests/products/products-crud.test.js` |