Beacon [beacon-v2]

{S}[B] Status Level [i]
playground
Provenance
Used by
Contributors
Source (2.0.0-draft.1)

Attributes

Type: object
Description: Metadata describing a beacon instance.

Properties

Property Type
alternativeUrl string
apiVersion string
createDateTime string
datasets array of "./BeaconDataset [HTML]"
description string
environment string
id string
info object
name string
organization ./BeaconOrganization [HTML]
sampleAlleleRequests array of "./BeaconAlleleRequest [HTML]"
updateDateTime string
version string
welcomeUrl string

alternativeUrl

Alternative URL to the API, e.g. a restricted version of this beacon (RFC 3986 format).

apiVersion

Version of the API provided by the beacon.

createDateTime

The time the beacon was created (ISO 8601 format).

datasets

Dataset(s) served by the beacon.

description

Description of the beacon.

environment

Environment the service is running in. Use this to distinguish between production, development and testing/staging deployments.

id

Unique identifier of the beacon. Use reverse domain name notation.

info

Additional unspecified metadata about the Beacon service.

name

Name of the beacon.

organization

sampleAlleleRequests

Examples of interesting queries, e.g. a few queries demonstrating different responses.

updateDateTime

The time the beacon was updated in (ISO 8601 format).

version

Version of the beacon.

welcomeUrl

URL to the welcome page for this beacon (RFC 3986 format).


2020-05-25