sb-beacon-api beaconRequestBody [ ↗ ]

{S}[B] Status [i]
proposed
Provenance
Used by
Contributors
Source (2.0.0)

Attributes

Type: object
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.

Properties

PropertyType
$schema../common/beaconCommonComponents.json#/definitions/$schema
meta./beaconRequestMeta.json
queryobject

$schema

meta

Information that is relevant to build the response.

query

Parameters to limit the list of returned results.