-
Notifications
You must be signed in to change notification settings - Fork 86
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
proposal: v2 Search endpoint and generalized entity model #527
Labels
enhancement
New feature or request
Comments
adamdecaf
added a commit
to adamdecaf/watchman
that referenced
this issue
Jan 4, 2024
adamdecaf
added a commit
to adamdecaf/watchman
that referenced
this issue
Jan 10, 2024
adamdecaf
added a commit
to adamdecaf/watchman
that referenced
this issue
Mar 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
With the recent additions of entity lists from around the world we've started to notice there are many overlapping fields (often named slightly differently) and the current
/search
endpoint has grown well beyond its initial scope. The current endpoint returns many key/array-of-objects results which are hard to parse though.This proposal is two fold.
/v2/search
endpoint which accepts generalized field queries to search across all listsGeneralized model for enties
The idea of a generalized model would be to offer a shared high-level search across all supported lists and shared fields for every entity supported by Watchman.
Initially the modeling could look like the following:
Q: Should we adopt the OpenSanctions modeling?
v2 Search Endpoint
Create a new
/v2/search
endpoint which accepts all of the generalized entity fields as parameters and searches across all supported lists. Results are returned in their generalized form with a sub-object of their source list data. (In the original naming of the source list.)Pros: One stop source for search with a basic interface across all lists.
Cons: Dynamic types can be annoying to deal with in some languages.
Related Issues
#525, #441, #443, #444, #445, #353, #352
The text was updated successfully, but these errors were encountered: