v1

Documentation

Index

• func ConvertCheckDispatchDebugInformation(ctx context.Context, caveatContext map[string]any, ...) (*v1.DebugInformation, error)
• func GetCaveatContext(ctx context.Context, caveatCtx *structpb.Struct, maxCaveatContextSize int) (map[string]any, error)
• func NewExperimentalServer(opts ...options.ExperimentalServerOptionsOption) v1.ExperimentalServiceServer
• func NewPermissionsServer(dispatch dispatch.Dispatcher, config PermissionsServerConfig) v1.PermissionsServiceServer
• func NewPreconditionFailedErr(precondition *v1.Precondition) error
• func NewSchemaServer(additiveOnly bool) v1.SchemaServiceServer
• func NewWatchServer() v1.WatchServiceServer
• func TranslateExpansionTree(node *core.RelationTupleTreeNode) *v1.PermissionRelationshipTree
• func TranslateRelationshipTree(tree *v1.PermissionRelationshipTree) *core.RelationTupleTreeNode
• type ErrCouldNotTransactionallyDelete
  • func NewCouldNotTransactionallyDeleteErr(filter *v1.RelationshipFilter, limit uint32) ErrCouldNotTransactionallyDelete
  • func (err ErrCouldNotTransactionallyDelete) GRPCStatus() *status.Status
• type ErrDuplicateRelationshipError
  • func NewDuplicateRelationshipErr(update *v1.RelationshipUpdate) ErrDuplicateRelationshipError
  • func (err ErrDuplicateRelationshipError) GRPCStatus() *status.Status
• type ErrExceedsMaximumPreconditions
  • func NewExceedsMaximumPreconditionsErr(preconditionCount uint16, maxCountAllowed uint16) ErrExceedsMaximumPreconditions
  • func (err ErrExceedsMaximumPreconditions) GRPCStatus() *status.Status
  • func (err ErrExceedsMaximumPreconditions) MarshalZerologObject(e *zerolog.Event)
• type ErrExceedsMaximumUpdates
  • func NewExceedsMaximumUpdatesErr(updateCount uint16, maxCountAllowed uint16) ErrExceedsMaximumUpdates
  • func (err ErrExceedsMaximumUpdates) GRPCStatus() *status.Status
  • func (err ErrExceedsMaximumUpdates) MarshalZerologObject(e *zerolog.Event)
• type ErrInvalidCursor
  • func NewInvalidCursorErr(reason string) ErrInvalidCursor
  • func (err ErrInvalidCursor) GRPCStatus() *status.Status
• type ErrPreconditionFailed
  • func (err ErrPreconditionFailed) GRPCStatus() *status.Status
  • func (err ErrPreconditionFailed) MarshalZerologObject(e *zerolog.Event)
• type PermissionsServerConfig

Functions

func ConvertCheckDispatchDebugInformation

func ConvertCheckDispatchDebugInformation(
	ctx context.Context,
	caveatContext map[string]any,
	metadata *dispatch.ResponseMeta,
	reader datastore.Reader,
) (*v1.DebugInformation, error)

ConvertCheckDispatchDebugInformation converts dispatch debug information found in the response metadata into DebugInformation returnable to the API.

func GetCaveatContext

func GetCaveatContext(ctx context.Context, caveatCtx *structpb.Struct, maxCaveatContextSize int) (map[string]any, error)

func NewExperimentalServer

func NewExperimentalServer(opts ...options.ExperimentalServerOptionsOption) v1.ExperimentalServiceServer

NewExperimentalServer creates a ExperimentalServiceServer instance.

func NewPermissionsServer

func NewPermissionsServer(
	dispatch dispatch.Dispatcher,
	config PermissionsServerConfig,
) v1.PermissionsServiceServer

NewPermissionsServer creates a PermissionsServiceServer instance.

func NewPreconditionFailedErr

func NewPreconditionFailedErr(precondition *v1.Precondition) error

NewPreconditionFailedErr constructs a new precondition failed error.

func NewSchemaServer

func NewSchemaServer(additiveOnly bool) v1.SchemaServiceServer

NewSchemaServer creates a SchemaServiceServer instance.

func NewWatchServer

func NewWatchServer() v1.WatchServiceServer

NewWatchServer creates an instance of the watch server.

func TranslateExpansionTree

func TranslateExpansionTree(node *core.RelationTupleTreeNode) *v1.PermissionRelationshipTree

func TranslateRelationshipTree

func TranslateRelationshipTree(tree *v1.PermissionRelationshipTree) *core.RelationTupleTreeNode

TranslateRelationshipTree translates a V1 PermissionRelationshipTree into a RelationTupleTreeNode.

Types

type ErrCouldNotTransactionallyDelete

type ErrCouldNotTransactionallyDelete struct {
	// contains filtered or unexported fields
}

ErrCouldNotTransactionallyDelete indicates that a deletion could not occur transactionally.

func NewCouldNotTransactionallyDeleteErr

func NewCouldNotTransactionallyDeleteErr(filter *v1.RelationshipFilter, limit uint32) ErrCouldNotTransactionallyDelete

NewCouldNotTransactionallyDeleteErr constructs a new could not transactionally deleter error.

func (ErrCouldNotTransactionallyDelete) GRPCStatus

func (err ErrCouldNotTransactionallyDelete) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

type ErrDuplicateRelationshipError

type ErrDuplicateRelationshipError struct {
	// contains filtered or unexported fields
}

ErrDuplicateRelationshipError indicates that an update was attempted on the same relationship.

func NewDuplicateRelationshipErr

func NewDuplicateRelationshipErr(update *v1.RelationshipUpdate) ErrDuplicateRelationshipError

NewDuplicateRelationshipErr constructs a new invalid subject error.

func (ErrDuplicateRelationshipError) GRPCStatus

func (err ErrDuplicateRelationshipError) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

type ErrExceedsMaximumPreconditions

type ErrExceedsMaximumPreconditions struct {
	// contains filtered or unexported fields
}

ErrExceedsMaximumPreconditions occurs when too many preconditions are given to a call.

func NewExceedsMaximumPreconditionsErr

func NewExceedsMaximumPreconditionsErr(preconditionCount uint16, maxCountAllowed uint16) ErrExceedsMaximumPreconditions

NewExceedsMaximumPreconditionsErr creates a new error representing that too many preconditions were given to a call.

func (ErrExceedsMaximumPreconditions) GRPCStatus

func (err ErrExceedsMaximumPreconditions) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

func (ErrExceedsMaximumPreconditions) MarshalZerologObject

func (err ErrExceedsMaximumPreconditions) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog object marshalling.

type ErrExceedsMaximumUpdates

type ErrExceedsMaximumUpdates struct {
	// contains filtered or unexported fields
}

ErrExceedsMaximumUpdates occurs when too many updates are given to a call.

func NewExceedsMaximumUpdatesErr

func NewExceedsMaximumUpdatesErr(updateCount uint16, maxCountAllowed uint16) ErrExceedsMaximumUpdates

NewExceedsMaximumUpdatesErr creates a new error representing that too many updates were given to a WriteRelationships call.

func (ErrExceedsMaximumUpdates) GRPCStatus

func (err ErrExceedsMaximumUpdates) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

func (ErrExceedsMaximumUpdates) MarshalZerologObject

func (err ErrExceedsMaximumUpdates) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog object marshalling.

type ErrInvalidCursor

type ErrInvalidCursor struct {
	// contains filtered or unexported fields
}

ErrInvalidCursor indicates that an invalid cursor was found.

func NewInvalidCursorErr

func NewInvalidCursorErr(reason string) ErrInvalidCursor

NewInvalidCursorErr constructs a new invalid cursor error.

func (ErrInvalidCursor) GRPCStatus

func (err ErrInvalidCursor) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

type ErrPreconditionFailed

type ErrPreconditionFailed struct {
	// contains filtered or unexported fields
}

ErrPreconditionFailed occurs when the precondition to a write tuple call does not match.

func (ErrPreconditionFailed) GRPCStatus

func (err ErrPreconditionFailed) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

func (ErrPreconditionFailed) MarshalZerologObject

func (err ErrPreconditionFailed) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog object marshalling.

type PermissionsServerConfig

type PermissionsServerConfig struct {
	// MaxUpdatesPerWrite holds the maximum number of updates allowed per
	// WriteRelationships call.
	MaxUpdatesPerWrite uint16

	// MaxPreconditionsCount holds the maximum number of preconditions allowed
	// on a WriteRelationships or DeleteRelationships call.
	MaxPreconditionsCount uint16

	// MaximumAPIDepth is the default/starting depth remaining for API calls made
	// to the permissions server.
	MaximumAPIDepth uint32

	// StreamingAPITimeout is the timeout for streaming APIs when no response has been
	// recently received.
	StreamingAPITimeout time.Duration

	// MaxCaveatContextSize defines the maximum length of the request caveat context in bytes
	MaxCaveatContextSize int

	// MaxDatastoreReadPageSize defines the maximum number of relationships loaded from the
	// datastore in one query.
	MaxDatastoreReadPageSize uint64
}

PermissionsServerConfig is configuration for the permissions server.