Mercurial > kallithea

comparison docs/api/api.rst @ 8935:ba64339f7937 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
api docs: make examples more like 4 space indented
author Mads Kiilerich <mads@kiilerich.com>
date Fri, 14 Oct 2022 14:02:15 +0200
parents 6f9dec2295dc
children ac5525c48f0a
comparison
equal deleted inserted replaced
8934:6f9dec2295dc 8935:ba64339f7937
573 "private": "<bool>", 573 "private": "<bool>",
574 "created_on" : "<date_time_created>", 574 "created_on" : "<date_time_created>",
575 "description" : "<description>", 575 "description" : "<description>",
576 "landing_rev": "<landing_rev>", 576 "landing_rev": "<landing_rev>",
577 "last_changeset": { 577 "last_changeset": {
578 "author": "<full_author>", 578 "author": "<full_author>",
579 "date": "<date_time_of_commit>", 579 "date": "<date_time_of_commit>",
580 "message": "<commit_message>", 580 "message": "<commit_message>",
581 "raw_id": "<raw_id>", 581 "raw_id": "<raw_id>",
582 "revision": "<numeric_revision>", 582 "revision": "<numeric_revision>",
583 "short_id": "<short_id>" 583 "short_id": "<short_id>"
584 }, 584 },
585 "owner": "<repo_owner>", 585 "owner": "<repo_owner>",
586 "fork_of": "<name_of_fork_parent>", 586 "fork_of": "<name_of_fork_parent>",
587 "members" : [ 587 "members" : [
588 { 588 {
589 "type": "user", 589 "type": "user",
590 "user_id" : "<user_id>", 590 "user_id" : "<user_id>",
591 "api_key" : "<api_key>", 591 "api_key" : "<api_key>",
592 "username" : "<username>", 592 "username" : "<username>",
607 "name" : "<usersgroupname>", 607 "name" : "<usersgroupname>",
608 "active": "<bool>", 608 "active": "<bool>",
609 "permission" : "repository.(read|write|admin)" 609 "permission" : "repository.(read|write|admin)"
610 }, 610 },
611 … 611 …
612 ], 612 ],
613 "followers": [ 613 "followers": [
614 { 614 {
615 "user_id" : "<user_id>", 615 "user_id" : "<user_id>",
616 "username" : "<username>", 616 "username" : "<username>",
617 "api_key" : "<api_key>", 617 "api_key" : "<api_key>",
618 "firstname": "<firstname>", 618 "firstname": "<firstname>",
624 "admin" : "<bool>", 624 "admin" : "<bool>",
625 "ldap_dn" : "<ldap_dn>", 625 "ldap_dn" : "<ldap_dn>",
626 "last_login": "<last_login>", 626 "last_login": "<last_login>",
627 }, 627 },
628 … 628 …
629 ], 629 ],
630 <if with_revision_names == True> 630 <if with_revision_names == True>
631 "tags": { 631 "tags": {
632 "<tagname>": "<raw_id>", 632 "<tagname>": "<raw_id>",
633 ... 633 ...
634 }, 634 },
635 "branches": { 635 "branches": {
636 "<branchname>": "<raw_id>", 636 "<branchname>": "<raw_id>",
637 ... 637 ...
638 }, 638 },
639 "bookmarks": { 639 "bookmarks": {
640 "<bookmarkname>": "<raw_id>", 640 "<bookmarkname>": "<raw_id>",
641 ... 641 ...
642 }, 642 },
643 <if with_pullrequests == True> 643 <if with_pullrequests == True>
644 "pull_requests": [ 644 "pull_requests": [
645 { 645 {
646 "status": "<pull_request_status>", 646 "status": "<pull_request_status>",
647 "pull_request_id": <pull_request_id>, 647 "pull_request_id": <pull_request_id>,