Skip to content

Commit 5a44f6c

Browse files
jstirnamanclaude
andcommitted
fix(influxdb3): Update request trigger specification format for Enterprise
Due to a bug in InfluxDB 3 Enterprise, the request trigger specification format diverges from InfluxDB 3 Core. Enterprise requires a JSON object format: {"request_path": {"path": "path-name"}} instead of the simpler "request:path-name" format used in Core. This commit updates: - API examples to use the correct JSON object format - Documentation to clearly show the required format - Schema validation to accept both string and object formats - Added clarifying note about the format difference Related to influxdata/influxdb#6171 which will address this in the 3.2.1 release. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 9588022 commit 5a44f6c

File tree

1 file changed

+25
-8
lines changed
  • api-docs/influxdb3/enterprise/v3

1 file changed

+25
-8
lines changed

api-docs/influxdb3/enterprise/v3/ref.yml

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,7 +1239,8 @@ paths:
12391239
db: mydb
12401240
plugin_filename: request.py
12411241
trigger_name: hello_world_trigger
1242-
trigger_specification: "request:hello-world"
1242+
# trigger_specification: "request:hello-world" - For 3.2.1 (issue#6171)
1243+
trigger_specification: '{"request_path": {"path": "hello-world"}}'
12431244
cron_friday_afternoon:
12441245
summary: Cron trigger for Friday afternoons
12451246
description: |
@@ -1472,19 +1473,22 @@ paths:
14721473
parameters:
14731474
- name: request_path
14741475
description: |
1475-
The path configured in the request trigger specification "request:<request_path>"` for the plugin.
1476+
The path configured in the request trigger specification for the plugin.
14761477
14771478
For example, if you define a trigger with the following:
14781479
14791480
```json
1480-
trigger_specification: "request:hello-world"
1481+
trigger_specification: {"request_path": {"path": "hello-world"}}
14811482
```
1482-
1483+
14831484
then, the HTTP API exposes the following plugin endpoint:
14841485
14851486
```
14861487
<INFLUXDB3_HOST>/api/v3/engine/hello-world
14871488
```
1489+
1490+
***Note:*** Currently, due to a bug in InfluxDB 3 Enterprise, the request trigger specification is different from Core.
1491+
14881492
in: path
14891493
required: true
14901494
schema:
@@ -2091,12 +2095,25 @@ components:
20912095
- `table:TABLE_NAME` - Triggers on write events to a specific table
20922096
20932097
### On-demand triggers
2094-
Format: `request:REQUEST_PATH`
2098+
Format: `{"request_path": {"path": "REQUEST_PATH"}}`
20952099
20962100
Creates an HTTP endpoint `/api/v3/engine/REQUEST_PATH` for manual invocation:
2097-
- `request:hello-world` - Creates endpoint `/api/v3/engine/hello-world`
2098-
- `request:data-export` - Creates endpoint `/api/v3/engine/data-export`
2099-
pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|request:[a-zA-Z0-9_-]+)$
2101+
- `{"request_path": {"path": "hello-world"}}` - Creates endpoint `/api/v3/engine/hello-world`
2102+
- `{"request_path": {"path": "data-export"}}` - Creates endpoint `/api/v3/engine/data-export`
2103+
2104+
***Note:*** Currently, due to a bug in InfluxDB 3 Enterprise, the request trigger specification is different from Core. Use the JSON object format shown above.
2105+
2106+
oneOf:
2107+
- type: string
2108+
pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*)$
2109+
- type: object
2110+
properties:
2111+
request_path:
2112+
type: object
2113+
properties:
2114+
path:
2115+
type: string
2116+
pattern: ^[a-zA-Z0-9_-]+$
21002117
example: cron:0 0 6 * * 1-5
21012118
trigger_arguments:
21022119
type: object

0 commit comments

Comments
 (0)