Skip to content

Commit

Permalink
Skeletal documentation for authz and identity modules
Browse files Browse the repository at this point in the history
  • Loading branch information
nickstenning committed Apr 25, 2015
1 parent d30584b commit dddb39a
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 255 deletions.
8 changes: 8 additions & 0 deletions doc/modules/authz.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
``annotator.authz.acl`` module
==============================

This module configures an authorization policy which grants or denies permission
on objects (especially annotations) based on the presence of ``permissions`` or
``user`` properties on the objects.

See :func:`annotator.authz.acl` for full API documentation.
20 changes: 20 additions & 0 deletions doc/modules/identity.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
``annotator.identity.simple`` module
=====================================

This module configures an identity policy which considers the identity of the
current user to be an opaque identifier. By default the identity is
unconfigured, but can be set.

Example
-------

::

app.include(annotator.identity.simple);
app
.start()
.then(function () {
app.ident.identity = 'joebloggs';
});

See :func:`annotator.identity.simple` for full API documentation.
255 changes: 0 additions & 255 deletions doc/modules/permissions.rst

This file was deleted.

0 comments on commit dddb39a

Please sign in to comment.