Clearly separate requests and responses in REST API documentation
Put the example requests and responses in the REST API documentation
into own boxes so that visually they are clearly separated.
Add a description of the response for the group creation, since it was
missing.
Change-Id: I904e8f204de35e0d1bba4918a46c4c6a82a6634f
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt
index 10a714c..9432259 100644
--- a/Documentation/rest-api-projects.txt
+++ b/Documentation/rest-api-projects.txt
@@ -18,9 +18,13 @@
link:#project-info[ProjectInfo] entries. The entries in the map are sorted
by project name.
+.Request
----
GET /projects/?d HTTP/1.0
+----
+.Response
+----
HTTP/1.1 200 OK
Content-Disposition: attachment
Content-Type: application/json;charset=UTF-8
@@ -59,9 +63,14 @@
This limits the results to those projects that start with the specified
prefix.
List all projects that start with `platform/`:
+
+.Request
----
GET /projects/?p=platform%2F HTTP/1.0
+----
+.Response
+----
HTTP/1.1 200 OK
Content-Disposition: attachment
Content-Type: application/json;charset=UTF-8
@@ -88,9 +97,14 @@
returned.
List all dashboards for the `work/my-project` project:
+
+.Request
----
GET /projects/work%2Fmy-project/dashboards/ HTTP/1.0
+----
+.Response
+----
HTTP/1.1 200 OK
Content-Disposition: attachment
Content-Type: application/json;charset=UTF-8
@@ -126,9 +140,14 @@
****
To retrieve only the default dashboard, add `default` to the URL:
+
+.Request
----
GET /projects/work%2Fmy-project/dashboards/default HTTP/1.0
+----
+.Response
+----
HTTP/1.1 200 OK
Content-Disposition: attachment
Content-Type: application/json;charset=UTF-8
