Type: object
Description: Metadata describing a beacon instance.

Properties

alternativeUrl

• type: string

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

alternativeUrl Value Example

"http://example.org/wiki/Main_Page"

apiVersion

• type: string

Version of the API provided by the beacon.

apiVersion Value Example

"v0.3"

createDateTime

• type: string

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

createDateTime Value Example

"2012-07-19 or 2017-01-17T20:33:40Z"

datasets

• type: array of “BeaconDataset.yaml#/ [HTML]”

Dataset(s) served by the beacon.

description

• type: string

Description of the beacon.

environment

• type: string

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

environment Value Example

"dev"

id

• type: string

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

id Value Example

"org.ga4gh.beacon"

info

• type: object

Additional unspecified metadata about the Beacon service.

info Value Example

{
   "additionalInfoKey1" : "additionalInfoValue1",
   "additionalInfoKey2" : [
      "additionalInfoValue2",
      "additionalInfoValue3"
   ]
}

name

• type: string

Name of the beacon.

organization

• type: BeaconOrganization.yaml#/ [HTML]

updateDateTime

• type: string

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

updateDateTime Value Example

"2012-07-19 or 2017-01-17T20:33:40Z"

version

• type: string

Version of the beacon.

version Value Example

"v0.1"

welcomeUrl

• type: string

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

welcomeUrl Value Example

"http://example.org/wiki/Main_Page"