Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Keyword Search Support #264

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

confused-Techie
Copy link
Member

@confused-Techie confused-Techie commented Jun 28, 2024

Requirements

  • Filling out the template is required.

  • All new code requires tests to ensure against regressions.

    • However, if your PR contains zero code changes, feel free to select the checkmark below to indicate so.
  • Have you ran tests against this code?

  • This PR contains zero code changes.

Description of the Change

As referenced in #206 we discussed how to allow users to search tags of packages, including tags that exist only on this platform.

In my reply there I detail several steps that would be needed to begin to support this kind functionality.

With the first step possible being one that enables the generic searching of details within the package.jsons keywords array at all. Which is exactly what this PR does.

Although unfortunately this PR doesn't support searching this field just yet, it will match with any exact matches just fine.

This new functionality is exposed via the query parameter tags on the following endpoints:

  • GET /api/packages/search
  • GET /api/packages

This will allow exact matches to be found for any existing packages data in the keywords array from the package.json. An example request would look like:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant