Graph search · GraphQL type

GraphSearchAutocompletePayload type

Completion suggestions for one graph search autocomplete request. Each suggestion list may be null when that kind of completion does not apply at the cursor position.

Fields

Field Name Description
help - String! A context-sensitive help message supporting Markdown syntax, empty when no help applies.
queryOperators - [GraphSearchAutocomplete!] Boolean query operator suggestions, e.g. AND, OR.
keys - [GraphSearchAutocompleteKey!] Search key completions, e.g. Endpoint.some -> Endpoint.something.
keyOperators - [GraphSearchAutocomplete!] Comparison operator completions for a resolved key, e.g. Endpoint.something -> Endpoint.something !=
values - [GraphSearchAutocomplete!] Value completions for a key value expression or a free text term, e.g. Endpoint.something != -> Endpoint.something != 'value'. The NULL keyword is suggested with the = and != operators to complete a null check (see SearchQueryMatchKeyNullExpression).
field - SearchQuerySchemaField The schema field the cursor's key resolved to (see SearchQuerySchemaField), null when the cursor is not on a key that resolves to exactly one field.

Related types

Example

Example

{
  "help": "abc123",
  "queryOperators": [GraphSearchAutocomplete],
  "keys": [GraphSearchAutocompleteKey],
  "keyOperators": [GraphSearchAutocomplete],
  "values": [GraphSearchAutocomplete],
  "field": SearchQuerySchemaField
}