Skip to content

Commit

Permalink
docs: update contact email
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinKolarik committed Nov 23, 2023
1 parent 7c9d6ce commit 113fd52
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions public/v1/spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@ info:
summary: The public Globalping API.
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:
url: https://github.com/jsdelivr/globalping/issues
email: [email protected]
email: [email protected]
license:
name: Open Software License 3.0
identifier: OSL-3.0
Expand All @@ -42,7 +42,7 @@ paths:
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
- Set the `inProgressUpdates` option to `true` if the application is running in interactive mode so that the user sees the results right away.
Expand Down Expand Up @@ -82,9 +82,9 @@ paths:
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.
Expand Down

0 comments on commit 113fd52

Please sign in to comment.