daqbuf/daqbuffer
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deliver enum channel as both numeric and stringified

Browse Source
This commit is contained in:
Dominik Werder
2024-09-03 16:33:40 +02:00
parent 4cc0f65a0b
commit 55b3bf4acd
21 changed files with 712 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
apidoc/src/SUMMARY.md
View File

@@ -5,3 +5,4 @@
- [Search Channels](search.md)
- [Binned Data](bins.md)
- [Event Data](events.md)
- [Map Pulse to Timestamp](pulsemap.md)

8
apidoc/src/events.md
View File

@@ -29,7 +29,7 @@ issue another request with `begDate` as given by `continueAt`.
## Events as framed JSON stream
To download larger amounts of JSON data it recommended to use the `json-framed` content encoding.
To download larger amounts data as JSON it is recommended to use the `json-framed` content encoding.
Using this encoding, the server can send the requested events as a stream of json objects, where each
json object contains a batch of events.
This content encoding is triggered via the `Accept: application/json-framed` header in the request.
@@ -44,10 +44,10 @@ The returned body looks like:
where each `[JSON-frame]` looks like:
```
[length N of the following JSON object: uint32 little-endian]
[reserved: 12 bytes of zero-padding]
[number of bytes N of the following json-encoded data, as ASCII-encoded number]
[newline]
[JSON object: N bytes]
[padding: P zero-bytes, 0 <= P <= 7, such that (N + P) mod 8 = 0]
[newline]
```
Note: "data" objects are currently identified by the presence of the `tss` key.