development

Documentation

Index

• type Development
  • func NewContainer() *Development
  • func (c *Development) Check(ctx context.Context, subject *v1.Subject, action string, entity *v1.Entity) (*v1.PermissionCheckResponse, error)
  • func (c *Development) DeleteTuple(ctx context.Context, filter *v1.TupleFilter) (token token.EncodedSnapToken, err error)
  • func (c *Development) LookupEntity(ctx context.Context, subject *v1.Subject, permission, entityType string) (res *v1.PermissionLookupEntityResponse, err error)
  • func (c *Development) LookupSubject(ctx context.Context, entity *v1.Entity, permission string, ...) (res *v1.PermissionLookupSubjectResponse, err error)
  • func (c *Development) ReadSchema(ctx context.Context) (sch *v1.SchemaDefinition, err error)
  • func (c *Development) ReadTuple(ctx context.Context, filter *v1.TupleFilter) (tuples *database.TupleCollection, ...)
  • func (c *Development) Validate(ctx context.Context, shape map[string]interface{}) *Progresses
  • func (c *Development) WriteSchema(ctx context.Context, schema string) (err error)
  • func (c *Development) WriteTuple(ctx context.Context, tuples []*v1.Tuple) (err error)
• type Progress
• type Progresses
  • func (l *Progresses) AddError(message string)
  • func (l *Progresses) AddProgress(message string)

Types

type Development

type Development struct {
	Container *servers.Container
}

func NewContainer

func NewContainer() *Development

func (*Development) Check

func (c *Development) Check(ctx context.Context, subject *v1.Subject, action string, entity *v1.Entity) (*v1.PermissionCheckResponse, error)

Check - Creates new permission check request

func (*Development) DeleteTuple

func (c *Development) DeleteTuple(ctx context.Context, filter *v1.TupleFilter) (token token.EncodedSnapToken, err error)

DeleteTuple - Creates new delete relation tuple request

func (*Development) LookupEntity

func (c *Development) LookupEntity(ctx context.Context, subject *v1.Subject, permission, entityType string) (res *v1.PermissionLookupEntityResponse, err error)

LookupEntity - Looks up an entity's permissions for a given subject and permission

func (*Development) LookupSubject

func (c *Development) LookupSubject(ctx context.Context, entity *v1.Entity, permission string, subjectReference *v1.RelationReference) (res *v1.PermissionLookupSubjectResponse, err error)

LookupSubject - Looks up a subject's permissions for a given entıty and permission

func (*Development) ReadSchema

func (c *Development) ReadSchema(ctx context.Context) (sch *v1.SchemaDefinition, err error)

ReadSchema - Creates new read schema request

func (*Development) ReadTuple

func (c *Development) ReadTuple(ctx context.Context, filter *v1.TupleFilter) (tuples *database.TupleCollection, continuousToken database.EncodedContinuousToken, err error)

ReadTuple - Creates new read API request

func (*Development) Validate

func (c *Development) Validate(ctx context.Context, shape map[string]interface{}) *Progresses

Validate performs validation and compilation of schema definitions. It takes a context and a shape map and returns a Progresses object which includes the results of each validation check.

func (*Development) WriteSchema

func (c *Development) WriteSchema(ctx context.Context, schema string) (err error)

WriteSchema - Creates new write schema request

func (*Development) WriteTuple

func (c *Development) WriteTuple(ctx context.Context, tuples []*v1.Tuple) (err error)

WriteTuple - Creates new write API request

type Progress

type Progress struct {
	IsError bool   `json:"is_error"`
	Message string `json:"message"`
}

Progress - progress

type Progresses

type Progresses struct {
	Pass       bool       `json:"pass"`
	ErrorCount int        `json:"error_count"`
	Messages   []Progress `json:"messages"`
}

Progresses - progress list

func (*Progresses) AddError

func (l *Progresses) AddError(message string)

AddError - add error to error list

func (*Progresses) AddProgress

func (l *Progresses) AddProgress(message string)

AddProgress - add progress to progress list