Document WebDAV Search API#224
Conversation
settermjd
added
enhancement
84215b1 to
fc5f275
Compare
730437c to
0fad8b3
Compare
|
The search-files report will use the ownCloud's search API, with whatever search implementation is available. In particular, if search_elastic or search_lucene apps are installed, they'll be used. The report will remain the same, but the returned files might be different according to however those apps are configured. Not sure if it's worthy to comment it here. For the rest, it looks good to me. |
|
@jvillafanez, can you provide more context to your comment? I don't quite get where it fits in or what needs to be changed to accommodate it. |
5f88263 to
6b11d03
Compare
|
Normally, the search will be done by the default search provider. This implies that the search pattern will only match the filenames. For example, if you search "ownCloud" you'll get files whose filename has "ownCloud" in it. In case you have search_elastic, by doing the exact same search you'll also get files having "ownCloud" in the contents. |
|
Ah, I understand now. Thanks for the clarification @jvillafanez. How is the search provider specified? |
|
I guess the app itself takes care of the registration, so it's a matter of install the app the configure it properly. I don't think there is any additional thing to do. |
|
Just specify the note about search options, based on the different search providers? |
6b11d03 to
c0cafa6
Compare
|
Yes, it should be fine. |
c0cafa6 to
cb0c0c3
Compare
|
@jvillafanez, note added. Please let me know if you're okay with it. |
This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.
Before, the file organisation was descending into a mess, so it needed to be stopped and fixed before it became complete chaos. This commit does that.
2364927 to
15764e0
Compare
This commit adds a note about the functionality that search apps provide over the default search provider.
15764e0 to
ff3e1ed
Compare
3 participants
This PR documents two reports in the WebDAV Search API, file-filter and search-files. It fixes owncloud/core#31873.
This PR makes extensive use of Antora's include directive, including both examples and partials. As a result, it may make the content a bit hard to review directly in GitHub. If you build the documentation locally, it will be much easier to review.