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

Search API documentation seems outdated? #257

Closed jordanpadams closed 1 year ago

jordanpadams commented 1 year ago

Checked for duplicates

Yes - I've already checked

🐛 Describe the bug

When I did looked at https://nasa-pds.github.io/pds-api/guides/search/endpoints.html#search-products, it seems the documentation is outdated?

🕵️ Expected behavior

Shouldn't the base level endpoint we predominantly direct users to be /api/search/1/products? And then all the /api/search/1/classes searches are more specialized for browsing the hierarchy? Maybe I lost track on this and this is what we want...

Also, our first test case says search for products but then the first example is for the first 10 collections matching some criteria? Seems a bit confusing.

📜 To Reproduce

https://nasa-pds.github.io/pds-api/guides/search/endpoints.html#search-products

🖥 Environment Info

N/A

📚 Version of Software Used

v1.1.0 (looks to be the same in the latest SNAPSHOT)

🩺 Test Data / Additional context

N/A

🦄 Related requirements

N/A

⚙️ Engineering Details

No response