search

NASA-PDS / registry-api

Web API service for the PDS Registry, providing the implementation of the PDS Search API (https://github.com/nasa-pds/pds-api) for the PDS Registry.
https://nasa-pds.github.io/pds-api
Apache License 2.0
2 stars 5 forks source link

As a user, I want to know what are all the possible properties I can search against (`/properties`) #506

Closed jordanpadams closed 1 month ago

jordanpadams commented 2 months ago

Checked for duplicates

No - I haven't checked

🧑‍🔬 User Persona(s)

No response

💪 Motivation

...so that I can know all the available properties I can search by in the API.

📖 Additional Details

No response

Acceptance Criteria

Given a running API service When I perform GET /properties Then I expect to receive the set of all properties available for search within the system

⚙️ Engineering Details

Note: This is a first barebones pass and what is returned by this endpoint. A more robust, detailed response will eventually be needed in order to support a more useful response (e.g. definitions)

🎉 I&T

No response

alexdunnjpl commented 1 month ago

@jordanpadams is this endpoint intended to ever support subsetting, or is it sufficient to (more or less) dump the union of all registry indices' _mapping content?

jordanpadams commented 1 month ago

@alexdunnjpl I think for now a dump of the _mapping works for now. We probably want a smarter version of this that actually pulls information from the PDS4 Information Model, but I think for now, just a top of what is searchable will do.

jordanpadams commented 1 month ago

@tloubrieu-jpl ☝️