python
/
aiohttp-security
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve docs

This commit is contained in:
Andrew Svetlov 2015-11-08 10:56:34 +08:00
parent 80beb70e9a
commit 71880dfc72
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/glossary.rst
View File

@ -47,6 +47,13 @@
*identity* is used for getting :term:`userid` and :term:`permissions`. *identity* is used for getting :term:`userid` and :term:`permissions`.
permission
Permission required for access to resource.
Permissions are just strings, and they have no required
composition: you can name permissions whatever you like.
userid userid
User's ID, most likely his *login* or *email* User's ID, most likely his *login* or *email*

2
docs/reference.rst
View File

@ -78,7 +78,7 @@ Public API functions
:param request: :class:`aiohttp.web.Request` object. :param request: :class:`aiohttp.web.Request` object.
:param str permission: requested permission. :param str permission: requested :term:`permission`.
:param context: additional object may be passed into :param context: additional object may be passed into
:meth:`AbstractAuthorizationPolicy.permission` :meth:`AbstractAuthorizationPolicy.permission`