Mercurial > kallithea
changeset 8933:379392017b6e stable
api docs: various minor changes
| author | Mads Kiilerich <mads@kiilerich.com> |
|---|---|
| date | Fri, 14 Oct 2022 13:36:21 +0200 |
| parents | d69c3e30f8b5 |
| children | 6f9dec2295dc |
| files | docs/api/api.rst kallithea/controllers/api/api.py |
| diffstat | 2 files changed, 15 insertions(+), 16 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/api/api.rst Thu Oct 13 19:37:43 2022 +0200 +++ b/docs/api/api.rst Fri Oct 14 13:36:21 2022 +0200 @@ -182,7 +182,7 @@ id : <id_given_in_input> result : { - "ip_addr_server": <ip_from_clien>", + "ip_addr_server": <ip_from_client>", "user_ips": [ { "ip_addr": "<ip_with_mask>", @@ -225,7 +225,7 @@ "emails": "<list_of_all_additional_emails>", "ip_addresses": "<list_of_ip_addresses_for_user>", "active" : "<bool>", - "admin" : "<bool>", + "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", "last_login": "<last_login>", "permissions": { @@ -265,7 +265,7 @@ "emails": "<list_of_all_additional_emails>", "ip_addresses": "<list_of_ip_addresses_for_user>", "active" : "<bool>", - "admin" : "<bool>", + "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", "last_login": "<last_login>", }, @@ -310,7 +310,7 @@ "email" : "<email>", "emails": "<list_of_all_additional_emails>", "active" : "<bool>", - "admin" : "<bool>", + "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", "last_login": "<last_login>", }, @@ -358,7 +358,7 @@ "email" : "<email>", "emails": "<list_of_all_additional_emails>", "active" : "<bool>", - "admin" : "<bool>", + "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", "last_login": "<last_login>", }, @@ -422,7 +422,7 @@ "email" : "<email>", "emails": "<list_of_all_additional_emails>", "active" : "<bool>", - "admin" : "<bool>", + "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", "last_login": "<last_login>", }, @@ -596,7 +596,7 @@ "email" : "<email>", "emails": "<list_of_all_additional_emails>", "active" : "<bool>", - "admin" : "<bool>", + "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", "last_login": "<last_login>", "permission" : "repository.(read|write|admin)" @@ -622,7 +622,7 @@ "emails": "<list_of_all_additional_emails>", "ip_addresses": "<list_of_ip_addresses_for_user>", "active" : "<bool>", - "admin" : "<bool>", + "admin" : "<bool>", "ldap_dn" : "<ldap_dn>", "last_login": "<last_login>", }, @@ -1062,7 +1062,7 @@ result: [ { "raw_id": "<raw_id>", - "short_id": "short_id": "<short_id>", + "short_id": "<short_id>", "author": "<full_author>", "date": "<date_time_of_commit>", "message": "<commit_message>",
--- a/kallithea/controllers/api/api.py Thu Oct 13 19:37:43 2022 +0200 +++ b/kallithea/controllers/api/api.py Fri Oct 14 13:36:21 2022 +0200 @@ -308,7 +308,7 @@ id : <id_given_in_input> result : { - "server_ip_addr": "<ip_from_clien>", + "server_ip_addr": "<ip_from_client>", "user_ips": [ { "ip_addr": "<ip_with_mask>", @@ -317,7 +317,7 @@ ... ] } - + error : null """ if userid is None: userid = request.authuser.user_id @@ -858,7 +858,7 @@ """ Adds a user to a user group. If user exists in that group success will be `false`. This command can be executed only using api_key - belonging to user with admin rights or an admin of given user group + belonging to user with admin rights or an admin of a given user group :param usergroupid: :type usergroupid: str or int @@ -870,7 +870,7 @@ id : <id_given_in_input> result : { "success": True|False # depends on if member is in group - "msg": "added member `<username>` to user group `<groupname>` | + "msg": "added member `<username>` to a user group `<groupname>` | User is already in that group" } @@ -973,7 +973,6 @@ id : <id_given_in_input> result : { - { "repo_id" : "<repo_id>", "repo_name" : "<reponame>" "repo_type" : "<repo_type>", @@ -1022,7 +1021,6 @@ "<bookmarkname>": "<raw_id>", ... }, - } } error : null @@ -1082,7 +1080,7 @@ "repo_name" : "<reponame>" "repo_type" : "<repo_type>", "clone_uri" : "<clone_uri>", - "private": : "<bool>", + "private" : "<bool>", "created_on" : "<datetimecreated>", "description" : "<description>", "landing_rev": "<landing_rev>", @@ -1376,6 +1374,7 @@ id : <id_for_response> api_key : "<api_key>" + method : "fork_repo" args: { "repoid" : "<reponame or repo_id>", "fork_name": "<forkname>",