update search api doc

IQSS · Dec 10, 2024 · 9cc3f7f · 9cc3f7f
1 parent 3be6369
commit 9cc3f7f
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/doc/sphinx-guides/source/api/search.rst b/doc/sphinx-guides/source/api/search.rst
@@ -21,9 +21,9 @@ Please note that in Dataverse Software 4.3 and older the "citation" field wrappe
 Parameters
 ----------
 
-===============  =======  ===========
+================ =======  ===========
 Name             Type     Description
-===============  =======  ===========
+================ =======  ===========
 q                string   The search term or terms. Using "title:data" will search only the "title" field. "*" can be used as a wildcard either alone or adjacent to a term (i.e. "bird*"). For example, https://demo.dataverse.org/api/search?q=title:data . For a list of fields to search, please see https://github.com/IQSS/dataverse/issues/2558 (for now).
 type             string   Can be either "dataverse", "dataset", or "file". Multiple "type" parameters can be used to include multiple types (i.e. ``type=dataset&type=file``). If omitted, all types will be returned.  For example, https://demo.dataverse.org/api/search?q=*&type=dataset
 subtree          string   The identifier of the Dataverse collection to which the search should be narrowed. The subtree of this Dataverse collection and all its children will be searched.  Multiple "subtree" parameters can be used to include multiple Dataverse collections. For example, https://demo.dataverse.org/api/search?q=data&subtree=birds&subtree=cats .