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

Remove legacy tags_list field #704

Closed
1 task
obulat opened this issue May 19, 2022 · 3 comments · Fixed by #956
Closed
1 task

Remove legacy tags_list field #704

obulat opened this issue May 19, 2022 · 3 comments · Fixed by #956
Assignees
Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API 🏁 status: ready for work Ready for work

Comments

@obulat
Copy link
Contributor

obulat commented May 19, 2022

Problem

The media models use an unnecessary legacy tags_list field.

Description

When the machine-generated tags were added, the data model for them changed from simple array of strings a list of ForeignKeys to a separate ImageTags table to an array of objects with properties such as provider and accuracy (only for machine-generated tags). The tags_list property was deprecated, but not removed from the database: cc-archive/cccatalog-api#182

We should remove it.

Alternatives

We could also convert all tags to use simple string array since we are not really using machine-generated tags. But I think we will want to use them in the future, and removing them now to re-add later is an unnecessary complication.

Additional context

Implementation

  • 🙋 I would be interested in implementing this feature.
@obulat obulat added 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work ✨ goal: improvement Improvement to an existing user-facing feature labels May 19, 2022
@krysal krysal added 🟨 priority: medium Not blocking but should be addressed soon 💻 aspect: code Concerns the software code in the repository and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels May 19, 2022
@dhruvkb
Copy link
Member

dhruvkb commented May 19, 2022

If we drop this from the Django models, will this need any change in the catalog or the ingestion server?

@obulat
Copy link
Contributor Author

obulat commented May 20, 2022

The catalog will not need to change anything because the tags column in the catalog is not changing. But the ingestion server will probably need to be updated.

@dhruvkb
Copy link
Member

dhruvkb commented May 20, 2022

Since the ingestion server makes no explicit reference to the columns and picks the overlapping ones, removing it from the API DB would be more than enough for the ingestion server to not copy it. I think this can be marked as ready for work then.

@dhruvkb dhruvkb added the 🏁 status: ready for work Ready for work label May 20, 2022
@krysal krysal mentioned this issue Jun 22, 2022
29 tasks
@obulat obulat transferred this issue from WordPress/openverse-api Feb 22, 2023
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Openverse Backlog Feb 23, 2023
@obulat obulat added 🧱 stack: api Related to the Django API and removed 🧱 stack: backend labels Mar 20, 2023
@obulat obulat moved this from 📋 Backlog to 🏗 In progress in Openverse Backlog Mar 20, 2023
@obulat obulat added 🧰 goal: internal improvement Improvement that benefits maintainers, not users and removed ✨ goal: improvement Improvement to an existing user-facing feature labels Mar 20, 2023
@obulat obulat self-assigned this Mar 22, 2023
@obulat obulat moved this to In Progress in Openverse Data Normalization Mar 22, 2023
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Openverse Backlog Apr 27, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in Openverse Data Normalization Apr 27, 2023
@dhruvkb dhruvkb added this to the Data normalization milestone Dec 2, 2023
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: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API 🏁 status: ready for work Ready for work
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants