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

As a user, I want to get a bad request error if I use a URL parameter which is not supported #252

Open tloubrieu-jpl opened 1 year ago

tloubrieu-jpl commented 1 year ago

Checked for duplicates

No - I haven't checked

Related problems

I'm frustrated when make a typo in a parameter and I get a result from the API anyway but without my parameter being understood.

🧑‍🔬 User Persona(s)

Data user

💪 Motivation

...so that I can quickly spot wrong usage of the API

📖 Additional Details

Check tht there is not a extensibility motivation for supporting extra parameter silently. However I believe this is true at the specification level (the specification is extensible) but should not be true at the implementation level (the implementation is limited and should be explicit about it)

Acceptance Criteria

Given deployed server When I perform a request curl http://{server-host}/product?keyword=thing Then I expect i expect an error 400, with a text message saying parameter 'keyword' is not supported by the API

⚙️ Engineering Details

Provide some design / implementation details and/or a sub-task checklist as needed. Convert issue to Epic if estimate is outside the scope of 1 sprint.

tloubrieu-jpl commented 1 year ago

The feature request is motivated by ticket https://github.com/NASA-PDS/registry-api/issues/227