API Reference Sekisho v#0.1.0-dev

Copy Markdown View Source

Modules

Permissions for Phoenix.

A permission refused: what authorize/3 returns and authorize!/3 raises.

Why a permission is allowed or not: what explain/3 returns.

A role given to someone on a record: a row of sekisho_grants.

Permissions in LiveView: events checked before your handle_event/3 runs, and pages that lose their access while they are open.

Sekisho's tables, in a migration of your app.

The rules of one resource: an Ecto schema.

A role a record defines for itself (an org's "Support"): a row of sekisho_roles, with a name and some of its policy's permissions.

Roles, relations and groups from your own tables, as queries.

Assertions for your tests, whose failures say why (explain/3)

Mix Tasks

Generates the migration of Sekisho's tables in your repo: the one that installs them, or, after an upgrade of Sekisho, the one that brings them to their latest version.

Installs Sekisho in a Phoenix application.