kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[Documentation] Update docs and UPGRADE file

Browse source
This commit is contained in:
Grzegorz Sadowski 2016-10-06 12:55:19 +02:00
parent 08b3bd7058
commit f3369fcb2d
6 changed files with 22 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
UPGRADE.md
View file

@ -3,6 +3,11 @@ UPGRADE
## From 0.19 to 1.0.0-alpha ## 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 ### Product and ProductBundle
* Renamed ``options`` property to ``optionValues`` in ``ProductVariant`` * Renamed ``options`` property to ``optionValues`` in ``ProductVariant``

2
docs/api/checkouts.rst
View file

@ -144,7 +144,7 @@ The response will contain the updated order information.
"email_canonical": "xschaefer@example.com", "email_canonical": "xschaefer@example.com",
"enabled": true, "enabled": true,
"expired": false, "expired": false,
"groups": [], "group": [],
"id": 5, "id": 5,
"locked": false, "locked": false,
"roles": [], "roles": [],

8
docs/api/customers.rst
View file

@ -272,7 +272,7 @@ Example Response
"first_name":"Levi", "first_name":"Levi",
"last_name":"Friesen", "last_name":"Friesen",
"gender":"u", "gender":"u",
"groups":[ "group":[
] ]
} }
@ -356,7 +356,7 @@ Example Response
"first_name":"John", "first_name":"John",
"last_name":"Diggle", "last_name":"Diggle",
"gender":"m", "gender":"m",
"groups":[ "group":[
] ]
} }
@ -410,7 +410,7 @@ Example Response
"Please choose your gender." "Please choose your gender."
] ]
}, },
"groups":{ "group":{
} }
} }
@ -529,7 +529,7 @@ Example Response
"Please choose your gender." "Please choose your gender."
] ]
}, },
"groups":{ "group":{
} }
} }

6
docs/api/orders.rst
View file

@ -116,7 +116,7 @@ The response will contain the newly created order information.
"email":"ygrant@example.com", "email":"ygrant@example.com",
"email_canonical":"ygrant@example.com", "email_canonical":"ygrant@example.com",
"enabled":false, "enabled":false,
"groups":[ "group":[
], ],
"locked":false, "locked":false,
@ -306,7 +306,7 @@ Response
"email":"ygrant@example.com", "email":"ygrant@example.com",
"email_canonical":"ygrant@example.com", "email_canonical":"ygrant@example.com",
"enabled":false, "enabled":false,
"groups":[ "group":[
], ],
"locked":false, "locked":false,
@ -391,7 +391,7 @@ Response
"email":"chelsie.witting@example.com", "email":"chelsie.witting@example.com",
"email_canonical":"chelsie.witting@example.com", "email_canonical":"chelsie.witting@example.com",
"enabled":true, "enabled":true,
"groups":[ "group":[
], ],
"locked":false, "locked":false,

8
docs/api/users.rst
View file

@ -60,7 +60,7 @@ Response will contain a paginated list of users.
"email_canonical": "chelsie.witting@example.com", "email_canonical": "chelsie.witting@example.com",
"enabled": true, "enabled": true,
"expired": false, "expired": false,
"groups": [], "group": [],
"id": 481, "id": 481,
"locked": false, "locked": false,
"password": "EbOLtGHYxJKotA+bdb9BElhXPd8qZsnlo8CjDdCk+qFR22EEZJoOTntBX/M5GUXw2vnEqOKIEVPaJr66yxXqqQ==", "password": "EbOLtGHYxJKotA+bdb9BElhXPd8qZsnlo8CjDdCk+qFR22EEZJoOTntBX/M5GUXw2vnEqOKIEVPaJr66yxXqqQ==",
@ -97,7 +97,7 @@ Response
"email_canonical": "chelsie.witting@example.com", "email_canonical": "chelsie.witting@example.com",
"enabled": true, "enabled": true,
"expired": false, "expired": false,
"groups": [], "group": [],
"id": 481, "id": 481,
"locked": false, "locked": false,
"password": "EbOLtGHYxJKotA+bdb9BElhXPd8qZsnlo8CjDdCk+qFR22EEZJoOTntBX/M5GUXw2vnEqOKIEVPaJr66yxXqqQ==", "password": "EbOLtGHYxJKotA+bdb9BElhXPd8qZsnlo8CjDdCk+qFR22EEZJoOTntBX/M5GUXw2vnEqOKIEVPaJr66yxXqqQ==",
@ -145,7 +145,7 @@ Response
"email_canonical": "chelsie.witting@example.com", "email_canonical": "chelsie.witting@example.com",
"enabled": true, "enabled": true,
"expired": false, "expired": false,
"groups": [], "group": [],
"id": 481, "id": 481,
"locked": false, "locked": false,
"password": "EbOLtGHYxJKotA+bdb9BElhXPd8qZsnlo8CjDdCk+qFR22EEZJoOTntBX/M5GUXw2vnEqOKIEVPaJr66yxXqqQ==", "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", "email_canonical": "sylius@example.com",
"enabled": true, "enabled": true,
"expired": false, "expired": false,
"groups": [], "group": [],
"id": 1, "id": 1,
"last_login": "2014-12-08T13:08:02+0000", "last_login": "2014-12-08T13:08:02+0000",
"locked": false, "locked": false,

10
docs/components/User/models.rst
View file

@ -26,7 +26,7 @@ concerning personal data and as default has the following properties:
+----------------+---------------------------------------------------+---------------+ +----------------+---------------------------------------------------+---------------+
| user | Corresponding user object | UserInterface | | user | Corresponding user object | UserInterface |
+----------------+---------------------------------------------------+---------------+ +----------------+---------------------------------------------------+---------------+
| groups | Customer's groups | Collection | | group | Customer's groups | Collection |
+----------------+---------------------------------------------------+---------------+ +----------------+---------------------------------------------------+---------------+
| createdAt | Date of creation | \DateTime | | createdAt | Date of creation | \DateTime |
+----------------+---------------------------------------------------+---------------+ +----------------+---------------------------------------------------+---------------+
@ -35,7 +35,7 @@ concerning personal data and as default has the following properties:
.. note:: .. note::
This model implements ``CustomerInterface`` and ``GroupableInterface`` This model implements ``CustomerInterface``
User User
---- ----
@ -88,10 +88,10 @@ As default has the following properties:
This model implements ``UserInterface`` 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: As default has the following properties:
+----------+------------------------+---------+ +----------+------------------------+---------+
@ -104,7 +104,7 @@ As default has the following properties:
.. note:: .. note::
This model implements ``GroupInterface`` This model implements ``CustomerGroupInterface``
UserOAuth UserOAuth
--------- ---------