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
3 stars 5 forks source link

As a user, I want to be able to support wildcards anywhere within a given string #437

Open jordanpadams opened 6 months ago

jordanpadams commented 6 months ago

Checked for duplicates

Yes - I've already checked

πŸ§‘β€πŸ”¬ User Persona(s)

Data User

πŸ’ͺ Motivation

...so that I can use wildcards throughout a string, not just at the beginning or end

πŸ“– Additional Details

Note: Documentation needs to also be updated here: https://nasa-pds.github.io/pds-api/guides/search/endpoints.html

This sentence doesn't really make any sense since there is no mention of wildcards on the page linked:

Wildcard searching is available with the like operator. The wildcarding syntax of the {literal value} follows the OpenSearch Simple Query String convention.

Acceptance Criteria

Given When I perform Then I expect

βš™οΈ Engineering Details

Per the original API spec:

The PDS Search API also supports wild cards ? and . A search with no q parameter specified will default to q= (search for all possible records).

If we do not support this, we should be much more clear in our documentation how/if wildcards work or don't work.

Note: This is partially implemented with suffix wildcards only.

Related Tickets:

πŸŽ‰ I&T

No response