##// END OF EJS Templates
API docs improvement....
marcink -
r2143:c1f1f066 beta
parent child Browse files
Show More
@@ -27,7 +27,7 b' API ACCESS'
27 27 All clients are required to send JSON-RPC spec JSON data::
28 28
29 29 {
30 "id:<id>,
30 "id:"<id>",
31 31 "api_key":"<api_key>",
32 32 "method":"<method_name>",
33 33 "args":{"<arg_key>":"<arg_val>"}
@@ -50,9 +50,9 b' Simply provide'
50 50 RhodeCode API will return always a JSON-RPC response::
51 51
52 52 {
53 "id":<id>,
54 "result": "<result>",
55 "error": null
53 "id":<id>, # matching id sent by request
54 "result": "<result>"|null, # JSON formatted result, null if any errors
55 "error": "null"|<error_message> # JSON formatted error (if any)
56 56 }
57 57
58 58 All responses from API will be `HTTP/1.0 200 OK`, if there's an error while
@@ -72,6 +72,7 b' belonging to user with admin rights'
72 72
73 73 INPUT::
74 74
75 id : <id_for_response>
75 76 api_key : "<api_key>"
76 77 method : "pull"
77 78 args : {
@@ -94,6 +95,7 b' rights.'
94 95
95 96 INPUT::
96 97
98 id : <id_for_response>
97 99 api_key : "<api_key>"
98 100 method : "get_user"
99 101 args : {
@@ -126,6 +128,7 b' belonging to user with admin rights.'
126 128
127 129 INPUT::
128 130
131 id : <id_for_response>
129 132 api_key : "<api_key>"
130 133 method : "get_users"
131 134 args : { }
@@ -157,6 +160,7 b' be executed only using api_key belonging'
157 160
158 161 INPUT::
159 162
163 id : <id_for_response>
160 164 api_key : "<api_key>"
161 165 method : "create_user"
162 166 args : {
@@ -188,6 +192,7 b' be executed only using api_key belonging'
188 192
189 193 INPUT::
190 194
195 id : <id_for_response>
191 196 api_key : "<api_key>"
192 197 method : "update_user"
193 198 args : {
@@ -220,6 +225,7 b' belonging to user with admin rights.'
220 225
221 226 INPUT::
222 227
228 id : <id_for_response>
223 229 api_key : "<api_key>"
224 230 method : "get_users_group"
225 231 args : {
@@ -258,6 +264,7 b' api_key belonging to user with admin rig'
258 264
259 265 INPUT::
260 266
267 id : <id_for_response>
261 268 api_key : "<api_key>"
262 269 method : "get_users_groups"
263 270 args : { }
@@ -296,6 +303,7 b' belonging to user with admin rights'
296 303
297 304 INPUT::
298 305
306 id : <id_for_response>
299 307 api_key : "<api_key>"
300 308 method : "create_users_group"
301 309 args: {
@@ -322,6 +330,7 b' belonging to user with admin rights'
322 330
323 331 INPUT::
324 332
333 id : <id_for_response>
325 334 api_key : "<api_key>"
326 335 method : "add_user_users_group"
327 336 args: {
@@ -350,6 +359,7 b' using api_key belonging to user with adm'
350 359
351 360 INPUT::
352 361
362 id : <id_for_response>
353 363 api_key : "<api_key>"
354 364 method : "remove_user_from_users_group"
355 365 args: {
@@ -376,6 +386,7 b' be executed only using api_key belonging'
376 386
377 387 INPUT::
378 388
389 id : <id_for_response>
379 390 api_key : "<api_key>"
380 391 method : "get_repo"
381 392 args: {
@@ -423,6 +434,7 b' belonging to user with admin rights'
423 434
424 435 INPUT::
425 436
437 id : <id_for_response>
426 438 api_key : "<api_key>"
427 439 method : "get_repos"
428 440 args: { }
@@ -452,6 +464,7 b' with admin rights'
452 464
453 465 INPUT::
454 466
467 id : <id_for_response>
455 468 api_key : "<api_key>"
456 469 method : "get_repo_nodes"
457 470 args: {
@@ -485,6 +498,7 b' and create "baz" repository with "bar" a'
485 498
486 499 INPUT::
487 500
501 id : <id_for_response>
488 502 api_key : "<api_key>"
489 503 method : "create_repo"
490 504 args: {
@@ -514,6 +528,7 b' belonging to user with admin rights.'
514 528
515 529 INPUT::
516 530
531 id : <id_for_response>
517 532 api_key : "<api_key>"
518 533 method : "delete_repo"
519 534 args: {
@@ -538,6 +553,7 b' with admin rights.'
538 553
539 554 INPUT::
540 555
556 id : <id_for_response>
541 557 api_key : "<api_key>"
542 558 method : "grant_user_permission"
543 559 args: {
@@ -563,6 +579,7 b' only using api_key belonging to user wit'
563 579
564 580 INPUT::
565 581
582 id : <id_for_response>
566 583 api_key : "<api_key>"
567 584 method : "revoke_user_permission"
568 585 args: {
@@ -588,6 +605,7 b' api_key belonging to user with admin rig'
588 605
589 606 INPUT::
590 607
608 id : <id_for_response>
591 609 api_key : "<api_key>"
592 610 method : "grant_users_group_permission"
593 611 args: {
@@ -612,6 +630,7 b' executed only using api_key belonging to'
612 630
613 631 INPUT::
614 632
633 id : <id_for_response>
615 634 api_key : "<api_key>"
616 635 method : "revoke_users_group_permission"
617 636 args: {
General Comments 0
You need to be logged in to leave comments. Login now