Changeset - 0b6982223baa
[Not reviewed]
beta
0 2 0
Marcin Kuzminski - 13 years ago 2013-04-22 14:11:53
marcin@python-works.com
cleanup code
2 files changed with 2 insertions and 4 deletions:
0 comments (0 inline, 0 general)
docs/api/api.rst
Show inline comments
 
@@ -14,25 +14,25 @@ API ACCESS FOR WEB VIEWS
 
++++++++++++++++++++++++
 

	
 
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)`.
 

	
 
To make this operation easier, starting from version 1.7.0 there's a white list
 
of views that will have API access enabled. Simply edit `api_access_controllers_whitelist`
 
option in your .ini file, and define views that should have API access enabled.
 
Following example shows how to enable API access to patch/diff raw file and archive
 
in RhodeCode::
 

	
 
    api_access_controllers_whitelist = 
 
    api_access_controllers_whitelist =
 
        ChangesetController:changeset_patch,
 
        ChangesetController:changeset_raw,
 
        FilesController:raw,
 
        FilesController:archivefile
 

	
 

	
 
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. Exposing raw diffs is a good way to integrate with
 
3rd party services like code review, or build farms that could download archives.
 

	
 

	
docs/usage/general.rst
Show inline comments
 
@@ -116,25 +116,25 @@ clone url in summary page.
 

	
 

	
 

	
 
Visual settings in admin pannel
 
-------------------------------
 

	
 

	
 
Visualisation settings in RhodeCode settings view are extra customizations
 
of server behavior. There are 3 main section in the settings.
 

	
 
General
 
~~~~~~~
 
    
 

	
 
`Use repository extra fields` option allows to set a custom fields for each
 
repository in the system. Each new field consists of 3 attributes `field key`,
 
`field label`, `field description`. Example usage of such fields would be to
 
define company specific information into repositories eg. defining repo_manager
 
key that would add give info about a manager of each repository. There's no
 
limit for adding custom fields. Newly created fields are accessible via API.
 

	
 

	
 
Icons
 
~~~~~
 

	
 
Show public repo icon / Show private repo icon on repositories - defines if
 
@@ -146,14 +146,12 @@ Meta-Tagging
 

	
 
With this option enabled, special metatags that are recognisible by RhodeCode
 
will be turned into colored tags. Currently available tags are::
 

	
 
    [featured]
 
    [stale]
 
    [dead]
 
    [lang => lang]
 
    [license => License]
 
    [requires => Repo]
 
    [recommends => Repo]
 
    [see => URI]
 

	
 

	
0 comments (0 inline, 0 general)