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

request for more documentation on the /search endpoint #52

Open
jellomoat opened this issue Feb 6, 2025 · 1 comment
Open

request for more documentation on the /search endpoint #52

jellomoat opened this issue Feb 6, 2025 · 1 comment
Assignees

Comments

@jellomoat
Copy link

Hi! Could you please provide more documentation on the /search endpoint here?

It would be especially helpful to have a list of valid parameters/more examples of how to structure queries for common use cases, eg filtering by template and combining multiple filters. I was only able to figure out syntax for filtering through trial and error and reviewing GitHub issues in the main uwazi repo.

@aphilop
Copy link
Collaborator

aphilop commented Feb 6, 2025

Hi @jellomoat,

Thanks for reaching out about your need regarding the documentation. We are currently in the process of rethinking/revamping the Uwazi documentation and providing more information about the API is definitely in our plans.
However, I can not tell how long this would take, so I am wondering how to best support you in the meantime.
If you could share some more context, we might be able to put something together that addresses your specific needs.
For example:

  • What are you trying to achieve using the API?
  • What kind of information are you interested in getting through it?
  • How complex is your template/filter structure?
  • Do you use a self-hosted version of Uwazi or one that we host?

Looking forward to getting this sorted for you!

@aphilop aphilop self-assigned this Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants