From f3369fcb2d473665a71cf37454f59f15ef9dcc5c Mon Sep 17 00:00:00 2001 From: Grzegorz Sadowski Date: Thu, 6 Oct 2016 12:55:19 +0200 Subject: [PATCH] [Documentation] Update docs and UPGRADE file --- UPGRADE.md | 5 +++++ docs/api/checkouts.rst | 2 +- docs/api/customers.rst | 8 ++++---- docs/api/orders.rst | 6 +++--- docs/api/users.rst | 8 ++++---- docs/components/User/models.rst | 10 +++++----- 6 files changed, 22 insertions(+), 17 deletions(-) diff --git a/UPGRADE.md b/UPGRADE.md index a549afb602..eec806f995 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -3,6 +3,11 @@ UPGRADE ## From 0.19 to 1.0.0-alpha +### Customer + + * Renamed ``Group`` to ``CustomerGroup`` + * Changed relation between ``CustomerGroup`` and ``Customer`` to one-to-many + ### Product and ProductBundle * Renamed ``options`` property to ``optionValues`` in ``ProductVariant`` diff --git a/docs/api/checkouts.rst b/docs/api/checkouts.rst index f72713d0f2..0981f6e986 100644 --- a/docs/api/checkouts.rst +++ b/docs/api/checkouts.rst @@ -144,7 +144,7 @@ The response will contain the updated order information. "email_canonical": "xschaefer@example.com", "enabled": true, "expired": false, - "groups": [], + "group": [], "id": 5, "locked": false, "roles": [], diff --git a/docs/api/customers.rst b/docs/api/customers.rst index 6795644cfb..03f2d2967a 100644 --- a/docs/api/customers.rst +++ b/docs/api/customers.rst @@ -272,7 +272,7 @@ Example Response "first_name":"Levi", "last_name":"Friesen", "gender":"u", - "groups":[ + "group":[ ] } @@ -356,7 +356,7 @@ Example Response "first_name":"John", "last_name":"Diggle", "gender":"m", - "groups":[ + "group":[ ] } @@ -410,7 +410,7 @@ Example Response "Please choose your gender." ] }, - "groups":{ + "group":{ } } @@ -529,7 +529,7 @@ Example Response "Please choose your gender." ] }, - "groups":{ + "group":{ } } diff --git a/docs/api/orders.rst b/docs/api/orders.rst index 3b064e5465..ace12caeee 100644 --- a/docs/api/orders.rst +++ b/docs/api/orders.rst @@ -116,7 +116,7 @@ The response will contain the newly created order information. "email":"ygrant@example.com", "email_canonical":"ygrant@example.com", "enabled":false, - "groups":[ + "group":[ ], "locked":false, @@ -306,7 +306,7 @@ Response "email":"ygrant@example.com", "email_canonical":"ygrant@example.com", "enabled":false, - "groups":[ + "group":[ ], "locked":false, @@ -391,7 +391,7 @@ Response "email":"chelsie.witting@example.com", "email_canonical":"chelsie.witting@example.com", "enabled":true, - "groups":[ + "group":[ ], "locked":false, diff --git a/docs/api/users.rst b/docs/api/users.rst index 3233ae4f04..6a0b6c1e1b 100644 --- a/docs/api/users.rst +++ b/docs/api/users.rst @@ -60,7 +60,7 @@ Response will contain a paginated list of users. "email_canonical": "chelsie.witting@example.com", "enabled": true, "expired": false, - "groups": [], + "group": [], "id": 481, "locked": false, "password": "EbOLtGHYxJKotA+bdb9BElhXPd8qZsnlo8CjDdCk+qFR22EEZJoOTntBX/M5GUXw2vnEqOKIEVPaJr66yxXqqQ==", @@ -97,7 +97,7 @@ Response "email_canonical": "chelsie.witting@example.com", "enabled": true, "expired": false, - "groups": [], + "group": [], "id": 481, "locked": false, "password": "EbOLtGHYxJKotA+bdb9BElhXPd8qZsnlo8CjDdCk+qFR22EEZJoOTntBX/M5GUXw2vnEqOKIEVPaJr66yxXqqQ==", @@ -145,7 +145,7 @@ Response "email_canonical": "chelsie.witting@example.com", "enabled": true, "expired": false, - "groups": [], + "group": [], "id": 481, "locked": false, "password": "EbOLtGHYxJKotA+bdb9BElhXPd8qZsnlo8CjDdCk+qFR22EEZJoOTntBX/M5GUXw2vnEqOKIEVPaJr66yxXqqQ==", @@ -238,7 +238,7 @@ The successful response will contain the user object with a confirmation token a "email_canonical": "sylius@example.com", "enabled": true, "expired": false, - "groups": [], + "group": [], "id": 1, "last_login": "2014-12-08T13:08:02+0000", "locked": false, diff --git a/docs/components/User/models.rst b/docs/components/User/models.rst index de1b136cf3..4008b33556 100644 --- a/docs/components/User/models.rst +++ b/docs/components/User/models.rst @@ -26,7 +26,7 @@ concerning personal data and as default has the following properties: +----------------+---------------------------------------------------+---------------+ | user | Corresponding user object | UserInterface | +----------------+---------------------------------------------------+---------------+ -| groups | Customer's groups | Collection | +| group | Customer's groups | Collection | +----------------+---------------------------------------------------+---------------+ | createdAt | Date of creation | \DateTime | +----------------+---------------------------------------------------+---------------+ @@ -35,7 +35,7 @@ concerning personal data and as default has the following properties: .. note:: - This model implements ``CustomerInterface`` and ``GroupableInterface`` + This model implements ``CustomerInterface`` User ---- @@ -88,10 +88,10 @@ As default has the following properties: This model implements ``UserInterface`` -Group +CustomerGroup ----- -The customer group is represented as a **Group** instance. It can be used to classify customers. +The customer group is represented as a **CustomerGroup** instance. It can be used to classify customers. As default has the following properties: +----------+------------------------+---------+ @@ -104,7 +104,7 @@ As default has the following properties: .. note:: - This model implements ``GroupInterface`` + This model implements ``CustomerGroupInterface`` UserOAuth ---------