Expose provider information in the tags #4273
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
Milestone
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 theTagSerializer
here (note that we'll need to setsource="provider"
, since the field in the database isprovider
):openverse/api/api/serializers/media_serializers.py
Line 442 in 3ed38fc
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
The text was updated successfully, but these errors were encountered: