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

Expose provider information in the tags #4273

Closed
AetherUnbound opened this issue May 6, 2024 · 0 comments · Fixed by #4280
Closed

Expose provider information in the tags #4273

AetherUnbound opened this issue May 6, 2024 · 0 comments · Fixed by #4280
Assignees
Labels
💻 aspect: code Concerns the software code in the repository 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API

Comments

@AetherUnbound
Copy link
Collaborator

Description

Related to #431

In order to differentiate the source of various tags, both creator- and machine-generated, we plan to expose the provider information to the tags block in the API results.

This can be done by adding a new field, unstable__provider, to the TagSerializer here (note that we'll need to set source="provider", since the field in the database is provider):

class TagSerializer(serializers.Serializer):

We are using unstable__provider here so that we have the flexibility to remove or change the parameter name down the line without affecting API versioning. The parameter itself can be stabilized after this project is complete.

Additional context

See: https://docs.openverse.org/projects/proposals/rekognition_data/20240423-implementation_plan_machine_generated_tags_api.html#expose-provider-in-tags

@AetherUnbound AetherUnbound added 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API labels May 6, 2024
@AetherUnbound AetherUnbound self-assigned this May 6, 2024
@openverse-bot openverse-bot moved this to 📋 Backlog in Openverse Backlog May 6, 2024
@AetherUnbound AetherUnbound moved this from 📋 Backlog to 📅 To Do in Openverse Backlog May 6, 2024
@openverse-bot openverse-bot moved this from 📅 To Do to 🏗 In Progress in Openverse Backlog May 7, 2024
@openverse-bot openverse-bot moved this from 🏗 In Progress to ✅ Done in Openverse Backlog May 7, 2024
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: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant