Skip to content

Commit

Permalink
update search api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenwinship committed Dec 10, 2024
1 parent 5f1ea6b commit 3be6369
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/sphinx-guides/source/api/search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ geo_point string Latitude and longitude in the form ``geo_point=42.3,-7
geo_radius string Radial distance in kilometers from ``geo_point`` (which must be supplied as well) such as ``geo_radius=1.5``.
metadata_fields string Includes the requested fields for each dataset in the response. Multiple "metadata_fields" parameters can be used to include several fields. The value must be in the form "{metadata_block_name}:{field_name}" to include a specific field from a metadata block (see :ref:`example <dynamic-citation-some>`) or "{metadata_field_set_name}:\*" to include all the fields for a metadata block (see :ref:`example <dynamic-citation-all>`). "{field_name}" cannot be a subfield of a compound field. If "{field_name}" is a compound field, all subfields are included.
show_type_counts boolean Whether or not to include total_count_per_object_type for types: dataverse, dataset, and files.
=============== ======= ===========
================ ======= ===========

Basic Search Example
--------------------
Expand Down

0 comments on commit 3be6369

Please sign in to comment.