Protocol Documentation

user is the user making the request

target is the request/response represented as a Struct

headers are the request headers

name is the unique name of the authorizer

method is the rpc method that will invoke the authorizer

expression is the boolean CEL expression that evaluates either the request or response body

target_responses sets the authorizer to evaluate request bodies

target_responses sets the authorizer to evaluate response bodies

doc_ref is the ref to the target doc. (validator.field) = {msg_exists : true}]

gtype is the type of connections to return. (validator.field) = {regex : "^.{1,225}$"}

expression is a CEL expression used to filter connections/modes

limit is the maximum number of items to return. (validator.field) = {int_gt : 0}

custom sorting of the results. (validator.field) = {regex : "((^|, )(|ref.gid|ref.gtype|^attributes.(.*)))+$"}

seek to a specific key for pagination

reverse the results

ref is the ref to the connection

attributes are k/v pairs

directed is false if the connection is bi-directional

from is the doc ref that is the source of the connection

to is the doc ref that is the destination of the connection

ref is the ref to the new Connection. If an id isn't present, one will be generated.

attributes are k/v pairs

directed is false if the connection is bi-directional

from is the doc ref that is the root of the connection

to is the doc ref that is the destination of the connection

if target_docs is true, this validator will be applied to documents.

if target_connections is true, this validator will be applied to connections.

ref is the ref to the doc

k/v pairs

ref is the ref to the new Doc. If an id isn't present, one will be generated.

arbitrary k/v pairs

docs is an array of doc constructors

docs is an array of docs

ref is the ref to the target doc/connection to patch

attributes are k/v pairs used to overwrite k/v pairs on a doc/connection

filter is used to filter docs/connections to patch

attributes are k/v pairs used to overwrite k/v pairs on all docs/connections that pass the filter

seek to a specific key for pagination

reverse the results

search in a specific index

expression is a CEL expression used to filter connections/nodes

gtype is the doc/connection type to be filtered

expression is a CEL expression used to filter connections/modes

limit is the maximum number of items to return

custom sorting of the results.

seek to a specific key for pagination

reverse the results

search in a specific index

open id connect discovery uri ex: https://accounts.google.com/.well-known/openid-configuration (env: GRAPHIK_OPEN_ID)

persistant storage ref (env: GRAPHIK_STORAGE_PATH)

cors allow headers (env: GRAPHIK_ALLOW_HEADERS)

cors allow methods (env: GRAPHIK_ALLOW_METHODS)

cors allow origins (env: GRAPHIK_ALLOW_ORIGINS)

root user is a list of email addresses that bypass authorizers. (env: GRAPHIK_ROOT_USERS)

docs are docs present in the graph

connections are connections present in the graph

gtype is the doc/connection type to be filtered

expression is a CEL expression used to filter connections/modes

if target_docs is true, this index will be applied to documents.

if target_connections is true, this index will be applied to connections.

name is the unique name of the Index

gtype is the doc/connection type to be filtered

expression is a CEL expression used to filter connections/modes

if target_docs is true, this index will be applied to documents.

if target_connections is true, this index will be applied to connections.

channel is the channel the message was sent to

data is the data sent with the message

user is the sender that triggered/sent the message

timestamp is when the message was sent

channel is the target channel to send the message to

data is the data to send with the message

message returns PONG if healthy

gtype is the type of the doc/connection ex: pet

gid is the unique id of the doc/connection within the context of it's type

gtype is the type of the doc/connection ex: pet

gid is the unique id of the doc/connection within the context of it's type

connection_types are the types of connections in the graph

doc_types are the types of docs in the graph

attributes are k/v pairs

directed is false if the connection is bi-directional

from is the doc ref that is the root of the connection

attributes are k/v pairs

directed is false if the connection is bi-directional

channel is the target channel to filter from

expression is CEL expression used to filter messages

minimum message timestamp to stream (optional)

maximum message timestamp to stream (optional)

custom sorting of the results. (validator.field) = {regex : "((^|, )(|ref.gid|ref.gtype|^attributes.(.*)))+$"}

maximum degree/depth of nodes to be visited during traversal

maximum number of nodes to be visited during traversal

custom sorting of the results. (validator.field) = {regex : "((^|, )(|ref.gid|ref.gtype|^attributes.(.*)))+$"}

maximum degree/depth of nodes to be visited during traversal

maximum number of nodes to be visited during traversal

name is the unique name of the authorizer

gtype is the type of doc/connection will invoke the trigger

trigger is the arrow syntax expression that mutates the doc/connection before it is stored ref: https://github.com/graphikDB/trigger

if target_docs is true, this trigger will be applied to documents.

if target_connections is true, this trigger will be applied to connections.