Skip to content

Commit dddb39a

Browse files
committed
Skeletal documentation for authz and identity modules
1 parent d30584b commit dddb39a

File tree

3 files changed

+28
-255
lines changed

3 files changed

+28
-255
lines changed

doc/modules/authz.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
``annotator.authz.acl`` module
2+
==============================
3+
4+
This module configures an authorization policy which grants or denies permission
5+
on objects (especially annotations) based on the presence of ``permissions`` or
6+
``user`` properties on the objects.
7+
8+
See :func:`annotator.authz.acl` for full API documentation.

doc/modules/identity.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
``annotator.identity.simple`` module
2+
=====================================
3+
4+
This module configures an identity policy which considers the identity of the
5+
current user to be an opaque identifier. By default the identity is
6+
unconfigured, but can be set.
7+
8+
Example
9+
-------
10+
11+
::
12+
13+
app.include(annotator.identity.simple);
14+
app
15+
.start()
16+
.then(function () {
17+
app.ident.identity = 'joebloggs';
18+
});
19+
20+
See :func:`annotator.identity.simple` for full API documentation.

doc/modules/permissions.rst

Lines changed: 0 additions & 255 deletions
This file was deleted.

0 commit comments

Comments
 (0)