-
Notifications
You must be signed in to change notification settings - Fork 20
/
beaconReceivedRequestSummary.yaml
51 lines (51 loc) · 2.07 KB
/
beaconReceivedRequestSummary.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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
$schema: https://json-schema.org/draft/2020-12/schema
description: >-
Section of the response that summarize the request received as it has
been interpreted by the Beacon server. This summary can help to identify
differences between the incoming request and its interpretation or processing,
e.g. in the response granularity or pagination.
The required properties include those that should be part of every request.
type: object
properties:
apiVersion:
description: >-
API version expected by the client to be supported by the server
and used in the response format.
$ref: ../../common/beaconCommonComponents.yaml#/definitions/ApiVersion
requestedSchemas:
description: >-
Set of schemas to be used in the response to a request.
`minItems: 0` is used to confirm that an empty array is acceptable here.
$ref: ../../common/beaconCommonComponents.yaml#/definitions/ListOfSchemas
minItems: 0
$comment: >-
TODO: Add the format attribute as a uri.
filters:
description: >-
Filters as submitted in the request.
$ref: ../../common/beaconCommonComponents.yaml#/definitions/Filters
requestParameters:
description: >-
Dictionary of request parameters received in the `RequestBody` or as part
of a GET request.
$ref: ../../requests/requestParameters.yaml
includeResultsetResponses:
$ref: ../../common/beaconCommonComponents.yaml#/definitions/IncludeResultsetResponses
pagination:
description: >-
Pagination as requested for the results.
$ref: ../../common/beaconCommonComponents.yaml#/definitions/Pagination
requestedGranularity:
description: >-
Requested granularity for the response which may differe from the
response's actual granularity.
$ref: ../../common/beaconCommonComponents.yaml#/definitions/Granularity
testMode:
description: >-
Used for indicating that a request was received in a test context.
$ref: ../../common/beaconCommonComponents.yaml#/definitions/TestMode
required:
- apiVersion
- requestedSchemas
- pagination
- requestedGranularity