engineering/unrhodecode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: updated API documentation.

Browse source
This commit is contained in:
Marcin Kuzminski 2018-01-30 17:27:35 +01:00
parent cd89cf7ea9
commit af86f42d40
6 changed files with 67 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/api/methods/deprecated-methods.rst
View file

@ -38,13 +38,13 @@ changeset_comment
Example error output:
.. code-block:: javascript
.. code-block:: json
{
"id" : "<id_given_in_input>",
"id" : <id_given_in_input>,
"result" : {
"msg": "Commented on commit `<revision>` for repository `<repoid>`",
"status_change": null or "<status>",
"status_change": null or <status>,
"success": true
},
"error" : null

64
docs/api/methods/pull-request-methods.rst
View file

@ -6,7 +6,7 @@ pull_request methods
close_pull_request
------------------
.. py:function:: close_pull_request(apiuser, repoid, pullrequestid, userid=<Optional:<OptionalAttr:apiuser>>, message=<Optional:''>)
.. py:function:: close_pull_request(apiuser, pullrequestid, repoid=<Optional:None>, userid=<Optional:<OptionalAttr:apiuser>>, message=<Optional:''>)
Close the pull request specified by `pullrequestid`.
@ -39,7 +39,7 @@ close_pull_request
comment_pull_request
--------------------
.. py:function:: comment_pull_request(apiuser, repoid, pullrequestid, message=<Optional:None>, commit_id=<Optional:None>, status=<Optional:None>, comment_type=<Optional:u'note'>, resolves_comment_id=<Optional:None>, userid=<Optional:<OptionalAttr:apiuser>>)
.. py:function:: comment_pull_request(apiuser, pullrequestid, repoid=<Optional:None>, message=<Optional:None>, commit_id=<Optional:None>, status=<Optional:None>, comment_type=<Optional:u'note'>, resolves_comment_id=<Optional:None>, userid=<Optional:<OptionalAttr:apiuser>>)
Comment on the pull request specified with the `pullrequestid`,
in the |repo| specified by the `repoid`, and optionally change the
@ -47,7 +47,7 @@ comment_pull_request
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
:param repoid: The repository name or repository ID.
:param repoid: Optional repository name or repository ID.
:type repoid: str or int
:param pullrequestid: The pull request ID.
:type pullrequestid: int
@ -120,14 +120,14 @@ create_pull_request
get_pull_request
----------------
.. py:function:: get_pull_request(apiuser, repoid, pullrequestid)
.. py:function:: get_pull_request(apiuser, pullrequestid, repoid=<Optional:None>)
Get a pull request based on the given ID.
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
:param repoid: Repository name or repository ID from where the pull
request was opened.
:param repoid: Optional, repository name or repository ID from where
the pull request was opened.
:type repoid: str or int
:param pullrequestid: ID of the requested pull request.
:type pullrequestid: int
@ -199,6 +199,48 @@ get_pull_request
"error": null
get_pull_request_comments
-------------------------
.. py:function:: get_pull_request_comments(apiuser, pullrequestid, repoid=<Optional:None>)
Get all comments of pull request specified with the `pullrequestid`
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
:param repoid: Optional repository name or repository ID.
:type repoid: str or int
:param pullrequestid: The pull request ID.
:type pullrequestid: int
Example output:
.. code-block:: bash
id : <id_given_in_input>
result : [
{
"comment_author": {
"active": true,
"full_name_or_username": "Tom Gore",
"username": "admin"
},
"comment_created_on": "2017-01-02T18:43:45.533",
"comment_f_path": null,
"comment_id": 25,
"comment_lineno": null,
"comment_status": {
"status": "under_review",
"status_lbl": "Under Review"
},
"comment_text": "Example text",
"comment_type": null,
"pull_request_version": null
}
],
error : null
get_pull_requests
-----------------
@ -208,7 +250,7 @@ get_pull_requests
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
:param repoid: Repository name or repository ID.
:param repoid: Optional repository name or repository ID.
:type repoid: str or int
:param status: Only return pull requests with the specified status.
Valid options are.
@ -289,14 +331,14 @@ get_pull_requests
merge_pull_request
------------------
.. py:function:: merge_pull_request(apiuser, repoid, pullrequestid, userid=<Optional:<OptionalAttr:apiuser>>)
.. py:function:: merge_pull_request(apiuser, pullrequestid, repoid=<Optional:None>, userid=<Optional:<OptionalAttr:apiuser>>)
Merge the pull request specified by `pullrequestid` into its target
repository.
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
:param repoid: The Repository name or repository ID of the
:param repoid: Optional, repository name or repository ID of the
target repository to which the |pr| is to be merged.
:type repoid: str or int
:param pullrequestid: ID of the pull request which shall be merged.
@ -326,13 +368,13 @@ merge_pull_request
update_pull_request
-------------------
.. py:function:: update_pull_request(apiuser, repoid, pullrequestid, title=<Optional:''>, description=<Optional:''>, reviewers=<Optional:None>, update_commits=<Optional:None>)
.. py:function:: update_pull_request(apiuser, pullrequestid, repoid=<Optional:None>, title=<Optional:''>, description=<Optional:''>, reviewers=<Optional:None>, update_commits=<Optional:None>)
Updates a pull request.
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
:param repoid: The repository name or repository ID.
:param repoid: Optional repository name or repository ID.
:type repoid: str or int
:param pullrequestid: The pull request ID.
:type pullrequestid: int

2
docs/api/methods/repo-group-methods.rst
View file

@ -115,7 +115,7 @@ get_repo_group
"group_description": "repo group description",
"group_id": 14,
"group_name": "group name",
"members": [
"permissions": [
{
"name": "super-admin-username",
"origin": "super-admin",

23
docs/api/methods/repo-methods.rst
View file

@ -306,26 +306,6 @@ get_repo
"lock_reason": null,
"locked_by": null,
"locked_date": null,
"members": [
{
"name": "super-admin-name",
"origin": "super-admin",
"permission": "repository.admin",
"type": "user"
},
{
"name": "owner-name",
"origin": "owner",
"permission": "repository.admin",
"type": "user"
},
{
"name": "user-group-name",
"origin": "permission",
"permission": "repository.write",
"type": "user_group"
}
],
"owner": "owner-name",
"permissions": [
{
@ -533,9 +513,6 @@ get_repo_settings
"hooks_outgoing_pull_logger": true,
"phases_publish": "True",
"rhodecode_hg_use_rebase_for_merging": true,
"rhodecode_hg_close_branch_before_merging": false,
"rhodecode_git_use_rebase_for_merging": true,
"rhodecode_git_close_branch_before_merging": false,
"rhodecode_pr_merge_enabled": true,
"rhodecode_use_outdated_comments": true
}

8
docs/api/methods/user-group-methods.rst
View file

@ -162,7 +162,7 @@ get_user_group
"active": true,
"group_description": "group description",
"group_name": "group name",
"members": [
"permissions": [
{
"name": "owner-name",
"origin": "owner",
@ -183,6 +183,12 @@ get_user_group
"type": "user_group"
}
],
"permissions_summary": {
"repositories": {
"aa-root-level-repo-1": "repository.admin"
},
"repositories_groups": {}
},
"owner": "owner name",
"users": [],
"users_group_id": 2

5
docs/api/methods/user-methods.rst
View file

@ -160,7 +160,8 @@ get_user
"last_login": "Timestamp",
"last_activity": "Timestamp",
"lastname": "surnae",
"permissions": {
"permissions": <deprecated>,
"permissions_summary": {
"global": [
"hg.inherit_default_perms.true",
"usergroup.read",
@ -178,7 +179,7 @@ get_user
"repositories": { "username/example": "repository.write"},
"repositories_groups": { "user-group/repo": "group.none" },
"user_groups": { "user_group_name": "usergroup.read" }
},
}
"user_id": 32,
"username": "username"
}