diff --git a/httpret/static/documentation/index.html b/httpret/static/documentation/index.html index a06f9db..6717bf8 100644 --- a/httpret/static/documentation/index.html +++ b/httpret/static/documentation/index.html @@ -44,7 +44,12 @@ curl -H 'Accept: application/json' 'http://sf-daqbuf-21:8380/api/4/binned?channe

Partial result

-

Note the keys continue_at and missing_bins.

+

If the requested range takes longer time to retrieve, then a partial result with at least one bin is returned.

+

The partial result will contain the necessary information to send another request with a range that +starts with the first missing bin.

+

This information is provided by the continue_at and missing_bins fields.

+

This enables the user agent to start the presentation to the user while updating the UI as new bins are retrieved.

+

Example:

 {
   "continue_at": "2021-05-25T16:00:00.000Z",
@@ -88,7 +93,7 @@ curl -H 'Accept: application/json' 'http://sf-daqbuf-21:8380/api/4/binned?channe
 
 

Finalised range

If the server can determine that no more data will be added to the requested time range -then it will add the flag finalised_range to the response.

+then it will add the flag finalised_range: true to the response.

@@ -103,6 +108,35 @@ then it will add the flag finalised_range to the response.

Request header: "Accept" must be "application/json"

+

CURL example:

+
+curl -H 'Accept: application/json' 'http://sf-daqbuf-21:8380/api/4/search/channel?sourceRegex=CV.E.+37&nameRegex=120.+y2$'
+
+ +

Example result

+
+{
+  "channels": [
+    {
+      "name": "S10MA01-DBPM120:Y2",
+      "source": "tcp://S20-CVME-DBPM2371:9000",
+      "type": "Float32",
+      "shape": [],
+      "unit": "",
+      "description": ""
+    },
+    {
+      "name": "S20SY02-DBPM120:Y2",
+      "source": "tcp://S20-CVME-DBPM2371:9000",
+      "type": "Float32",
+      "shape": [],
+      "unit": "",
+      "description": ""
+    }
+  ]
+}
+
+

Feedback and comments very much appreciated!

dominik.werder@psi.ch