Align REST urls using underscores or camelCase only
15580
Reporter: mdoering
Assignee: mdoering
Type: Improvement
Summary: Align REST urls using underscores or camelCase only
Priority: Blocker
Resolution: Fixed
Status: Resolved
Created: 2014-05-01 13:40:16.024
Updated: 2014-06-25 12:13:33.141
Resolved: 2014-06-25 12:13:33.108
Description: The REST API urls mix the use of underscores and camelCase for multi word based paths. For GET parameters we seem to only use camelCase.
Apart from the following registry urls we use underscore in paths and camelCase in GET parameters:
organization/UUID/hostedDataset
organization/UUID/ownedDataset
organization/nonPublishing
installation/nonPublishing
node/pendingEndorsement
node/UUID/pendingEndorsement
node/activeCountries
machinetag in a path is a single word, it should be machineTag
Propose to make all paths use camelCase only, never underscores.]]>
Author: mdoering@gbif.org
Created: 2014-06-24 16:46:34.779
Updated: 2014-06-24 16:49:37.765
Leaving this issue for CLB URLs and parameters only, creating new related issues for other projects.
URLs to refactor for CLB are:
{noformat}
/species/{int}/species_profiles
/species/{int}/vernacular_names
/species/{int}/type_specimens
/species/search?is_extinct=
/dataset_metrics/{UUID}
{noformat}
Author: mdoering@gbif.org
Created: 2014-06-24 16:50:50.697
Updated: 2014-06-24 16:51:02.342
Propose to expose clb dataset metrics in our API as
{noformat}/dataset/{UUID}/metrics{noformat}
and changing the underlying clb ws to use that convention too
Author: mdoering@gbif.org
Created: 2014-06-25 11:49:01.569
Updated: 2014-06-25 11:49:01.569
isExtinct search works fine, just needs API doc update:
http://api.gbif.org/v0.9/species/search?limit=1&q=mammalia&isExtinct=true