Replace API collection paths with search parameters #3869
Labels
💻 aspect: code
Concerns the software code in the repository
✨ goal: improvement
Improvement to an existing user-facing feature
🟧 priority: high
Stalls work on the project or its dependents
🧱 stack: api
Related to the Django API
Milestone
Problem
Additional search views in the API should use the
/search
endpoint with query parameters instead of separate endpoints with path parameters.Description
The following changes are necessary:
unstable__collection
and also addunstable_tag
(singular, in addition to pluraltags
that's used for search within tags instead of exact match)build_collection_query
methodAdditional changes
During the writing and review process, the following changes were also added:
MediaSearchRequestSourceSerializer
was merged into theMediaSearchRequestSerializer
. We now need to addmedia_type
to the serializer context when calling it.SHOW_COLLECTION_DOCS
env variable allows to show the updated documentation for the search endpoint. When it's set to False, no changes are shown in the API doc site.Additional context
The changes were discussed in Rethinking additional search views URLs
The text was updated successfully, but these errors were encountered: