Add API for getting facets.#279
Open
colinrobinsonuib wants to merge 4 commits intoProfessionalWiki:masterfrom
Open
Add API for getting facets.#279colinrobinsonuib wants to merge 4 commits intoProfessionalWiki:masterfrom
colinrobinsonuib wants to merge 4 commits intoProfessionalWiki:masterfrom
Conversation
Closed
Member
|
@colinrobinsonuib Thanks for the patch! What is your use case that motivates the addition of this new API endpoint? |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #279 +/- ##
============================================
- Coverage 74.07% 69.29% -4.78%
- Complexity 399 414 +15
============================================
Files 47 48 +1
Lines 1292 1381 +89
============================================
Hits 957 957
- Misses 335 424 +89 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Author
I'm running mediawiki fully headless, so I need the API to be able to use faceted searches in my frontend. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
It is already possible to search using facets with the existing search API.
Example:
/api.php?action=query&list=search&format=json&srsearch=john+haswbfacet%3AP1%3DQ91&srnamespace=120Is the same as searching
john haswbfacet:P1=Q91on the search page. But this only gives you the results, not the facets available to do another search. Getting those facets is crucial for building a headless application.You can search on the elasticsearch server directly as I show in this comment #275 (comment)
This PR adds a new API endpoint for retriving those values directly through mediawiki without needing to expose the elasticsearch server.
Example usage:
api.php?action=wbfacetsearch&search=john+haswbfacet:P1=Q91&format=json&namespaces=120Response: