Mercurial > kallithea

comparison docs/api/api.rst @ 6654:bf9900e6e177

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
api: add option to get pullrequests for get_repo
author domruf <dominikruf@gmail.com>
date Wed, 29 Mar 2017 22:12:50 +0200
parents 98d26beb0965
children 6452215a54ee
comparison
equal deleted inserted replaced
6653:98d26beb0965 6654:bf9900e6e177
586 api_key : "<api_key>" 586 api_key : "<api_key>"
587 method : "get_repo" 587 method : "get_repo"
588 args: { 588 args: {
589 "repoid" : "<reponame or repo_id>", 589 "repoid" : "<reponame or repo_id>",
590 "with_revision_names": "<bool> = Optional(False)", 590 "with_revision_names": "<bool> = Optional(False)",
591 "with_pullrequests": "<bool> = Optional(False)",
591 } 592 }
592 593
593 OUTPUT:: 594 OUTPUT::
594 595
595 id : <id_given_in_input> 596 id : <id_given_in_input>
670 }, 671 },
671 "bookmarks": { 672 "bookmarks": {
672 "<bookmarkname>": "<raw_id>", 673 "<bookmarkname>": "<raw_id>",
673 ... 674 ...
674 }, 675 },
676 <if with_pullrequests == True>
677 "pull_requests": [
678 {
679 "status": "<pull_request_status>",
680 "pull_request_id": <pull_request_id>,
681 "description": "<pull_request_description>",
682 "title": "<pull_request_title>",
683 "url": "<pull_request_url>",
684 "reviewers": [
685 {
686 "username": "<user_id>",
687 },
688 ...
689 ],
690 "org_repo_url": "<repo_url>",
691 "org_ref_parts": [
692 "<ref_type>",
693 "<ref_name>",
694 "<raw_id>"
695 ],
696 "other_ref_parts": [
697 "<ref_type>",
698 "<ref_name>",
699 "<raw_id>"
700 ],
701 "comments": [
702 {
703 "username": "<user_id>",
704 "text": "<comment text>",
705 "comment_id": "<comment_id>",
706 },
707 ...
708 ],
709 "owner": "<username>",
710 "statuses": [
711 {
712 "status": "<status_of_review>", # "under_review", "approved" or "rejected"
713 "reviewer": "<user_id>",
714 "modified_at": "<date_time_of_review>" # iso 8601 date, server's timezone
715 },
716 ...
717 ],
718 "revisions": [
719 "<raw_id>",
720 ...
721 ]
722 },
723 ...
724 ]
675 } 725 }
676 error: null 726 error: null
677 727
678 get_repos 728 get_repos
679 ^^^^^^^^^ 729 ^^^^^^^^^