search

ga4gh / mme-apis

Documentation for the MatchmakerExchange APIs
https://github.com/ga4gh/mme-apis
34 stars 19 forks source link

Disclaimer in response #129

Closed Relequestual closed 7 years ago

Relequestual commented 8 years ago

I think some systems are already adding their disclaimer in the response as an unofficial additional field using the underscore syntax.

We could add this for 1.1.

fschiettecatte commented 8 years ago

GeneMatcher adds a “_disclaimer” field at the top level of both request and response, I would suggest making this official as “disclaimer” and make it an optional field.

fschiettecatte commented 7 years ago

So it does not drop off the list, @Relequestual suggested adding 'terms' alongside 'disclaimer', see: https://github.com/ga4gh/mme-apis/issues/140

Relequestual commented 7 years ago

Decipher will be adding an _disclaimer with our next release.

fschiettecatte commented 7 years ago

Following Baltimore MME meeting:

_disclaimer is formalized to disclaimer and we are adding terms as well. Both are optional, live in the root object, and can be included with every request and response.

Relequestual commented 7 years ago

I think terms was only needed for the stats endpoint, and not the core MME API response object.

fschiettecatte commented 7 years ago

True, I remember now, might just be easier to generalize these across the endpoint for consistency & simplicity, they are optional.