Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs(api): document gh: prefix for plugin_filename field 

Add documentation for the gh: prefix that allows loading plugins
directly from GitHub repositories. Updates both Core and Enterprise
OpenAPI specs with:

- Updated plugin_filename field description explaining gh: prefix syntax
- New github_plugin example showing usage with system_metrics plugin

closes #6968

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
docs/6968-gh-plugin-prefix
rcater 2026-03-20 15:23:16 -05:00
parent 6ad85f85bd
commit 334f89bb85
2 changed files with 40 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
api-docs/influxdb3/core/v3/influxdb3-core-openapi.yaml
View File

@ -886,6 +886,20 @@ paths:
trigger_settings:
run_async: false
error_behavior: Log
github_plugin:
summary: Trigger using a plugin from GitHub
description: |
Load a plugin directly from the influxdb3_plugins repository using the `gh:` prefix.
The server fetches the plugin file when the trigger is created or started.
value:
db: mydb
plugin_filename: "gh:influxdata/system_metrics/system_metrics.py"
trigger_name: system_metrics_trigger
trigger_specification: "every:1m"
disabled: false
trigger_settings:
run_async: false
error_behavior: Log
responses:
"200":
description: Success. Processing engine trigger created.
@ -2764,7 +2778,12 @@ components:
description: |
The path and filename of the plugin to execute--for example,
`schedule.py` or `endpoints/report.py`.
The path can be absolute or relative to the `--plugins-dir` directory configured when starting InfluxDB 3.
The path can be absolute or relative to the `--plugin-dir` directory configured when starting InfluxDB 3.
To load a plugin directly from a remote repository, use the `gh:` prefix--for example,
`gh:influxdata/system_metrics/system_metrics.py`. By default, `gh:` paths resolve to
the [influxdata/influxdb3_plugins](https://github.com/influxdata/influxdb3_plugins) repository.
Configure a custom repository with the `--plugin-repo` server option.
The plugin file must implement the trigger interface associated with the trigger's specification.
trigger_name:

21
api-docs/influxdb3/enterprise/v3/influxdb3-enterprise-openapi.yaml
View File

@ -887,6 +887,20 @@ paths:
trigger_settings:
run_async: false
error_behavior: Log
github_plugin:
summary: Trigger using a plugin from GitHub
description: |
Load a plugin directly from the influxdb3_plugins repository using the `gh:` prefix.
The server fetches the plugin file when the trigger is created or started.
value:
db: mydb
plugin_filename: "gh:influxdata/system_metrics/system_metrics.py"
trigger_name: system_metrics_trigger
trigger_specification: "every:1m"
disabled: false
trigger_settings:
run_async: false
error_behavior: Log
responses:
"200":
description: Success. Processing engine trigger created.
@ -3051,7 +3065,12 @@ components:
description: |
The path and filename of the plugin to execute--for example,
`schedule.py` or `endpoints/report.py`.
The path can be absolute or relative to the `--plugins-dir` directory configured when starting InfluxDB 3.
The path can be absolute or relative to the `--plugin-dir` directory configured when starting InfluxDB 3.
To load a plugin directly from a remote repository, use the `gh:` prefix--for example,
`gh:influxdata/system_metrics/system_metrics.py`. By default, `gh:` paths resolve to
the [influxdata/influxdb3_plugins](https://github.com/influxdata/influxdb3_plugins) repository.
Configure a custom repository with the `--plugin-repo` server option.
The plugin file must implement the trigger interface associated with the trigger's specification.
node_spec: