Skip to content

Commit 113fd52

Browse files
committed
docs: update contact email
1 parent 7c9d6ce commit 113fd52

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

public/v1/spec.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@ info:
44
summary: The public Globalping API.
55
description: |
66
Monitor, debug, and benchmark your internet infrastructure from a globally distributed network of probes.
7-
7+
88
## Client guidelines
9-
9+
1010
If you implement an application interacting with the API, please consider the "client guidelines"
1111
section of each endpoint below to provide the best UX and reduce the chance of your application breaking in the future.
12-
12+
1313
### General guidelines for non-browser based apps:
1414
1515
- 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).
1616
- 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.
1717
- When requesting the measurement status, implement ETag-based client-side caching using the `ETag`/`If-None-Match` headers.
18-
18+
1919
## Endpoints
20-
20+
2121
https://api.globalping.io/v1/
2222
version: 1.0.0
2323
termsOfService: https://github.com/jsdelivr/globalping
2424
contact:
2525
url: https://github.com/jsdelivr/globalping/issues
26-
email: dak@prospectone.io
26+
email: d@jsdelivr.com
2727
license:
2828
name: Open Software License 3.0
2929
identifier: OSL-3.0
@@ -42,7 +42,7 @@ paths:
4242
Creates a new measurement with the configured parameters.
4343
The measurement runs asynchronously and its current state can be retrieved
4444
at the URL returned in the `Location` header.
45-
45+
4646
### Client guidelines
4747
4848
- Set the `inProgressUpdates` option to `true` if the application is running in interactive mode so that the user sees the results right away.
@@ -82,9 +82,9 @@ paths:
8282
Retrieves data of an existing measurement.
8383
A link to this endpoint is returned in the `Location` response header when creating the measurement.
8484
The measurement is typically available for up to 7 days after creation.
85-
85+
8686
### Client guidelines
87-
87+
8888
- Use the following algorithm for measurement result pooling:
8989
1. Request the measurement status.
9090
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.

0 commit comments

Comments
 (0)