-
Notifications
You must be signed in to change notification settings - Fork 302
chore(mono): /api/v3 processing engine request parameters: #6128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Update trigger-spec syntax for schedule triggers - Specify that cron only supports extended cron format - Provide examples and pattern validation for trigger-specs - Update response status - Cleanup use - Misc. updates and cleanup - Add test plugins
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the InfluxDB 3 processing engine by adding new test plugins, revising trigger-spec examples, and improving API documentation for both Enterprise and Core.
- Adds new test plugins for processing writes, scheduled calls, and HTTP requests.
- Updates documentation with enhanced examples, revised response statuses, and detailed trigger specification validation.
- Cleans up formatting and reference inconsistencies in plugin and API docs.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
test/influxdb3-plugins/wal_table.py | Adds a plugin to process write batches with logging and derived data output |
test/influxdb3-plugins/schedule.py | Implements scheduled call processing with optional argument logging |
test/influxdb3-plugins/request.py | Introduces a plugin for processing HTTP requests with JSON body handling |
content/shared/v3-core-plugins/_index.md | Updates the plugin type table and trigger-spec examples with extended cron details |
api-docs/influxdb3/enterprise/v3/ref.yml | Enhances docs with refined descriptions, updated response statuses, and examples |
api-docs/influxdb3/core/v3/ref.yml | Mirrors Enterprise updates with improved trigger-spec examples and API documentation |
Comments suppressed due to low confidence (1)
api-docs/influxdb3/enterprise/v3/ref.yml:1372
- [nitpick] For clarity and consistency, consider enclosing 'path:<plugin_path>' in backticks so that it stands out as a literal trigger specification.
The path configured in the request trigger specification "path:<plugin_path>" for the plugin.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! The one thing I noticed is that the product names are not dynamic. Is that because it is a .yml file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍🏻
Not exactly. Long story. TLDR: API reference content doesn't go through the Hugo engine |
Staging: