Describes a query engine that can be used to search content on the node.
Query engines may be general purpose or specialized for particular communities or domains.
The version of the underlying query engine. Used by clients to determine possible
compatibility concerns or features available.
Version of the schema in use by the query engine, e.g. "1.0.1"
The full, human readable name of the query engine. For example:
"Apache SOLR"
An optional human readable description of the query engine. This can be
used to describe any special capabilities or intended uses for the query engine. For example,
a query engine may be tuned to suit a particular audience or domain as opposed to providing
a general purpose discovery mechanism.
This field may also contain links to additional information about the query engine,
such as documentation for the search syntax provided by the query engine implemntors.
A list of query fields supported by the query engine.
A list of query engine names that indicate the possible values for
CNRead.getQueryEngineDescription and CNRead.query REST API endpoints.
The name of a queryEngine. This value will be used as a path element in
REST API calls and so should not contain characters that will need to be escaped.
The name of the field as used programmatically when
constructing queries or other rferences to the field.
An optional, repeatable, brief description of the field that can be
used to help guide developers or end users in appropriate use of the field. May for
example, contain a links to additional documentation.
The type of the field, expressed in the language peculiar to the
query engine being described.
Indicates if the field may be used in constructing queries (as opposed
to only appearing in results)
Indicates if the field values may be returned in search results.
Indicates if the field can be used for sorting results.
Indicates if the field may contain multiple values. Some query engines
such as SOLR support this capability.