Skip to content

Commit c457493

Browse files
committed
chore(influxdb3): v3.2.1 fixes request trigger spec in 3Ent. Remove Core-Ent divergence notes.
1 parent 3a1afd1 commit c457493

File tree

4 files changed

+10
-75
lines changed

4 files changed

+10
-75
lines changed

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

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,8 +1239,7 @@ paths:
12391239
db: mydb
12401240
plugin_filename: request.py
12411241
trigger_name: hello_world_trigger
1242-
# trigger_specification: "request:hello-world" - For 3.2.1 (issue#6171)
1243-
trigger_specification: {"request_path": {"path": "hello-world"}}
1242+
trigger_specification: request:hello-world
12441243
cron_friday_afternoon:
12451244
summary: Cron trigger for Friday afternoons
12461245
description: |
@@ -1478,17 +1477,14 @@ paths:
14781477
For example, if you define a trigger with the following:
14791478
14801479
```json
1481-
trigger_specification: {"request_path": {"path": "hello-world"}}
1480+
trigger_specification: "request:hello-world"
14821481
```
1483-
1482+
14841483
then, the HTTP API exposes the following plugin endpoint:
14851484
14861485
```
14871486
<INFLUXDB3_HOST>/api/v3/engine/hello-world
14881487
```
1489-
1490-
***Note:*** Currently, due to a bug in InfluxDB 3 Enterprise, the request trigger specification is different from Core.
1491-
14921488
in: path
14931489
required: true
14941490
schema:
@@ -2094,25 +2090,12 @@ components:
20942090
- `table:TABLE_NAME` - Triggers on write events to a specific table
20952091
20962092
### On-demand triggers
2097-
Format: `{"request_path": {"path": "REQUEST_PATH"}}`
2093+
Format: `request:REQUEST_PATH`
20982094
20992095
Creates an HTTP endpoint `/api/v3/engine/REQUEST_PATH` for manual invocation:
2100-
- `{"request_path": {"path": "hello-world"}}` - Creates endpoint `/api/v3/engine/hello-world`
2101-
- `{"request_path": {"path": "data-export"}}` - Creates endpoint `/api/v3/engine/data-export`
2102-
2103-
***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.
2104-
2105-
oneOf:
2106-
- type: string
2107-
pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*)$
2108-
- type: object
2109-
properties:
2110-
request_path:
2111-
type: object
2112-
properties:
2113-
path:
2114-
type: string
2115-
pattern: ^[a-zA-Z0-9_-]+$
2096+
- `request:hello-world` - Creates endpoint `/api/v3/engine/hello-world`
2097+
- `request:data-export` - Creates endpoint `/api/v3/engine/data-export`
2098+
pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|request:[a-zA-Z0-9_-]+)$
21162099
example: cron:0 0 6 * * 1-5
21172100
trigger_arguments:
21182101
type: object

content/shared/influxdb3-cli/create/trigger.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -113,15 +113,3 @@ influxdb3 create trigger \
113113
Creating a trigger in a disabled state prevents it from running immediately. You can enable it later when you're ready to activate it.
114114

115115
{{% /code-placeholders %}}
116-
117-
{{% show-in "enterprise" %}}
118-
> [!Warning]
119-
> #### Request trigger specification format differs between CLI and API
120-
>
121-
> Due to a bug in InfluxDB 3 Enterprise, the request trigger specification format differs:
122-
>
123-
> - **CLI**: `request:<REQUEST_PATH>` (same as Core CLI and API)
124-
> - **Enterprise API**: `{"request_path": {"path": "<REQUEST_PATH>"}}`
125-
>
126-
> See the [API reference](/influxdb3/enterprise/api/#operation/PostConfigureProcessingEngineTrigger) for examples. Use `influxdb3 show summary` to verify the actual trigger specification.
127-
{{% /show-in %}}

content/shared/influxdb3-get-started/processing-engine.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,6 @@ specifications:
4141
The plugin receives the HTTP request headers and content, and can parse,
4242
process, and send the data into the database or to third-party services.
4343

44-
{{% show-in "enterprise" %}}
45-
> [!Warning]
46-
> #### Request trigger specification format differs between CLI and API
47-
>
48-
> Due to a bug in InfluxDB 3 Enterprise, the request trigger specification format differs:
49-
>
50-
> - **CLI**: `request:<REQUEST_PATH>` (same as Core CLI and API)
51-
> - **Enterprise API**: `{"request_path": {"path": "<REQUEST_PATH>"}}`
52-
>
53-
> See the [API reference](/influxdb3/enterprise/api/#operation/PostConfigureProcessingEngineTrigger) for examples. Use `influxdb3 show summary` to verify the actual trigger specification.
54-
{{% /show-in %}}
55-
5644
## Activate the processing engine
5745

5846
To activate the processing engine, include the `--plugin-dir <PLUGIN_DIR>` option

content/shared/v3-core-plugins/_index.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ def process_scheduled_call(influxdb3_local, call_time, args=None):
224224

225225
#### Create an HTTP request plugin
226226

227-
HTTP request plugins respond to API calls using [`request:`](#trigger-on-http-requests) trigger specifications{{% show-in "enterprise" %}} (CLI) or `{"request_path": {"path": "..."}}` (HTTP API){{% /show-in %}}. Use them for:
227+
HTTP request plugins respond to API calls using [`request:`](#trigger-on-http-requests) trigger specifications. Use them for:
228228

229229
- Creating custom API endpoints
230230
- Webhooks for external integrations
@@ -263,7 +263,7 @@ After writing your plugin:
263263
|------------|----------------------|-----------------|
264264
| Data write | `table:<TABLE_NAME>` or `all_tables` | When data is written to tables |
265265
| Scheduled | `every:<DURATION>` or `cron:<EXPRESSION>` | At specified time intervals |
266-
| HTTP request | `request:<REQUEST_PATH>`{{% show-in "enterprise" %}} (CLI) or `{"request_path": {"path": "<REQUEST_PATH>"}}` (HTTP API){{% /show-in %}} | When HTTP requests are received |
266+
| HTTP request | `request:<REQUEST_PATH>` | When HTTP requests are received |
267267

268268
### Use the create trigger command
269269

@@ -367,18 +367,6 @@ To view triggers associated with a database, use the `influxdb3 show summary` co
367367
influxdb3 show summary --database my_database --token AUTH_TOKEN
368368
```
369369

370-
{{% show-in "enterprise" %}}
371-
> [!Warning]
372-
> #### Request trigger specification format differs between CLI and API
373-
>
374-
> Due to a bug in InfluxDB 3 Enterprise, the request trigger specification format differs:
375-
>
376-
> - **CLI**: `request:<REQUEST_PATH>` (same as Core CLI and API)
377-
> - **Enterprise API**: `{"request_path": {"path": "<REQUEST_PATH>"}}`
378-
>
379-
> See the [API reference](/influxdb3/enterprise/api/#operation/PostConfigureProcessingEngineTrigger) for examples. Use `influxdb3 show summary` to verify the actual trigger specification.
380-
{{% /show-in %}}
381-
382370
### Pass arguments to plugins
383371

384372
Use trigger arguments to pass configuration from a trigger to the plugin it runs. You can use this for:
@@ -600,19 +588,7 @@ Each plugin must run on a node that supports its trigger type:
600588
|--------------------|--------------------------|-----------------------------|
601589
| Data write | `table:` or `all_tables` | Ingester nodes |
602590
| Scheduled | `every:` or `cron:` | Any node with scheduler |
603-
| HTTP request | `request:`{{% show-in "enterprise" %}} (CLI) or `{"request_path": {"path": "..."}}` (HTTP API){{% /show-in %}} | Nodes that serve API traffic|
604-
605-
{{% show-in "enterprise" %}}
606-
> [!Note]
607-
> #### Request trigger specification format differs between CLI and API
608-
>
609-
> Due to a bug in InfluxDB 3 Enterprise, the request trigger specification format differs:
610-
>
611-
> - **CLI**: `request:<REQUEST_PATH>` (same as Core CLI and API)
612-
> - **Enterprise API**: `{"request_path": {"path": "<REQUEST_PATH>"}}`
613-
>
614-
> See the [API reference](/influxdb3/enterprise/api/#operation/PostConfigureProcessingEngineTrigger) for examples.
615-
{{% /show-in %}}
591+
| HTTP request | `request:` | Nodes that serve API traffic|
616592

617593
For example:
618594
- Run write-ahead log (WAL) plugins on ingester nodes.

0 commit comments

Comments
 (0)