woocommerce / woocommerce/subscriptions-rest-api-docs
Change the example create subscriptions requests to use `_gmt` suffixed subscription date keys
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 8
- Forks
- 4
- Avg merge
- 4h 32m
- Merged PRs (30d)
- 2
Description
Description of the Documentation Issue
Following the completion of 4219-gh-woocommerce/woocommerce-subscriptions, we need to update our docs use _gmt suffixed keys (eg start_date_gmt) in the example update and create subscription requests. For consistency with the properties list.
Using the unsuffixed keys is correct, at the moment, and will continue to be supported, however, we should be clear in the documentation they are they are also GMT based dates, there for backwards compatibility and shouldn't be used.
Link to the Section Containing the Issue
https://woocommerce.github.io/subscriptions-rest-api-docs/#create-a-subscription in the example requests.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked create-a-subscription section and locate the example create and update subscription requests; compare their date fields with the properties list. Update the examples to use the _gmt-suffixed date keys, and verify the documented requests consistently use the preferred GMT-based names.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100