The Open API specification for Synapse is now available for download!

Download Open API Spec

SearchAutocompleteBody

org.sagebionetworks.repo.model.search.SearchAutocompleteBody

Body of an autocomplete request — the OpenSearch _search shape narrowed to the type-ahead subset. The autocomplete endpoint allowlists only query and _source; pagination, sort, aggregations, suggesters, and highlight are not accepted. See the autocomplete REST endpoint for the allowed inner-clause shapes and field-reference rules.

Field Type Description
query Query

A single OpenSearch query DSL clause. Exactly one of the properties below may be set — the set property names the clause kind. See query vs. filter context and term-level vs. full-text queries.

The field-keyed leaf clauses (match, term, range, ...) are maps whose key is the column name and whose value is the per-field options object — only the long form is accepted (e.g. {"match":{"title":{"query":"x"}}}, not the {"match":{"title":"x"}} shorthand). The compound clauses (bool, dis_max, ...) nest further Query DSL clauses recursively.

_source SourceFilter A source filter selecting which columns are returned on each hit. Carried as the SearchQuery _source field. Only this typed {includes, excludes} form is accepted — the boolean (true / false) and bare-array shorthands are not.