Peernet-Archive/core
1
0
Fork 0
mirror of https://github.com/PeernetOfficial/core.git synced 2026-07-17 02:47:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

webapi: Document time zone behavior.

Browse Source
This commit is contained in:
Kleissner
2021-10-19 17:36:18 +02:00
parent f954c4777b
commit 285bed59e3
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
webapi/readme.md
View File

@@ -65,6 +65,8 @@ These are the functions provided by the API:
# API Documentation
All times used by the API (both input and output) are UTC based. It is the frontend's responsibility to convert the times to the local time zone for visualization to the end user where appropriate.
## Informational Functions
### Status
@@ -578,6 +580,8 @@ type SearchRequestResponse struct {
}
```
Note that the date format for the `datefrom` and `dateto` fields is "2006-01-02 15:04:05" which is different to native JSON time encoding used elsewhere. The time zone is UTC.
Example POST request to `http://127.0.0.1:112/search`:
```json
@@ -610,6 +614,8 @@ If reset is set, all results will be filtered and sorted according to the provid
The statistics of all results (regardless of applied runtime filters) can be returned immediately in the `statistics` field by specifying `&stats=1`. If will be only provided if the statistics change, i.e. if at least one file is returned. The returned statistics is the `SearchStatisticData` structure and matches with what is returned by `/search/statistic`.
Note that the date format for the `&from=` and `&to=` parameters is "2006-01-02 15:04:05" which is different to native JSON time encoding used elsewhere. The time zone is UTC.
```
Request: GET /search/result?id=[UUID]&limit=[max records]
Optional parameters: