Change search facet parameters to be camelCase

15582
Reporter: mdoering
Assignee: mdoering
Type: Improvement
Summary: Change search facet parameters to be camelCase
Priority: Critical
Resolution: Fixed
Status: Resolved
Created: 2014-05-01 14:26:47.347
Updated: 2014-06-25 12:29:51.596
Resolved: 2014-06-25 12:29:51.564
        
Description: The faceted registry and species search take 4 facet GET parameters which use camel case according to our API docs:

facet	A list of facet names used to retrieve the 100 most frequent values for a field. Allowed facets are: dataset_key, highertaxon_key, rank, status, extinct, habitat, and name_type. Additionally threat and nomenclatural_status are legal values but not yet implemented, so data will not yet be returned for them.

facet_mincount	Used in combination with the facet parameter. Set facet_mincount={#} to exclude facets with a count less than {#}, e.g. /search?facet=type&facet_only=true&facet_mincount=10000 only shows the type value 'OCCURRENCE' because 'CHECKLIST' and 'METADATA' have counts less than 10000.

facet_multiselect	Used in combination with the facet parameter. Set facet_multiselect=true to still return counts for values that are not currently filtered, e.g. /search?facet=type&facet_only=true&type=CHECKLIST&facet_multiselect=true still shows type values 'OCCURRENCE' and 'METADATA' even though type is being filtered by type=CHECKLIST

facet_only	Used in combination with the facet parameter. Set facet_only=true to show only facets and exclude search results.




Propose to use camelCase instead and remove facet_only in favor over setting limit=0 (currently disabled).

Facet values themselves should also be in camelCase, not using underscores]]>
    

Author: omeyn@gbif.org
Comment: Only thing that needs doing here is documentation that shows usage in camelCase (the search api already accepts almost any case/underscore)
Created: 2014-06-24 10:30:42.23
Updated: 2014-06-24 10:30:42.23

Author: mdoering@gbif.org
Created: 2014-06-25 12:29:51.594
Updated: 2014-06-25 12:29:51.594
        
Apart from POR-2234 API docs are updated:
https://github.com/gbif/portal-web/commit/bc5e5fe9d0ef115f9c52882b77605b9d1b3b642b