kallithea Changeset - 59ae82850e76

Changeset - 59ae82850e76

Parent rev.

Child rev.

[Not reviewed]

Merge beta

2 46 2

Liad Shani - 14 years ago 2011-10-09 23:49:00
liadff@gmail.com

Merge with upstream

4 files changed:

README.rst

docs/api/api.rst

docs/changelog.rst

docs/images/screenshot1_main_page.png

bin+mod

Changeset was too big and was cut off... Show full diff anyway

0 comments (0 inline, 0 general)

README.rst

➞

Show inline comments

@@ @@ -2,10 +2,11 @@ @@
 Welcome to RhodeCode (RhodiumCode) documentation!
 =================================================
-``RhodeCode`` (formerly hg-app) is a Pylons framework based Mercurial repository
 ``RhodeCode`` is a Pylons framework based Mercurial repository
 browser/management tool with a built in push/pull server and full text search.
 It works on http/https and has a built in permission/authentication system with
 the ability to authenticate via LDAP.
 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also supports
 simple API so it's easy integrable with existing systems.
 RhodeCode is similar in some respects to github or bitbucket_,
 however RhodeCode can be run as standalone hosted application on your own server.

docs/api/api.rst

➞

Show inline comments

@@ @@ -6,11 +6,12 @@ API @@
 Starting from RhodeCode version 1.2 a simple API was implemented.
 There's one schema for calling all api methods. API is implemented
 with JSON protocol both ways.
 There's a single schema for calling all api methods. API is implemented
 with JSON protocol both ways. An url to send API request in RhodeCode is
 <your_server>/_admin/api
-Clients need to send JSON data in such format::
+All clients need to send JSON data in such format::
+    {
         "api_key":"<api_key>",
@@ @@ -18,16 +19,20 @@ Clients need to send JSON data in such f @@
         "args":{"<arg_key>":"<arg_val>"}
+    }
 Simply provide api_key for access and permission validation
 method is name of method to call
 and args is an key:value list of arguments to pass to method
 Example call for autopulling remotes repos using curl::
     curl https://server.com/_admin/api -X POST -H 'content-type:text/plain' --data-binary '{"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}'
 Simply provide
  - *api_key* for access and permission validation.
  - *method* is name of method to call
  - *args* is an key:value list of arguments to pass to method
 .. note::
     api_key can be found in your user account page
-And will receive JSON formatted answer::
+RhodeCode API will return always a JSON formatted answer::
+    {
         "result": "<result>",
@@ @@ -35,7 +40,7 @@ And will receive JSON formatted answer:: @@
+    }
 All responses from API will be `HTTP/1.0 200 OK`, if there's an error while
-calling api **error** key from response will contain failure description
 calling api *error* key from response will contain failure description
 and result will be null.
 API METHODS
@@ @@ -46,11 +51,61 @@ pull @@
 ----
 Pulls given repo from remote location. Can be used to automatically keep
 remote repos upto date. This command can be executed only using admin users
 api_key
 remote repos up to date. This command can be executed only using api_key
 belonging to user with admin rights
 ::
 INPUT::
     api_key:"<api_key>"
     method: "pull"
     args: {"repo":<repo_name>}
 OUTPUT::
     result:"Pulled from <repo_name>"
     error:null
 create_user
 -----------
 Creates new user in RhodeCode. This command can be executed only using api_key
 belonging to user with admin rights
 INPUT::
     api_key:"<api_key>"
     method: "create_user"
     args: {"username": "<username>",
            "password": "<password>",
            "active":   "<bool>",
            "admin":    "<bool>",
            "name":     "<firstname>",
            "lastname": "<lastname>",
            "email":    "<useremail>"}
 OUTPUT::
     result:{"id": <newuserid>,
             "msg":"created new user <username>"}
     error:null
 create_users_group
 ------------------
 creates new users group. This command can be executed only using api_key
 belonging to user with admin rights
 INPUT::
     api_key:"<api_key>"
     method: "create_user"
     args: {"name":  "<groupname>",
            "active":"<bool>"}
 OUTPUT::
     result:{"id": <newusersgroupid>,
             "msg":"created new users group <groupname>"}
     error:null

docs/changelog.rst

➞

Show inline comments

@@ @@ -3,7 +3,8 @@ @@
 Changelog
 =========
 .2.0 (**2011-XX-XX**)
 .3.0 (**XXXX-XX-XX**)
 ======================
 :status: in-progress
@@ @@ -12,6 +13,29 @@ Changelog @@
 news
 ----
 fixes
 -----
 .2.1 (**2011-10-08**)
 ======================
 news
 ----
 fixes
 -----
 - fixed problems with basic auth and push problems
 - gui fixes
 - fixed logger
 .2.0 (**2011-10-07**)
 ======================
 news
 ----
 - implemented #47 repository groups
 - implemented #89 Can setup google analytics code from settings menu
 - implemented #91 added nicer looking archive urls with more download options

docs/images/screenshot1_main_page.png

➞

Show inline comments

binary diff not shown

Show images

Changeset was too big and was cut off... Show full diff anyway

0 comments (0 inline, 0 general)