Add HTTP API examples to Processing Engine plugin documentation#6789
Merged
jstirnaman merged 6 commits intocopilot/fix-disabled-field-requirementfrom Feb 4, 2026
Merged
Conversation
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add HTTP API examples to InfluxDB 3 plugins documentation
Add HTTP API examples to Processing Engine plugin documentation
Feb 4, 2026
Contributor
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Contributor
Author
jstirnaman
requested changes
Feb 4, 2026
|
|
||
| Replace {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{% token-link "admin" %}} | ||
|
|
||
| For complete reference, see [Update plugin file](/influxdb3/version/api/v3/#operation/PutPluginFile). |
Contributor
There was a problem hiding this comment.
@copilot Instead of linking here, set the url in {{% api-endpoint method="PUT" endpoint="{{< influxdb/host >}}/api/v3/plugins/files" %}} line 461.
Contributor
Author
There was a problem hiding this comment.
Updated in dc175fc. Added api-ref parameter to api-endpoint shortcode and removed the separate link sentence.
| - {{% code-placeholder-key %}}`TRIGGER_SPEC`{{% /code-placeholder-key %}}: Trigger specification (see [examples](#trigger-specification-examples)) | ||
| - {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{% token-link "database" %}}{{% show-in "enterprise" %}} with write permissions on the specified database{{% /show-in %}} | ||
|
|
||
| For complete reference, see [Create processing engine trigger](/influxdb3/version/api/v3/#operation/PostConfigureProcessingEngineTrigger). |
Contributor
There was a problem hiding this comment.
@copilot Set the URL in {{% api-endpoint method="POST" endpoint="{{< influxdb/host >}}/api/v3/configure/processing_engine_trigger" %}}, line 595 instead of this sentence.
Contributor
Author
There was a problem hiding this comment.
Updated in dc175fc. Added api-ref parameter to api-endpoint shortcode and removed the separate link sentence.
| curl -X POST "{{< influxdb/host >}}/api/v3/configure/processing_engine_trigger" \ | ||
| --header "Authorization: Bearer AUTH_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ |
| curl -X POST "{{< influxdb/host >}}/api/v3/configure/processing_engine_trigger" \ | ||
| --header "Authorization: Bearer AUTH_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ |
| curl -X POST "{{< influxdb/host >}}/api/v3/configure/processing_engine_trigger" \ | ||
| --header "Authorization: Bearer AUTH_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ |
| curl -X POST "{{< influxdb/host >}}/api/v3/configure/processing_engine_trigger" \ | ||
| --header "Authorization: Bearer AUTH_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ |
| curl -X POST "{{< influxdb/host >}}/api/v3/configure/processing_engine_trigger" \ | ||
| --header "Authorization: Bearer AUTH_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ |
| curl -X POST "{{< influxdb/host >}}/api/v3/configure/processing_engine_trigger" \ | ||
| --header "Authorization: Bearer AUTH_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ |
| curl -X POST "{{< influxdb/host >}}/api/v3/configure/processing_engine_trigger" \ | ||
| --header "Authorization: Bearer AUTH_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ |
| curl -X POST "{{< influxdb/host >}}/api/v3/configure/processing_engine_trigger" \ | ||
| --header "Authorization: Bearer AUTH_TOKEN" \ | ||
| --header "Content-Type: application/json" \ | ||
| --data '{ |
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
jstirnaman
requested changes
Feb 4, 2026
|
|
||
| Replace {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{% token-link "admin" %}} | ||
|
|
||
| For complete reference, see [Update plugin file](/influxdb3/version/api/v3/#operation/PutPluginFile). |
Contributor
There was a problem hiding this comment.
@copilot Set this URL in {{% api-endpoint method="PUT" endpoint="{{< influxdb/host >}}/api/v3/plugins/files" %}}, line 397 instead of in this sentence.
Contributor
Author
There was a problem hiding this comment.
Updated in e27fa28. Added api-ref parameter to the upload plugin api-endpoint shortcode and removed the separate link sentence.
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
jstirnaman
changed the base branch from
master
to
copilot/fix-disabled-field-requirement
jstirnaman
merged commit 8568326
into
copilot/fix-disabled-field-requirement
1 check passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add HTTP API examples to Processing Engine plugin documentation
This PR adds comprehensive HTTP API examples alongside CLI examples in the Processing Engine guide, addressing the issue requirement to "Include API examples" for Core and Enterprise processing engine guides.
✅ All Requirements Met
api-docs/influxdb3/for accurate endpoint detailsdisabledfield to all API examples per review feedbackapi-refparameter in all api-endpoint shortcodes instead of separate link sentences📝 Sections Updated (10 major additions)
PUT /api/v3/plugins/filesendpointPUT /api/v3/plugins/filesendpointPOST /api/v3/configure/processing_engine_triggerwith full parameterstable:andall_tablesevery:andcron:request:specificationstrigger_argumentsobject usagerun_asyncsettingerror_behavioroptions (Retry,Disable)POST /api/v3/configure/plugin_environment/install_packages🎨 Implementation Details
Formatting:
{{< code-tabs-wrapper >}}for CLI vs HTTP API comparison{{% code-placeholders %}}{{% api-endpoint %}}withapi-refparameter for direct linksParameter Accuracy:
api-docs/influxdb3/core/v3/ref.ymldb,plugin_filename,trigger_specification,trigger_settingsdisabledfieldDocumentation Links:
api-endpointshortcodes viaapi-refparameter📊 Statistics
🔍 Testing Notes
📚 Related Files
content/shared/influxdb3-plugins/_index.mdapi-docs/influxdb3/core/v3/ref.yml/influxdb3/core/plugins//influxdb3/enterprise/plugins/Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.