comparison docs/api/api.rst @ 1491:e63a2841714d beta

API docs update
author Marcin Kuzminski <marcin@python-works.com>
date Thu, 29 Sep 2011 03:34:01 +0300
parents ebb90cfdac83
children 256e729a94cd
comparison
equal deleted inserted replaced
1490:76b358f81926 1491:e63a2841714d
5 === 5 ===
6 6
7 7
8 Starting from RhodeCode version 1.2 a simple API was implemented. 8 Starting from RhodeCode version 1.2 a simple API was implemented.
9 There's one schema for calling all api methods. API is implemented 9 There's one schema for calling all api methods. API is implemented
10 with JSON protocol both ways. 10 with JSON protocol both ways. An url to send API request in RhodeCode is
11 <your-server>/_admin/api
11 12
12 13
13 Clients need to send JSON data in such format:: 14 Clients need to send JSON data in such format::
14 15
15 { 16 {
48 Pulls given repo from remote location. Can be used to automatically keep 49 Pulls given repo from remote location. Can be used to automatically keep
49 remote repos upto date. This command can be executed only using admin users 50 remote repos upto date. This command can be executed only using admin users
50 api_key 51 api_key
51 52
52 :: 53 ::
53 54 api_key:"<api_key>"
54 method: "pull" 55 method: "pull"
55 args: {"repo":<repo_name>} 56 args: {"repo":<repo_name>}
56 57