Mercurial > public > src > rhodecode

diff docs/api/api.rst @ 1896:320dec24fb9a beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added instruction on enabling the API access to web views
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 28 Dec 2011 23:57:57 +0200
parents 203af05539e0
children 9da24750f563
line wrap: on
line diff
--- a/docs/api/api.rst	Wed Dec 28 04:12:27 2011 +0200
+++ b/docs/api/api.rst	Wed Dec 28 23:57:57 2011 +0200
@@ -11,6 +11,13 @@
 <your_server>/_admin/api
 
 
+API access can also be turned on for each view decorated with `@LoginRequired`
+decorator. To enable API access simple change standard login decorator into
+`@LoginRequired(api_access=True)`. After such a change view can be accessed
+by adding a GET parameter to url `?api_key=<api_key>`. By default it's only
+enabled on RSS/ATOM feed views.
+
+
 All clients are required to send JSON-RPC spec JSON data::
 
     {