Skip to content
Docs

beacon_operations.get_beacon_service_info

GET
/service-info
 
curl --request GET \
  --url https://raw.githubusercontent.com/beacon/v2/service-info

Get information about the beacon using GA4GH ServiceInfo format

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful operation

Media type application/json
GA4GH service-info API specification

A way for a service to describe basic metadata concerning a service alongside a set of capabilities and/or limitations of the service. More information on GitHub.

object
contactUrl

URL of the contact for the provider of this service, e.g. a link to a contact form (RFC 3986 format), or an email (RFC 2368 format).

string format: uri
createdAt

Timestamp describing when the service was first deployed and available (RFC 3339 format)

string format: date-time
description

Description of the service. Should be human readable and provide information about the service.

string
documentationUrl

URL of the documentation of this service (RFC 3986 format). This should help someone learn how to use your service, including any specifics required to access data, e.g. authentication.

string format: uri
environment

Environment the service is running in. Use this to distinguish between production, development and testing/staging deployments. Suggested values are prod, test, dev, staging. However this is advised and not enforced.

string
id
required

Unique ID of this service. Reverse domain name notation is recommended, though not required. The identifier should attempt to be globally unique so it can be used in downstream aggregator services e.g. Service Registry.

string
name
required

Name of this service. Should be human readable.

string
organization
required

Organization providing the service

object
name
required

Name of the organization responsible for the service

string
url
required

URL of the website of the organization (RFC 3986 format)

string format: uri
type
required

Type of a GA4GH service

object
artifact
required

Name of the API or GA4GH specification implemented. Official GA4GH types should be assigned as part of standards approval process. Custom artifacts are supported.

string
group
required

Namespace in reverse domain name format. Use org.ga4gh for implementations compliant with official GA4GH specifications. For services with custom APIs not standardized by GA4GH, or implementations diverging from official GA4GH specifications, use a different namespace (e.g. your organization’s reverse domain name).

string
version
required

Version of the API or specification. GA4GH specifications use semantic versioning.

string
updatedAt

Timestamp describing when the service was last updated (RFC 3339 format)

string format: date-time
version
required

Version of the service being described. Semantic versioning is recommended, but other identifiers, such as dates or commit hashes, are also allowed. The version should be changed whenever the service is updated.

string
Example 
{
  "contactUrl": "mailto:support@example.com",
  "createdAt": "2019-06-04T12:58:19Z",
  "description": "This service provides...",
  "documentationUrl": "https://docs.myservice.example.com",
  "environment": "test",
  "id": "org.ga4gh.myservice",
  "name": "My project",
  "organization": {
    "name": "My organization",
    "url": "https://example.com"
  },
  "type": {
    "artifact": "beacon",
    "group": "org.ga4gh",
    "version": "1.0.0"
  },
  "updatedAt": "2019-06-04T12:58:19Z",
  "version": "1.0.0"
}