Mercurial > public > src > rhodecode
changeset 1996:0bd97250cd36 beta
docs update
| author | Marcin Kuzminski <marcin@python-works.com> |
|---|---|
| date | Tue, 17 Jan 2012 23:13:19 +0200 |
| parents | f2bd5b0c1094 |
| children | 32e1e0745d3c |
| files | docs/api/api.rst |
| diffstat | 1 files changed, 5 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/api/api.rst Tue Jan 17 20:51:42 2012 +0200 +++ b/docs/api/api.rst Tue Jan 17 23:13:19 2012 +0200 @@ -13,10 +13,11 @@ API ACCESS FOR WEB VIEWS ++++++++++++++++++++++++ -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 +API access can also be turned on for each web view in RhodeCode that is +decorated with `@LoginRequired` decorator. To enable API access simple change +the standard login decorator to `@LoginRequired(api_access=True)`. +After this change, a rhodecode view can be accessed without login by adding a +GET parameter `?api_key=<api_key>` to url. By default this is only enabled on RSS/ATOM feed views.