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

Create a special ug_sources parameter for use in integrations #3421

Open
obulat opened this issue Nov 30, 2023 · 2 comments
Open

Create a special ug_sources parameter for use in integrations #3421

obulat opened this issue Nov 30, 2023 · 2 comments
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API

Comments

@obulat
Copy link
Contributor

obulat commented Nov 30, 2023

Problem

Currently we exclude some sources from the Openverse integrations. The sources list can change over time, and updating it everywhere can be tedious and time-consuming.

Description

Create a special value for the source parameter, ug_sources (user-generated sources, looking for a better name), that would be set in the API layer to the sources that are user-generated and should be filtered out to ensure that the API returns non-sensitive results. The build_search_query would then convert this special parameter to a list of the sources that we have marked as sources to filter out from integrations.

Alternatives

Update the integrations individually. This would be tedious and would require much more work for updates.

Additional context

This change could also improve the query performance because currently the integrations use a very long list of sources in filters.

@obulat obulat added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: api Related to the Django API labels Nov 30, 2023
@openverse-bot openverse-bot moved this to 📋 Backlog in Openverse Backlog Nov 30, 2023
@obulat obulat moved this from 📋 Backlog to 📅 To Do in Openverse Backlog Nov 30, 2023
@obulat obulat moved this from 📅 To Do to 📋 Backlog in Openverse Backlog Nov 30, 2023
@firatbezir
Copy link
Contributor

i can take a look at this, @obulat could you please specify the path for this issue?

@obulat
Copy link
Contributor Author

obulat commented Mar 21, 2024

i can take a look at this, @obulat could you please specify the path for this issue?

It would be better if you took one of the "help wanted" issues, @firatbezir ,as those usually have a more clear scope

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants