commit cafc717a1ef3f8923967828d75593cec7aadcc02 parent 58e5aceecbbc0ed5fc6400111e833d8fd5e7c7cb Author: Cedric Zwahlen <cedric.zwahlen@students.bfh.ch> Date: Thu, 6 Jun 2024 00:49:58 +0200 Add progress Diffstat:
| M | core/api-auditor.rst | | | 36 | ++++++++++++++++++++++++++++++++++++ |
1 file changed, 36 insertions(+), 0 deletions(-)
diff --git a/core/api-auditor.rst b/core/api-auditor.rst @@ -2398,6 +2398,42 @@ This section is used to obtain a list of purses. This endpoint is still experimental. The endpoint will be further developed as needed. + .. _progress-list: + +Progress +-------- + +This section contains information about the auditing progress an auditor has made. + +.. http:get:: /monitoring/progress + + Get the progress stored by the auditor. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`Progress` objects. If no elements could be found, an empty array is returned + + + + **Details:** + + .. ts:def:: Progress + + interface Progress { + + // Key associated with a given progress point + progress_key : String; + + // How much of the exchanges data has been processed so far + progress_offset : Integer; + + } + + .. note:: + + This endpoint is still experimental. The endpoint will be further developed as needed. + ---------- Complaints ----------