Merge pull request #6 from skyverge/ch63258/update-the-memberships-rest-api-documentation

Author: unfulvio

.dockerignore

@@ -0,0 +1,2 @@
+build/
+.github/

Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:2.6-slim
+
+WORKDIR /srv/docs
+
+VOLUME /srv/docs/source
+EXPOSE 4567
+
+COPY . /srv/docs
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        build-essential \
+        nodejs \
+    && gem install bundler \
+    && bundle install \
+    && apt-get remove -y build-essential \
+    && apt-get autoremove -y \
+    && rm -rf /var/lib/apt/lists/*
+
+CMD ["bundle", "exec", "middleman", "server", "--watcher-force-polling"]

README.md

@@ -15,15 +15,9 @@ You can contribute to this documentation by:
 
 > Please **do not submit feature requests or support requests for the REST API** here. You can use the [WooIdeas board](http://ideas.woocommerce.com/forums/133476-woocommerce?category_id=125014) or [Contact SkyVerge support](https://www.skyverge.com/support/).
 
-## Updating pages
-
-This project uses [Slate](https://github.com/lord/slate) for building the documentation pages.
+## Running locally
 
-Follow [Slate readme](https://github.com/lord/slate/blob/master/README.md) and [wiki](https://github.com/lord/slate/wiki) for instructions on how to edit files and make changes.
-
-## Deploying an update 
-
-To install locally use:
+### Natively
 
 ```shell
 bundle install
@@ -37,7 +31,33 @@ Then, to test changes locally run:
 bundle exec middleman server
 ```
 
-Finally, after pushing changes and you are ready to deploy use the script:
+### Via Docker
+
+1. Build the docker image:
+    ```shell
+    docker build . -t docs
+    ```
+1. Start the image:
+    ```shell
+    docker run -d --rm --name docs -p 4567:4567 -v $(pwd)/build:/srv/docs/build -v $(pwd)/source:/srv/docs/source docs
+    ```
+
+You will be able to access your site at http://localhost:4567.
+
+To build your sources while the container is running, run:
+```shell
+docker exec -it docs /bin/bash -c "bundle exec middleman build"
+```
+
+## Updating pages
+
+This project uses [Slate](https://github.com/lord/slate) for building the documentation pages.
+
+Follow [Slate readme](https://github.com/lord/slate/blob/master/README.md) and [wiki](https://github.com/lord/slate/wiki) for instructions on how to edit files and make changes.
+
+## Deploying an update 
+
+After pushing changes and you are ready to deploy use the script:
 
 ```shell
 bash deploy.sh

source/includes/_user_memberships.md

@@ -28,6 +28,7 @@ Property             | Type                            | Description
 `cancelled_date`     | <code>datetime&#124;null</code> | The date (in Atom format) when the membership was cancelled, in the local timezone. This is `null` if the membership was not cancelled. 
 `cancelled_date_gmt` | <code>datetime&#124;null</code> | The date (in Atom format) when the membership was cancelled, in UTC. This is `null` if the membership was not cancelled.
 `view_url`           | <code>string</code>             | _`read-only`_<br><br>URL pointing to the site's Members Area accessible to the membership's owner.    
+`profile_fields`     | <code>array&#124;object</code>  | Holds any profile fields set on the membership. Each array item has a "slug" _`(string)`_ and a "value" (either a _`boolean`_, an _`integer`_, _`float`_, _`string`_, or _`array`_).
 `meta_data`          | <code>array&#124;object</code>  | Holds any WordPress meta data set on the membership. Each array item has an "id" _`(integer)`_, a "key" _`(string)`_ and a "value" (either a _`boolean`_, an _`integer`_, or _`string`_, which could also represent serialized data).
 `links`              | <code>array</code>              | _`read-only`_<br><br>An array of items linking to related objects accessible through the REST API.   
 

source/includes/user_memberships/_create.md

@@ -35,6 +35,7 @@ $woocommerce->post( 'memberships/members', $user_membership_data );
     "cancelled_date": null,
     "cancelled_date_gmt": null,
     "view_url": "http://skyverge.test/my-account/members-area/222/my-membership-content/",
+    "profile_fields": [],
     "meta_data": [],
     "_links": {
         "self": [
@@ -78,5 +79,6 @@ Attribute            | Type                            | Description
 `end_date_gmt`       | <code>datetime</code>           | _Optional_. The date when the membership will end, in UTC. If status is expired, defaults to the present time when the request is issued.
 `paused_date_gmt`    | <code>datetime</code>           | _Optional_. The date when the membership has been paused since, in UTC. If status is paused, defaults to the present time when the request is issued.
 `cancelled_date_gmt` | <code>datetime</code>           | _Optional_. The date when the membership has been cancelled, in UTC. If status is cancelled, defaults to the present time when the request is issued.
+`profile_fields`     | <code>array&#124;object</code>  | _Optional_. Pass any profile fields to be set on the membership. Each array item has a "slug" _`(string)`_ and a "value" (either a _`boolean`_, an _`integer`_, _`float`_, _`string`_, or _`array`_).
 `meta_data`          | <code>array</code>              | _Optional_. Pass any WordPress post meta data to be set on the membership. Each array item has an "id" _`(integer)`_, a "key" _`(string)`_ and a "value" (either a _`boolean`_, an _`integer`_, or _`string`_, which could also represent serialized data).
 

source/includes/user_memberships/_read.md

@@ -31,6 +31,7 @@ $woocommerce->get( 'memberships/members' );
     "cancelled_date": null,
     "cancelled_date_gmt": null,
     "view_url": "http://skyverge.test/my-account/members-area/10/my-membership-content/",
+    "profile_fields": [],
     "meta_data": [],
     "_links": {
       "self": [
@@ -117,6 +118,7 @@ $woocommerce->get( 'memberships/members/<id>' );
   "cancelled_date": null,
   "cancelled_date_gmt": null,
   "view_url": "http://skyverge.test/my-account/members-area/10/my-membership-content/",
+  "profile_fields": [],
   "meta_data": [],
   "_links": {
     "self": [

source/includes/user_memberships/_update.md

@@ -34,6 +34,7 @@ $woocommerce->put( 'memberships/members', $user_membership_data );
     "cancelled_date": null,
     "cancelled_date_gmt": null,
     "view_url": "http://skyverge.test/my-account/members-area/222/my-membership-content/",
+    "profile_fields": [],
     "meta_data": [],
     "_links": {
         "self": [