Merge pull request #1073 from gitblit/1062-DocEditorUpdates

Paul Martin

2016-04-30 a502d96a860456ec5e8c96761db70f7cabb74751

 src/site/rpc.mkd

@@ -14,7 +14,7 @@


### Gitblit Manager



[Gitblit Manager](http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%) is an example Java/Swing application that allows remote management (repository and user objects) and administration (server settings) of a Gitblit server.

The Gitblit Manager is an example Java/Swing application that allows remote management (repository and user objects) and administration (server settings) of a Gitblit server.

  

This application uses a combination of RSS feeds and the JSON RPC interface, both of which are part of the [Gitblit API](http://code.google.com/p/gitblit/downloads/detail?name=%API%) library, to present live information from a Gitblit server.  Some JSON RPC methods from the utility class `com.gitblit.utils.RpcUtils` are not currently used by the Gitblit Manager.



@@ -32,6 +32,7 @@
<tr><th>url parameter</th><th>default</th><th>description</th></tr>

<tr><td colspan='3'><b>standard query</b></td></tr>

<tr><td><em>repository</em></td><td><em>required</em></td><td>repository name is part of the url (see examples below)</td></tr>

<tr><td>ot=</td><td><em>optional</em><br/>default: COMMIT</td><td>object type to return in results. COMMIT or TAG</td></tr>

<tr><td>h=</td><td><em>optional</em><br/>default: HEAD</td><td>starting branch, ref, or commit id</td></tr>

<tr><td>l=</td><td><em>optional</em><br/>default: web.syndicationEntries</td><td>maximum return count</td></tr>

<tr><td>pg=</td><td><em>optional</em><br/>default: 0</td><td>page number for paging<br/>(offset into history = pagenumber*maximum return count)</td></tr>

@@ -130,7 +131,7 @@


### Example: LIST_REPOSITORIES



**url**: https://localhost/rpc?req=LIST_REPOSITORIES  
**url**: https://localhost/rpc/?req=LIST_REPOSITORIES  
**response body**: Map&lt;String, RepositoryModel&gt; where the map key is the clone url of the repository



```json

@@ -182,7 +183,7 @@


The original repository name is specified in the *name* url parameter.  The new name is set within the JSON object.



**url**: https://localhost/rpc?req=EDIT_REPOSITORY&name=libraries/xmlapache.git  
**url**: https://localhost/rpc/?req=EDIT_REPOSITORY&name=libraries/xmlapache.git  
**post body**: RepositoryModel



```json

@@ -210,7 +211,7 @@
```



### Example: LIST_USERS

**url**: https://localhost/rpc?req=LIST_USERS  
**url**: https://localhost/rpc/?req=LIST_USERS  
**response body**: List&lt;UserModel&gt;



```json

@@ -236,7 +237,7 @@
```



### Example: LIST_SETTINGS

**url**: https://localhost/rpc?req=LIST_SETTINGS  
**url**: https://localhost/rpc/?req=LIST_SETTINGS  
**response body**: ServerSettings



```json

@@ -267,7 +268,7 @@
```



### Example: LIST_STATUS

**url**: https://localhost/rpc?req=LIST_STATUS  
**url**: https://localhost/rpc/?req=LIST_STATUS  
**response body**: ServerStatus



```json