GA4GHV20

Show information about this service. It is assumed that removing this endpoint from a URL will result in a valid URL to query against

get/ga4gh/trs/v2/service-info

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/ga4gh/trs/v2/service-info
  • Auth
    none declared

Response

A successful operation to request the service information about this running service.'

contactUrlstring

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).

createdAtstring date-time

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

descriptionstring

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

documentationUrlstring

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.

environmentstring

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.

idstring 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.

namestring required

Name of this service. Should be human readable.

updatedAtstring date-time

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

versionstring 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.

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 54 revisions of this API.