namespace

Documentation

Index

• func AnnotateNamespace(ts *typesystem.ValidatedNamespaceTypeSystem) error
• func CheckNamespaceAndRelation(ctx context.Context, namespace string, relation string, allowEllipsis bool, ...) error
• func CheckNamespaceAndRelations(ctx context.Context, checks []TypeAndRelationToCheck, ds datastore.Reader) error
• func ListReferencedNamespaces(nsdefs []*core.NamespaceDefinition) []string
• func NewDuplicateRelationError(nsName string, relationName string) error
• func NewNamespaceNotFoundErr(nsName string) error
• func NewPermissionsCycleErr(nsName string, permissionNames []string) error
• func NewRelationNotFoundErr(nsName string, relationName string) error
• func NewUnusedCaveatParameterErr(caveatName string, paramName string) error
• func ReadNamespaceAndRelation(ctx context.Context, namespace string, relation string, ds datastore.Reader) (*core.NamespaceDefinition, *core.Relation, error)
• func ValidateCaveatDefinition(caveat *core.CaveatDefinition) error
• type DuplicateRelationError
  • func (err DuplicateRelationError) DetailsMetadata() map[string]string
  • func (err DuplicateRelationError) MarshalZerologObject(e *zerolog.Event)
• type NamespaceNotFoundError
  • func (err NamespaceNotFoundError) DetailsMetadata() map[string]string
  • func (err NamespaceNotFoundError) MarshalZerologObject(e *zerolog.Event)
  • func (err NamespaceNotFoundError) NotFoundNamespaceName() string
• type PermissionsCycleError
  • func (err PermissionsCycleError) DetailsMetadata() map[string]string
  • func (err PermissionsCycleError) MarshalZerologObject(e *zerolog.Event)
• type RelationNotFoundError
  • func (err RelationNotFoundError) DetailsMetadata() map[string]string
  • func (err RelationNotFoundError) MarshalZerologObject(e *zerolog.Event)
  • func (err RelationNotFoundError) NamespaceName() string
  • func (err RelationNotFoundError) NotFoundRelationName() string
• type TypeAndRelationToCheck
• type UnusedCaveatParameterError
  • func (err UnusedCaveatParameterError) DetailsMetadata() map[string]string
  • func (err UnusedCaveatParameterError) MarshalZerologObject(e *zerolog.Event)

Functions

func AnnotateNamespace

func AnnotateNamespace(ts *typesystem.ValidatedNamespaceTypeSystem) error

AnnotateNamespace annotates the namespace in the type system with computed aliasing and cache key metadata for more efficient dispatching.

func CheckNamespaceAndRelation

func CheckNamespaceAndRelation(
	ctx context.Context,
	namespace string,
	relation string,
	allowEllipsis bool,
	ds datastore.Reader,
) error

CheckNamespaceAndRelation checks that the specified namespace and relation exist in the datastore.

Returns datastore.NamespaceNotFoundError if the namespace cannot be found. Returns RelationNotFoundError if the relation was not found in the namespace. Returns the direct downstream error for all other unknown error.

func CheckNamespaceAndRelations

func CheckNamespaceAndRelations(ctx context.Context, checks []TypeAndRelationToCheck, ds datastore.Reader) error

CheckNamespaceAndRelations ensures that the given namespace+relation checks all succeed. If any fail, returns an error.

Returns NamespaceNotFoundError if the namespace cannot be found. Returns RelationNotFoundError if the relation was not found in the namespace. Returns the direct downstream error for all other unknown error.

func ListReferencedNamespaces

func ListReferencedNamespaces(nsdefs []*core.NamespaceDefinition) []string

ListReferencedNamespaces returns the names of all namespaces referenced in the given namespace definitions. This includes the namespaces themselves, as well as any found in type information on relations.

func NewDuplicateRelationError

func NewDuplicateRelationError(nsName string, relationName string) error

NewDuplicateRelationError constructs an error indicating that a relation was defined more than once in a namespace.

func NewNamespaceNotFoundErr

func NewNamespaceNotFoundErr(nsName string) error

NewNamespaceNotFoundErr constructs a new namespace not found error.

func NewPermissionsCycleErr

func NewPermissionsCycleErr(nsName string, permissionNames []string) error

NewPermissionsCycleErr constructs an error indicating that a cycle exists amongst permissions.

func NewRelationNotFoundErr

func NewRelationNotFoundErr(nsName string, relationName string) error

NewRelationNotFoundErr constructs a new relation not found error.

func NewUnusedCaveatParameterErr

func NewUnusedCaveatParameterErr(caveatName string, paramName string) error

NewUnusedCaveatParameterErr constructs indicating that a parameter was unused in a caveat expression.

func ReadNamespaceAndRelation

func ReadNamespaceAndRelation(
	ctx context.Context,
	namespace string,
	relation string,
	ds datastore.Reader,
) (*core.NamespaceDefinition, *core.Relation, error)

ReadNamespaceAndRelation checks that the specified namespace and relation exist in the datastore.

Returns NamespaceNotFoundError if the namespace cannot be found. Returns RelationNotFoundError if the relation was not found in the namespace. Returns the direct downstream error for all other unknown error.

func ValidateCaveatDefinition

func ValidateCaveatDefinition(caveat *core.CaveatDefinition) error

ValidateCaveatDefinition validates the parameters and types within the given caveat definition, including usage of the parameters.

Types

type DuplicateRelationError

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

DuplicateRelationError occurs when a duplicate relation was found inside a namespace.

func (DuplicateRelationError) DetailsMetadata

func (err DuplicateRelationError) DetailsMetadata() map[string]string

DetailsMetadata returns the metadata for details for this error.

func (DuplicateRelationError) MarshalZerologObject

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

MarshalZerologObject implements zerolog object marshalling.

type NamespaceNotFoundError

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

NamespaceNotFoundError occurs when a namespace was not found.

func (NamespaceNotFoundError) DetailsMetadata

func (err NamespaceNotFoundError) DetailsMetadata() map[string]string

DetailsMetadata returns the metadata for details for this error.

func (NamespaceNotFoundError) MarshalZerologObject

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

MarshalZerologObject implements zerolog object marshalling.

func (NamespaceNotFoundError) NotFoundNamespaceName

func (err NamespaceNotFoundError) NotFoundNamespaceName() string

NotFoundNamespaceName is the name of the namespace not found.

type PermissionsCycleError

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

PermissionsCycleError occurs when a cycle exists within permissions.

func (PermissionsCycleError) DetailsMetadata

func (err PermissionsCycleError) DetailsMetadata() map[string]string

DetailsMetadata returns the metadata for details for this error.

func (PermissionsCycleError) MarshalZerologObject

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

MarshalZerologObject implements zerolog object marshalling.

type RelationNotFoundError

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

RelationNotFoundError occurs when a relation was not found under a namespace.

func (RelationNotFoundError) DetailsMetadata

func (err RelationNotFoundError) DetailsMetadata() map[string]string

DetailsMetadata returns the metadata for details for this error.

func (RelationNotFoundError) MarshalZerologObject

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

func (RelationNotFoundError) NamespaceName

func (err RelationNotFoundError) NamespaceName() string

NamespaceName returns the name of the namespace in which the relation was not found.

func (RelationNotFoundError) NotFoundRelationName

func (err RelationNotFoundError) NotFoundRelationName() string

NotFoundRelationName returns the name of the relation not found.

type TypeAndRelationToCheck

type TypeAndRelationToCheck struct {
	// NamespaceName is the namespace name to ensure exists.
	NamespaceName string

	// RelationName is the relation name to ensure exists under the namespace.
	RelationName string

	// AllowEllipsis, if true, allows for the ellipsis as the RelationName.
	AllowEllipsis bool
}

TypeAndRelationToCheck is a single check of a namespace+relation pair.

type UnusedCaveatParameterError

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

UnusedCaveatParameterError indicates that a caveat parameter is unused in the caveat expression.

func (UnusedCaveatParameterError) DetailsMetadata

func (err UnusedCaveatParameterError) DetailsMetadata() map[string]string

DetailsMetadata returns the metadata for details for this error.

func (UnusedCaveatParameterError) MarshalZerologObject

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

MarshalZerologObject implements zerolog object marshalling.