Skip to content

docs(api): add draft dataset version read references - #900

Draft
nik13 wants to merge 1 commit into
mainfrom
docs/TH-8551-dataset-version-reads
Draft

nik13 wants to merge 1 commit into
mainfrom
docs/TH-8551-dataset-version-reads

Conversation

@nik13

@nik13 nik13 commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Adds draft references for the read-only dataset-version list and detail APIs in future-agi/future-agi#3462. The pages document the exact GET routes, limit/offset bounds, tenant-scoped 404 behavior, response fields, and successful and invalid-query cURL examples. Both pages are linked in the dataset API navigation.

Related: TH-8551, TH-8565.

The pages are labeled draft and use a configurable test-deployment base URL. They do not document version writes or experiment execution. Keep this PR draft until the dependent API contract and deployment are ready for documentation publication.

Validation:

  • npm ci --ignore-scripts and npm ci --dry-run --ignore-scripts passed.
  • npx astro build passed: 1,183 pages built.
  • npm run audit-links passed: 0 broken navigation links and 0 broken content links; the repository reports 29 orphan pages.
  • node scripts/check-deleted-pages.mjs main passed: no deleted pages.
  • git diff --check passed.
  • Fields and bounds were checked against the backend serializers, models, routes, and views in the dependent core stack. Request examples were not executed against a live service; no API runtime or E2E qualification is claimed.

AI assistance: Codex wrote and verified this documentation change. Browser/E2E: not run for this reference-only draft.

@nik13
nik13 force-pushed the docs/TH-8551-dataset-version-reads branch from 20b140f to 7e9d14b Compare October 12, 2026 23:50

This branch has not been deployed

No deployments
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.

1 participant