-
Notifications
You must be signed in to change notification settings - Fork 20
/
beaconResponseMeta.yaml
32 lines (32 loc) · 1.29 KB
/
beaconResponseMeta.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
$schema: https://json-schema.org/draft/2020-12/schema
description: >-
Information about the response that could be relevant for the Beacon
client in order to interpret the results.
type: object
properties:
beaconId:
$ref: ../../common/beaconCommonComponents.yaml#/definitions/BeaconId
apiVersion:
$ref: ../../common/beaconCommonComponents.yaml#/definitions/ApiVersion
returnedSchemas:
description: >-
The `returnedSchemas` parameter indicates that the request has been interpreted
for the indicated entity. This helps to disambiguate between negative responses
due to e.g. no hit on a well understood request and failures to interpret or
answer the request due to a missing entity.
$ref: ../../common/beaconCommonComponents.yaml#/definitions/ListOfSchemas
returnedGranularity:
description: >-
Granularity of the Beacon response which may differ from the requested one.
For details see the prototype definition.
$ref: ../../common/beaconCommonComponents.yaml#/definitions/Granularity
testMode:
$ref: ../../common/beaconCommonComponents.yaml#/definitions/TestMode
receivedRequestSummary:
$ref: ./beaconReceivedRequestSummary.yaml
required:
- beaconId
- apiVersion
- returnedSchemas
- returnedGranularity
- receivedRequestSummary