45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
---
|
|
id: plugin.sample-plugin
|
|
title: Sample Plugin
|
|
scope: plugins
|
|
status: active
|
|
priority: 10
|
|
visibility: user
|
|
category: Plugin
|
|
tags: plugin, sample-plugin
|
|
generated: true
|
|
editable: false
|
|
updated_at: "2026-06-25T12:06:11.231Z"
|
|
---
|
|
# Sample Plugin
|
|
Example plugin with a simple page.
|
|
## Metadata
|
|
Plugin ID: sample-plugin
|
|
Version: 0.1.0
|
|
Default state: enabled
|
|
## Web Routes
|
|
- /plugins/sample-plugin
|
|
- GET /plugins/sample-plugin
|
|
## Route Reference
|
|
### MOUNT /plugins/sample-plugin
|
|
|
|
- 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/sample-plugin
|
|
|
|
- Purpose: Renders or serves the sample-plugin plugin page.
|
|
- Inputs: No request parameters detected by static analysis.
|
|
- Response format: HTML page rendered from an EJS view
|
|
- Access: No explicit access guard detected in the route handler; check surrounding router/mount middleware.
|
|
- 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/sample-plugin
|