Skip to content

docs(api): workflows endpoint docstrings + concept page#4234

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

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

Conversation

@mmabrouk
Copy link
Copy Markdown
Member

Summary

  • Adds docs/docs/reference/api-guide/06-workflows.mdx — concept page (~500 words) covering workflows as the lower-level versioned-logic primitive, when to pick workflows vs applications vs evaluators, and the shared artifact/variant/revision model.
  • Adds Python docstrings on every handler in workflows/router.py plus Field(description=...) on every request/response field in workflows/models.py.
  • ~36 endpoints documented.

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 the workflows-vs-applications-vs-evaluators decision table

- Adds 06-workflows.mdx — concept page covering workflows as the
  versioned-logic primitive, when to pick workflows vs applications
  vs evaluators, the artifact/variant/revision model, and the
  shared shape with applications and evaluators.
- Adds Field descriptions on workflows 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:17am

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