From 4661a27c5a8e4b8d5a661f75a0eb088f471bba37 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20Kol=C3=A1rik?= <martin@kolarik.sk>
Date: Wed, 26 Jul 2023 21:45:07 +0200
Subject: [PATCH] docs: explain probesCount

---
 public/v1/spec.yaml | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/public/v1/spec.yaml b/public/v1/spec.yaml
index c0c45f9b..50d68729 100644
--- a/public/v1/spec.yaml
+++ b/public/v1/spec.yaml
@@ -40,6 +40,8 @@ paths:
       operationId: createMeasurement
       description: |
         Creates a new measurement with the configured parameters.
+        The measurement runs asynchronously and its current state can be retrieved
+        at the URL returned in the `Location` header.
         
         ### Client guidelines
 
@@ -163,7 +165,7 @@ components:
         id:
           type: string
         probesCount:
-          type: integer
+          $ref: '#/components/schemas/MeasurementProbesCount'
     Latitude:
       type: number
     Longitude:
@@ -546,6 +548,9 @@ components:
             - HTTPS
             - HTTP2
           default: HTTPS
+    MeasurementProbesCount:
+      type: integer
+      description: The number of probes that performed the measurement. Smaller or equal to `limit`.
     MeasurementResolver:
       description: A DNS resolver to use for the query. Defaults to the probe's system resolver.
       anyOf:
@@ -651,8 +656,7 @@ components:
           format: date-time
           description: Time when the measurement was last updated.
         probesCount:
-          type: integer
-          description: The number of probes that performed the measurement. Smaller or equal to `limit`.
+          $ref: '#/components/schemas/MeasurementProbesCount'
         locations:
           allOf:
             - $ref: '#/components/schemas/MeasurementLocations'