From 614edef19e58c98784d02b8212e10aae13575f19 Mon Sep 17 00:00:00 2001 From: Zach Stepek Date: Tue, 23 Feb 2016 09:26:45 -0600 Subject: [PATCH 1/2] Introduction: Diff. between v3 and older versions Modified to include links to relevant documentation for new functionality. Revised text for some items to ease readability. --- source/includes/v3/_introduction.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/includes/v3/_introduction.md b/source/includes/v3/_introduction.md index 4280b4ff..58c0ea21 100644 --- a/source/includes/v3/_introduction.md +++ b/source/includes/v3/_introduction.md @@ -37,12 +37,12 @@ The `v1` and `v2` APIs will be removed in future versions. * v3 implements full basic authentication ([conforms to the Basic auth spec)](http://tools.ietf.org/html/rfc2617)). * v3 fixes the OAuth implementation to be compliant with the [Oauth 1.0a specs](http://tools.ietf.org/html/rfc5849). -* v3 includes a new endpoint to get all product orders. -* v3 has new endpoints to allow bulk actions as edition and creation of products, orders, customers and coupons. -* v3 introduces new product attribute endpoints (`GET`, `POST`, `PUT` and `DELETE`). -* v3 deprecated the product/sku/<id> endpoint (because a SKU can be generated with any character, besides that there is a filter callend `filter[sku]`). -* v3 includes category thumbnails on the requests for `product/categories`. -* v3 uses our option to auto generate passwords for new customers. +* v3 includes a new endpoint to [get all product orders](#view-list-of-product-orders). +* v3 has new endpoints for bulk creation and updating of [products](#create-update-multiple-products), [orders](#create-update-multiple-orders), [customers](#create-update-multiple-customers) and [coupons](#create-update-multiple-coupons). +* v3 introduces new [product attribute endpoints](#product-attributes) (`GET`, `POST`, `PUT` and `DELETE`). +* v3 deprecated the product/sku/<id> endpoint (because a SKU can be generated with any character and there is a filter, `filter[sku]`, that covers this use case). +* v3 includes category thumbnails with requests for `product/categories`. +* v3 can auto generate passwords for new customers if the "automatically generate customer password" option is enabled. ### API Docs for past versions ### From 1776c9943dbeeffd2ad71c450078ebe14f469a97 Mon Sep 17 00:00:00 2001 From: Zach Stepek Date: Tue, 23 Feb 2016 12:20:19 -0600 Subject: [PATCH 2/2] Prioritizing v3 content Changes in v3 are likely to be most important, so I swapped the "Differences between v1 and v2" and "Differences between v3 and older versions" sections and renamed "Differences between v3 and older versions" to "What's changed in v3?" --- source/includes/v3/_introduction.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/source/includes/v3/_introduction.md b/source/includes/v3/_introduction.md index 58c0ea21..ebcc810f 100644 --- a/source/includes/v3/_introduction.md +++ b/source/includes/v3/_introduction.md @@ -22,6 +22,18 @@ The current API version is `v3` which takes a first-order position in endpoints. The `v1` and `v2` APIs will be removed in future versions. +### What's changed in v3? ### + +* v3 implements full basic authentication ([conforms to the Basic auth spec)](http://tools.ietf.org/html/rfc2617)). +* v3 fixes the OAuth implementation to be compliant with the [Oauth 1.0a specs](http://tools.ietf.org/html/rfc5849). +* v3 includes a new endpoint to [get all product orders](#view-list-of-product-orders). +* v3 has new endpoints for bulk creation and updating of [products](#create-update-multiple-products), [orders](#create-update-multiple-orders), [customers](#create-update-multiple-customers) and [coupons](#create-update-multiple-coupons). +* v3 introduces new [product attribute endpoints](#product-attributes) (`GET`, `POST`, `PUT` and `DELETE`). +* v3 deprecated the product/sku/<id> endpoint (because a SKU can be generated with any character and there is a filter, `filter[sku]`, that covers this use case). +* v3 includes category thumbnails with requests for `product/categories`. +* v3 can auto generate passwords for new customers if the "automatically generate customer password" option is enabled. + + ### Differences between v1 and v2 ### * v1 supports XML response format, v2 only supports JSON. @@ -33,17 +45,6 @@ The `v1` and `v2` APIs will be removed in future versions. * v1 does not include any endpoints for getting valid order statuses, v2 includes an endpoint for listing valid order statuses (`GET /orders/statuses`). * v2 supports the core features added in WooCommerce 2.2, primarily order refunds (via the `/orders/refunds` endpoint) and Webhooks (via the `/webhooks`). -### Differences between v3 and older versions ### - -* v3 implements full basic authentication ([conforms to the Basic auth spec)](http://tools.ietf.org/html/rfc2617)). -* v3 fixes the OAuth implementation to be compliant with the [Oauth 1.0a specs](http://tools.ietf.org/html/rfc5849). -* v3 includes a new endpoint to [get all product orders](#view-list-of-product-orders). -* v3 has new endpoints for bulk creation and updating of [products](#create-update-multiple-products), [orders](#create-update-multiple-orders), [customers](#create-update-multiple-customers) and [coupons](#create-update-multiple-coupons). -* v3 introduces new [product attribute endpoints](#product-attributes) (`GET`, `POST`, `PUT` and `DELETE`). -* v3 deprecated the product/sku/<id> endpoint (because a SKU can be generated with any character and there is a filter, `filter[sku]`, that covers this use case). -* v3 includes category thumbnails with requests for `product/categories`. -* v3 can auto generate passwords for new customers if the "automatically generate customer password" option is enabled. - ### API Docs for past versions ### * [WooCommerce REST API v1 docs](v1.html)