diff --git a/README.md b/README.md index cf865924..3cc0f8c2 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,13 @@ Furthermore, two non-abstract configs (`dev`, `prod`) are provided, which implem If you plan to provide new extensions or make adjustments and want to provide those to the general public, it is recommended to add a new configuration for your specific case. This can be e.g. an abstract class (e.g. WSCloudBaseConfig), which extends the base class providing certain needed keys or functions. If you provide an abstract class, please make sure to add at least one non-abstract class showing the implementation needed. +## Trace Keys +There are two endpoints, one for uploading and one for downloading trace keys. How long trace keys are stored in the database can be configured via the `db.removeAfterDays` property in the properties file. + +- /v1/traceKeys?lastSync=\: `GET` Returns a list of trace keys. The optional `lastSync` parameter needs to be epoch milliseconds. If set, only trace keys uploaded after `lastSync` are returned, otherwise all uploaded trace keys are returned. + +- /v1/debug/traceKeys?startTime=\&endTime=\&ctx=\: `POST` This request is used by the [QR Trace Upload Web App](https://github.com/notifyme-app/notifyme-upload-web) to upload an encoded trace key (`ctx`) together with start and end time of the problematic event in epoch milliseconds. + ## Swagger We use [Springboot-Swagger-3](https://github.com/Ubique-OSS/springboot-swagger3) to generate a `YAML` based on settings and controllers found in the project. We include a up-to-date version in each release. Currently they are lacking the documentation, but should provide enough information to use them in [Swagger Editor](https://editor.swagger.io).