{S}[B] Status [i] | community |
---|---|
Provenance | |
Used by | |
Contributors | |
Source (2.0.0-draft.3) |
Type: object
Description: Metadata describing a beacon instance.
Property | Type |
---|---|
alternativeUrl | string |
apiVersion | string |
createDateTime | string |
datasets | array of "BeaconDataset.yaml#/ [HTML]" |
description | string |
environment | string |
id | string |
info | object |
name | string |
organization | BeaconOrganization.yaml#/ [HTML] |
updateDateTime | string |
version | string |
welcomeUrl | 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"
Version of the API provided by the beacon.
apiVersion
Value Example"v0.3"
The time the beacon was created (ISO 8601 format).
createDateTime
Value Example"2012-07-19 or 2017-01-17T20:33:40Z"
Dataset(s) served by the beacon.
Description of the beacon.
Environment the service is running in. Use this to distinguish between production, development and testing/staging deployments.
environment
Value Example"dev"
Unique identifier of the beacon. Use reverse domain name notation.
id
Value Example"org.ga4gh.beacon"
Additional unspecified metadata about the Beacon service.
info
Value Example{
"additionalInfoKey1" : "additionalInfoValue1",
"additionalInfoKey2" : [
"additionalInfoValue2",
"additionalInfoValue3"
]
}
Name of the beacon.
The time the beacon was updated in (ISO 8601 format).
updateDateTime
Value Example"2012-07-19 or 2017-01-17T20:33:40Z"
Version of the beacon.
version
Value Example"v0.1"
URL to the welcome page for this beacon (RFC 3986 format).
welcomeUrl
Value Example"http://example.org/wiki/Main_Page"