Mercurial > kallithea
comparison docs/api/api.rst @ 6683:19bc05bd8cf7
api: add get_changesets
| author | domruf <dominikruf@gmail.com> |
|---|---|
| date | Tue, 06 Jun 2017 19:40:18 +0200 |
| parents | 6452215a54ee |
| children | caa482f8fb5f |
comparison
equal
deleted
inserted
replaced
| 6682:d18dfba3c245 | 6683:19bc05bd8cf7 |
|---|---|
| 1069 "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`", | 1069 "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`", |
| 1070 "success": true | 1070 "success": true |
| 1071 } | 1071 } |
| 1072 error: null | 1072 error: null |
| 1073 | 1073 |
| 1074 get_changesets | |
| 1075 ^^^^^^^^^^^^^^ | |
| 1076 | |
| 1077 Get changesets of a given repository. This command can only be executed using the api_key | |
| 1078 of a user with read permissions to the repository. | |
| 1079 | |
| 1080 INPUT:: | |
| 1081 | |
| 1082 id : <id_for_response> | |
| 1083 api_key : "<api_key>" | |
| 1084 method : "get_changesets" | |
| 1085 args: { | |
| 1086 "repoid" : "<reponame or repo_id>", | |
| 1087 "start": "<revision number> = Optional(None)", | |
| 1088 "end": "<revision number> = Optional(None)", | |
| 1089 "start_date": "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format | |
| 1090 "end_date": "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format | |
| 1091 "branch_name": "<branch name filter> = Optional(None)", | |
| 1092 "reverse": "<bool> = Optional(False)", | |
| 1093 "with_file_list": "<bool> = Optional(False)" | |
| 1094 } | |
| 1095 | |
| 1096 OUTPUT:: | |
| 1097 | |
| 1098 id : <id_given_in_input> | |
| 1099 result: [ | |
| 1100 { | |
| 1101 "raw_id": "<raw_id>", | |
| 1102 "short_id": "short_id": "<short_id>", | |
| 1103 "author": "<full_author>", | |
| 1104 "date": "<date_time_of_commit>", | |
| 1105 "message": "<commit_message>", | |
| 1106 "revision": "<numeric_revision>", | |
| 1107 <if with_file_list == True> | |
| 1108 "added": [<list of added files>], | |
| 1109 "changed": [<list of changed files>], | |
| 1110 "removed": [<list of removed files>] | |
| 1111 }, | |
| 1112 ... | |
| 1113 ] | |
| 1114 error: null | |
| 1115 | |
| 1074 get_changeset | 1116 get_changeset |
| 1075 ^^^^^^^^^^^^^ | 1117 ^^^^^^^^^^^^^ |
| 1076 | 1118 |
| 1077 Get information and review status for a given changeset. This command can only | 1119 Get information and review status for a given changeset. This command can only |
| 1078 be executed using the api_key of a user with read permissions to the | 1120 be executed using the api_key of a user with read permissions to the |