ga4gh-discovery / ga4gh-service-info

GA4GH service-info specification.
Apache License 2.0
9 stars 8 forks source link

Figure out a way to align with ELIXIR Beacon's Beacon Network proposal #5

Closed mcupak closed 5 years ago

mcupak commented 5 years ago

Proposal:

GET /info
Returns the ServiceInfo of the service.
ServiceInfo (/ or /info) 
id* string, example: org.ga4gh.service1 - Unique identifier of the service. Use reverse domain name notation. 
name* string - Name of the service. 
serviceType* string, example: Beacon - Service type from a controlled vocabulary that is detailed on the documentation of the version of the service. 
apiVersion* string, example: v0.3 - Version of the API provided by the service. 
serviceUrl* string, example: http://example.org/service URL to the root endpoint for this service (RFC 3986 format). 
entryPoint* boolean - This is/is not an entry point in the network. - ONLY BAs can set it to true
organization* ServiceOrganization{...} 
description string - Description of the service. 
version string, example: v0.1 - Version of the service. 
publicKey* string, example: {a RSA2048 key 2048+ long} or {EC196 bytes long eliptic curve key} 
open* boolean, example: false, if this service only accepts queries from the network; true, otherwise.
welcomeUrl string, example: http://example.org/wiki/Main_Page - URL to the welcome page for this service (RFC 3986 format). 
alternativeUrl string, example: http://example.org/wiki/Main_Page - Alternative URL to the API, e.g. a restricted version of this service (RFC 3986 format). 
createDateTime string, example: 2012-07-19 or 2017-01-17T20:33:40Z - The time the service was created (ISO 8601 format). 
updateDateTime string, example: 2012-07-19 or 2017-01-17T20:33:40Z - The time the service was most recently updated in (ISO 8601 format).
mcupak commented 5 years ago

This has been discussed over email and we're now aligned.