Updates based on issues in the WooCommerce repo #243
Conversation
This also removes redundant properties from Orders Fixes woocommerce/woocommerce#43444
Refs #46895
Property type set to string to match schema Fixes woocommerce/woocommerce#28474
coreymckrill
requested review from
a team and
vedanshujain
and removed request for
a team
coreymckrill
requested review from
Konamiman and
naman03malhotra
and removed request for
vedanshujain
|
Switching the reviewers to Nestor and Naman since they are working on docs updates. |
| | `rate_code` | string | Tax rate code. <i class="label label-info">read-only</i> | | ||
| | `rate_id` | integer | Tax rate ID. <i class="label label-info">read-only</i> | | ||
| | `label` | string | Tax rate label. <i class="label label-info">read-only</i> | | ||
| | `compound` | boolean | Show if is a compound tax rate. <i class="label label-info">read-only</i> | |
There was a problem hiding this comment.
"show if it's a compound" is better maybe?
There was a problem hiding this comment.
Yeah, that grammar could definitely be improved. Updated in 849b306
| | `orderby` | string | Sort collection by object attribute. Options: `date`, `modified`, `id`, `include`, `title` and `slug`. Default is `date`. | | ||
| | `parent` | array | Limit result set to those of particular parent IDs. | | ||
| | `parent_exclude` | array | Limit result set to all items except those of a particular parent ID. | | ||
| | `dp` | integer | Number of decimal points to use in each resource. Default is `2`. | |
There was a problem hiding this comment.
Side note: should we perhaps use the full name decimal_points instead of the abbreviation here?
There was a problem hiding this comment.
should we perhaps use the full name decimal_points instead of the abbreviation here?
dp is the name of the parameter used in the REST API, so if we changed it in the docs, we'd need to update the endpoint as well. Replacing dp with decimal_points would be backwards-incompatible, but I guess we could add decimal_points as an alias of dp.
I agree decimal_points would have been a better name from the start, though. For now I think we should keep the docs and the endpoint as they are.
There was a problem hiding this comment.
I agree decimal_points would have been a better name from the start, though. For now I think we should keep the docs and the endpoint as they are.
👍
| | `orderby` | string | Sort collection by object attribute. Options: `date`, `modified`, `id`, `include`, `title` and `slug`. Default is `date`. | | ||
| | `parent` | array | Limit result set to those of particular parent IDs. | | ||
| | `parent_exclude` | array | Limit result set to all items except those of a particular parent ID. | | ||
| | `dp` | integer | Number of decimal points to use in each resource. Default is `2`. | |
There was a problem hiding this comment.
I agree decimal_points would have been a better name from the start, though. For now I think we should keep the docs and the endpoint as they are.
👍
There are several issues in the backlog of the REST API focus in the WooCommerce repo. This attempts to batch fixes for those issues into one PR.
To test
./build.sh. This will create abuilddirectory in the repo.index.htmlfile in the build directory and open it in a browser. You should see something that looks just like the live REST API docs site.