search

NASA-PDS / pds-api

PDS web APIs specifications and user's manual
http://nasa-pds.github.io/pds-api
Other
5 stars 3 forks source link

Update API endpoints to use `identifier` instead of `lidvid` #108

Closed jordanpadams closed 3 years ago

jordanpadams commented 3 years ago

💪 Motivation

Considering the current API supports both endpoint/{lid} and endpoint/{lidvid}, it is confusing that the API spec specifically says endpoint/{lidvid}. Additionally, with the completion of NASA-PDS/registry-api#447 , specifying latest and all doesn't make sense in the context of endpoint/{lidvid} because the specific version of the product is implied.

📖 Additional Details

Update all API endpoints from endpoint/{lidvid} to endpoint/{identifier}. For the description of identifier, we can note that this is lidvid or lid.

⚙️ Engineering Details

jordanpadams commented 3 years ago

@tloubrieu-jpl any thoughts on this welcome.

tloubrieu-jpl commented 3 years ago

@jordanpadams @tdddblog I would use 'id' to match what we use in the reponse format so that it super clear to the user that we are speaking of the same thing.