From fffb0c93bd581f0f2f83f99ff23f00004b383a21 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20Kol=C3=A1rik?= <martin@kolarik.sk>
Date: Mon, 24 Jul 2023 15:01:44 +0200
Subject: [PATCH] docs: add guidelines

---
 public/v1/spec.yaml | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/public/v1/spec.yaml b/public/v1/spec.yaml
index cb8cebd4..d5f3fe2e 100644
--- a/public/v1/spec.yaml
+++ b/public/v1/spec.yaml
@@ -2,7 +2,23 @@ openapi: 3.1.0
 info:
   title: Globalping API
   summary: The public Globalping API.
-  description: Monitor, debug, and benchmark your internet infrastructure from a globally distributed network of probes.
+  description: |
+    Monitor, debug, and benchmark your internet infrastructure from a globally distributed network of probes.
+    
+    ## Client guidelines
+    
+    If you implement an application interacting with the API, please consider the "client guidelines"
+    section of each endpoint below to provide the best UX and reduce the chance of your application breaking in the future.
+    
+    ### General guidelines for non-browser based apps:
+
+    - Set a `User-Agent` header. The recommended format and approach is [as here](https://github.com/jsdelivr/data.jsdelivr.com/blob/60c5154d26c403ba9dd403a8ddc5e42a31931f0d/config/default.js#L9).
+    - Set an `Accept-Encoding` header with a value of either `br` (preferred) or `gzip`, depending on what your client can support. The compression has a significant impact on the response size.
+    - When requesting the measurement status, implement ETag-based client-side caching using the `ETag`/`If-None-Match` headers.
+    
+    ## Endpoints
+    
+    https://api.globalping.io/v1/
   version: 1.0.0
   termsOfService: https://github.com/jsdelivr/globalping
   contact:
@@ -24,6 +40,11 @@ paths:
       operationId: createMeasurement
       description: |
         Creates a new measurement with the configured parameters.
+        
+        ### Client guidelines
+
+        - Set the `inProgressUpdates` option to `true` if the application is running in interactive mode so that the user sees the results right away.
+          - If the application is interactive by default but also implements a "CI" mode to be used in scripts, do not set the flag in the CI mode.
       requestBody:
         content:
           application/json:
@@ -56,6 +77,14 @@ paths:
       description: |
         Retrieves data of an existing measurement.
         A link to this endpoint is returned in the `Location` response header when creating the measurement.
+        The measurement is typically available for up to 7 days after creation.
+        
+        ### Client guidelines
+        
+        - Use the following algorithm for measurement result pooling:
+          1. Request the measurement status.
+          2. If the status is `in-progress`, wait 500 ms and repeat from step 1. Note that it is important to wait 500 ms *after* receiving the response, instead of simply using an "every 500 ms" interval. For large measurements, the request itself may take a few hundred milliseconds to complete.
+          3. If the status is anything else, stop. The measurement is no longer running. Any value other than `in-progress` is final.
       responses:
         '200':
           $ref: '#/components/responses/measurement200'