add docs

Scifabric · Jan 26, 2017 · d7d4735 · d7d4735
1 parent 336f838
commit d7d4735
Showing 1 changed file with 24 additions and 1 deletion.
diff --git a/doc/api.rst b/doc/api.rst
@@ -2086,4 +2086,27 @@ If a project is already unfeatured:
     {
       "status_code": 415,
       "error": "Project.id 1069 is not featured"
-    }
+    }
+
+Help privacy
+~~~~~~~~~~~~
+**Endpoint: /help/privacy**
+
+*Allowed methods*: **GET**
+
+**GET**
+
+Gives you the privacy policy for your PYBOSSA
+
+* **content**: Simplified HTML of rendered privacy policy.
+* **template**: The Jinja2 template that could be rendered.
+* **title**: the title for the endpoint.
+
+**Example output**
+
+.. code-block:: python
+    {
+      "content": "<html><body><p>privacy policy here</p></body></html>"
+      "template": "help/privacy.html",
+      "title": "Privacy Policy"
+    }