From 6c4be170559efa112bb92cd1676543e86850e976 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Fri, 25 Oct 2013 18:32:13 -0400
Subject: [PATCH] Documentation
---
src/site/rpc.mkd | 28 ++++++++++++++++++----------
1 files changed, 18 insertions(+), 10 deletions(-)
diff --git a/src/site/rpc.mkd b/src/site/rpc.mkd
index 8f56229..6fa9ba5 100644
--- a/src/site/rpc.mkd
+++ b/src/site/rpc.mkd
@@ -58,6 +58,7 @@
## JSON Remote Procedure Call (RPC) Interface
### RPC Protocol Versions
+
<table class="table">
<tbody>
<tr><th>Release</th><th>Protocol Version</th></tr>
@@ -78,6 +79,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>
@@ -120,6 +122,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>
@@ -134,7 +137,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",
@@ -177,7 +181,7 @@
"size": "4.8 MB"
}
}
-</pre>
+```
### Example: EDIT_REPOSITORY (rename)
@@ -185,7 +189,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",
@@ -207,12 +212,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",
@@ -232,12 +238,13 @@
]
}
]
-</pre>
+```
### Example: LIST_SETTINGS
**url**: https://localhost/rpc?req=LIST_SETTINGS
**response body**: ServerSettings
-<pre>
+
+```json
{
"settings": {
"web.siteName": {
@@ -262,12 +269,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",
@@ -294,4 +302,4 @@
"heapSize": 1899560960,
"servletContainer": "jetty/7.4.3.v20110701"
}
-</pre>
\ No newline at end of file
+```
\ No newline at end of file
--
Gitblit v1.9.1