beacon-v2 BeaconInfo [ ↗ ]

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

Attributes

Type: object
Description: Metadata describing a beacon instance.

Properties

PropertyType
alternativeUrlstring
apiVersionstring
createDateTimestring
datasetsarray of "BeaconDataset.yaml#/ [HTML]"
descriptionstring
environmentstring
idstring
infoobject
namestring
organizationBeaconOrganization.yaml#/ [HTML]
updateDateTimestring
versionstring
welcomeUrlstring

alternativeUrl

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

Version of the API provided by the beacon.

apiVersion Value Example
"v0.3"

createDateTime

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

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

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.

environment Value Example
"dev"

id

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

id Value Example
"org.ga4gh.beacon"

info

Additional unspecified metadata about the Beacon service.

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

name

Name of the beacon.

organization

updateDateTime

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

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

version

Version of the beacon.

version Value Example
"v0.1"

welcomeUrl

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

welcomeUrl Value Example
"http://example.org/wiki/Main_Page"