$schema: https://json-schema.org/draft/2020-12/schema
description: >-
  Schema for the Beacon request. It is named `RequestBody` to keep the
  same nomenclature used by OpenAPI v3, but it actually contains the definition
  of the whole HTTP POST request payload.
type: object
properties:
  $schema:
    $ref: ../common/beaconCommonComponents.yaml#/$defs/$schema
  meta:
    description: >-
      Information relevant for building the response.
    $ref: ./beaconRequestMeta.yaml
  query:
    $ref: '#/$defs/BeaconQuery'
$defs:
  BeaconQuery:
    description: >-
      Parameters to limit the list of returned results.
    type: object
    properties:
      requestParameters:
        description: >-
          Parameters used for the entry type specific query elements.
        $ref: ./requestParameters.yaml
      filters:
        $ref: ./filteringTerms.yaml
      includeResultsetResponses:
        $ref: ../common/beaconCommonComponents.yaml#/$defs/IncludeResultsetResponses
      pagination:
        description: >-
          Pagination parameters applied to response documents, in case of record
          level granularity.
        $ref: ../common/beaconCommonComponents.yaml#/$defs/Pagination
      requestedGranularity:
        description: >-
          Requested granularity for the response. Beacons do not have to respond
          with the requested granularity, e.g. may respond with count results
          although record level granularity had been requested but indicate the
          granularity of the response in the response's metadata.
        $ref: ../common/beaconCommonComponents.yaml#/$defs/Granularity
      testMode:
        description: >-
          Used for indicating that a request or response is done in a test
          context.
        $ref: ../common/beaconCommonComponents.yaml#/$defs/TestMode
required:
  - meta