Skip to content

Commit

Permalink
docs: explain probesCount
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinKolarik committed Jul 26, 2023
1 parent 0d97fad commit 4661a27
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions public/v1/spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -163,7 +165,7 @@ components:
id:
type: string
probesCount:
type: integer
$ref: '#/components/schemas/MeasurementProbesCount'
Latitude:
type: number
Longitude:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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'
Expand Down

0 comments on commit 4661a27

Please sign in to comment.