archesproject / arches-docs

official repo for Arches documentation
https://arches.readthedocs.io
9 stars 20 forks source link

document using "search/resources" url for 3rd party usage #428

Open whatisgalen opened 2 months ago

whatisgalen commented 2 months ago

describe the issue

Any client can access the search_results method over http via the url search/resources$ however there isn't any documentation about how to modify the query object for the GET request. Most query object modification happens in the frontend in the search components, and then each search component has its evaluation logic in its respective python file on the backend. This ticket is different from #222 in that it proposes documenting core arches search components as well as 3rd party client usage of the search/resources$ url.

please add links to existing docs or code (if relevant)
which release does this issue concern?

all