View Source Permify.Schema (Permify v0.1.0)

Provides some functions to manipulate the Permify schema.

Link to this section Summary

lookup_req()

lookup_resp()

read_resp()

schema()

Lookup your authorization model

Read your authorization model

Write your authorization model

@type lookup_req() :: %{
  entity_type: binary(),
  relation_names: [binary()],
  schema_version: Permify.schema_version()
}

@type lookup_resp() :: [binary()]

@type read_resp() :: map()

@type schema() :: binary()

@spec lookup(Permify.Client.t(), lookup_req()) ::
  {:ok, lookup_resp()} | Permify.Client.error()

Lookup your authorization model

@spec read(Permify.Client.t(), Permify.schema_version()) ::
  {:ok, read_resp()} | Permify.Client.error()

Read your authorization model

@spec write(Permify.Client.t(), schema()) ::
  {:ok, Permify.schema_version()} | Permify.Client.error()

Write your authorization model