Update documentation

This commit is contained in:
Julien Duponchelle committed 2016-07-22 13:54:57 +02:00
1 parent ce557ecd23
commit 19b035d7e4
205 files changed
+1043 -945

No files matched your search

@@ -0,0 +1,18 @@
/v2/projects/{project_id}/export
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/projects/**{project_id}**/export
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Export a project as a portable archive
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: File returned
- **404**: The project doesn't exist
@@ -0,0 +1,34 @@
/v2/projects/{project_id}/files/{path:.+}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/projects/**{project_id}**/files/**{path:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a file from a project. Beware you have warranty to be able to access only to file global to the project (for example README.txt)
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist
POST /v2/projects/**{project_id}**/files/**{path:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write a file to a project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The path doesn't exist
@@ -0,0 +1,31 @@
/v2/projects/{project_id}/import
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/import
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Import a project from a portable archive
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: Project imported
- **403**: Forbidden to import project
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
</table>