From ad9170e0371fe45da29405338efd5f5da58c0abc Mon Sep 17 00:00:00 2001
From: Peter Amstutz <peter.amstutz@curii.com>
Date: Mon, 21 Mar 2022 16:30:02 -0400
Subject: [PATCH] 18767: Move to 'list' section and mention ways to list files.

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>
---
 .../methods/collections.html.textile.liquid   | 60 +++++++++----------
 1 file changed, 30 insertions(+), 30 deletions(-)

diff --git a/doc/api/methods/collections.html.textile.liquid b/doc/api/methods/collections.html.textile.liquid
index cb20693603..a2a6a77e19 100644
--- a/doc/api/methods/collections.html.textile.liquid
+++ b/doc/api/methods/collections.html.textile.liquid
@@ -55,36 +55,6 @@ Referenced blocks are protected from garbage collection in Keep.
 
 Data can be shared with other users via the Arvados permission model.
 
-h3. Searching Collections for names of file or directories
-
-You can search collections for specific file or directory names (whole or part) using the following filter in a "list":../methods.html#index query.
-
-<pre>
-filters: [["file_names", "ilike", "%sample1234.fastq%"]]
-</pre>
-
-Note: @file_names@ is a hidden field used for indexing.  It is not returned by any API call.  On the client, to get the list of files, you will need to parse the @manifest_text@.
-
-As of this writing (Arvados 2.4), you can also search for directory paths, but _not_ complete file paths.
-
-In other words, this will work (when @dir3@ is a directory):
-
-<pre>
-filters: [["file_names", "ilike", "%dir1/dir2/dir3%"]]
-</pre>
-
-However, this will _not_ return the desired results (where @sample1234.fastq@ is a file):
-
-<pre>
-filters: [["file_names", "ilike", "%dir1/dir2/dir3/sample1234.fastq%"]]
-</pre>
-
-As a workaround, you can search for both the directory path and file name separately, and then filter on the client side.
-
-<pre>
-filters: [["file_names", "ilike", "%dir1/dir2/dir3%"], ["file_names", "ilike", "%sample1234.fastq%"]]
-</pre>
-
 h2. Methods
 
 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
@@ -139,6 +109,36 @@ table(table table-bordered table-condensed).
 
 Note: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in results by default.  If you need it, pass a @select@ parameter that includes @manifest_text@.
 
+h4. Searching Collections for names of file or directories
+
+You can search collections for specific file or directory names (whole or part) using the following filter in a @list@ query.
+
+<pre>
+filters: [["file_names", "ilike", "%sample1234.fastq%"]]
+</pre>
+
+Note: @file_names@ is a hidden field used for indexing.  It is not returned by any API call.  On the client, you can programmatically enumerate all the files in a collection using @arv-ls@, the Python SDK @Collection@ class, Go SDK @FileSystem@ struct, the WebDAV API, or the S3-compatible API.
+
+As of this writing (Arvados 2.4), you can also search for directory paths, but _not_ complete file paths.
+
+In other words, this will work (when @dir3@ is a directory):
+
+<pre>
+filters: [["file_names", "ilike", "%dir1/dir2/dir3%"]]
+</pre>
+
+However, this will _not_ return the desired results (where @sample1234.fastq@ is a file):
+
+<pre>
+filters: [["file_names", "ilike", "%dir1/dir2/dir3/sample1234.fastq%"]]
+</pre>
+
+As a workaround, you can search for both the directory path and file name separately, and then filter on the client side.
+
+<pre>
+filters: [["file_names", "ilike", "%dir1/dir2/dir3%"], ["file_names", "ilike", "%sample1234.fastq%"]]
+</pre>
+
 h3. update
 
 Update attributes of an existing Collection.
-- 
2.30.2