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

Updated Contributing to the WooCommerce REST API (markdown)

Mike Jolley 2017-05-24 10:36:56 +01:00
parent 7dd0fdfaa1
commit 04aa9bfc44
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Contributing-to-the-WooCommerce-REST-API.md

@ -58,8 +58,6 @@ You can also use the `OPTIONS` command to return all information about an endpoi
![Customer schema](https://woocommerce.files.wordpress.com/2017/05/2017-05-24-at-10-24.png)
[You can read more about schemas in the handbook](https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/).
To look at an example schema, [see the customers API](https://github.com/woocommerce/woocommerce/blob/3.0.0/includes/api/class-wc-rest-customer-downloads-controller.php#L78-L168).
Each item in the schema represents data. Data has fixed names/keys and types. Take downloads for example:
@ -89,6 +87,8 @@ Each item in the schema represents data. Data has fixed names/keys and types. Ta
This shows that the API will return an array of file objects, and each object has 2 properties; name and file.
[You can read more about schemas in the handbook](https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/).
## Deprecation of older versions
API Versions are kept around for 2 years after being replaced and removed in the next **major** version after the date passes.