Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider filtering by model #36

Closed
mcupak opened this issue Jan 31, 2019 · 2 comments
Closed

Consider filtering by model #36

mcupak opened this issue Jan 31, 2019 · 2 comments
Labels
elixir Proposal from the ELIXIR Beacon driver project
Milestone

Comments

@mcupak
Copy link
Collaborator

mcupak commented Jan 31, 2019

Proposal from Beacon:

GET /services?model={model}
Returns an array of ServiceInfo in an specific model, i.e.: "Beacon-v1" or "GA4GH-ServiceInfo-v0.1"
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 mcupak added the elixir Proposal from the ELIXIR Beacon driver project label Jan 31, 2019
@mcupak
Copy link
Collaborator Author

mcupak commented Jan 31, 2019

Consider using a different format of the model string, the goal is match schema and its version. Concluded on the call it's too early to include this now.

@mcupak mcupak added this to the 0.2.0 milestone Jan 31, 2019
@mcupak
Copy link
Collaborator Author

mcupak commented Jul 18, 2019

Closing in favour of #35 as model and type are now the same.

@mcupak mcupak closed this as completed Jul 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
elixir Proposal from the ELIXIR Beacon driver project
Projects
None yet
Development

No branches or pull requests

1 participant