Show More
This diff has been collapsed as it changes many lines, (530 lines changed) Show them Hide them | |||
@@ -115,7 +115,7 b' OUTPUT::' | |||
|
115 | 115 | |
|
116 | 116 | id : <id_given_in_input> |
|
117 | 117 | result : "Pulled from `<reponame>`" |
|
118 |
error : |
|
|
118 | error : null | |
|
119 | 119 | |
|
120 | 120 | rescan_repos |
|
121 | 121 | ^^^^^^^^^^^^ |
@@ -138,7 +138,7 b' OUTPUT::' | |||
|
138 | 138 | id : <id_given_in_input> |
|
139 | 139 | result : "{'added': [<list of names of added repos>], |
|
140 | 140 | 'removed': [<list of names of removed repos>]}" |
|
141 |
error : |
|
|
141 | error : null | |
|
142 | 142 | |
|
143 | 143 | invalidate_cache |
|
144 | 144 | ^^^^^^^^^^^^^^^^ |
@@ -160,7 +160,7 b' OUTPUT::' | |||
|
160 | 160 | |
|
161 | 161 | id : <id_given_in_input> |
|
162 | 162 | result : "Caches of repository `<reponame>`" |
|
163 |
error : |
|
|
163 | error : null | |
|
164 | 164 | |
|
165 | 165 | get_ip |
|
166 | 166 | ^^^^^^ |
@@ -182,16 +182,16 b' OUTPUT::' | |||
|
182 | 182 | |
|
183 | 183 | id : <id_given_in_input> |
|
184 | 184 | result : { |
|
185 | "ip_addr_server": <ip_from_client>", | |
|
186 | "user_ips": [ | |
|
185 | "ip_addr_server" : <ip_from_client>", | |
|
186 | "user_ips" : [ | |
|
187 | 187 | { |
|
188 | "ip_addr": "<ip_with_mask>", | |
|
189 | "ip_range": ["<start_ip>", "<end_ip>"], | |
|
188 | "ip_addr" : "<ip_with_mask>", | |
|
189 | "ip_range" : ["<start_ip>", "<end_ip>"], | |
|
190 | 190 | }, |
|
191 | 191 | ... |
|
192 | ] | |
|
192 | ] | |
|
193 | 193 | } |
|
194 |
error : |
|
|
194 | error : null | |
|
195 | 195 | |
|
196 | 196 | get_user |
|
197 | 197 | ^^^^^^^^ |
@@ -213,29 +213,29 b' INPUT::' | |||
|
213 | 213 | OUTPUT:: |
|
214 | 214 | |
|
215 | 215 | id : <id_given_in_input> |
|
216 | result: None if user does not exist or | |
|
217 | { | |
|
216 | result : None if user does not exist or | |
|
217 | { | |
|
218 | 218 | "user_id" : "<user_id>", |
|
219 | 219 | "api_key" : "<api_key>", |
|
220 | 220 | "username" : "<username>", |
|
221 |
"firstname" |
|
|
221 | "firstname" : "<firstname>", | |
|
222 | 222 | "lastname" : "<lastname>", |
|
223 | 223 | "email" : "<email>", |
|
224 |
"emails" |
|
|
224 | "emails" : "<list_of_all_additional_emails>", | |
|
225 | 225 | "ip_addresses": "<list_of_ip_addresses_for_user>", |
|
226 | 226 | "active" : "<bool>", |
|
227 | 227 | "admin" : "<bool>", |
|
228 | 228 | "ldap_dn" : "<ldap_dn>", |
|
229 |
"last_login" |
|
|
229 | "last_login" : "<last_login>", | |
|
230 | 230 | "permissions": { |
|
231 | 231 | "global": ["hg.create.repository", |
|
232 | 232 | "repository.read", |
|
233 | 233 | "hg.register.manual_activate"], |
|
234 | "repositories": {"repo1": "repository.none"}, | |
|
235 | "repositories_groups": {"Group1": "group.read"} | |
|
234 | "repositories" : {"repo1" : "repository.none"}, | |
|
235 | "repositories_groups" : {"Group1" : "group.read"} | |
|
236 | 236 | }, |
|
237 | } | |
|
238 |
error |
|
|
237 | } | |
|
238 | error : null | |
|
239 | 239 | |
|
240 | 240 | get_users |
|
241 | 241 | ^^^^^^^^^ |
@@ -253,24 +253,24 b' INPUT::' | |||
|
253 | 253 | OUTPUT:: |
|
254 | 254 | |
|
255 | 255 | id : <id_given_in_input> |
|
256 | result: [ | |
|
256 | result : [ | |
|
257 | 257 | { |
|
258 | 258 | "user_id" : "<user_id>", |
|
259 | 259 | "api_key" : "<api_key>", |
|
260 | 260 | "username" : "<username>", |
|
261 |
"firstname" |
|
|
261 | "firstname" : "<firstname>", | |
|
262 | 262 | "lastname" : "<lastname>", |
|
263 | 263 | "email" : "<email>", |
|
264 |
"emails" |
|
|
264 | "emails" : "<list_of_all_additional_emails>", | |
|
265 | 265 | "ip_addresses": "<list_of_ip_addresses_for_user>", |
|
266 | 266 | "active" : "<bool>", |
|
267 | 267 | "admin" : "<bool>", |
|
268 | 268 | "ldap_dn" : "<ldap_dn>", |
|
269 |
"last_login" |
|
|
269 | "last_login" : "<last_login>", | |
|
270 | 270 | }, |
|
271 | 271 | β¦ |
|
272 | ] | |
|
273 |
error |
|
|
272 | ] | |
|
273 | error : null | |
|
274 | 274 | |
|
275 | 275 | .. _create-user: |
|
276 | 276 | |
@@ -299,22 +299,22 b' INPUT::' | |||
|
299 | 299 | OUTPUT:: |
|
300 | 300 | |
|
301 | 301 | id : <id_given_in_input> |
|
302 | result: { | |
|
302 | result : { | |
|
303 | 303 | "msg" : "created new user `<username>`", |
|
304 | "user": { | |
|
304 | "user" : { | |
|
305 | 305 | "user_id" : "<user_id>", |
|
306 | 306 | "username" : "<username>", |
|
307 | 307 | "firstname": "<firstname>", |
|
308 | 308 | "lastname" : "<lastname>", |
|
309 | 309 | "email" : "<email>", |
|
310 |
"emails" |
|
|
310 | "emails" : "<list_of_all_additional_emails>", | |
|
311 | 311 | "active" : "<bool>", |
|
312 | 312 | "admin" : "<bool>", |
|
313 | 313 | "ldap_dn" : "<ldap_dn>", |
|
314 | 314 | "last_login": "<last_login>", |
|
315 | 315 | }, |
|
316 | } | |
|
317 |
error |
|
|
316 | } | |
|
317 | error : null | |
|
318 | 318 | |
|
319 | 319 | Example:: |
|
320 | 320 | |
@@ -346,23 +346,23 b' INPUT::' | |||
|
346 | 346 | OUTPUT:: |
|
347 | 347 | |
|
348 | 348 | id : <id_given_in_input> |
|
349 | result: { | |
|
349 | result : { | |
|
350 | 350 | "msg" : "updated user ID:<userid> <username>", |
|
351 | "user": { | |
|
351 | "user" : { | |
|
352 | 352 | "user_id" : "<user_id>", |
|
353 | 353 | "api_key" : "<api_key>", |
|
354 | 354 | "username" : "<username>", |
|
355 | 355 | "firstname": "<firstname>", |
|
356 | 356 | "lastname" : "<lastname>", |
|
357 | 357 | "email" : "<email>", |
|
358 |
"emails" |
|
|
358 | "emails" : "<list_of_all_additional_emails>", | |
|
359 | 359 | "active" : "<bool>", |
|
360 | 360 | "admin" : "<bool>", |
|
361 | 361 | "ldap_dn" : "<ldap_dn>", |
|
362 | 362 | "last_login": "<last_login>", |
|
363 | 363 | }, |
|
364 | } | |
|
365 |
error |
|
|
364 | } | |
|
365 | error : null | |
|
366 | 366 | |
|
367 | 367 | delete_user |
|
368 | 368 | ^^^^^^^^^^^ |
@@ -382,11 +382,11 b' INPUT::' | |||
|
382 | 382 | OUTPUT:: |
|
383 | 383 | |
|
384 | 384 | id : <id_given_in_input> |
|
385 | result: { | |
|
385 | result : { | |
|
386 | 386 | "msg" : "deleted user ID:<userid> <username>", |
|
387 | "user": null | |
|
388 | } | |
|
389 |
error |
|
|
387 | "user" : null | |
|
388 | } | |
|
389 | error : null | |
|
390 | 390 | |
|
391 | 391 | get_user_group |
|
392 | 392 | ^^^^^^^^^^^^^^ |
@@ -410,7 +410,7 b' OUTPUT::' | |||
|
410 | 410 | { |
|
411 | 411 | "users_group_id" : "<id>", |
|
412 | 412 | "group_name" : "<groupname>", |
|
413 |
"active" |
|
|
413 | "active" : "<bool>", | |
|
414 | 414 | "members" : [ |
|
415 | 415 | { |
|
416 | 416 | "user_id" : "<user_id>", |
@@ -419,7 +419,7 b' OUTPUT::' | |||
|
419 | 419 | "firstname": "<firstname>", |
|
420 | 420 | "lastname" : "<lastname>", |
|
421 | 421 | "email" : "<email>", |
|
422 |
"emails" |
|
|
422 | "emails" : "<list_of_all_additional_emails>", | |
|
423 | 423 | "active" : "<bool>", |
|
424 | 424 | "admin" : "<bool>", |
|
425 | 425 | "ldap_dn" : "<ldap_dn>", |
@@ -450,7 +450,7 b' OUTPUT::' | |||
|
450 | 450 | { |
|
451 | 451 | "users_group_id" : "<id>", |
|
452 | 452 | "group_name" : "<groupname>", |
|
453 |
"active" |
|
|
453 | "active" : "<bool>", | |
|
454 | 454 | }, |
|
455 | 455 | β¦ |
|
456 | 456 | ] |
@@ -467,24 +467,24 b' INPUT::' | |||
|
467 | 467 | id : <id_for_response> |
|
468 | 468 | api_key : "<api_key>" |
|
469 | 469 | method : "create_user_group" |
|
470 |
args |
|
|
470 | args : { | |
|
471 | 471 | "group_name": "<groupname>", |
|
472 | 472 | "owner" : "<owner_name_or_id = Optional(=apiuser)>", |
|
473 |
"active" |
|
|
473 | "active" : "<bool> = Optional(True)" | |
|
474 | 474 | } |
|
475 | 475 | |
|
476 | 476 | OUTPUT:: |
|
477 | 477 | |
|
478 | 478 | id : <id_given_in_input> |
|
479 | result: { | |
|
480 | "msg": "created new user group `<groupname>`", | |
|
481 | "users_group": { | |
|
479 | result : { | |
|
480 | "msg" : "created new user group `<groupname>`", | |
|
481 | "users_group" : { | |
|
482 | 482 | "users_group_id" : "<id>", |
|
483 | 483 | "group_name" : "<groupname>", |
|
484 |
"active" |
|
|
484 | "active" : "<bool>", | |
|
485 | 485 | }, |
|
486 | } | |
|
487 |
error |
|
|
486 | } | |
|
487 | error : null | |
|
488 | 488 | |
|
489 | 489 | add_user_to_user_group |
|
490 | 490 | ^^^^^^^^^^^^^^^^^^^^^^ |
@@ -498,7 +498,7 b' INPUT::' | |||
|
498 | 498 | id : <id_for_response> |
|
499 | 499 | api_key : "<api_key>" |
|
500 | 500 | method : "add_user_user_group" |
|
501 |
args |
|
|
501 | args : { | |
|
502 | 502 | "usersgroupid" : "<user group id or name>", |
|
503 | 503 | "userid" : "<user_id or username>", |
|
504 | 504 | } |
@@ -506,12 +506,12 b' INPUT::' | |||
|
506 | 506 | OUTPUT:: |
|
507 | 507 | |
|
508 | 508 | id : <id_given_in_input> |
|
509 | result: { | |
|
510 | "success": True|False # depends on if member is in group | |
|
511 | "msg": "added member `<username>` to a user group `<groupname>` | | |
|
512 | User is already in that group" | |
|
513 | } | |
|
514 |
error |
|
|
509 | result : { | |
|
510 | "success" : True|False # depends on if member is in group | |
|
511 | "msg" : "added member `<username>` to a user group `<groupname>` | | |
|
512 | User is already in that group" | |
|
513 | } | |
|
514 | error : null | |
|
515 | 515 | |
|
516 | 516 | remove_user_from_user_group |
|
517 | 517 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
@@ -525,7 +525,7 b' INPUT::' | |||
|
525 | 525 | id : <id_for_response> |
|
526 | 526 | api_key : "<api_key>" |
|
527 | 527 | method : "remove_user_from_user_group" |
|
528 |
args |
|
|
528 | args : { | |
|
529 | 529 | "usersgroupid" : "<user group id or name>", |
|
530 | 530 | "userid" : "<user_id or username>", |
|
531 | 531 | } |
@@ -533,12 +533,12 b' INPUT::' | |||
|
533 | 533 | OUTPUT:: |
|
534 | 534 | |
|
535 | 535 | id : <id_given_in_input> |
|
536 | result: { | |
|
537 |
"success" |
|
|
538 | "msg": "removed member <username> from user group <groupname> | | |
|
539 | User wasn't in group" | |
|
540 | } | |
|
541 |
error |
|
|
536 | result : { | |
|
537 | "success" : True|False, # depends on if member is in group | |
|
538 | "msg" : "removed member <username> from user group <groupname> | | |
|
539 | User wasn't in group" | |
|
540 | } | |
|
541 | error : null | |
|
542 | 542 | |
|
543 | 543 | get_repo |
|
544 | 544 | ^^^^^^^^ |
@@ -553,144 +553,144 b' INPUT::' | |||
|
553 | 553 | id : <id_for_response> |
|
554 | 554 | api_key : "<api_key>" |
|
555 | 555 | method : "get_repo" |
|
556 |
args |
|
|
556 | args : { | |
|
557 | 557 | "repoid" : "<reponame or repo_id>", |
|
558 | "with_revision_names": "<bool> = Optional(False)", | |
|
559 | "with_pullrequests": "<bool> = Optional(False)", | |
|
558 | "with_revision_names" : "<bool> = Optional(False)", | |
|
559 | "with_pullrequests" : "<bool> = Optional(False)", | |
|
560 | 560 | } |
|
561 | 561 | |
|
562 | 562 | OUTPUT:: |
|
563 | 563 | |
|
564 | 564 | id : <id_given_in_input> |
|
565 | result: None if repository does not exist or | |
|
566 | { | |
|
565 | result : None if repository does not exist or | |
|
566 | { | |
|
567 | 567 | "repo_id" : "<repo_id>", |
|
568 | 568 | "repo_name" : "<reponame>" |
|
569 | 569 | "repo_type" : "<repo_type>", |
|
570 | 570 | "clone_uri" : "<clone_uri>", |
|
571 |
"enable_downloads" |
|
|
571 | "enable_downloads" : "<bool>", | |
|
572 | 572 | "enable_statistics": "<bool>", |
|
573 |
"private" |
|
|
573 | "private" : "<bool>", | |
|
574 | 574 | "created_on" : "<date_time_created>", |
|
575 | 575 | "description" : "<description>", |
|
576 |
"landing_rev" |
|
|
577 |
"last_changeset" |
|
|
578 |
"author" |
|
|
579 |
"date" |
|
|
580 |
"message" |
|
|
581 |
"raw_id" |
|
|
576 | "landing_rev" : "<landing_rev>", | |
|
577 | "last_changeset" : { | |
|
578 | "author" : "<full_author>", | |
|
579 | "date" : "<date_time_of_commit>", | |
|
580 | "message" : "<commit_message>", | |
|
581 | "raw_id" : "<raw_id>", | |
|
582 | 582 | "revision": "<numeric_revision>", |
|
583 | 583 | "short_id": "<short_id>" |
|
584 | 584 | }, |
|
585 |
"owner" |
|
|
586 |
"fork_of" |
|
|
585 | "owner" : "<repo_owner>", | |
|
586 | "fork_of" : "<name_of_fork_parent>", | |
|
587 | 587 | "members" : [ |
|
588 | 588 | { |
|
589 |
"type" |
|
|
589 | "type" : "user", | |
|
590 | 590 | "user_id" : "<user_id>", |
|
591 | 591 | "api_key" : "<api_key>", |
|
592 | 592 | "username" : "<username>", |
|
593 |
"firstname" |
|
|
593 | "firstname" : "<firstname>", | |
|
594 | 594 | "lastname" : "<lastname>", |
|
595 | 595 | "email" : "<email>", |
|
596 |
"emails" |
|
|
596 | "emails" : "<list_of_all_additional_emails>", | |
|
597 | 597 | "active" : "<bool>", |
|
598 | 598 | "admin" : "<bool>", |
|
599 | 599 | "ldap_dn" : "<ldap_dn>", |
|
600 |
"last_login" |
|
|
600 | "last_login" : "<last_login>", | |
|
601 | 601 | "permission" : "repository.(read|write|admin)" |
|
602 | 602 | }, |
|
603 | 603 | β¦ |
|
604 | 604 | { |
|
605 |
"type" |
|
|
605 | "type" : "users_group", | |
|
606 | 606 | "id" : "<usersgroupid>", |
|
607 | 607 | "name" : "<usersgroupname>", |
|
608 |
"active" |
|
|
608 | "active" : "<bool>", | |
|
609 | 609 | "permission" : "repository.(read|write|admin)" |
|
610 | 610 | }, |
|
611 | 611 | β¦ |
|
612 | 612 | ], |
|
613 |
"followers" |
|
|
613 | "followers" : [ | |
|
614 | 614 | { |
|
615 | 615 | "user_id" : "<user_id>", |
|
616 | 616 | "username" : "<username>", |
|
617 | 617 | "api_key" : "<api_key>", |
|
618 |
"firstname" |
|
|
618 | "firstname" : "<firstname>", | |
|
619 | 619 | "lastname" : "<lastname>", |
|
620 | 620 | "email" : "<email>", |
|
621 |
"emails" |
|
|
621 | "emails" : "<list_of_all_additional_emails>", | |
|
622 | 622 | "ip_addresses": "<list_of_ip_addresses_for_user>", |
|
623 | 623 | "active" : "<bool>", |
|
624 | 624 | "admin" : "<bool>", |
|
625 | 625 | "ldap_dn" : "<ldap_dn>", |
|
626 |
"last_login" |
|
|
626 | "last_login" : "<last_login>", | |
|
627 | 627 | }, |
|
628 | 628 | β¦ |
|
629 | 629 | ], |
|
630 | 630 | <if with_revision_names == True> |
|
631 | "tags": { | |
|
632 | "<tagname>": "<raw_id>", | |
|
631 | "tags" : { | |
|
632 | "<tagname>" : "<raw_id>", | |
|
633 | 633 | ... |
|
634 | 634 | }, |
|
635 | "branches": { | |
|
636 | "<branchname>": "<raw_id>", | |
|
635 | "branches" : { | |
|
636 | "<branchname>" : "<raw_id>", | |
|
637 | 637 | ... |
|
638 | 638 | }, |
|
639 | "bookmarks": { | |
|
640 | "<bookmarkname>": "<raw_id>", | |
|
639 | "bookmarks" : { | |
|
640 | "<bookmarkname>" : "<raw_id>", | |
|
641 | 641 | ... |
|
642 | 642 | }, |
|
643 | 643 | <if with_pullrequests == True> |
|
644 | "pull_requests": [ | |
|
644 | "pull_requests" : [ | |
|
645 | 645 | { |
|
646 | "status": "<pull_request_status>", | |
|
647 | "pull_request_id": <pull_request_id>, | |
|
648 | "description": "<pull_request_description>", | |
|
649 | "title": "<pull_request_title>", | |
|
650 | "url": "<pull_request_url>", | |
|
651 | "reviewers": [ | |
|
646 | "status" : "<pull_request_status>", | |
|
647 | "pull_request_id" : <pull_request_id>, | |
|
648 | "description" : "<pull_request_description>", | |
|
649 | "title" : "<pull_request_title>", | |
|
650 | "url" : "<pull_request_url>", | |
|
651 | "reviewers" : [ | |
|
652 | 652 | { |
|
653 | "username": "<user_id>", | |
|
653 | "username" : "<user_id>", | |
|
654 | 654 | }, |
|
655 | 655 | ... |
|
656 | 656 | ], |
|
657 | "org_repo_url": "<repo_url>", | |
|
658 | "org_ref_parts": [ | |
|
657 | "org_repo_url" : "<repo_url>", | |
|
658 | "org_ref_parts" : [ | |
|
659 | 659 | "<ref_type>", |
|
660 | 660 | "<ref_name>", |
|
661 | 661 | "<raw_id>" |
|
662 | 662 | ], |
|
663 | "other_ref_parts": [ | |
|
663 | "other_ref_parts" : [ | |
|
664 | 664 | "<ref_type>", |
|
665 | 665 | "<ref_name>", |
|
666 | 666 | "<raw_id>" |
|
667 | 667 | ], |
|
668 | "comments": [ | |
|
668 | "comments" : [ | |
|
669 | 669 | { |
|
670 | "username": "<user_id>", | |
|
671 | "text": "<comment text>", | |
|
672 | "comment_id": "<comment_id>", | |
|
670 | "username" : "<user_id>", | |
|
671 | "text" : "<comment text>", | |
|
672 | "comment_id" : "<comment_id>", | |
|
673 | 673 | }, |
|
674 | 674 | ... |
|
675 | 675 | ], |
|
676 | "owner": "<username>", | |
|
677 | "statuses": [ | |
|
676 | "owner" : "<username>", | |
|
677 | "statuses" : [ | |
|
678 | 678 | { |
|
679 | "status": "<status_of_review>", # "under_review", "approved" or "rejected" | |
|
680 | "reviewer": "<user_id>", | |
|
681 | "modified_at": "<date_time_of_review>" # iso 8601 date, server's timezone | |
|
679 | "status" : "<status_of_review>", # "under_review", "approved" or "rejected" | |
|
680 | "reviewer" : "<user_id>", | |
|
681 | "modified_at" : "<date_time_of_review>" # iso 8601 date, server's timezone | |
|
682 | 682 | }, |
|
683 | 683 | ... |
|
684 | 684 | ], |
|
685 | "revisions": [ | |
|
685 | "revisions" : [ | |
|
686 | 686 | "<raw_id>", |
|
687 | 687 | ... |
|
688 | 688 | ] |
|
689 | 689 | }, |
|
690 | 690 | ... |
|
691 | 691 | ] |
|
692 | } | |
|
693 |
error |
|
|
692 | } | |
|
693 | error : null | |
|
694 | 694 | |
|
695 | 695 | get_repos |
|
696 | 696 | ^^^^^^^^^ |
@@ -704,12 +704,12 b' INPUT::' | |||
|
704 | 704 | id : <id_for_response> |
|
705 | 705 | api_key : "<api_key>" |
|
706 | 706 | method : "get_repos" |
|
707 |
args |
|
|
707 | args : { } | |
|
708 | 708 | |
|
709 | 709 | OUTPUT:: |
|
710 | 710 | |
|
711 | 711 | id : <id_given_in_input> |
|
712 | result: [ | |
|
712 | result : [ | |
|
713 | 713 | { |
|
714 | 714 | "repo_id" : "<repo_id>", |
|
715 | 715 | "repo_name" : "<reponame>" |
@@ -718,15 +718,15 b' OUTPUT::' | |||
|
718 | 718 | "private" : "<bool>", |
|
719 | 719 | "created_on" : "<datetimecreated>", |
|
720 | 720 | "description" : "<description>", |
|
721 |
"landing_rev" |
|
|
722 |
"owner" |
|
|
723 |
"fork_of" |
|
|
724 |
"enable_downloads" |
|
|
721 | "landing_rev" : "<landing_rev>", | |
|
722 | "owner" : "<repo_owner>", | |
|
723 | "fork_of" : "<name_of_fork_parent>", | |
|
724 | "enable_downloads" : "<bool>", | |
|
725 | 725 | "enable_statistics": "<bool>", |
|
726 | 726 | }, |
|
727 | 727 | β¦ |
|
728 | ] | |
|
729 |
error |
|
|
728 | ] | |
|
729 | error : null | |
|
730 | 730 | |
|
731 | 731 | get_repo_nodes |
|
732 | 732 | ^^^^^^^^^^^^^^ |
@@ -740,24 +740,24 b' INPUT::' | |||
|
740 | 740 | id : <id_for_response> |
|
741 | 741 | api_key : "<api_key>" |
|
742 | 742 | method : "get_repo_nodes" |
|
743 |
args |
|
|
743 | args : { | |
|
744 | 744 | "repoid" : "<reponame or repo_id>" |
|
745 |
"revision" |
|
|
745 | "revision" : "<revision>", | |
|
746 | 746 | "root_path" : "<root_path>", |
|
747 |
"ret_type" |
|
|
747 | "ret_type" : "<ret_type> = Optional('all')" | |
|
748 | 748 | } |
|
749 | 749 | |
|
750 | 750 | OUTPUT:: |
|
751 | 751 | |
|
752 | 752 | id : <id_given_in_input> |
|
753 | result: [ | |
|
753 | result : [ | |
|
754 | 754 | { |
|
755 | 755 | "name" : "<name>" |
|
756 | 756 | "type" : "<type>", |
|
757 | 757 | }, |
|
758 | 758 | β¦ |
|
759 | ] | |
|
760 |
error |
|
|
759 | ] | |
|
760 | error : null | |
|
761 | 761 | |
|
762 | 762 | create_repo |
|
763 | 763 | ^^^^^^^^^^^ |
@@ -777,7 +777,7 b' INPUT::' | |||
|
777 | 777 | id : <id_for_response> |
|
778 | 778 | api_key : "<api_key>" |
|
779 | 779 | method : "create_repo" |
|
780 |
args |
|
|
780 | args : { | |
|
781 | 781 | "repo_name" : "<reponame>", |
|
782 | 782 | "owner" : "<owner_name_or_id = Optional(=apiuser)>", |
|
783 | 783 | "repo_type" : "<repo_type> = Optional('hg')", |
@@ -785,16 +785,16 b' INPUT::' | |||
|
785 | 785 | "private" : "<bool> = Optional(False)", |
|
786 | 786 | "clone_uri" : "<clone_uri> = Optional(None)", |
|
787 | 787 | "landing_rev" : "<landing_rev> = Optional('tip')", |
|
788 |
"enable_downloads" |
|
|
788 | "enable_downloads" : "<bool> = Optional(False)", | |
|
789 | 789 | "enable_statistics": "<bool> = Optional(False)", |
|
790 | 790 | } |
|
791 | 791 | |
|
792 | 792 | OUTPUT:: |
|
793 | 793 | |
|
794 | 794 | id : <id_given_in_input> |
|
795 | result: { | |
|
796 | "msg": "Created new repository `<reponame>`", | |
|
797 | "repo": { | |
|
795 | result : { | |
|
796 | "msg" : "Created new repository `<reponame>`", | |
|
797 | "repo" : { | |
|
798 | 798 | "repo_id" : "<repo_id>", |
|
799 | 799 | "repo_name" : "<reponame>" |
|
800 | 800 | "repo_type" : "<repo_type>", |
@@ -802,14 +802,14 b' OUTPUT::' | |||
|
802 | 802 | "private" : "<bool>", |
|
803 | 803 | "created_on" : "<datetimecreated>", |
|
804 | 804 | "description" : "<description>", |
|
805 |
"landing_rev" |
|
|
806 |
"owner" |
|
|
807 |
"fork_of" |
|
|
808 |
"enable_downloads" |
|
|
805 | "landing_rev" : "<landing_rev>", | |
|
806 | "owner" : "<username or user_id>", | |
|
807 | "fork_of" : "<name_of_fork_parent>", | |
|
808 | "enable_downloads" : "<bool>", | |
|
809 | 809 | "enable_statistics": "<bool>", |
|
810 | 810 | }, |
|
811 | } | |
|
812 |
error |
|
|
811 | } | |
|
812 | error : null | |
|
813 | 813 | |
|
814 | 814 | update_repo |
|
815 | 815 | ^^^^^^^^^^^ |
@@ -824,7 +824,7 b' INPUT::' | |||
|
824 | 824 | id : <id_for_response> |
|
825 | 825 | api_key : "<api_key>" |
|
826 | 826 | method : "update_repo" |
|
827 |
args |
|
|
827 | args : { | |
|
828 | 828 | "repoid" : "<reponame or repo_id>" |
|
829 | 829 | "name" : "<reponame> = Optional('')", |
|
830 | 830 | "group" : "<group_id> = Optional(None)", |
@@ -833,39 +833,39 b' INPUT::' | |||
|
833 | 833 | "private" : "<bool> = Optional(False)", |
|
834 | 834 | "clone_uri" : "<clone_uri> = Optional(None)", |
|
835 | 835 | "landing_rev" : "<landing_rev> = Optional('tip')", |
|
836 |
"enable_downloads" |
|
|
836 | "enable_downloads" : "<bool> = Optional(False)", | |
|
837 | 837 | "enable_statistics": "<bool> = Optional(False)", |
|
838 | 838 | } |
|
839 | 839 | |
|
840 | 840 | OUTPUT:: |
|
841 | 841 | |
|
842 | 842 | id : <id_given_in_input> |
|
843 | result: { | |
|
844 | "msg": "updated repo ID:repo_id `<reponame>`", | |
|
845 | "repository": { | |
|
843 | result : { | |
|
844 | "msg" : "updated repo ID:repo_id `<reponame>`", | |
|
845 | "repository" : { | |
|
846 | 846 | "repo_id" : "<repo_id>", |
|
847 | 847 | "repo_name" : "<reponame>" |
|
848 | 848 | "repo_type" : "<repo_type>", |
|
849 | 849 | "clone_uri" : "<clone_uri>", |
|
850 |
"private" |
|
|
850 | "private" : "<bool>", | |
|
851 | 851 | "created_on" : "<datetimecreated>", |
|
852 | 852 | "description" : "<description>", |
|
853 |
"landing_rev" |
|
|
854 |
"owner" |
|
|
855 |
"fork_of" |
|
|
856 |
"enable_downloads" |
|
|
853 | "landing_rev" : "<landing_rev>", | |
|
854 | "owner" : "<username or user_id>", | |
|
855 | "fork_of" : "<name_of_fork_parent>", | |
|
856 | "enable_downloads" : "<bool>", | |
|
857 | 857 | "enable_statistics": "<bool>", |
|
858 |
"last_changeset" |
|
|
859 |
"author" |
|
|
860 |
"date" |
|
|
861 |
"message" |
|
|
862 |
"raw_id" |
|
|
858 | "last_changeset" : { | |
|
859 | "author" : "<full_author>", | |
|
860 | "date" : "<date_time_of_commit>", | |
|
861 | "message" : "<commit_message>", | |
|
862 | "raw_id" : "<raw_id>", | |
|
863 | 863 | "revision": "<numeric_revision>", |
|
864 | 864 | "short_id": "<short_id>" |
|
865 | 865 | } |
|
866 | 866 | }, |
|
867 | } | |
|
868 |
error |
|
|
867 | } | |
|
868 | error : null | |
|
869 | 869 | |
|
870 | 870 | fork_repo |
|
871 | 871 | ^^^^^^^^^ |
@@ -883,24 +883,24 b' INPUT::' | |||
|
883 | 883 | id : <id_for_response> |
|
884 | 884 | api_key : "<api_key>" |
|
885 | 885 | method : "fork_repo" |
|
886 |
args |
|
|
886 | args : { | |
|
887 | 887 | "repoid" : "<reponame or repo_id>", |
|
888 |
"fork_name" |
|
|
889 |
"owner" |
|
|
890 |
"description" |
|
|
888 | "fork_name" : "<forkname>", | |
|
889 | "owner" : "<username or user_id = Optional(=apiuser)>", | |
|
890 | "description" : "<description>", | |
|
891 | 891 | "copy_permissions": "<bool>", |
|
892 |
"private" |
|
|
893 |
"landing_rev" |
|
|
892 | "private" : "<bool>", | |
|
893 | "landing_rev" : "<landing_rev>" | |
|
894 | 894 | } |
|
895 | 895 | |
|
896 | 896 | OUTPUT:: |
|
897 | 897 | |
|
898 | 898 | id : <id_given_in_input> |
|
899 | result: { | |
|
900 | "msg": "Created fork of `<reponame>` as `<forkname>`", | |
|
901 | "success": true | |
|
902 | } | |
|
903 |
error |
|
|
899 | result : { | |
|
900 | "msg" : "Created fork of `<reponame>` as `<forkname>`", | |
|
901 | "success" : true | |
|
902 | } | |
|
903 | error : null | |
|
904 | 904 | |
|
905 | 905 | delete_repo |
|
906 | 906 | ^^^^^^^^^^^ |
@@ -915,19 +915,19 b' INPUT::' | |||
|
915 | 915 | id : <id_for_response> |
|
916 | 916 | api_key : "<api_key>" |
|
917 | 917 | method : "delete_repo" |
|
918 |
args |
|
|
918 | args : { | |
|
919 | 919 | "repoid" : "<reponame or repo_id>", |
|
920 |
"forks" |
|
|
920 | "forks" : "`delete` or `detach` = Optional(None)" | |
|
921 | 921 | } |
|
922 | 922 | |
|
923 | 923 | OUTPUT:: |
|
924 | 924 | |
|
925 | 925 | id : <id_given_in_input> |
|
926 | result: { | |
|
927 | "msg": "Deleted repository `<reponame>`", | |
|
928 | "success": true | |
|
929 | } | |
|
930 |
error |
|
|
926 | result : { | |
|
927 | "msg" : "Deleted repository `<reponame>`", | |
|
928 | "success" : true | |
|
929 | } | |
|
930 | error : null | |
|
931 | 931 | |
|
932 | 932 | grant_user_permission |
|
933 | 933 | ^^^^^^^^^^^^^^^^^^^^^ |
@@ -940,7 +940,7 b' INPUT::' | |||
|
940 | 940 | id : <id_for_response> |
|
941 | 941 | api_key : "<api_key>" |
|
942 | 942 | method : "grant_user_permission" |
|
943 |
args |
|
|
943 | args : { | |
|
944 | 944 | "repoid" : "<reponame or repo_id>" |
|
945 | 945 | "userid" : "<username or user_id>" |
|
946 | 946 | "perm" : "(repository.(none|read|write|admin))", |
@@ -949,11 +949,11 b' INPUT::' | |||
|
949 | 949 | OUTPUT:: |
|
950 | 950 | |
|
951 | 951 | id : <id_given_in_input> |
|
952 | result: { | |
|
952 | result : { | |
|
953 | 953 | "msg" : "Granted perm: `<perm>` for user: `<username>` in repo: `<reponame>`", |
|
954 | "success": true | |
|
955 | } | |
|
956 |
error |
|
|
954 | "success" : true | |
|
955 | } | |
|
956 | error : null | |
|
957 | 957 | |
|
958 | 958 | revoke_user_permission |
|
959 | 959 | ^^^^^^^^^^^^^^^^^^^^^^ |
@@ -965,8 +965,8 b' INPUT::' | |||
|
965 | 965 | |
|
966 | 966 | id : <id_for_response> |
|
967 | 967 | api_key : "<api_key>" |
|
968 |
method |
|
|
969 |
args |
|
|
968 | method : "revoke_user_permission" | |
|
969 | args : { | |
|
970 | 970 | "repoid" : "<reponame or repo_id>" |
|
971 | 971 | "userid" : "<username or user_id>" |
|
972 | 972 | } |
@@ -974,11 +974,11 b' INPUT::' | |||
|
974 | 974 | OUTPUT:: |
|
975 | 975 | |
|
976 | 976 | id : <id_given_in_input> |
|
977 | result: { | |
|
977 | result : { | |
|
978 | 978 | "msg" : "Revoked perm for user: `<username>` in repo: `<reponame>`", |
|
979 | "success": true | |
|
980 | } | |
|
981 |
error |
|
|
979 | "success" : true | |
|
980 | } | |
|
981 | error : null | |
|
982 | 982 | |
|
983 | 983 | grant_user_group_permission |
|
984 | 984 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
@@ -992,7 +992,7 b' INPUT::' | |||
|
992 | 992 | id : <id_for_response> |
|
993 | 993 | api_key : "<api_key>" |
|
994 | 994 | method : "grant_user_group_permission" |
|
995 |
args |
|
|
995 | args : { | |
|
996 | 996 | "repoid" : "<reponame or repo_id>" |
|
997 | 997 | "usersgroupid" : "<user group id or name>" |
|
998 | 998 | "perm" : "(repository.(none|read|write|admin))", |
@@ -1001,11 +1001,11 b' INPUT::' | |||
|
1001 | 1001 | OUTPUT:: |
|
1002 | 1002 | |
|
1003 | 1003 | id : <id_given_in_input> |
|
1004 | result: { | |
|
1004 | result : { | |
|
1005 | 1005 | "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`", |
|
1006 | "success": true | |
|
1007 | } | |
|
1008 |
error |
|
|
1006 | "success" : true | |
|
1007 | } | |
|
1008 | error : null | |
|
1009 | 1009 | |
|
1010 | 1010 | revoke_user_group_permission |
|
1011 | 1011 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
@@ -1017,8 +1017,8 b' INPUT::' | |||
|
1017 | 1017 | |
|
1018 | 1018 | id : <id_for_response> |
|
1019 | 1019 | api_key : "<api_key>" |
|
1020 |
method |
|
|
1021 |
args |
|
|
1020 | method : "revoke_user_group_permission" | |
|
1021 | args : { | |
|
1022 | 1022 | "repoid" : "<reponame or repo_id>" |
|
1023 | 1023 | "usersgroupid" : "<user group id or name>" |
|
1024 | 1024 | } |
@@ -1026,11 +1026,11 b' INPUT::' | |||
|
1026 | 1026 | OUTPUT:: |
|
1027 | 1027 | |
|
1028 | 1028 | id : <id_given_in_input> |
|
1029 | result: { | |
|
1029 | result : { | |
|
1030 | 1030 | "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`", |
|
1031 | "success": true | |
|
1032 | } | |
|
1033 |
error |
|
|
1031 | "success" : true | |
|
1032 | } | |
|
1033 | error : null | |
|
1034 | 1034 | |
|
1035 | 1035 | get_changesets |
|
1036 | 1036 | ^^^^^^^^^^^^^^ |
@@ -1042,37 +1042,37 b' INPUT::' | |||
|
1042 | 1042 | |
|
1043 | 1043 | id : <id_for_response> |
|
1044 | 1044 | api_key : "<api_key>" |
|
1045 |
method |
|
|
1046 |
args |
|
|
1045 | method : "get_changesets" | |
|
1046 | args : { | |
|
1047 | 1047 | "repoid" : "<reponame or repo_id>", |
|
1048 | "start": "<revision number> = Optional(None)", | |
|
1049 | "end": "<revision number> = Optional(None)", | |
|
1050 | "start_date": "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format | |
|
1051 | "end_date": "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format | |
|
1052 | "branch_name": "<branch name filter> = Optional(None)", | |
|
1053 | "reverse": "<bool> = Optional(False)", | |
|
1054 | "with_file_list": "<bool> = Optional(False)" | |
|
1048 | "start" : "<revision number> = Optional(None)", | |
|
1049 | "end" : "<revision number> = Optional(None)", | |
|
1050 | "start_date" : "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format | |
|
1051 | "end_date" : "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format | |
|
1052 | "branch_name" : "<branch name filter> = Optional(None)", | |
|
1053 | "reverse" : "<bool> = Optional(False)", | |
|
1054 | "with_file_list" : "<bool> = Optional(False)" | |
|
1055 | 1055 | } |
|
1056 | 1056 | |
|
1057 | 1057 | OUTPUT:: |
|
1058 | 1058 | |
|
1059 | 1059 | id : <id_given_in_input> |
|
1060 | result: [ | |
|
1060 | result : [ | |
|
1061 | 1061 | { |
|
1062 | "raw_id": "<raw_id>", | |
|
1063 | "short_id": "<short_id>", | |
|
1064 | "author": "<full_author>", | |
|
1065 | "date": "<date_time_of_commit>", | |
|
1066 | "message": "<commit_message>", | |
|
1067 | "revision": "<numeric_revision>", | |
|
1062 | "raw_id" : "<raw_id>", | |
|
1063 | "short_id" : "<short_id>", | |
|
1064 | "author" : "<full_author>", | |
|
1065 | "date" : "<date_time_of_commit>", | |
|
1066 | "message" : "<commit_message>", | |
|
1067 | "revision" : "<numeric_revision>", | |
|
1068 | 1068 | <if with_file_list == True> |
|
1069 | "added": [<list of added files>], | |
|
1070 | "changed": [<list of changed files>], | |
|
1071 | "removed": [<list of removed files>] | |
|
1069 | "added" : [<list of added files>], | |
|
1070 | "changed" : [<list of changed files>], | |
|
1071 | "removed" : [<list of removed files>] | |
|
1072 | 1072 | }, |
|
1073 | 1073 | ... |
|
1074 | 1074 | ] |
|
1075 |
error |
|
|
1075 | error : null | |
|
1076 | 1076 | |
|
1077 | 1077 | get_changeset |
|
1078 | 1078 | ^^^^^^^^^^^^^ |
@@ -1085,32 +1085,32 b' INPUT::' | |||
|
1085 | 1085 | |
|
1086 | 1086 | id : <id_for_response> |
|
1087 | 1087 | api_key : "<api_key>" |
|
1088 |
method |
|
|
1089 |
args |
|
|
1088 | method : "get_changeset" | |
|
1089 | args : { | |
|
1090 | 1090 | "repoid" : "<reponame or repo_id>", |
|
1091 | 1091 | "raw_id" : "<raw_id>", |
|
1092 | "with_reviews": "<bool> = Optional(False)" | |
|
1092 | "with_reviews" : "<bool> = Optional(False)" | |
|
1093 | 1093 | } |
|
1094 | 1094 | |
|
1095 | 1095 | OUTPUT:: |
|
1096 | 1096 | |
|
1097 | 1097 | id : <id_given_in_input> |
|
1098 | result: { | |
|
1099 |
"author" |
|
|
1100 |
"date" |
|
|
1101 |
"message" |
|
|
1102 |
"raw_id" |
|
|
1098 | result : { | |
|
1099 | "author" : "<full_author>", | |
|
1100 | "date" : "<date_time_of_commit>", | |
|
1101 | "message" : "<commit_message>", | |
|
1102 | "raw_id" : "<raw_id>", | |
|
1103 | 1103 | "revision": "<numeric_revision>", |
|
1104 | 1104 | "short_id": "<short_id>", |
|
1105 | "reviews": [{ | |
|
1106 |
"reviewer" |
|
|
1107 | "modified_at": "<date_time_of_review>", # iso 8601 date, server's timezone | |
|
1108 |
"status" |
|
|
1105 | "reviews" : [{ | |
|
1106 | "reviewer" : "<username>", | |
|
1107 | "modified_at" : "<date_time_of_review>", # iso 8601 date, server's timezone | |
|
1108 | "status" : "<status_of_review>", # "under_review", "approved" or "rejected" | |
|
1109 | 1109 | }, |
|
1110 | 1110 | ... |
|
1111 | 1111 | ] |
|
1112 | } | |
|
1113 |
error |
|
|
1112 | } | |
|
1113 | error : null | |
|
1114 | 1114 | |
|
1115 | 1115 | Example output:: |
|
1116 | 1116 | |
@@ -1153,60 +1153,60 b' INPUT::' | |||
|
1153 | 1153 | |
|
1154 | 1154 | id : <id_for_response> |
|
1155 | 1155 | api_key : "<api_key>" |
|
1156 |
method |
|
|
1157 |
args |
|
|
1156 | method : "get_pullrequest" | |
|
1157 | args : { | |
|
1158 | 1158 | "pullrequest_id" : "<pullrequest_id>", |
|
1159 | 1159 | } |
|
1160 | 1160 | |
|
1161 | 1161 | OUTPUT:: |
|
1162 | 1162 | |
|
1163 | 1163 | id : <id_given_in_input> |
|
1164 | result: { | |
|
1165 | "status": "<pull_request_status>", | |
|
1166 | "pull_request_id": <pull_request_id>, | |
|
1167 | "description": "<pull_request_description>", | |
|
1168 | "title": "<pull_request_title>", | |
|
1169 | "url": "<pull_request_url>", | |
|
1170 | "reviewers": [ | |
|
1164 | result : { | |
|
1165 | "status" : "<pull_request_status>", | |
|
1166 | "pull_request_id" : <pull_request_id>, | |
|
1167 | "description" : "<pull_request_description>", | |
|
1168 | "title" : "<pull_request_title>", | |
|
1169 | "url" : "<pull_request_url>", | |
|
1170 | "reviewers" : [ | |
|
1171 | 1171 | { |
|
1172 | "username": "<user_name>", | |
|
1172 | "username" : "<user_name>", | |
|
1173 | 1173 | }, |
|
1174 | 1174 | ... |
|
1175 | 1175 | ], |
|
1176 | "org_repo_url": "<repo_url>", | |
|
1177 | "org_ref_parts": [ | |
|
1176 | "org_repo_url" : "<repo_url>", | |
|
1177 | "org_ref_parts" : [ | |
|
1178 | 1178 | "<ref_type>", |
|
1179 | 1179 | "<ref_name>", |
|
1180 | 1180 | "<raw_id>" |
|
1181 | 1181 | ], |
|
1182 | "other_ref_parts": [ | |
|
1182 | "other_ref_parts" : [ | |
|
1183 | 1183 | "<ref_type>", |
|
1184 | 1184 | "<ref_name>", |
|
1185 | 1185 | "<raw_id>" |
|
1186 | 1186 | ], |
|
1187 | "comments": [ | |
|
1187 | "comments" : [ | |
|
1188 | 1188 | { |
|
1189 | "username": "<user_name>", | |
|
1190 | "text": "<comment text>", | |
|
1191 | "comment_id": "<comment_id>", | |
|
1189 | "username" : "<user_name>", | |
|
1190 | "text" : "<comment text>", | |
|
1191 | "comment_id" : "<comment_id>", | |
|
1192 | 1192 | }, |
|
1193 | 1193 | ... |
|
1194 | 1194 | ], |
|
1195 | "owner": "<username>", | |
|
1196 | "statuses": [ | |
|
1195 | "owner" : "<username>", | |
|
1196 | "statuses" : [ | |
|
1197 | 1197 | { |
|
1198 | "status": "<status_of_review>", # "under_review", "approved" or "rejected" | |
|
1199 | "reviewer": "<user_name>", | |
|
1200 | "modified_at": "<date_time_of_review>" # iso 8601 date, server's timezone | |
|
1198 | "status" : "<status_of_review>", # "under_review", "approved" or "rejected" | |
|
1199 | "reviewer" : "<user_name>", | |
|
1200 | "modified_at" : "<date_time_of_review>" # iso 8601 date, server's timezone | |
|
1201 | 1201 | }, |
|
1202 | 1202 | ... |
|
1203 | 1203 | ], |
|
1204 | "revisions": [ | |
|
1204 | "revisions" : [ | |
|
1205 | 1205 | "<raw_id>", |
|
1206 | 1206 | ... |
|
1207 | 1207 | ] |
|
1208 | 1208 | }, |
|
1209 |
error |
|
|
1209 | error : null | |
|
1210 | 1210 | |
|
1211 | 1211 | comment_pullrequest |
|
1212 | 1212 | ^^^^^^^^^^^^^^^^^^^ |
@@ -1218,19 +1218,19 b' INPUT::' | |||
|
1218 | 1218 | |
|
1219 | 1219 | id : <id_for_response> |
|
1220 | 1220 | api_key : "<api_key>" |
|
1221 |
method |
|
|
1222 |
args |
|
|
1223 |
"pull_request_id" |
|
|
1224 |
"comment_msg" |
|
|
1225 |
"status" |
|
|
1226 |
"close_pr" |
|
|
1221 | method : "comment_pullrequest" | |
|
1222 | args : { | |
|
1223 | "pull_request_id" : "<pull_request_id>", | |
|
1224 | "comment_msg" : Optional(''), | |
|
1225 | "status" : Optional(None), # "under_review", "approved" or "rejected" | |
|
1226 | "close_pr" : Optional(False)", | |
|
1227 | 1227 | } |
|
1228 | 1228 | |
|
1229 | 1229 | OUTPUT:: |
|
1230 | 1230 | |
|
1231 | 1231 | id : <id_given_in_input> |
|
1232 | result: True | |
|
1233 |
error |
|
|
1232 | result : True | |
|
1233 | error : null | |
|
1234 | 1234 | |
|
1235 | 1235 | |
|
1236 | 1236 | API access for web views |
@@ -174,10 +174,10 b' class ApiController(JSONRPCController):' | |||
|
174 | 174 | |
|
175 | 175 | id : <id_given_in_input> |
|
176 | 176 | result : { |
|
177 | "msg": "Pulled from `<repository name>`" | |
|
178 | "repository": "<repository name>" | |
|
177 | "msg" : "Pulled from `<repository name>`" | |
|
178 | "repository" : "<repository name>" | |
|
179 | 179 | } |
|
180 |
error : |
|
|
180 | error : null | |
|
181 | 181 | |
|
182 | 182 | ERROR OUTPUT:: |
|
183 | 183 | |
@@ -223,7 +223,7 b' class ApiController(JSONRPCController):' | |||
|
223 | 223 | 'added': [<added repository name>,...] |
|
224 | 224 | 'removed': [<removed repository name>,...] |
|
225 | 225 | } |
|
226 |
error : |
|
|
226 | error : null | |
|
227 | 227 | |
|
228 | 228 | ERROR OUTPUT:: |
|
229 | 229 | |
@@ -260,7 +260,7 b' class ApiController(JSONRPCController):' | |||
|
260 | 260 | 'msg': Cache for repository `<repository name>` was invalidated, |
|
261 | 261 | 'repository': <repository name> |
|
262 | 262 | } |
|
263 |
error : |
|
|
263 | error : null | |
|
264 | 264 | |
|
265 | 265 | ERROR OUTPUT:: |
|
266 | 266 | |
@@ -303,14 +303,14 b' class ApiController(JSONRPCController):' | |||
|
303 | 303 | |
|
304 | 304 | id : <id_given_in_input> |
|
305 | 305 | result : { |
|
306 | "server_ip_addr": "<ip_from_client>", | |
|
307 | "user_ips": [ | |
|
306 | "server_ip_addr" : "<ip_from_client>", | |
|
307 | "user_ips" : [ | |
|
308 | 308 | { |
|
309 | "ip_addr": "<ip_with_mask>", | |
|
310 | "ip_range": ["<start_ip>", "<end_ip>"], | |
|
309 | "ip_addr" : "<ip_with_mask>", | |
|
310 | "ip_range" : ["<start_ip>", "<end_ip>"], | |
|
311 | 311 | }, |
|
312 | 312 | ... |
|
313 | ] | |
|
313 | ] | |
|
314 | 314 | } |
|
315 | 315 | error : null |
|
316 | 316 | """ |
@@ -335,12 +335,12 b' class ApiController(JSONRPCController):' | |||
|
335 | 335 | |
|
336 | 336 | id : <id_given_in_input> |
|
337 | 337 | result : { |
|
338 | 'modules': [ [<module name>, <module version>], ...] | |
|
339 | 'py_version': <python version>, | |
|
340 | 'platform': <platform type>, | |
|
341 | 'kallithea_version': <kallithea version>, | |
|
342 | 'git_version': '<git version>', | |
|
343 | 'git_path': '<git path>' | |
|
338 | 'modules' : [ [<module name>, <module version>], ...] | |
|
339 | 'py_version' : <python version>, | |
|
340 | 'platform' : <platform type>, | |
|
341 | 'kallithea_version' : <kallithea version>, | |
|
342 | 'git_version' : '<git version>', | |
|
343 | 'git_path' : '<git path>' | |
|
344 | 344 | } |
|
345 | 345 | error : null |
|
346 | 346 | """ |
@@ -360,26 +360,26 b' class ApiController(JSONRPCController):' | |||
|
360 | 360 | OUTPUT:: |
|
361 | 361 | |
|
362 | 362 | id : <id_given_in_input> |
|
363 | result: None if user does not exist or | |
|
364 | { | |
|
363 | result : None if user does not exist or | |
|
364 | { | |
|
365 | 365 | "user_id" : "<user_id>", |
|
366 | 366 | "username" : "<username>", |
|
367 |
"firstname" |
|
|
367 | "firstname" : "<firstname>", | |
|
368 | 368 | "lastname" : "<lastname>", |
|
369 | 369 | "email" : "<email>", |
|
370 |
"emails" |
|
|
370 | "emails" : "[<list of all emails including additional ones>]", | |
|
371 | 371 | "active" : "<bool: user active>", |
|
372 | 372 | "admin" : "<bool: user is admin>", |
|
373 | "permissions": { | |
|
374 | "global": ["hg.create.repository", | |
|
375 | "repository.read", | |
|
376 | "hg.register.manual_activate"], | |
|
377 | "repositories": {"repo1": "repository.none"}, | |
|
378 | "repositories_groups": {"Group1": "group.read"}, | |
|
379 | "user_groups": { "usrgrp1": "usergroup.admin" } | |
|
373 | "permissions" : { | |
|
374 | "global" : ["hg.create.repository", | |
|
375 | "repository.read", | |
|
376 | "hg.register.manual_activate"], | |
|
377 | "repositories" : {"repo1" : "repository.none"}, | |
|
378 | "repositories_groups" : {"Group1" : "group.read"}, | |
|
379 | "user_groups" : { "usrgrp1" : "usergroup.admin" } | |
|
380 | 380 | }, |
|
381 | } | |
|
382 |
error |
|
|
381 | } | |
|
382 | error : null | |
|
383 | 383 | """ |
|
384 | 384 | if not HasPermissionAny('hg.admin')(): |
|
385 | 385 | # make sure normal user does not pass someone else userid, |
@@ -406,8 +406,8 b' class ApiController(JSONRPCController):' | |||
|
406 | 406 | OUTPUT:: |
|
407 | 407 | |
|
408 | 408 | id : <id_given_in_input> |
|
409 | result: [<user_object>, ...] | |
|
410 |
error |
|
|
409 | result : [<user_object>, ...] | |
|
410 | error : null | |
|
411 | 411 | """ |
|
412 | 412 | return [ |
|
413 | 413 | user.get_api_data() |
@@ -448,11 +448,11 b' class ApiController(JSONRPCController):' | |||
|
448 | 448 | OUTPUT:: |
|
449 | 449 | |
|
450 | 450 | id : <id_given_in_input> |
|
451 | result: { | |
|
451 | result : { | |
|
452 | 452 | "msg" : "created new user `<username>`", |
|
453 | "user": <user_obj> | |
|
454 | } | |
|
455 |
error |
|
|
453 | "user" : <user_obj> | |
|
454 | } | |
|
455 | error : null | |
|
456 | 456 | |
|
457 | 457 | ERROR OUTPUT:: |
|
458 | 458 | |
@@ -527,11 +527,11 b' class ApiController(JSONRPCController):' | |||
|
527 | 527 | OUTPUT:: |
|
528 | 528 | |
|
529 | 529 | id : <id_given_in_input> |
|
530 | result: { | |
|
530 | result : { | |
|
531 | 531 | "msg" : "updated user ID:<userid> <username>", |
|
532 | "user": <user_object>, | |
|
533 | } | |
|
534 |
error |
|
|
532 | "user" : <user_object>, | |
|
533 | } | |
|
534 | error : null | |
|
535 | 535 | |
|
536 | 536 | ERROR OUTPUT:: |
|
537 | 537 | |
@@ -583,11 +583,11 b' class ApiController(JSONRPCController):' | |||
|
583 | 583 | OUTPUT:: |
|
584 | 584 | |
|
585 | 585 | id : <id_given_in_input> |
|
586 | result: { | |
|
586 | result : { | |
|
587 | 587 | "msg" : "deleted user ID:<userid> <username>", |
|
588 | "user": null | |
|
589 | } | |
|
590 |
error |
|
|
588 | "user" : null | |
|
589 | } | |
|
590 | error : null | |
|
591 | 591 | |
|
592 | 592 | ERROR OUTPUT:: |
|
593 | 593 | |
@@ -629,10 +629,10 b' class ApiController(JSONRPCController):' | |||
|
629 | 629 | { |
|
630 | 630 | "users_group_id" : "<id>", |
|
631 | 631 | "group_name" : "<groupname>", |
|
632 | "group_description": "<description>" | |
|
633 |
"active" |
|
|
634 |
"owner" |
|
|
635 | "members" : [<user_obj>,...] | |
|
632 | "group_description" : "<description>" | |
|
633 | "active" : "<bool>", | |
|
634 | "owner" : "<username>" | |
|
635 | "members" : [<user_obj>,...] | |
|
636 | 636 | } |
|
637 | 637 | error : null |
|
638 | 638 | """ |
@@ -682,11 +682,11 b' class ApiController(JSONRPCController):' | |||
|
682 | 682 | OUTPUT:: |
|
683 | 683 | |
|
684 | 684 | id : <id_given_in_input> |
|
685 | result: { | |
|
686 | "msg": "created new user group `<groupname>`", | |
|
687 | "user_group": <user_group_object> | |
|
688 | } | |
|
689 |
error |
|
|
685 | result : { | |
|
686 | "msg" : "created new user group `<groupname>`", | |
|
687 | "user_group" : <user_group_object> | |
|
688 | } | |
|
689 | error : null | |
|
690 | 690 | |
|
691 | 691 | ERROR OUTPUT:: |
|
692 | 692 | |
@@ -740,10 +740,10 b' class ApiController(JSONRPCController):' | |||
|
740 | 740 | |
|
741 | 741 | id : <id_given_in_input> |
|
742 | 742 | result : { |
|
743 | "msg": 'updated user group ID:<user group id> <user group name>', | |
|
744 | "user_group": <user_group_object> | |
|
743 | "msg" : 'updated user group ID:<user group id> <user group name>', | |
|
744 | "user_group" : <user_group_object> | |
|
745 | 745 | } |
|
746 |
error : |
|
|
746 | error : null | |
|
747 | 747 | |
|
748 | 748 | ERROR OUTPUT:: |
|
749 | 749 | |
@@ -792,9 +792,9 b' class ApiController(JSONRPCController):' | |||
|
792 | 792 | |
|
793 | 793 | id : <id_given_in_input> |
|
794 | 794 | result : { |
|
795 | "msg": "deleted user group ID:<user_group_id> <user_group_name>" | |
|
795 | "msg" : "deleted user group ID:<user_group_id> <user_group_name>" | |
|
796 | 796 | } |
|
797 |
error : |
|
|
797 | error : null | |
|
798 | 798 | |
|
799 | 799 | ERROR OUTPUT:: |
|
800 | 800 | |
@@ -845,11 +845,11 b' class ApiController(JSONRPCController):' | |||
|
845 | 845 | |
|
846 | 846 | id : <id_given_in_input> |
|
847 | 847 | result : { |
|
848 | "success": True|False # depends on if member is in group | |
|
849 | "msg": "added member `<username>` to a user group `<groupname>` | | |
|
850 | User is already in that group" | |
|
848 | "success" : True|False # depends on if member is in group | |
|
849 | "msg" : "added member `<username>` to a user group `<groupname>` | | |
|
850 | User is already in that group" | |
|
851 | 851 | } |
|
852 |
error : |
|
|
852 | error : null | |
|
853 | 853 | |
|
854 | 854 | ERROR OUTPUT:: |
|
855 | 855 | |
@@ -899,12 +899,12 b' class ApiController(JSONRPCController):' | |||
|
899 | 899 | OUTPUT:: |
|
900 | 900 | |
|
901 | 901 | id : <id_given_in_input> |
|
902 | result: { | |
|
903 |
"success" |
|
|
904 | "msg": "removed member <username> from user group <groupname> | | |
|
905 | User wasn't in group" | |
|
906 | } | |
|
907 |
error |
|
|
902 | result : { | |
|
903 | "success" : True|False, # depends on if member is in group | |
|
904 | "msg" : "removed member <username> from user group <groupname> | | |
|
905 | User wasn't in group" | |
|
906 | } | |
|
907 | error : null | |
|
908 | 908 | """ |
|
909 | 909 | user = get_user_or_error(userid) |
|
910 | 910 | user_group = get_user_group_or_error(usergroupid) |
@@ -949,52 +949,52 b' class ApiController(JSONRPCController):' | |||
|
949 | 949 | "repo_name" : "<reponame>" |
|
950 | 950 | "repo_type" : "<repo_type>", |
|
951 | 951 | "clone_uri" : "<clone_uri>", |
|
952 |
"enable_downloads" |
|
|
952 | "enable_downloads" : "<bool>", | |
|
953 | 953 | "enable_statistics": "<bool>", |
|
954 |
"private" |
|
|
954 | "private" : "<bool>", | |
|
955 | 955 | "created_on" : "<date_time_created>", |
|
956 | 956 | "description" : "<description>", |
|
957 |
"landing_rev" |
|
|
958 |
"last_changeset" |
|
|
959 |
"author" |
|
|
960 |
"date" |
|
|
961 |
"message" |
|
|
962 |
"raw_id" |
|
|
957 | "landing_rev" : "<landing_rev>", | |
|
958 | "last_changeset" : { | |
|
959 | "author" : "<full_author>", | |
|
960 | "date" : "<date_time_of_commit>", | |
|
961 | "message" : "<commit_message>", | |
|
962 | "raw_id" : "<raw_id>", | |
|
963 | 963 | "revision": "<numeric_revision>", |
|
964 | 964 | "short_id": "<short_id>" |
|
965 | 965 | } |
|
966 |
"owner" |
|
|
967 |
"fork_of" |
|
|
966 | "owner" : "<repo_owner>", | |
|
967 | "fork_of" : "<name_of_fork_parent>", | |
|
968 | 968 | "members" : [ |
|
969 | 969 | { |
|
970 |
"name" |
|
|
970 | "name" : "<username>", | |
|
971 | 971 | "type" : "user", |
|
972 | 972 | "permission" : "repository.(read|write|admin)" |
|
973 | 973 | }, |
|
974 | 974 | β¦ |
|
975 | 975 | { |
|
976 |
"name" |
|
|
976 | "name" : "<usergroup name>", | |
|
977 | 977 | "type" : "user_group", |
|
978 | 978 | "permission" : "usergroup.(read|write|admin)" |
|
979 | 979 | }, |
|
980 | 980 | β¦ |
|
981 | 981 | ] |
|
982 |
"followers" |
|
|
982 | "followers" : [<user_obj>, ...], | |
|
983 | 983 | <if with_revision_names == True> |
|
984 | "tags": { | |
|
985 | "<tagname>": "<raw_id>", | |
|
984 | "tags" : { | |
|
985 | "<tagname>" : "<raw_id>", | |
|
986 | 986 | ... |
|
987 | 987 | }, |
|
988 | "branches": { | |
|
989 | "<branchname>": "<raw_id>", | |
|
988 | "branches" : { | |
|
989 | "<branchname>" : "<raw_id>", | |
|
990 | 990 | ... |
|
991 | 991 | }, |
|
992 | "bookmarks": { | |
|
993 | "<bookmarkname>": "<raw_id>", | |
|
992 | "bookmarks" : { | |
|
993 | "<bookmarkname>" : "<raw_id>", | |
|
994 | 994 | ... |
|
995 | 995 | }, |
|
996 | } | |
|
997 |
error : |
|
|
996 | } | |
|
997 | error : null | |
|
998 | 998 | """ |
|
999 | 999 | repo = get_repo_or_error(repoid) |
|
1000 | 1000 | |
@@ -1044,7 +1044,7 b' class ApiController(JSONRPCController):' | |||
|
1044 | 1044 | OUTPUT:: |
|
1045 | 1045 | |
|
1046 | 1046 | id : <id_given_in_input> |
|
1047 | result: [ | |
|
1047 | result : [ | |
|
1048 | 1048 | { |
|
1049 | 1049 | "repo_id" : "<repo_id>", |
|
1050 | 1050 | "repo_name" : "<reponame>" |
@@ -1053,15 +1053,15 b' class ApiController(JSONRPCController):' | |||
|
1053 | 1053 | "private" : "<bool>", |
|
1054 | 1054 | "created_on" : "<datetimecreated>", |
|
1055 | 1055 | "description" : "<description>", |
|
1056 |
"landing_rev" |
|
|
1057 |
"owner" |
|
|
1058 |
"fork_of" |
|
|
1059 |
"enable_downloads" |
|
|
1056 | "landing_rev" : "<landing_rev>", | |
|
1057 | "owner" : "<repo_owner>", | |
|
1058 | "fork_of" : "<name_of_fork_parent>", | |
|
1059 | "enable_downloads" : "<bool>", | |
|
1060 | 1060 | "enable_statistics": "<bool>", |
|
1061 | 1061 | }, |
|
1062 | 1062 | β¦ |
|
1063 | ] | |
|
1064 |
error |
|
|
1063 | ] | |
|
1064 | error : null | |
|
1065 | 1065 | """ |
|
1066 | 1066 | if not HasPermissionAny('hg.admin')(): |
|
1067 | 1067 | repos = request.authuser.get_all_user_repos() |
@@ -1094,14 +1094,14 b' class ApiController(JSONRPCController):' | |||
|
1094 | 1094 | OUTPUT:: |
|
1095 | 1095 | |
|
1096 | 1096 | id : <id_given_in_input> |
|
1097 | result: [ | |
|
1097 | result : [ | |
|
1098 | 1098 | { |
|
1099 | 1099 | "name" : "<name>" |
|
1100 | 1100 | "type" : "<type>", |
|
1101 | 1101 | }, |
|
1102 | 1102 | β¦ |
|
1103 | ] | |
|
1104 |
error |
|
|
1103 | ] | |
|
1104 | error : null | |
|
1105 | 1105 | """ |
|
1106 | 1106 | repo = get_repo_or_error(repoid) |
|
1107 | 1107 | |
@@ -1169,11 +1169,11 b' class ApiController(JSONRPCController):' | |||
|
1169 | 1169 | OUTPUT:: |
|
1170 | 1170 | |
|
1171 | 1171 | id : <id_given_in_input> |
|
1172 | result: { | |
|
1173 | "msg": "Created new repository `<reponame>`", | |
|
1174 | "success": true | |
|
1175 | } | |
|
1176 |
error |
|
|
1172 | result : { | |
|
1173 | "msg" : "Created new repository `<reponame>`", | |
|
1174 | "success" : true | |
|
1175 | } | |
|
1176 | error : null | |
|
1177 | 1177 | |
|
1178 | 1178 | ERROR OUTPUT:: |
|
1179 | 1179 | |
@@ -1342,24 +1342,24 b' class ApiController(JSONRPCController):' | |||
|
1342 | 1342 | id : <id_for_response> |
|
1343 | 1343 | api_key : "<api_key>" |
|
1344 | 1344 | method : "fork_repo" |
|
1345 |
args |
|
|
1345 | args : { | |
|
1346 | 1346 | "repoid" : "<reponame or repo_id>", |
|
1347 |
"fork_name" |
|
|
1348 |
"owner" |
|
|
1349 |
"description" |
|
|
1347 | "fork_name" : "<forkname>", | |
|
1348 | "owner" : "<username or user_id = Optional(=apiuser)>", | |
|
1349 | "description" : "<description>", | |
|
1350 | 1350 | "copy_permissions": "<bool>", |
|
1351 |
"private" |
|
|
1352 |
"landing_rev" |
|
|
1351 | "private" : "<bool>", | |
|
1352 | "landing_rev" : "<landing_rev>" | |
|
1353 | 1353 | } |
|
1354 | 1354 | |
|
1355 | 1355 | OUTPUT:: |
|
1356 | 1356 | |
|
1357 | 1357 | id : <id_given_in_input> |
|
1358 | result: { | |
|
1359 | "msg": "Created fork of `<reponame>` as `<forkname>`", | |
|
1360 | "success": true | |
|
1361 | } | |
|
1362 |
error |
|
|
1358 | result : { | |
|
1359 | "msg" : "Created fork of `<reponame>` as `<forkname>`", | |
|
1360 | "success" : true | |
|
1361 | } | |
|
1362 | error : null | |
|
1363 | 1363 | """ |
|
1364 | 1364 | repo = get_repo_or_error(repoid) |
|
1365 | 1365 | repo_name = repo.repo_name |
@@ -1442,11 +1442,11 b' class ApiController(JSONRPCController):' | |||
|
1442 | 1442 | OUTPUT:: |
|
1443 | 1443 | |
|
1444 | 1444 | id : <id_given_in_input> |
|
1445 | result: { | |
|
1446 | "msg": "Deleted repository `<reponame>`", | |
|
1447 | "success": true | |
|
1448 | } | |
|
1449 |
error |
|
|
1445 | result : { | |
|
1446 | "msg" : "Deleted repository `<reponame>`", | |
|
1447 | "success" : true | |
|
1448 | } | |
|
1449 | error : null | |
|
1450 | 1450 | """ |
|
1451 | 1451 | repo = get_repo_or_error(repoid) |
|
1452 | 1452 | |
@@ -1496,11 +1496,11 b' class ApiController(JSONRPCController):' | |||
|
1496 | 1496 | OUTPUT:: |
|
1497 | 1497 | |
|
1498 | 1498 | id : <id_given_in_input> |
|
1499 | result: { | |
|
1499 | result : { | |
|
1500 | 1500 | "msg" : "Granted perm: `<perm>` for user: `<username>` in repo: `<reponame>`", |
|
1501 | "success": true | |
|
1502 | } | |
|
1503 |
error |
|
|
1501 | "success" : true | |
|
1502 | } | |
|
1503 | error : null | |
|
1504 | 1504 | """ |
|
1505 | 1505 | repo = get_repo_or_error(repoid) |
|
1506 | 1506 | user = get_user_or_error(userid) |
@@ -1538,11 +1538,11 b' class ApiController(JSONRPCController):' | |||
|
1538 | 1538 | OUTPUT:: |
|
1539 | 1539 | |
|
1540 | 1540 | id : <id_given_in_input> |
|
1541 | result: { | |
|
1541 | result : { | |
|
1542 | 1542 | "msg" : "Revoked perm for user: `<username>` in repo: `<reponame>`", |
|
1543 | "success": true | |
|
1544 | } | |
|
1545 |
error |
|
|
1543 | "success" : true | |
|
1544 | } | |
|
1545 | error : null | |
|
1546 | 1546 | """ |
|
1547 | 1547 | repo = get_repo_or_error(repoid) |
|
1548 | 1548 | user = get_user_or_error(userid) |
@@ -1582,9 +1582,9 b' class ApiController(JSONRPCController):' | |||
|
1582 | 1582 | id : <id_given_in_input> |
|
1583 | 1583 | result : { |
|
1584 | 1584 | "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`", |
|
1585 | "success": true | |
|
1585 | "success" : true | |
|
1586 | 1586 | } |
|
1587 |
error : |
|
|
1587 | error : null | |
|
1588 | 1588 | |
|
1589 | 1589 | ERROR OUTPUT:: |
|
1590 | 1590 | |
@@ -1639,11 +1639,11 b' class ApiController(JSONRPCController):' | |||
|
1639 | 1639 | OUTPUT:: |
|
1640 | 1640 | |
|
1641 | 1641 | id : <id_given_in_input> |
|
1642 | result: { | |
|
1642 | result : { | |
|
1643 | 1643 | "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`", |
|
1644 | "success": true | |
|
1645 | } | |
|
1646 |
error |
|
|
1644 | "success" : true | |
|
1645 | } | |
|
1646 | error : null | |
|
1647 | 1647 | """ |
|
1648 | 1648 | repo = get_repo_or_error(repoid) |
|
1649 | 1649 | user_group = get_user_group_or_error(usergroupid) |
@@ -1744,10 +1744,10 b' class ApiController(JSONRPCController):' | |||
|
1744 | 1744 | |
|
1745 | 1745 | id : <id_given_in_input> |
|
1746 | 1746 | result : { |
|
1747 | "msg": "created new repo group `<repo_group_name>`" | |
|
1748 | "repo_group": <repogroup_object> | |
|
1747 | "msg" : "created new repo group `<repo_group_name>`" | |
|
1748 | "repo_group" : <repogroup_object> | |
|
1749 | 1749 | } |
|
1750 |
error : |
|
|
1750 | error : null | |
|
1751 | 1751 | |
|
1752 | 1752 | ERROR OUTPUT:: |
|
1753 | 1753 | |
@@ -1820,10 +1820,10 b' class ApiController(JSONRPCController):' | |||
|
1820 | 1820 | |
|
1821 | 1821 | id : <id_given_in_input> |
|
1822 | 1822 | result : { |
|
1823 | 'msg': 'deleted repo group ID:<repogroupid> <repogroupname> | |
|
1824 | 'repo_group': null | |
|
1823 | 'msg' : 'deleted repo group ID:<repogroupid> <repogroupname> | |
|
1824 | 'repo_group' : null | |
|
1825 | 1825 | } |
|
1826 |
error : |
|
|
1826 | error : null | |
|
1827 | 1827 | |
|
1828 | 1828 | ERROR OUTPUT:: |
|
1829 | 1829 | |
@@ -1869,11 +1869,11 b' class ApiController(JSONRPCController):' | |||
|
1869 | 1869 | OUTPUT:: |
|
1870 | 1870 | |
|
1871 | 1871 | id : <id_given_in_input> |
|
1872 | result: { | |
|
1872 | result : { | |
|
1873 | 1873 | "msg" : "Granted perm: `<perm>` (recursive:<apply_to_children>) for user: `<username>` in repo group: `<repo_group_name>`", |
|
1874 | "success": true | |
|
1875 | } | |
|
1876 |
error |
|
|
1874 | "success" : true | |
|
1875 | } | |
|
1876 | error : null | |
|
1877 | 1877 | |
|
1878 | 1878 | ERROR OUTPUT:: |
|
1879 | 1879 | |
@@ -1929,11 +1929,11 b' class ApiController(JSONRPCController):' | |||
|
1929 | 1929 | OUTPUT:: |
|
1930 | 1930 | |
|
1931 | 1931 | id : <id_given_in_input> |
|
1932 | result: { | |
|
1932 | result : { | |
|
1933 | 1933 | "msg" : "Revoked perm (recursive:<apply_to_children>) for user: `<username>` in repo group: `<repo_group_name>`", |
|
1934 | "success": true | |
|
1935 | } | |
|
1936 |
error |
|
|
1934 | "success" : true | |
|
1935 | } | |
|
1936 | error : null | |
|
1937 | 1937 | |
|
1938 | 1938 | ERROR OUTPUT:: |
|
1939 | 1939 | |
@@ -1994,9 +1994,9 b' class ApiController(JSONRPCController):' | |||
|
1994 | 1994 | id : <id_given_in_input> |
|
1995 | 1995 | result : { |
|
1996 | 1996 | "msg" : "Granted perm: `<perm>` (recursive:<apply_to_children>) for user group: `<usersgroupname>` in repo group: `<repo_group_name>`", |
|
1997 | "success": true | |
|
1997 | "success" : true | |
|
1998 | 1998 | } |
|
1999 |
error : |
|
|
1999 | error : null | |
|
2000 | 2000 | |
|
2001 | 2001 | ERROR OUTPUT:: |
|
2002 | 2002 | |
@@ -2059,11 +2059,11 b' class ApiController(JSONRPCController):' | |||
|
2059 | 2059 | OUTPUT:: |
|
2060 | 2060 | |
|
2061 | 2061 | id : <id_given_in_input> |
|
2062 | result: { | |
|
2062 | result : { | |
|
2063 | 2063 | "msg" : "Revoked perm (recursive:<apply_to_children>) for user group: `<usersgroupname>` in repo group: `<repo_group_name>`", |
|
2064 | "success": true | |
|
2065 | } | |
|
2066 |
error |
|
|
2064 | "success" : true | |
|
2065 | } | |
|
2066 | error : null | |
|
2067 | 2067 | |
|
2068 | 2068 | ERROR OUTPUT:: |
|
2069 | 2069 | |
@@ -2169,10 +2169,10 b' class ApiController(JSONRPCController):' | |||
|
2169 | 2169 | |
|
2170 | 2170 | id : <id_given_in_input> |
|
2171 | 2171 | result : { |
|
2172 | "msg": "created new gist", | |
|
2173 | "gist": <gist_object> | |
|
2172 | "msg" : "created new gist", | |
|
2173 | "gist" : <gist_object> | |
|
2174 | 2174 | } |
|
2175 |
error : |
|
|
2175 | error : null | |
|
2176 | 2176 | |
|
2177 | 2177 | ERROR OUTPUT:: |
|
2178 | 2178 | |
@@ -2215,10 +2215,10 b' class ApiController(JSONRPCController):' | |||
|
2215 | 2215 | |
|
2216 | 2216 | id : <id_given_in_input> |
|
2217 | 2217 | result : { |
|
2218 | "msg": "deleted gist ID: <gist_id>", | |
|
2219 | "gist": null | |
|
2218 | "msg" : "deleted gist ID: <gist_id>", | |
|
2219 | "gist" : null | |
|
2220 | 2220 | } |
|
2221 |
error : |
|
|
2221 | error : null | |
|
2222 | 2222 | |
|
2223 | 2223 | ERROR OUTPUT:: |
|
2224 | 2224 |
General Comments 0
You need to be logged in to leave comments.
Login now