Skip to content

docs: update README to clarify route-level host middleware configuration #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pikann merged 1 commit into from
May 14, 2026
Merged

docs: update README to clarify route-level host middleware configuration #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ The bridge between your plugin and the Paca host. Available via `Init(ctx)`:
- `ctx.Route(method, path, handler)` — register an HTTP endpoint
- `ctx.On(event, handler)` — subscribe to a core platform event

Route-level host middleware (for example `authn`, `requireFreshPassword`,
`requirePermissions`) is configured in `plugin.json` under
`backend.routes[].middlewares`.

### `DB`
Typed SQL execution. The host enforces row-level scoping; you can only see data for the project where the plugin is enabled.
- `db.Query(sql, args...)` — execute a read query; returns `[]map[string]any`
Expand Down
Loading