← Back to branch summary

~blr/rutabaga/doc-update

« back to all changes in this revision

Viewing changes to docs/api.rst

  • Committer: Kit Randel
  • Date: 2015-10-27 03:28:28 UTC
  • Revision ID: kit.randel@canonical.com-20151027032828-czgg5sevvm1jlqzz
Split rutabaga docs into 'Getting Started' and 'API docs' sections.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api.rst
 
1
API Documentation
 
2
=================
 
3
 
 
4
Web Token REST API
 
5
##################
 
6
 
 
7
The Rutabaga API provides the following endpoints:
 
8
 
 
9
.. cornice-autodoc::
 
10
   :modules: rutabaga.views
 
11
          
 
12
 
 
13
Auth API
 
14
########
 
15
 
 
16
The auth module provides methods for creating, persisting, invaliding
 
17
and deleting tokens. Tokens are persisted to a sqlite3 store.
 
18
 
 
19
.. automodule:: rutabaga.auth
 
20
   :members: