Repository navigation
docs(api): remove ML prediction endpoints from the API reference (vNext) - #1981
Conversation
spiceai/spiceai#11684 deleted the model_components crate and all ONNX/Tract ML inference, including the GET /v1/models/{name}/predict and POST /v1/predict HTTP endpoints. The vNext docs no longer describe ML model serving (the Machine Learning Models feature page is marked deprecated), but the published HTTP API reference still lists both endpoints because website/public/openapi.json was never refreshed. Remove the two paths (and their now-unreferenced PredictRequest / PredictResponse / PredictStatus / BatchPredictRequest / BatchPredictResponse schemas) from the OpenAPI spec, delete the generated MDX/JSON pages, and drop the two sidebar entries under the AI category. vNext only: both endpoints exist through v2.1.x, so the versioned snapshots correctly keep them.
✅ Pull with Spice PassedPassing checks:
|
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
1 similar comment
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
|
🚀 deployed to https://b66e642e.spiceai-org-website.pages.dev |
|
Heads-up on the red Generate API Docs check: it is a pre-existing repo failure, not caused by this PR. The
Practical consequence: the bot cannot regenerate the API MDX for this PR, so the generated pages in the diff were produced locally with Worth a separate |
|
The red Tracked in #1996, fixed by #1997. This check should go green here once that lands and this branch picks up trunk. |
|
🚀 deployed to https://5e3d79c6.spiceai-org-website.pages.dev |
|
🚀 deployed to https://0e249b63.spiceai-org-website.pages.dev |
Summary
The published HTTP API reference still documents two endpoints that no longer exist in the runtime:
trunkML Prediction(get-model-predict)GET /v1/models/{name}/predictBatch ML Predictions(post-batch-predict)POST /v1/predictspiceai/spiceai#11684 (
remove(ml): delete model_components crate and ONNX/Tract ML inference, merged 2026-07-09, post-v2.1.1) deleted themodel_componentscrate and both HTTP routes.crates/runtime/src/http/routes.rsontrunkregisters nopredictroute at all, andModelSource::SpiceAI/ONNX model loading is gone.The docs sweep for that source PR updated the prose pages —
features/machine-learning-models/index.mdis correctly marked Deprecated in vNext and explicitly says the/v1/predictand/v1/models/{name}/predictendpoints were removed — but it missed the generated API reference, because those pages come fromwebsite/public/openapi.json(last refreshed for spiceai/spiceai#10272, spec version2.0.0-unstable). So the docs simultaneously say the endpoints are gone and publish reference pages with "Try it" panels for them.What changed
website/public/openapi.json: removed the/v1/predictand/v1/models/{name}/predictpaths, plus the five schemas that were reachable only from them (PredictRequest,PredictResponse,PredictStatus,BatchPredictRequest,BatchPredictResponse).PredictionContent/PredictionContentContentare kept — those belong to/v1/chat/completions.get-model-predict.*andpost-batch-predict.*underwebsite/docs/api/HTTP/.website/docs/api/HTTP/sidebar.ts(AI category).npx docusaurus gen-api-docs spicewas re-run against the edited spec and produces no further changes to the remaining pages (it is idempotent here), so the diff is deletion-only — no churn in the base64api:blobs of unrelated operations.Version scope
vNext only. Both endpoints exist through v2.1.1, so every
versioned_docs/version-*/api/HTTP/snapshot correctly retains them (verified: 9 versioned snapshots still carryget-model-predict/post-batch-predict, and none were touched).No page outside
versioned_docs/links to either removed page (grep -rn 'get-model-predict\|post-batch-predict' website/).Source refs
remove(ml): delete model_components crate and ONNX/Tract ML inferencespiceai/spiceai@trunkcrates/runtime/src/http/routes.rs— nopredictroutespiceai/spiceai@trunk.schema/openapi.json— generated spec has neither pathTest plan
cd website && npm run buildpassessidebar.ts,openapi.json)