145 lines
8.1 KiB
Markdown
145 lines
8.1 KiB
Markdown
---
|
|
id: plugin.okf
|
|
title: OKF Knowledge
|
|
scope: plugins
|
|
status: active
|
|
priority: 10
|
|
visibility: user
|
|
category: Plugin
|
|
tags: plugin, okf
|
|
generated: true
|
|
editable: false
|
|
updated_at: "2026-06-25T12:06:11.231Z"
|
|
---
|
|
# OKF Knowledge
|
|
Role-gated knowledge, facts, and Q&A entries for Lumi communities.
|
|
## Metadata
|
|
Plugin ID: okf
|
|
Version: 0.1.0
|
|
Default state: enabled
|
|
## Web Routes
|
|
- /plugins/okf
|
|
- GET /plugins/okf
|
|
- GET /plugins/okf/admin
|
|
- POST /plugins/okf/admin/community
|
|
- POST /plugins/okf/admin/community/:slug
|
|
- POST /plugins/okf/admin/entries
|
|
- POST /plugins/okf/admin/entries/:slug
|
|
- POST /plugins/okf/admin/entries/:slug/:action
|
|
- POST /plugins/okf/admin/entries/:slug/versions/:version/restore
|
|
- POST /plugins/okf/admin/permissions
|
|
- POST /plugins/okf/admin/permissions/:id/revoke
|
|
- GET /plugins/okf/:slug
|
|
## Route Reference
|
|
### MOUNT /plugins/okf
|
|
|
|
- Purpose: Mounts the plugin router at this base WebUI path.
|
|
- Inputs: No request parameters detected by static analysis.
|
|
- Response format: Plugin router mount point.
|
|
- Access: Access is controlled by the mount options and individual plugin routes.
|
|
- Side effects: No direct route action; child routes handle requests.
|
|
- Limits/notes: Mount metadata is inferred from static source scanning.
|
|
|
|
### GET /plugins/okf
|
|
|
|
- Purpose: Renders or serves the okf plugin page.
|
|
- Inputs: query: `category`, `q`, `tag`
|
|
- Response format: HTML page rendered from an EJS view
|
|
- Access: logged-in session required or used
|
|
- Side effects: Usually read-only.
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations.
|
|
|
|
### GET /plugins/okf/admin
|
|
|
|
- Purpose: Renders the okf plugin administration page.
|
|
- Inputs: No request parameters detected by static analysis.
|
|
- Response format: HTML page rendered by a helper
|
|
- Access: OKF editor or manager permission required; admin access expected
|
|
- Side effects: Usually read-only.
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations.
|
|
|
|
### POST /plugins/okf/admin/community
|
|
|
|
- Purpose: Processes the okf plugin administration action for community.
|
|
- Inputs: body: `body`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: OKF editor or manager permission required; admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Errors are caught and usually returned as a flash message, JSON error, or error page. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/okf/admin/community/:slug
|
|
|
|
- Purpose: Processes the okf plugin administration action for community slug.
|
|
- Inputs: path params: `slug`; body: `body`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: OKF editor or manager permission required; admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Errors are caught and usually returned as a flash message, JSON error, or error page. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/okf/admin/entries
|
|
|
|
- Purpose: Processes the okf plugin administration action for entries.
|
|
- Inputs: body: full submitted body is passed to a helper; exact fields are defined by the matching form/service
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: OKF editor or manager permission required; admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Errors are caught and usually returned as a flash message, JSON error, or error page. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/okf/admin/entries/:slug
|
|
|
|
- Purpose: Processes the okf plugin administration action for entries slug.
|
|
- Inputs: path params: `slug`; body: full submitted body is passed to a helper; exact fields are defined by the matching form/service
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: OKF editor or manager permission required; admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Errors are caught and usually returned as a flash message, JSON error, or error page. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/okf/admin/entries/:slug/:action
|
|
|
|
- Purpose: Processes the okf plugin administration action for entries slug action.
|
|
- Inputs: path params: `action`, `slug`; body: `note`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: OKF editor or manager permission required; admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Errors are caught and usually returned as a flash message, JSON error, or error page. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/okf/admin/entries/:slug/versions/:version/restore
|
|
|
|
- Purpose: Processes the okf plugin administration action for entries slug versions version restore.
|
|
- Inputs: path params: `slug`, `version`; body: `note`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: OKF editor or manager permission required; admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Errors are caught and usually returned as a flash message, JSON error, or error page. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/okf/admin/permissions
|
|
|
|
- Purpose: Processes the okf plugin administration action for permissions.
|
|
- Inputs: body: full submitted body is passed to a helper; exact fields are defined by the matching form/service
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Errors are caught and usually returned as a flash message, JSON error, or error page. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### POST /plugins/okf/admin/permissions/:id/revoke
|
|
|
|
- Purpose: Processes the okf plugin administration action for permissions id revoke.
|
|
- Inputs: path params: `id`
|
|
- Response format: HTTP redirect after handling the request
|
|
- Access: admin access expected; logged-in session required or used
|
|
- Side effects: writes or mutates server-side state
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations. Errors are caught and usually returned as a flash message, JSON error, or error page. Most non-API POST routes are browser form submissions and usually redirect after completion.
|
|
|
|
### GET /plugins/okf/:slug
|
|
|
|
- Purpose: Renders or serves the okf plugin page for slug.
|
|
- Inputs: path params: `slug`
|
|
- Response format: HTML page rendered from an EJS view
|
|
- Access: logged-in session required or used
|
|
- Side effects: Usually read-only.
|
|
- Limits/notes: Generated from static route source analysis; confirm exact behavior in the handler before changing integrations.
|
|
## Commands
|
|
- No plugin command triggers detected.
|
|
## Source
|
|
Plugin folder: plugins/okf
|