hop delays

1 files changed, 32 insertions, 0 deletions

diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index fd0b855..0509709 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -1686,6 +1686,10 @@ components:
           oneOf:
             - $ref: '#/components/schemas/ClockOffset'
             - type: 'null'
+        hopDelay:
+          oneOf:
+            - $ref: '#/components/schemas/HopDelay'
+            - type: 'null'
 
     Counter:
       type: object
@@ -1765,6 +1769,34 @@ components:
           type: integer
           description: Give or take this much (half the round trip).
 
+    HopDelay:
+      type: object
+      description: How long a peer's sync messages take to come, from its clock when it generated one to ours when we handle it, its clock offset taken off (`measurements.md`, Per peer). Good to half the round trip, the offset's error; that error is the same for every message while the offset stands, so the minutes' means show a trend exactly.
+      required: [count, meanMs, halfWithinMs, p99WithinMs, belowZero, byMinuteMs, halfRttMs]
+      properties:
+        count:
+          type: integer
+          description: Messages measured since this node started.
+        meanMs:
+          type: integer
+        halfWithinMs:
+          type: [integer, 'null']
+          description: The bucket bound by which half came (the propagation buckets of `/admin/stats`); null if beyond the last.
+        p99WithinMs:
+          type: [integer, 'null']
+          description: The same for 99%.
+        belowZero:
+          type: integer
+          description: Messages that took less than nothing by the clocks (the offset's error was larger), counted as 0 above.
+        byMinuteMs:
+          type: array
+          items:
+            type: [integer, 'null']
+          description: The mean of each of the last 15 minutes, oldest first, the last the current one; null for a minute without messages. May be negative.
+        halfRttMs:
+          type: [integer, 'null']
+          description: Half the round trip to it now, from PINGs, which wait behind nothing; what the delay takes beyond it waits in queues (or is the offset's error). Null without a recent round trip.
+
     Throughput:
       type: object
       required: [bytesPerSec, samples, secsAgo]