Skip to content

docs: add the shared forecasting plugin interface - #199

Merged
Aliaksei-Kharlap merged 1 commit into
mainfrom
docs/forecasting-interface
Nov 9, 2026
Merged

Aliaksei-Kharlap merged 1 commit into
mainfrom
docs/forecasting-interface

Conversation

@Aliaksei-Kharlap

Copy link
Copy Markdown
Collaborator

Summary

Adds docs/FORECASTING_INTERFACE.md, version 1 of the interface that chronos_forecasting and prophet_forecasting implement:

  • capabilities manifest, forecast_interface.json
  • on-demand requests in measurement and query mode, writing the forecast, backtest
  • how history, filters, series, series tags and the horizon are selected
  • response and error codes with HTTP statuses
  • scheduled and on-write triggers
  • stored forecast rows
  • settings: sources and precedence, trigger arguments, durations, credentials, reserved keys

On-write mode, credentials and the unauthorized and timeout codes are part of the interface, but no plugin implements them yet.

The READMEs of both plugins link to this document.

Closes #186
Refs influxdata/influxdb3_ui#1817

@Aliaksei-Kharlap
Aliaksei-Kharlap merged commit 639ecec into main Nov 9, 2026
7 checks passed
@Aliaksei-Kharlap
Aliaksei-Kharlap deleted the docs/forecasting-interface branch November 9, 2026 17:25
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.

Forecasting plugins: a shared interface that apps can call

2 participants