Skip to content

docs: Update NSQL API for optional model and sample_data default#1717

Merged
lukekim merged 2 commits into
trunkfrom
docs/nsql-ux-updates
May 11, 2026
Merged

docs: Update NSQL API for optional model and sample_data default#1717
lukekim merged 2 commits into
trunkfrom
docs/nsql-ux-updates

Conversation

@claudespice
Copy link
Copy Markdown
Collaborator

Summary

  • Update /v1/nsql API docs: model field is now optional (auto-selects the only compatible LLM)
  • Correct sample_data_enabled default from true to false

Source PRs

Changes

  • website/docs/api/HTTP/post-nsql.api.mdx — Updated model field description to reflect optional behavior and auto-selection, corrected sample_data_enabled default to false, removed model from the request example

Test plan

  • API docs render correctly
  • Descriptions match source code behavior

…efault

The /v1/nsql endpoint model field is now optional — when omitted, the
runtime auto-selects the only compatible LLM model. The
sample_data_enabled default changed from true to false.
@claudespice claudespice self-assigned this May 11, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions
Copy link
Copy Markdown

🚀 deployed to https://47c8fddb.spiceai-org-website.pages.dev

@github-actions
Copy link
Copy Markdown

🚀 deployed to https://31624ba0.spiceai-org-website.pages.dev

@lukekim lukekim merged commit ec0bdc3 into trunk May 11, 2026
6 checks passed
@lukekim lukekim deleted the docs/nsql-ux-updates branch May 11, 2026 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants