Skip to content

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

Merged
merged 2 commits into from
Jun 9, 2025

Conversation

jstirnaman
Copy link
Contributor

  • 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

Staging:

- 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
Copy link
Contributor

@Copilot Copilot AI left a 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.

@jstirnaman jstirnaman requested review from sanderson and removed request for praveen-influx June 9, 2025 14:54
Copy link
Contributor

@MeelahMe MeelahMe left a 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?

Copy link
Collaborator

@sanderson sanderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

@jstirnaman
Copy link
Contributor Author

Looks good! The one thing I noticed is that the product names are not dynamic. Is that because it is a .yml file?

Not exactly. Long story. TLDR: API reference content doesn't go through the Hugo engine
The Redocly OpenAPI tool parses the spec and uses JavaScript to render to HTML when the browser loads it.

@jstirnaman jstirnaman merged commit 47cb2ce into master Jun 9, 2025
1 check passed
@jstirnaman jstirnaman deleted the influxdb3-trigger-api branch June 9, 2025 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants