From 0353c1fc521826c57a318affec4fbec7aa3b71e9 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Wed, 05 Mar 2014 11:42:34 -0500 Subject: [PATCH] Allow unregistered milestone selection on edit ticket page --- src/site/rpc.mkd | 39 ++++++++++++++++++++------------------- 1 files changed, 20 insertions(+), 19 deletions(-) diff --git a/src/site/rpc.mkd b/src/site/rpc.mkd index 26575d9..58b2966 100644 --- a/src/site/rpc.mkd +++ b/src/site/rpc.mkd @@ -21,15 +21,6 @@ **NOTE:** Gitblit Manager stores your login credentials **INSECURELY** in homedir/.gitblit/config. -### Eclipse/EGit "Import from Gitblit" Feature (Planning) - -One obvious goal of a Gitblit RPC mechanism would be to have an Eclipse/EGit Feature that allows authentication and enumeration of Gitblit repositories from the Eclipse *Import...* menu. Batch cloning would be supported and delegated to EGit. - -This particular project should not be difficult as the only external dependency for `com.gitblit.utils.RpcUtils` is [google-gson](http://google-gson.googlecode.com) which is already a dependency of the EGit/GitHub Mylyn feature. - -One proposal from the EGit team is to define a common JSON RPC method for enumeration of repositories which can be implemented by Git hosts. The EGit team would then implement the UI and the client-side enumeration code. This idea was raised as part of this [feature request for EGit](https://bugs.eclipse.org/bugs/show_bug.cgi?id=361251). - -Currently this project is in the planning stage. ## RSS Query Interface @@ -58,6 +49,7 @@ ## JSON Remote Procedure Call (RPC) Interface ### RPC Protocol Versions + <table class="table"> <tbody> <tr><th>Release</th><th>Protocol Version</th></tr> @@ -66,6 +58,7 @@ <tr><td>Gitblit v0.9.0 - v1.0.0</td><td>3</td></tr> <tr><td>Gitblit v1.1.0</td><td>4</td></tr> <tr><td>Gitblit v1.2.0+</td><td>5</td></tr> +<tr><td>Gitblit v1.3.1+</td><td>6</td></tr> </tbody> </table> @@ -77,6 +70,7 @@ Use *SET_REPOSITORY_TEAM_PERMISSIONS* instead. ### RPC Request and Response Types + <table class="table"> <tr><th colspan='2'>url parameters</th><th rowspan='2'>required<br/>user<br/>permission</th><th rowspan='2'>protocol<br/>version</th><th colspan='2'>json</th></tr> <tr><th>req=</th><th>name=</th><th>post body</th><th>response body</th></tr> @@ -85,6 +79,7 @@ <tr><td>LIST_REPOSITORIES</td><td>-</td><td>-</td><td>1</td><td>-</td><td>Map<String, RepositoryModel></td></tr> <tr><td>LIST_BRANCHES</td><td>-</td><td>-</td><td>1</td><td>-</td><td>Map<String, List<String>></td></tr> <tr><td>LIST_SETTINGS</td><td>-</td><td><em>-</em></td><td>1</td><td>-</td><td>ServerSettings (basic keys)</td></tr> +<tr><td>GET_USER</td><td>user name</td><td>-</td><td>6</td><td>-</td><td>UserModel</td></tr> <tr><td colspan='6'><em>web.enableRpcManagement=true</em></td></tr> <tr><td>CREATE_REPOSITORY</td><td>repository name</td><td><em>admin</em></td><td>1</td><td>RepositoryModel</td><td>-</td></tr> <tr><td>EDIT_REPOSITORY</td><td>repository name</td><td><em>admin</em></td><td>1</td><td>RepositoryModel</td><td>-</td></tr> @@ -118,6 +113,7 @@ </table> ### RPC/HTTP Response Codes + <table class="table"> <tr><th>code</th><th>name</th><th>description</th></tr> <tr><td>200</td><td>success</td><td>Gitblit processed the request successfully</td></tr> @@ -132,7 +128,8 @@ **url**: https://localhost/rpc?req=LIST_REPOSITORIES **response body**: Map<String, RepositoryModel> where the map key is the clone url of the repository -<pre> + +```json { "https://localhost/git/libraries/xmlapache.git": { "name": "libraries/xmlapache.git", @@ -175,7 +172,7 @@ "size": "4.8 MB" } } -</pre> +``` ### Example: EDIT_REPOSITORY (rename) @@ -183,7 +180,8 @@ **url**: https://localhost/rpc?req=EDIT_REPOSITORY&name=libraries/xmlapache.git **post body**: RepositoryModel -<pre> + +```json { "name": "libraries/xmlapache-renamed.git", "description": "apache xmlrpc client and server", @@ -205,12 +203,13 @@ "skipSummaryMetrics": false, "size": "102 KB" } -</pre> +``` ### Example: LIST_USERS **url**: https://localhost/rpc?req=LIST_USERS **response body**: List<UserModel> -<pre> + +```json [ { "username": "admin", @@ -230,12 +229,13 @@ ] } ] -</pre> +``` ### Example: LIST_SETTINGS **url**: https://localhost/rpc?req=LIST_SETTINGS **response body**: ServerSettings -<pre> + +```json { "settings": { "web.siteName": { @@ -260,12 +260,13 @@ } } } -</pre> +``` ### Example: LIST_STATUS **url**: https://localhost/rpc?req=LIST_STATUS **response body**: ServerStatus -<pre> + +```json { "bootDate": "2011-10-22T12:13:00Z", "version": "0.7.0-SNAPSHOT", @@ -292,4 +293,4 @@ "heapSize": 1899560960, "servletContainer": "jetty/7.4.3.v20110701" } -</pre> \ No newline at end of file +``` -- Gitblit v1.9.1