Additional parameters for GET queries and documentation of use vs. POST/schemas

[mbaudis]

As per various discussions, using GET request seems a rather widely used concept with implementers (rapid UI integration w/o need of using specific frameworks; easier documentation, examples, testing etc.). In fact, while we also implement POST in parallel, for Progenetix so far we rely on GET.

I would propose that we provide an extended matrix for parameters in GET queries. Examples here are

• includeDescendantTerms - this can in POST be provided per filter but works for "medium complex use cases" as a global parameter
• requestedGranularity, includeResultsetResponses - simple globals, but need to be documented that they can be used in GET
• requestedSchemas - could be supported as resolving to entityType?
• ...

IMO it would be much easier for many implementers to see such parameters as simple query parameters, and then the comparable documentation of the POST schemas.

Also see ga4gh-beacon/beacon-framework-v2#43

[jrambla]

Is your suggestion about adding these parameters to the endpoints.yaml files?