Mercurial > kallithea
changeset 8936:ac5525c48f0a stable
api docs: more consistent use of space around ":" in examples
The examples are informal pseudo code - not json and not python. But let's try
to be consistent anyway.
| author | Mads Kiilerich <mads@kiilerich.com> |
|---|---|
| date | Fri, 14 Oct 2022 14:25:12 +0200 |
| parents | ba64339f7937 |
| children | 2dd317e9cc4b |
| files | docs/api/api.rst kallithea/controllers/api/api.py |
| diffstat | 2 files changed, 424 insertions(+), 424 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/api/api.rst Fri Oct 14 14:02:15 2022 +0200 +++ b/docs/api/api.rst Fri Oct 14 14:25:12 2022 +0200 @@ -115,7 +115,7 @@ id : <id_given_in_input> result : "Pulled from `<reponame>`" - error : null + error : null rescan_repos ^^^^^^^^^^^^ @@ -138,7 +138,7 @@ id : <id_given_in_input> result : "{'added': [<list of names of added repos>], 'removed': [<list of names of removed repos>]}" - error : null + error : null invalidate_cache ^^^^^^^^^^^^^^^^ @@ -160,7 +160,7 @@ id : <id_given_in_input> result : "Caches of repository `<reponame>`" - error : null + error : null get_ip ^^^^^^ @@ -182,16 +182,16 @@ id : <id_given_in_input> result : { - "ip_addr_server": <ip_from_client>", - "user_ips": [ + "ip_addr_server" : <ip_from_client>", + "user_ips" : [ { - "ip_addr": "<ip_with_mask>", - "ip_range": ["<start_ip>", "<end_ip>"], + "ip_addr" : "<ip_with_mask>", + "ip_range" : ["<start_ip>", "<end_ip>"], }, ... - ] + ] } - error : null + error : null get_user ^^^^^^^^ @@ -213,29 +213,29 @@ OUTPUT:: id : <id_given_in_input> - result: None if user does not exist or - { + result : None if user does not exist or + { "user_id" : "<user_id>", "api_key" : "<api_key>", "username" : "<username>", - "firstname": "<firstname>", + "firstname" : "<firstname>", "lastname" : "<lastname>", "email" : "<email>", - "emails": "<list_of_all_additional_emails>", + "emails" : "<list_of_all_additional_emails>", "ip_addresses": "<list_of_ip_addresses_for_user>", "active" : "<bool>", "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", - "last_login": "<last_login>", + "last_login" : "<last_login>", "permissions": { "global": ["hg.create.repository", "repository.read", "hg.register.manual_activate"], - "repositories": {"repo1": "repository.none"}, - "repositories_groups": {"Group1": "group.read"} + "repositories" : {"repo1" : "repository.none"}, + "repositories_groups" : {"Group1" : "group.read"} }, - } - error: null + } + error : null get_users ^^^^^^^^^ @@ -253,24 +253,24 @@ OUTPUT:: id : <id_given_in_input> - result: [ + result : [ { "user_id" : "<user_id>", "api_key" : "<api_key>", "username" : "<username>", - "firstname": "<firstname>", + "firstname" : "<firstname>", "lastname" : "<lastname>", "email" : "<email>", - "emails": "<list_of_all_additional_emails>", + "emails" : "<list_of_all_additional_emails>", "ip_addresses": "<list_of_ip_addresses_for_user>", "active" : "<bool>", "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", - "last_login": "<last_login>", + "last_login" : "<last_login>", }, … - ] - error: null + ] + error : null .. _create-user: @@ -299,22 +299,22 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "created new user `<username>`", - "user": { + "user" : { "user_id" : "<user_id>", "username" : "<username>", "firstname": "<firstname>", "lastname" : "<lastname>", "email" : "<email>", - "emails": "<list_of_all_additional_emails>", + "emails" : "<list_of_all_additional_emails>", "active" : "<bool>", "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", "last_login": "<last_login>", }, - } - error: null + } + error : null Example:: @@ -346,23 +346,23 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "updated user ID:<userid> <username>", - "user": { + "user" : { "user_id" : "<user_id>", "api_key" : "<api_key>", "username" : "<username>", "firstname": "<firstname>", "lastname" : "<lastname>", "email" : "<email>", - "emails": "<list_of_all_additional_emails>", + "emails" : "<list_of_all_additional_emails>", "active" : "<bool>", "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", "last_login": "<last_login>", }, - } - error: null + } + error : null delete_user ^^^^^^^^^^^ @@ -382,11 +382,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "deleted user ID:<userid> <username>", - "user": null - } - error: null + "user" : null + } + error : null get_user_group ^^^^^^^^^^^^^^ @@ -410,7 +410,7 @@ { "users_group_id" : "<id>", "group_name" : "<groupname>", - "active": "<bool>", + "active" : "<bool>", "members" : [ { "user_id" : "<user_id>", @@ -419,7 +419,7 @@ "firstname": "<firstname>", "lastname" : "<lastname>", "email" : "<email>", - "emails": "<list_of_all_additional_emails>", + "emails" : "<list_of_all_additional_emails>", "active" : "<bool>", "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", @@ -450,7 +450,7 @@ { "users_group_id" : "<id>", "group_name" : "<groupname>", - "active": "<bool>", + "active" : "<bool>", }, … ] @@ -467,24 +467,24 @@ id : <id_for_response> api_key : "<api_key>" method : "create_user_group" - args: { + args : { "group_name": "<groupname>", "owner" : "<owner_name_or_id = Optional(=apiuser)>", - "active": "<bool> = Optional(True)" + "active" : "<bool> = Optional(True)" } OUTPUT:: id : <id_given_in_input> - result: { - "msg": "created new user group `<groupname>`", - "users_group": { + result : { + "msg" : "created new user group `<groupname>`", + "users_group" : { "users_group_id" : "<id>", "group_name" : "<groupname>", - "active": "<bool>", + "active" : "<bool>", }, - } - error: null + } + error : null add_user_to_user_group ^^^^^^^^^^^^^^^^^^^^^^ @@ -498,7 +498,7 @@ id : <id_for_response> api_key : "<api_key>" method : "add_user_user_group" - args: { + args : { "usersgroupid" : "<user group id or name>", "userid" : "<user_id or username>", } @@ -506,12 +506,12 @@ OUTPUT:: id : <id_given_in_input> - result: { - "success": True|False # depends on if member is in group - "msg": "added member `<username>` to a user group `<groupname>` | - User is already in that group" - } - error: null + result : { + "success" : True|False # depends on if member is in group + "msg" : "added member `<username>` to a user group `<groupname>` | + User is already in that group" + } + error : null remove_user_from_user_group ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -525,7 +525,7 @@ id : <id_for_response> api_key : "<api_key>" method : "remove_user_from_user_group" - args: { + args : { "usersgroupid" : "<user group id or name>", "userid" : "<user_id or username>", } @@ -533,12 +533,12 @@ OUTPUT:: id : <id_given_in_input> - result: { - "success": True|False, # depends on if member is in group - "msg": "removed member <username> from user group <groupname> | - User wasn't in group" - } - error: null + result : { + "success" : True|False, # depends on if member is in group + "msg" : "removed member <username> from user group <groupname> | + User wasn't in group" + } + error : null get_repo ^^^^^^^^ @@ -553,144 +553,144 @@ id : <id_for_response> api_key : "<api_key>" method : "get_repo" - args: { + args : { "repoid" : "<reponame or repo_id>", - "with_revision_names": "<bool> = Optional(False)", - "with_pullrequests": "<bool> = Optional(False)", + "with_revision_names" : "<bool> = Optional(False)", + "with_pullrequests" : "<bool> = Optional(False)", } OUTPUT:: id : <id_given_in_input> - result: None if repository does not exist or - { + result : None if repository does not exist or + { "repo_id" : "<repo_id>", "repo_name" : "<reponame>" "repo_type" : "<repo_type>", "clone_uri" : "<clone_uri>", - "enable_downloads": "<bool>", + "enable_downloads" : "<bool>", "enable_statistics": "<bool>", - "private": "<bool>", + "private" : "<bool>", "created_on" : "<date_time_created>", "description" : "<description>", - "landing_rev": "<landing_rev>", - "last_changeset": { - "author": "<full_author>", - "date": "<date_time_of_commit>", - "message": "<commit_message>", - "raw_id": "<raw_id>", + "landing_rev" : "<landing_rev>", + "last_changeset" : { + "author" : "<full_author>", + "date" : "<date_time_of_commit>", + "message" : "<commit_message>", + "raw_id" : "<raw_id>", "revision": "<numeric_revision>", "short_id": "<short_id>" }, - "owner": "<repo_owner>", - "fork_of": "<name_of_fork_parent>", + "owner" : "<repo_owner>", + "fork_of" : "<name_of_fork_parent>", "members" : [ { - "type": "user", + "type" : "user", "user_id" : "<user_id>", "api_key" : "<api_key>", "username" : "<username>", - "firstname": "<firstname>", + "firstname" : "<firstname>", "lastname" : "<lastname>", "email" : "<email>", - "emails": "<list_of_all_additional_emails>", + "emails" : "<list_of_all_additional_emails>", "active" : "<bool>", "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", - "last_login": "<last_login>", + "last_login" : "<last_login>", "permission" : "repository.(read|write|admin)" }, … { - "type": "users_group", + "type" : "users_group", "id" : "<usersgroupid>", "name" : "<usersgroupname>", - "active": "<bool>", + "active" : "<bool>", "permission" : "repository.(read|write|admin)" }, … ], - "followers": [ + "followers" : [ { "user_id" : "<user_id>", "username" : "<username>", "api_key" : "<api_key>", - "firstname": "<firstname>", + "firstname" : "<firstname>", "lastname" : "<lastname>", "email" : "<email>", - "emails": "<list_of_all_additional_emails>", + "emails" : "<list_of_all_additional_emails>", "ip_addresses": "<list_of_ip_addresses_for_user>", "active" : "<bool>", "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", - "last_login": "<last_login>", + "last_login" : "<last_login>", }, … ], <if with_revision_names == True> - "tags": { - "<tagname>": "<raw_id>", + "tags" : { + "<tagname>" : "<raw_id>", ... }, - "branches": { - "<branchname>": "<raw_id>", + "branches" : { + "<branchname>" : "<raw_id>", ... }, - "bookmarks": { - "<bookmarkname>": "<raw_id>", + "bookmarks" : { + "<bookmarkname>" : "<raw_id>", ... }, <if with_pullrequests == True> - "pull_requests": [ + "pull_requests" : [ { - "status": "<pull_request_status>", - "pull_request_id": <pull_request_id>, - "description": "<pull_request_description>", - "title": "<pull_request_title>", - "url": "<pull_request_url>", - "reviewers": [ + "status" : "<pull_request_status>", + "pull_request_id" : <pull_request_id>, + "description" : "<pull_request_description>", + "title" : "<pull_request_title>", + "url" : "<pull_request_url>", + "reviewers" : [ { - "username": "<user_id>", + "username" : "<user_id>", }, ... ], - "org_repo_url": "<repo_url>", - "org_ref_parts": [ + "org_repo_url" : "<repo_url>", + "org_ref_parts" : [ "<ref_type>", "<ref_name>", "<raw_id>" ], - "other_ref_parts": [ + "other_ref_parts" : [ "<ref_type>", "<ref_name>", "<raw_id>" ], - "comments": [ + "comments" : [ { - "username": "<user_id>", - "text": "<comment text>", - "comment_id": "<comment_id>", + "username" : "<user_id>", + "text" : "<comment text>", + "comment_id" : "<comment_id>", }, ... ], - "owner": "<username>", - "statuses": [ + "owner" : "<username>", + "statuses" : [ { - "status": "<status_of_review>", # "under_review", "approved" or "rejected" - "reviewer": "<user_id>", - "modified_at": "<date_time_of_review>" # iso 8601 date, server's timezone + "status" : "<status_of_review>", # "under_review", "approved" or "rejected" + "reviewer" : "<user_id>", + "modified_at" : "<date_time_of_review>" # iso 8601 date, server's timezone }, ... ], - "revisions": [ + "revisions" : [ "<raw_id>", ... ] }, ... ] - } - error: null + } + error : null get_repos ^^^^^^^^^ @@ -704,12 +704,12 @@ id : <id_for_response> api_key : "<api_key>" method : "get_repos" - args: { } + args : { } OUTPUT:: id : <id_given_in_input> - result: [ + result : [ { "repo_id" : "<repo_id>", "repo_name" : "<reponame>" @@ -718,15 +718,15 @@ "private" : "<bool>", "created_on" : "<datetimecreated>", "description" : "<description>", - "landing_rev": "<landing_rev>", - "owner": "<repo_owner>", - "fork_of": "<name_of_fork_parent>", - "enable_downloads": "<bool>", + "landing_rev" : "<landing_rev>", + "owner" : "<repo_owner>", + "fork_of" : "<name_of_fork_parent>", + "enable_downloads" : "<bool>", "enable_statistics": "<bool>", }, … - ] - error: null + ] + error : null get_repo_nodes ^^^^^^^^^^^^^^ @@ -740,24 +740,24 @@ id : <id_for_response> api_key : "<api_key>" method : "get_repo_nodes" - args: { + args : { "repoid" : "<reponame or repo_id>" - "revision" : "<revision>", + "revision" : "<revision>", "root_path" : "<root_path>", - "ret_type" : "<ret_type> = Optional('all')" + "ret_type" : "<ret_type> = Optional('all')" } OUTPUT:: id : <id_given_in_input> - result: [ + result : [ { "name" : "<name>" "type" : "<type>", }, … - ] - error: null + ] + error : null create_repo ^^^^^^^^^^^ @@ -777,7 +777,7 @@ id : <id_for_response> api_key : "<api_key>" method : "create_repo" - args: { + args : { "repo_name" : "<reponame>", "owner" : "<owner_name_or_id = Optional(=apiuser)>", "repo_type" : "<repo_type> = Optional('hg')", @@ -785,16 +785,16 @@ "private" : "<bool> = Optional(False)", "clone_uri" : "<clone_uri> = Optional(None)", "landing_rev" : "<landing_rev> = Optional('tip')", - "enable_downloads": "<bool> = Optional(False)", + "enable_downloads" : "<bool> = Optional(False)", "enable_statistics": "<bool> = Optional(False)", } OUTPUT:: id : <id_given_in_input> - result: { - "msg": "Created new repository `<reponame>`", - "repo": { + result : { + "msg" : "Created new repository `<reponame>`", + "repo" : { "repo_id" : "<repo_id>", "repo_name" : "<reponame>" "repo_type" : "<repo_type>", @@ -802,14 +802,14 @@ "private" : "<bool>", "created_on" : "<datetimecreated>", "description" : "<description>", - "landing_rev": "<landing_rev>", - "owner": "<username or user_id>", - "fork_of": "<name_of_fork_parent>", - "enable_downloads": "<bool>", + "landing_rev" : "<landing_rev>", + "owner" : "<username or user_id>", + "fork_of" : "<name_of_fork_parent>", + "enable_downloads" : "<bool>", "enable_statistics": "<bool>", }, - } - error: null + } + error : null update_repo ^^^^^^^^^^^ @@ -824,7 +824,7 @@ id : <id_for_response> api_key : "<api_key>" method : "update_repo" - args: { + args : { "repoid" : "<reponame or repo_id>" "name" : "<reponame> = Optional('')", "group" : "<group_id> = Optional(None)", @@ -833,39 +833,39 @@ "private" : "<bool> = Optional(False)", "clone_uri" : "<clone_uri> = Optional(None)", "landing_rev" : "<landing_rev> = Optional('tip')", - "enable_downloads": "<bool> = Optional(False)", + "enable_downloads" : "<bool> = Optional(False)", "enable_statistics": "<bool> = Optional(False)", } OUTPUT:: id : <id_given_in_input> - result: { - "msg": "updated repo ID:repo_id `<reponame>`", - "repository": { + result : { + "msg" : "updated repo ID:repo_id `<reponame>`", + "repository" : { "repo_id" : "<repo_id>", "repo_name" : "<reponame>" "repo_type" : "<repo_type>", "clone_uri" : "<clone_uri>", - "private": "<bool>", + "private" : "<bool>", "created_on" : "<datetimecreated>", "description" : "<description>", - "landing_rev": "<landing_rev>", - "owner": "<username or user_id>", - "fork_of": "<name_of_fork_parent>", - "enable_downloads": "<bool>", + "landing_rev" : "<landing_rev>", + "owner" : "<username or user_id>", + "fork_of" : "<name_of_fork_parent>", + "enable_downloads" : "<bool>", "enable_statistics": "<bool>", - "last_changeset": { - "author": "<full_author>", - "date": "<date_time_of_commit>", - "message": "<commit_message>", - "raw_id": "<raw_id>", + "last_changeset" : { + "author" : "<full_author>", + "date" : "<date_time_of_commit>", + "message" : "<commit_message>", + "raw_id" : "<raw_id>", "revision": "<numeric_revision>", "short_id": "<short_id>" } }, - } - error: null + } + error : null fork_repo ^^^^^^^^^ @@ -883,24 +883,24 @@ id : <id_for_response> api_key : "<api_key>" method : "fork_repo" - args: { + args : { "repoid" : "<reponame or repo_id>", - "fork_name": "<forkname>", - "owner": "<username or user_id = Optional(=apiuser)>", - "description": "<description>", + "fork_name" : "<forkname>", + "owner" : "<username or user_id = Optional(=apiuser)>", + "description" : "<description>", "copy_permissions": "<bool>", - "private": "<bool>", - "landing_rev": "<landing_rev>" + "private" : "<bool>", + "landing_rev" : "<landing_rev>" } OUTPUT:: id : <id_given_in_input> - result: { - "msg": "Created fork of `<reponame>` as `<forkname>`", - "success": true - } - error: null + result : { + "msg" : "Created fork of `<reponame>` as `<forkname>`", + "success" : true + } + error : null delete_repo ^^^^^^^^^^^ @@ -915,19 +915,19 @@ id : <id_for_response> api_key : "<api_key>" method : "delete_repo" - args: { + args : { "repoid" : "<reponame or repo_id>", - "forks" : "`delete` or `detach` = Optional(None)" + "forks" : "`delete` or `detach` = Optional(None)" } OUTPUT:: id : <id_given_in_input> - result: { - "msg": "Deleted repository `<reponame>`", - "success": true - } - error: null + result : { + "msg" : "Deleted repository `<reponame>`", + "success" : true + } + error : null grant_user_permission ^^^^^^^^^^^^^^^^^^^^^ @@ -940,7 +940,7 @@ id : <id_for_response> api_key : "<api_key>" method : "grant_user_permission" - args: { + args : { "repoid" : "<reponame or repo_id>" "userid" : "<username or user_id>" "perm" : "(repository.(none|read|write|admin))", @@ -949,11 +949,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Granted perm: `<perm>` for user: `<username>` in repo: `<reponame>`", - "success": true - } - error: null + "success" : true + } + error : null revoke_user_permission ^^^^^^^^^^^^^^^^^^^^^^ @@ -965,8 +965,8 @@ id : <id_for_response> api_key : "<api_key>" - method : "revoke_user_permission" - args: { + method : "revoke_user_permission" + args : { "repoid" : "<reponame or repo_id>" "userid" : "<username or user_id>" } @@ -974,11 +974,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Revoked perm for user: `<username>` in repo: `<reponame>`", - "success": true - } - error: null + "success" : true + } + error : null grant_user_group_permission ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -992,7 +992,7 @@ id : <id_for_response> api_key : "<api_key>" method : "grant_user_group_permission" - args: { + args : { "repoid" : "<reponame or repo_id>" "usersgroupid" : "<user group id or name>" "perm" : "(repository.(none|read|write|admin))", @@ -1001,11 +1001,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`", - "success": true - } - error: null + "success" : true + } + error : null revoke_user_group_permission ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -1017,8 +1017,8 @@ id : <id_for_response> api_key : "<api_key>" - method : "revoke_user_group_permission" - args: { + method : "revoke_user_group_permission" + args : { "repoid" : "<reponame or repo_id>" "usersgroupid" : "<user group id or name>" } @@ -1026,11 +1026,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`", - "success": true - } - error: null + "success" : true + } + error : null get_changesets ^^^^^^^^^^^^^^ @@ -1042,37 +1042,37 @@ id : <id_for_response> api_key : "<api_key>" - method : "get_changesets" - args: { + method : "get_changesets" + args : { "repoid" : "<reponame or repo_id>", - "start": "<revision number> = Optional(None)", - "end": "<revision number> = Optional(None)", - "start_date": "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format - "end_date": "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format - "branch_name": "<branch name filter> = Optional(None)", - "reverse": "<bool> = Optional(False)", - "with_file_list": "<bool> = Optional(False)" + "start" : "<revision number> = Optional(None)", + "end" : "<revision number> = Optional(None)", + "start_date" : "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format + "end_date" : "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format + "branch_name" : "<branch name filter> = Optional(None)", + "reverse" : "<bool> = Optional(False)", + "with_file_list" : "<bool> = Optional(False)" } OUTPUT:: id : <id_given_in_input> - result: [ + result : [ { - "raw_id": "<raw_id>", - "short_id": "<short_id>", - "author": "<full_author>", - "date": "<date_time_of_commit>", - "message": "<commit_message>", - "revision": "<numeric_revision>", + "raw_id" : "<raw_id>", + "short_id" : "<short_id>", + "author" : "<full_author>", + "date" : "<date_time_of_commit>", + "message" : "<commit_message>", + "revision" : "<numeric_revision>", <if with_file_list == True> - "added": [<list of added files>], - "changed": [<list of changed files>], - "removed": [<list of removed files>] + "added" : [<list of added files>], + "changed" : [<list of changed files>], + "removed" : [<list of removed files>] }, ... ] - error: null + error : null get_changeset ^^^^^^^^^^^^^ @@ -1085,32 +1085,32 @@ id : <id_for_response> api_key : "<api_key>" - method : "get_changeset" - args: { + method : "get_changeset" + args : { "repoid" : "<reponame or repo_id>", "raw_id" : "<raw_id>", - "with_reviews": "<bool> = Optional(False)" + "with_reviews" : "<bool> = Optional(False)" } OUTPUT:: id : <id_given_in_input> - result: { - "author": "<full_author>", - "date": "<date_time_of_commit>", - "message": "<commit_message>", - "raw_id": "<raw_id>", + result : { + "author" : "<full_author>", + "date" : "<date_time_of_commit>", + "message" : "<commit_message>", + "raw_id" : "<raw_id>", "revision": "<numeric_revision>", "short_id": "<short_id>", - "reviews": [{ - "reviewer": "<username>", - "modified_at": "<date_time_of_review>", # iso 8601 date, server's timezone - "status": "<status_of_review>", # "under_review", "approved" or "rejected" + "reviews" : [{ + "reviewer" : "<username>", + "modified_at" : "<date_time_of_review>", # iso 8601 date, server's timezone + "status" : "<status_of_review>", # "under_review", "approved" or "rejected" }, ... ] - } - error: null + } + error : null Example output:: @@ -1153,60 +1153,60 @@ id : <id_for_response> api_key : "<api_key>" - method : "get_pullrequest" - args: { + method : "get_pullrequest" + args : { "pullrequest_id" : "<pullrequest_id>", } OUTPUT:: id : <id_given_in_input> - result: { - "status": "<pull_request_status>", - "pull_request_id": <pull_request_id>, - "description": "<pull_request_description>", - "title": "<pull_request_title>", - "url": "<pull_request_url>", - "reviewers": [ + result : { + "status" : "<pull_request_status>", + "pull_request_id" : <pull_request_id>, + "description" : "<pull_request_description>", + "title" : "<pull_request_title>", + "url" : "<pull_request_url>", + "reviewers" : [ { - "username": "<user_name>", + "username" : "<user_name>", }, ... ], - "org_repo_url": "<repo_url>", - "org_ref_parts": [ + "org_repo_url" : "<repo_url>", + "org_ref_parts" : [ "<ref_type>", "<ref_name>", "<raw_id>" ], - "other_ref_parts": [ + "other_ref_parts" : [ "<ref_type>", "<ref_name>", "<raw_id>" ], - "comments": [ + "comments" : [ { - "username": "<user_name>", - "text": "<comment text>", - "comment_id": "<comment_id>", + "username" : "<user_name>", + "text" : "<comment text>", + "comment_id" : "<comment_id>", }, ... ], - "owner": "<username>", - "statuses": [ + "owner" : "<username>", + "statuses" : [ { - "status": "<status_of_review>", # "under_review", "approved" or "rejected" - "reviewer": "<user_name>", - "modified_at": "<date_time_of_review>" # iso 8601 date, server's timezone + "status" : "<status_of_review>", # "under_review", "approved" or "rejected" + "reviewer" : "<user_name>", + "modified_at" : "<date_time_of_review>" # iso 8601 date, server's timezone }, ... ], - "revisions": [ + "revisions" : [ "<raw_id>", ... ] }, - error: null + error : null comment_pullrequest ^^^^^^^^^^^^^^^^^^^ @@ -1218,19 +1218,19 @@ id : <id_for_response> api_key : "<api_key>" - method : "comment_pullrequest" - args: { - "pull_request_id": "<pull_request_id>", - "comment_msg": Optional(''), - "status": Optional(None), # "under_review", "approved" or "rejected" - "close_pr": Optional(False)", + method : "comment_pullrequest" + args : { + "pull_request_id" : "<pull_request_id>", + "comment_msg" : Optional(''), + "status" : Optional(None), # "under_review", "approved" or "rejected" + "close_pr" : Optional(False)", } OUTPUT:: id : <id_given_in_input> - result: True - error: null + result : True + error : null API access for web views
--- a/kallithea/controllers/api/api.py Fri Oct 14 14:02:15 2022 +0200 +++ b/kallithea/controllers/api/api.py Fri Oct 14 14:25:12 2022 +0200 @@ -174,10 +174,10 @@ id : <id_given_in_input> result : { - "msg": "Pulled from `<repository name>`" - "repository": "<repository name>" + "msg" : "Pulled from `<repository name>`" + "repository" : "<repository name>" } - error : null + error : null ERROR OUTPUT:: @@ -223,7 +223,7 @@ 'added': [<added repository name>,...] 'removed': [<removed repository name>,...] } - error : null + error : null ERROR OUTPUT:: @@ -260,7 +260,7 @@ 'msg': Cache for repository `<repository name>` was invalidated, 'repository': <repository name> } - error : null + error : null ERROR OUTPUT:: @@ -303,14 +303,14 @@ id : <id_given_in_input> result : { - "server_ip_addr": "<ip_from_client>", - "user_ips": [ + "server_ip_addr" : "<ip_from_client>", + "user_ips" : [ { - "ip_addr": "<ip_with_mask>", - "ip_range": ["<start_ip>", "<end_ip>"], + "ip_addr" : "<ip_with_mask>", + "ip_range" : ["<start_ip>", "<end_ip>"], }, ... - ] + ] } error : null """ @@ -335,12 +335,12 @@ id : <id_given_in_input> result : { - 'modules': [ [<module name>, <module version>], ...] - 'py_version': <python version>, - 'platform': <platform type>, - 'kallithea_version': <kallithea version>, - 'git_version': '<git version>', - 'git_path': '<git path>' + 'modules' : [ [<module name>, <module version>], ...] + 'py_version' : <python version>, + 'platform' : <platform type>, + 'kallithea_version' : <kallithea version>, + 'git_version' : '<git version>', + 'git_path' : '<git path>' } error : null """ @@ -360,26 +360,26 @@ OUTPUT:: id : <id_given_in_input> - result: None if user does not exist or - { + result : None if user does not exist or + { "user_id" : "<user_id>", "username" : "<username>", - "firstname": "<firstname>", + "firstname" : "<firstname>", "lastname" : "<lastname>", "email" : "<email>", - "emails": "[<list of all emails including additional ones>]", + "emails" : "[<list of all emails including additional ones>]", "active" : "<bool: user active>", "admin" : "<bool: user is admin>", - "permissions": { - "global": ["hg.create.repository", - "repository.read", - "hg.register.manual_activate"], - "repositories": {"repo1": "repository.none"}, - "repositories_groups": {"Group1": "group.read"}, - "user_groups": { "usrgrp1": "usergroup.admin" } + "permissions" : { + "global" : ["hg.create.repository", + "repository.read", + "hg.register.manual_activate"], + "repositories" : {"repo1" : "repository.none"}, + "repositories_groups" : {"Group1" : "group.read"}, + "user_groups" : { "usrgrp1" : "usergroup.admin" } }, - } - error: null + } + error : null """ if not HasPermissionAny('hg.admin')(): # make sure normal user does not pass someone else userid, @@ -406,8 +406,8 @@ OUTPUT:: id : <id_given_in_input> - result: [<user_object>, ...] - error: null + result : [<user_object>, ...] + error : null """ return [ user.get_api_data() @@ -448,11 +448,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "created new user `<username>`", - "user": <user_obj> - } - error: null + "user" : <user_obj> + } + error : null ERROR OUTPUT:: @@ -527,11 +527,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "updated user ID:<userid> <username>", - "user": <user_object>, - } - error: null + "user" : <user_object>, + } + error : null ERROR OUTPUT:: @@ -583,11 +583,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "deleted user ID:<userid> <username>", - "user": null - } - error: null + "user" : null + } + error : null ERROR OUTPUT:: @@ -629,10 +629,10 @@ { "users_group_id" : "<id>", "group_name" : "<groupname>", - "group_description": "<description>" - "active": "<bool>", - "owner": "<username>" - "members" : [<user_obj>,...] + "group_description" : "<description>" + "active" : "<bool>", + "owner" : "<username>" + "members" : [<user_obj>,...] } error : null """ @@ -682,11 +682,11 @@ OUTPUT:: id : <id_given_in_input> - result: { - "msg": "created new user group `<groupname>`", - "user_group": <user_group_object> - } - error: null + result : { + "msg" : "created new user group `<groupname>`", + "user_group" : <user_group_object> + } + error : null ERROR OUTPUT:: @@ -740,10 +740,10 @@ id : <id_given_in_input> result : { - "msg": 'updated user group ID:<user group id> <user group name>', - "user_group": <user_group_object> + "msg" : 'updated user group ID:<user group id> <user group name>', + "user_group" : <user_group_object> } - error : null + error : null ERROR OUTPUT:: @@ -792,9 +792,9 @@ id : <id_given_in_input> result : { - "msg": "deleted user group ID:<user_group_id> <user_group_name>" + "msg" : "deleted user group ID:<user_group_id> <user_group_name>" } - error : null + error : null ERROR OUTPUT:: @@ -845,11 +845,11 @@ id : <id_given_in_input> result : { - "success": True|False # depends on if member is in group - "msg": "added member `<username>` to a user group `<groupname>` | - User is already in that group" + "success" : True|False # depends on if member is in group + "msg" : "added member `<username>` to a user group `<groupname>` | + User is already in that group" } - error : null + error : null ERROR OUTPUT:: @@ -899,12 +899,12 @@ OUTPUT:: id : <id_given_in_input> - result: { - "success": True|False, # depends on if member is in group - "msg": "removed member <username> from user group <groupname> | - User wasn't in group" - } - error: null + result : { + "success" : True|False, # depends on if member is in group + "msg" : "removed member <username> from user group <groupname> | + User wasn't in group" + } + error : null """ user = get_user_or_error(userid) user_group = get_user_group_or_error(usergroupid) @@ -949,52 +949,52 @@ "repo_name" : "<reponame>" "repo_type" : "<repo_type>", "clone_uri" : "<clone_uri>", - "enable_downloads": "<bool>", + "enable_downloads" : "<bool>", "enable_statistics": "<bool>", - "private": "<bool>", + "private" : "<bool>", "created_on" : "<date_time_created>", "description" : "<description>", - "landing_rev": "<landing_rev>", - "last_changeset": { - "author": "<full_author>", - "date": "<date_time_of_commit>", - "message": "<commit_message>", - "raw_id": "<raw_id>", + "landing_rev" : "<landing_rev>", + "last_changeset" : { + "author" : "<full_author>", + "date" : "<date_time_of_commit>", + "message" : "<commit_message>", + "raw_id" : "<raw_id>", "revision": "<numeric_revision>", "short_id": "<short_id>" } - "owner": "<repo_owner>", - "fork_of": "<name_of_fork_parent>", + "owner" : "<repo_owner>", + "fork_of" : "<name_of_fork_parent>", "members" : [ { - "name": "<username>", + "name" : "<username>", "type" : "user", "permission" : "repository.(read|write|admin)" }, … { - "name": "<usergroup name>", + "name" : "<usergroup name>", "type" : "user_group", "permission" : "usergroup.(read|write|admin)" }, … ] - "followers": [<user_obj>, ...], + "followers" : [<user_obj>, ...], <if with_revision_names == True> - "tags": { - "<tagname>": "<raw_id>", + "tags" : { + "<tagname>" : "<raw_id>", ... }, - "branches": { - "<branchname>": "<raw_id>", + "branches" : { + "<branchname>" : "<raw_id>", ... }, - "bookmarks": { - "<bookmarkname>": "<raw_id>", + "bookmarks" : { + "<bookmarkname>" : "<raw_id>", ... }, - } - error : null + } + error : null """ repo = get_repo_or_error(repoid) @@ -1044,7 +1044,7 @@ OUTPUT:: id : <id_given_in_input> - result: [ + result : [ { "repo_id" : "<repo_id>", "repo_name" : "<reponame>" @@ -1053,15 +1053,15 @@ "private" : "<bool>", "created_on" : "<datetimecreated>", "description" : "<description>", - "landing_rev": "<landing_rev>", - "owner": "<repo_owner>", - "fork_of": "<name_of_fork_parent>", - "enable_downloads": "<bool>", + "landing_rev" : "<landing_rev>", + "owner" : "<repo_owner>", + "fork_of" : "<name_of_fork_parent>", + "enable_downloads" : "<bool>", "enable_statistics": "<bool>", }, … - ] - error: null + ] + error : null """ if not HasPermissionAny('hg.admin')(): repos = request.authuser.get_all_user_repos() @@ -1094,14 +1094,14 @@ OUTPUT:: id : <id_given_in_input> - result: [ + result : [ { "name" : "<name>" "type" : "<type>", }, … - ] - error: null + ] + error : null """ repo = get_repo_or_error(repoid) @@ -1169,11 +1169,11 @@ OUTPUT:: id : <id_given_in_input> - result: { - "msg": "Created new repository `<reponame>`", - "success": true - } - error: null + result : { + "msg" : "Created new repository `<reponame>`", + "success" : true + } + error : null ERROR OUTPUT:: @@ -1342,24 +1342,24 @@ id : <id_for_response> api_key : "<api_key>" method : "fork_repo" - args: { + args : { "repoid" : "<reponame or repo_id>", - "fork_name": "<forkname>", - "owner": "<username or user_id = Optional(=apiuser)>", - "description": "<description>", + "fork_name" : "<forkname>", + "owner" : "<username or user_id = Optional(=apiuser)>", + "description" : "<description>", "copy_permissions": "<bool>", - "private": "<bool>", - "landing_rev": "<landing_rev>" + "private" : "<bool>", + "landing_rev" : "<landing_rev>" } OUTPUT:: id : <id_given_in_input> - result: { - "msg": "Created fork of `<reponame>` as `<forkname>`", - "success": true - } - error: null + result : { + "msg" : "Created fork of `<reponame>` as `<forkname>`", + "success" : true + } + error : null """ repo = get_repo_or_error(repoid) repo_name = repo.repo_name @@ -1442,11 +1442,11 @@ OUTPUT:: id : <id_given_in_input> - result: { - "msg": "Deleted repository `<reponame>`", - "success": true - } - error: null + result : { + "msg" : "Deleted repository `<reponame>`", + "success" : true + } + error : null """ repo = get_repo_or_error(repoid) @@ -1496,11 +1496,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Granted perm: `<perm>` for user: `<username>` in repo: `<reponame>`", - "success": true - } - error: null + "success" : true + } + error : null """ repo = get_repo_or_error(repoid) user = get_user_or_error(userid) @@ -1538,11 +1538,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Revoked perm for user: `<username>` in repo: `<reponame>`", - "success": true - } - error: null + "success" : true + } + error : null """ repo = get_repo_or_error(repoid) user = get_user_or_error(userid) @@ -1582,9 +1582,9 @@ id : <id_given_in_input> result : { "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`", - "success": true + "success" : true } - error : null + error : null ERROR OUTPUT:: @@ -1639,11 +1639,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`", - "success": true - } - error: null + "success" : true + } + error : null """ repo = get_repo_or_error(repoid) user_group = get_user_group_or_error(usergroupid) @@ -1744,10 +1744,10 @@ id : <id_given_in_input> result : { - "msg": "created new repo group `<repo_group_name>`" - "repo_group": <repogroup_object> + "msg" : "created new repo group `<repo_group_name>`" + "repo_group" : <repogroup_object> } - error : null + error : null ERROR OUTPUT:: @@ -1820,10 +1820,10 @@ id : <id_given_in_input> result : { - 'msg': 'deleted repo group ID:<repogroupid> <repogroupname> - 'repo_group': null + 'msg' : 'deleted repo group ID:<repogroupid> <repogroupname> + 'repo_group' : null } - error : null + error : null ERROR OUTPUT:: @@ -1869,11 +1869,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Granted perm: `<perm>` (recursive:<apply_to_children>) for user: `<username>` in repo group: `<repo_group_name>`", - "success": true - } - error: null + "success" : true + } + error : null ERROR OUTPUT:: @@ -1929,11 +1929,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Revoked perm (recursive:<apply_to_children>) for user: `<username>` in repo group: `<repo_group_name>`", - "success": true - } - error: null + "success" : true + } + error : null ERROR OUTPUT:: @@ -1994,9 +1994,9 @@ id : <id_given_in_input> result : { "msg" : "Granted perm: `<perm>` (recursive:<apply_to_children>) for user group: `<usersgroupname>` in repo group: `<repo_group_name>`", - "success": true + "success" : true } - error : null + error : null ERROR OUTPUT:: @@ -2059,11 +2059,11 @@ OUTPUT:: id : <id_given_in_input> - result: { + result : { "msg" : "Revoked perm (recursive:<apply_to_children>) for user group: `<usersgroupname>` in repo group: `<repo_group_name>`", - "success": true - } - error: null + "success" : true + } + error : null ERROR OUTPUT:: @@ -2169,10 +2169,10 @@ id : <id_given_in_input> result : { - "msg": "created new gist", - "gist": <gist_object> + "msg" : "created new gist", + "gist" : <gist_object> } - error : null + error : null ERROR OUTPUT:: @@ -2215,10 +2215,10 @@ id : <id_given_in_input> result : { - "msg": "deleted gist ID: <gist_id>", - "gist": null + "msg" : "deleted gist ID: <gist_id>", + "gist" : null } - error : null + error : null ERROR OUTPUT::