Skip to main content

SearchTypesCapability

The search types the implementation supports, as a map of search type to its details. Presence of a key means the search type is supported. basic is always present; advanced is optional.

A search request with a searchType not declared here MUST be rejected with a 400 ValidationError. New search types are added by revision of this specification; clients MUST ignore search types they do not recognise.

basicobjectrequired

Basic search. It has no details to communicate; the value is an empty object.

advanced object

Declares advanced search, and the fields an advanced query may name.

fields objectrequired

The fields an advanced query may name, as a map of field name to its declaration. Every advanced field matches as text. A query naming a field not declared here MUST be rejected with a 422.

property name* AdvancedFieldCapability

Describes a field an advanced query may name.

labelstring

An optional human-readable display label for the field.

Example: Title
SearchTypesCapability
{
"basic": {},
"advanced": {
"fields": {
"name": {
"label": "Title"
},
"description": {}
}
}
}