Skip to content

Commit

Permalink
docs: update descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinKolarik committed Dec 6, 2023
1 parent e30da84 commit bc5599c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion public/v1/components/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@ components:
items:
$ref: 'schemas.yaml#/components/schemas/MeasurementLocationOption'
- type: string
description: Id of a previous measurement. Probes of that measurement in the same order are used to create a new measurement. Only probes are copied, measurement type and options may be any and should still be specified in request.
description: |
`id` of a previous measurement - its probes are reused for the new measurement and returned in the same order.
Measurement type and options are not reused and need to be specified in request.
MeasurementOptions:
anyOf:
- $ref: 'schemas.yaml#/components/schemas/MeasurementPingOptions'
Expand Down
2 changes: 1 addition & 1 deletion public/v1/spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ paths:
- 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.
- To use the same probes in different measurements pass id of the initial measurement to the `locations` option.
- To perform multiple measurements from exactly the same probes, create a single measurement first, then pass its `id` in the `locations` option for the other measurements.
requestBody:
content:
application/json:
Expand Down

0 comments on commit bc5599c

Please sign in to comment.