| | |
|---|
| | | **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
|
|---|
| | |
|
|---|
| | |
|---|
| | | <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>
|
|---|
| | |
|---|
| | | ## JSON Remote Procedure Call (RPC) Interface
|
|---|
| | |
|
|---|
| | | ### RPC Protocol Versions
|
|---|
| | |
|
|---|
| | | <table class="table">
|
|---|
| | | <tbody>
|
|---|
| | | <tr><th>Release</th><th>Protocol Version</th></tr>
|
|---|
| | |
|---|
| | | <tr><td>Gitblit v0.8.0</td><td>2</td></tr>
|
|---|
| | | <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>
|
|---|
| | | <tr><td>Gitblit v1.2.0</td><td>5</td></tr>
|
|---|
| | | <tr><td>Gitblit v1.3.1</td><td>6</td></tr>
|
|---|
| | | <tr><td>Gitblit v1.4.0</td><td>7</td></tr>
|
|---|
| | | <tr><td>Gitblit v1.6.0</td><td>8</td></tr>
|
|---|
| | | </tbody>
|
|---|
| | | </table>
|
|---|
| | |
|
|---|
| | |
|---|
| | | 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>
|
|---|
| | |
|---|
| | | <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>FORK_REPOSITORY</td><td>repository name</td><td><em>-</em></td><td>8</td><td>-</td><td>-</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>
|
|---|
| | |
|---|
| | | <tr><td>SET_REPOSITORY_TEAM_PERMISSIONS</td><td>repository name</td><td><em>admin</em></td><td>5</td><td>List<String></td><td>-</td></tr>
|
|---|
| | | <tr><td>LIST_SETTINGS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>ServerSettings (management keys)</td></tr>
|
|---|
| | | <tr><td>CLEAR_REPOSITORY_CACHE</td><td>-</td><td><em>-</em></td><td>4</td><td>-</td><td>-</td></tr>
|
|---|
| | | <tr><td>REINDEX_TICKETS</td><td>repository name</td><td><em>-</em></td><td>7</td><td>-</td><td>-</td></tr>
|
|---|
| | | <tr><td colspan='6'><em>web.enableRpcAdministration=true</em></td></tr>
|
|---|
| | | <tr><td>LIST_FEDERATION_REGISTRATIONS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>List<FederationModel></td></tr>
|
|---|
| | | <tr><td>LIST_FEDERATION_RESULTS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>List<FederationModel></td></tr>
|
|---|
| | |
|---|
| | | </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>
|
|---|
| | |
|---|
| | |
|
|---|
| | | **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",
|
|---|
| | |
|---|
| | | "size": "4.8 MB"
|
|---|
| | | }
|
|---|
| | | }
|
|---|
| | | </pre>
|
|---|
| | | ```
|
|---|
| | |
|
|---|
| | | ### Example: EDIT_REPOSITORY (rename)
|
|---|
| | |
|
|---|
| | |
|---|
| | |
|
|---|
| | | **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",
|
|---|
| | |
|---|
| | | "skipSummaryMetrics": false,
|
|---|
| | | "size": "102 KB"
|
|---|
| | | }
|
|---|
| | | </pre>
|
|---|
| | | ```
|
|---|
| | |
|
|---|
| | | ### Example: LIST_USERS
|
|---|
| | | **url**: https://localhost/rpc?req=LIST_USERS
|
|---|
| | | **response body**: List<UserModel>
|
|---|
| | | <pre>
|
|---|
| | |
|
|---|
| | | ```json
|
|---|
| | | [
|
|---|
| | | {
|
|---|
| | | "username": "admin",
|
|---|
| | |
|---|
| | | ]
|
|---|
| | | }
|
|---|
| | | ]
|
|---|
| | | </pre>
|
|---|
| | | ```
|
|---|
| | |
|
|---|
| | | ### Example: LIST_SETTINGS
|
|---|
| | | **url**: https://localhost/rpc?req=LIST_SETTINGS
|
|---|
| | | **response body**: ServerSettings
|
|---|
| | | <pre>
|
|---|
| | |
|
|---|
| | | ```json
|
|---|
| | | {
|
|---|
| | | "settings": {
|
|---|
| | | "web.siteName": {
|
|---|
| | |
|---|
| | | }
|
|---|
| | | }
|
|---|
| | | }
|
|---|
| | | </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",
|
|---|
| | |
|---|
| | | "heapSize": 1899560960,
|
|---|
| | | "servletContainer": "jetty/7.4.3.v20110701"
|
|---|
| | | }
|
|---|
| | | </pre> |
|---|
| | | ```
|
|---|
