Update API documentation

This commit is contained in:
Bernhard Ehlers committed 2018-01-08 09:26:44 +01:00
1 parent 21a7a68875
commit e6d2bd4424
360 files changed
+17598 -896

No files matched your search

+12
View File
@@ -11,6 +11,12 @@ Response status codes
**********************
- **200**: Project list
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projects.txt
POST /v2/compute/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -64,3 +70,9 @@ Output
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projects.txt
@@ -39,6 +39,12 @@ Output
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectid.txt
DELETE /v2/compute/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -50,6 +56,12 @@ Parameters
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Changes have been written on disk
- **404**: The project doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectid.txt
@@ -13,6 +13,12 @@ Parameters
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Project closed
- **404**: The project doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidclose.txt