Build documentation

docs/api/v1/project/projectsprojectidfiles.rst

@@ -0,0 +1,24 @@
+/v1/projects/{project_id}/files
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+List files of a project
+
+Parameters
+**********
+- **project_id**: The UUID of the project
+
+Response status codes
+**********************
+- **200**: Return list of files
+- **404**: The project doesn't exist
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_projectsprojectidfiles.txt
+

docs/api/v1/project/projectsprojectidfilespath.rst

@@ -0,0 +1,19 @@
+/v1/projects/{project_id}/files/{path:.+}
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/files/**{path:.+}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Get a file of a project
+
+Parameters
+**********
+- **project_id**: The UUID of the project
+
+Response status codes
+**********************
+- **200**: Return the file
+- **403**: Permission denied
+- **404**: The file doesn't exist
+

docs/api/v1/project/projectsprojectidnotifications.rst

@@ -0,0 +1,18 @@
+/v1/projects/{project_id}/notifications
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/notifications
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Receive notifications about the projects
+
+Parameters
+**********
+- **project_id**: The UUID of the project
+
+Response status codes
+**********************
+- **200**: End of stream
+- **404**: The project doesn't exist
+