Caution that roles should start with ROLE_ #4218
Conversation
In order to save someone else a few hours of frustration make it clear that the ROLE_ preface is not just for show.
| .. caution:: | ||
|
|
||
| The default role voter requires that all of the roles returned should be prefaced by ROLE_. | ||
| Example ROLE_ADMIN, ROLE_USER; not just ADMIN or USER. |
There was a problem hiding this comment.
I would reword this a bit and also link to the "Roles" section in the security chapter of the book:
.. caution::
The default role voter requires to prefix all roles with ``ROLE_`` (see
the :ref:`section about roles <book-security-roles>` in the book). For
example, your roles will be ``ROLE_ADMIN`` or ``ROLE_USER`` instead of
``ADMIN`` or ``USER``.In /book/security.rst you would then have to change it to something like this (add the label before the headline):
.. _book-security-roles:
Roles
-----
There was a problem hiding this comment.
I would not say The default role voter. the main confusion actually comes from a wrong usage of the term role in the documentation. See #4158
There was a problem hiding this comment.
@stof Well, I thought that at least http://symfony.com/doc/current/book/security.html#roles and its note are correct.
|
How about this version? I'm not sure 'security examples on this page' is clear, but it describes the problem I was having. |
|
Let me know if you would rather I rebased this once the language is correct. PS thanks Travis for catching each of my bonehead mistakes. |
|
👍 I think it's ready. |
|
Thanks for the addition and all of the fast tweaks. Cheers Jonathan! |
This PR was merged into the 2.3 branch. Discussion ---------- Caution that roles should start with ROLE_ In order to save someone else a few hours of frustration make it clear that the ROLE_ preface is not just for show. | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | Commits ------- 749996b Fix reference label f856641 Add label book-security-roles 9d13930 Add formatting, links, and clarity 1522de7 Caution that roles should start with ROLE_
In order to save someone else a few hours of frustration make it clear that the ROLE_ preface is not just for show.