search

ga4gh-beacon / beacon-v2

Unified repository for the GA4GH Beacon v2 API standard
Creative Commons Zero v1.0 Universal
24 stars 20 forks source link

Filtering terms in model fix #161

Open mbaudis opened 1 month ago

mbaudis commented 1 month ago

The previous filteringTerms.yaml/json endpoint definitions were odd:

This PR redefines filteringTerms endpoints as containing a list of

https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/sections/beaconFilteringTermsResults.json#/definitions/FilteringTerm

items. Should be non-breaking.

Thanks to @gsfk for repeatedly voicing concerns about filteringTerms in general ...

NOTE: Some of the changes in the diffs seem to come from previous direct edits on json files instead of proper edit in yaml -> run yamlerrunner.sh -> ordered JSON ...

gsfk commented 1 month ago

Are these files used anywhere? Is there a compelling reason to keep them?

mbaudis commented 1 month ago

Are these files used anywhere? Is there a compelling reason to keep them?

@gsfk They represent the endpoints for the entity specific filteringTerms results but are basically stand-ins for resource specific solutions. One could argue that they are defined in openAPI endpoints - but we actually want to transition away from those & need some place to indicate that something like these exists.

That being said, I do not think that the files/definitions are used directly (one of the reasons nobody has cared about their content...).