Skip to content

docs(api): testsets endpoint docstrings + concept page#4233

Draft
mmabrouk wants to merge 1 commit intomainfrom
docs/age-3734-testsets-endpoints
Draft

docs(api): testsets endpoint docstrings + concept page#4233
mmabrouk wants to merge 1 commit intomainfrom
docs/age-3734-testsets-endpoints

Conversation

@mmabrouk
Copy link
Copy Markdown
Member

Summary

  • Adds docs/docs/reference/api-guide/08-testsets.mdx — concept page (~600 words) covering testset versioning (artifact/variant/revision), the immutable-testcase model (content-addressed blobs), the dedup paths (canonical testcase_dedup_id and legacy __dedup_id__), CSV/JSON import/export, simple testsets, and how evaluations pin a testset revision.
  • Adds Python docstrings on every handler in testsets/router.py plus Field(description=...) on every request/response field in testsets/models.py and testcases/models.py.
  • ~32 endpoints documented across the structured and simple surfaces, plus the testcases surface.

Process notes

  • Pre-commit / gitleaks were not available in the sandbox; commit was made with --no-verify. No secrets touched. Hooks should be re-run locally before merge.
  • Agent died on API rate limit before pushing; salvaged from the worktree.

Related

Test plan

  • Endpoints exercised against eu.cloud.agenta.ai
  • Examples obfuscated; shapes match real responses
  • Reviewer: re-run pre-commit hooks locally before merge
  • Reviewer: spot-check dedup-path docstrings

- Adds 08-testsets.mdx — concept page covering immutable testcases,
  the versioned-bag model, dedup paths (testcase_dedup_id /
  __dedup_id__ legacy), import/export, simple testsets, and pinning
  in evaluations.
- Adds Field descriptions on testsets/testcases models and docstrings
  on every router handler.
@linear
Copy link
Copy Markdown

linear Bot commented Apr 28, 2026

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agenta-documentation Error Error Apr 28, 2026 10:13am

Request Review

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