Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Orion/Server API/Git API"
< Orion | Server API
| Line 38: | Line 38: | ||
TBD, see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=336116 bug 336116] | TBD, see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=336116 bug 336116] | ||
| − | + | = JSON representations = | |
| − | + | == File representation extension == | |
| − | + | The JSON representation for files and directories used by [Orion/Server API/File_API file API] may be extended as follows: | |
| + | |||
| + | The file API uses the following JSON representation for file and directory objects in request and response bodies. Required fields are shown in '''bold'''. A client cannot rely on the existence of non-required attribute in a file representation from a given Orion server. | ||
| + | |||
| + | {| border="1" cellspacing=0 style="text-align: center; width:90%" | ||
| + | |- width="100%" align="center" style="background:#ccccff; padding: 0 5px 0 5px;" | | ||
| + | ! Field | ||
| + | ! Data type | ||
| + | ! Value | ||
| + | |- | ||
| + | | GitDiff | ||
| + | | URI | ||
| + | | Location of Git Diff resource | ||
| + | |- | ||
| + | | GitStatus | ||
| + | | URI | ||
| + | | Location of Git Status resource | ||
| + | |} | ||
Revision as of 19:32, 17 February 2011
The Git API is a web server API for browsing and manipulating Git repositories.
Contents
Actions
Getting status for a git project
- Overview
- To retrieve the working tree status of a project, send a GET request to the git status location.
- HTTP Method
- GET
- Example Request
GET /git/status/file/MyProj/
- Example Response
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 22
TBD
- Detailed Explanation
- TBD.
Progress in being tracked on bug 337212.
Getting a diff
- Overview
- To retrieve changes changes between selected commits, commit and working tree, and so on. Send a GET request to the git diff location.
- HTTP Method
- GET
- Example Request
GET /git/diff/file/MyProj/
- Example Response
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 22
TBD
- Detailed Explanation
- TBD.
Progress in being tracked on bug 337212.
Other operations
TBD, see bug 336116
JSON representations
File representation extension
The JSON representation for files and directories used by [Orion/Server API/File_API file API] may be extended as follows:
The file API uses the following JSON representation for file and directory objects in request and response bodies. Required fields are shown in bold. A client cannot rely on the existence of non-required attribute in a file representation from a given Orion server.
| Field | Data type | Value |
|---|---|---|
| GitDiff | URI | Location of Git Diff resource |
| GitStatus | URI | Location of Git Status resource |