[chore] Clean up and unify (some of) the revision request field names by jp-agenta · Pull Request #4470 · Agenta-AI/agenta

jp-agenta · 2026-05-28T06:07:49Z

Summary

Stacked on #4469.

Renames the wrapper field on revision commit/log request bodies so each matches the snake_case form of its enclosing request class:

Endpoint	Before	After
`/workflows/revisions/commit`	`workflow_revision`	`workflow_revision_commit`
`/workflows/revisions/log`	`workflow`	`workflow_revisions_log`
`/applications/revisions/log`	`application`	`application_revisions_log`
`/evaluators/revisions/log`	`evaluator`	`evaluator_revisions_log`
`/environments/revisions/log`	`environment`	`environment_revisions_log`
`/queries/revisions/log`	`query_revisions`	`query_revisions_log`
`/testsets/revisions/log`	`testset_revision`	`testset_revisions_log`

Updates the FastAPI request models, the routers that read those fields, and the handwritten callers:

web/packages/agenta-entities/src/workflow/api/api.ts — commit bodies only; query/response uses of workflow_revision are intentionally unchanged.
sdks/python/agenta/sdk/managers/shared.py — history/ahistory log bodies.
11 workflow acceptance tests + 1 SDK workflow acceptance test (commit + log bodies).

Fern-generated clients are regenerated separately.

Test plan

Full API suite green
SDK Python suite green
Fern clients regenerate cleanly
Merge [feat] Add retrieval_info and allow full environment references into traces #4469 first, then rebase/merge this

🤖 Generated with Claude Code

Rename the wrapper field on revision commit/log request bodies so each matches the snake_case form of its enclosing request class. Outliers fixed: - /workflows/revisions/commit: workflow_revision -> workflow_revision_commit - /workflows/revisions/log: workflow -> workflow_revisions_log - /applications/revisions/log: application -> application_revisions_log - /evaluators/revisions/log: evaluator -> evaluator_revisions_log - /environments/revisions/log: environment -> environment_revisions_log - /queries/revisions/log: query_revisions -> query_revisions_log - /testsets/revisions/log: testset_revision -> testset_revisions_log Updates the FastAPI request models, the routers that read those fields, and the handwritten callers in: - web/packages/agenta-entities/src/workflow/api/api.ts (commit bodies only; query/response uses of workflow_revision remain unchanged) - sdks/python/agenta/sdk/managers/shared.py (history/ahistory log bodies) - 11 workflow acceptance tests + 1 SDK workflow acceptance test (commit + log bodies) Fern-generated clients regenerated separately.

vercel · 2026-05-28T06:07:54Z

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

Project	Deployment	Actions	Updated (UTC)
agenta-documentation	Ready	Preview, Comment	May 29, 2026 4:06pm

coderabbitai · 2026-05-28T06:08:09Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a2cb10ec-0818-4b4e-8f09-e0b8dee752df

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch refactor/unify-revision-request-fields

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-05-28T06:20:03Z

Railway Preview Environment


Status	Destroyed (PR converted to draft)

Updated at 2026-05-28T07:36:56.231Z

…nify-revision-request-fields

Copilot

Pull request overview

This PR standardizes the top-level wrapper field names in several revision commit/log request bodies so they match the snake_case form of their enclosing FastAPI request model names, and updates a subset of in-repo callers/tests accordingly.

Changes:

Renamed request wrapper fields for /workflows/revisions/commit and multiple */revisions/log endpoints (workflows, applications, evaluators, environments, queries, testsets).
Updated FastAPI request models + routers to read the renamed wrapper fields.
Updated handwritten callers (TS frontend workflow API, Python SDK history/ahistory) and acceptance tests to send the new wrapper keys.

Reviewed changes

Copilot reviewed 26 out of 26 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
web/packages/agenta-entities/src/workflow/api/api.ts	Updates workflow revision commit request bodies to use `workflow_revision_commit`.
sdks/python/oss/tests/pytest/acceptance/workflows/test_embeds_integration.py	Updates workflow commit acceptance-test payloads to use `workflow_revision_commit`.
sdks/python/agenta/sdk/managers/shared.py	Updates application revisions log payload wrapper to `application_revisions_log` (sync + async).
api/oss/tests/pytest/acceptance/workflows/test_workflow_revisions_queries.py	Updates workflow commit payload wrappers in revision query acceptance tests.
api/oss/tests/pytest/acceptance/workflows/test_workflow_revisions_basics.py	Updates workflow commit payload wrapper in basic revisions test.
api/oss/tests/pytest/acceptance/workflows/test_workflow_retrieval_info.py	Updates workflow commit payload wrappers in retrieval-info acceptance tests.
api/oss/tests/pytest/acceptance/workflows/test_workflow_lineage.py	Updates workflow revisions log payload wrapper to `workflow_revisions_log`.
api/oss/tests/pytest/acceptance/workflows/test_workflow_embeds.py	Updates workflow commit payload wrappers used by embed resolution tests.
api/oss/tests/pytest/acceptance/workflows/test_workflow_embeds_string.py	Updates workflow commit payload wrappers used by string-embed tests.
api/oss/tests/pytest/acceptance/workflows/test_workflow_embeds_security.py	Updates workflow commit payload wrappers used by embed security tests.
api/oss/tests/pytest/acceptance/workflows/test_workflow_embeds_retrieve_resolve.py	Updates workflow commit payload wrappers used by retrieve/resolve embed tests.
api/oss/tests/pytest/acceptance/workflows/test_workflow_embeds_legacy.py	Updates workflow commit payload wrappers used by legacy embed tests.
api/oss/tests/pytest/acceptance/workflows/test_workflow_embeds_errors.py	Updates workflow commit payload wrappers used by embed error-handling tests.
api/oss/tests/pytest/acceptance/workflows/test_workflow_embeds_cross_entity.py	Updates workflow commit payload wrappers used by cross-entity embed tests.
api/oss/src/apis/fastapi/workflows/router.py	Reads `workflow_revision_commit` and `workflow_revisions_log` from request bodies.
api/oss/src/apis/fastapi/workflows/models.py	Renames request model fields to `workflow_revision_commit` and `workflow_revisions_log`.
api/oss/src/apis/fastapi/testsets/router.py	Reads `testset_revisions_log` from request body.
api/oss/src/apis/fastapi/testsets/models.py	Renames log request wrapper field to `testset_revisions_log`.
api/oss/src/apis/fastapi/queries/router.py	Reads `query_revisions_log` from request body.
api/oss/src/apis/fastapi/queries/models.py	Renames log request wrapper field to `query_revisions_log`.
api/oss/src/apis/fastapi/evaluators/router.py	Reads `evaluator_revisions_log` from request body.
api/oss/src/apis/fastapi/evaluators/models.py	Renames log request wrapper field to `evaluator_revisions_log`.
api/oss/src/apis/fastapi/environments/router.py	Reads `environment_revisions_log` from request body (also minor formatting change).
api/oss/src/apis/fastapi/environments/models.py	Renames log request wrapper field to `environment_revisions_log`.
api/oss/src/apis/fastapi/applications/router.py	Reads `application_revisions_log` from request body (also minor formatting change).
api/oss/src/apis/fastapi/applications/models.py	Renames log request wrapper field to `application_revisions_log`.

Comments suppressed due to low confidence (8)

api/oss/src/apis/fastapi/workflows/models.py:251

This rename makes POST /workflows/revisions/commit reject the legacy wrapper key workflow_revision, which is still used by existing clients in this repo (e.g. generated TS client). To avoid an immediate breaking change, consider accepting the old key as a validation alias while keeping the new field name in the OpenAPI schema.

class WorkflowRevisionCommitRequest(BaseModel):
    workflow_revision_commit: WorkflowRevisionCommit = Field(
        description=(
            "Revision to append to a variant's history. Requires `workflow_variant_id` "
            "and optional `message`; `data` carries the new configuration."
        ),
    )

api/oss/src/apis/fastapi/workflows/models.py:369

This rename makes POST /workflows/revisions/log reject the legacy wrapper key workflow, which is still used by existing clients. If you want a non-breaking transition, accept the old key via a Pydantic validation_alias while documenting/serializing the new name.

class WorkflowRevisionsLogRequest(BaseModel):
    workflow_revisions_log: WorkflowRevisionsLog = Field(
        description=(
            "Log query. Supply `workflow_id`, `workflow_variant_id`, or "
            "`workflow_revision_id` to scope the log, and an optional `depth`."
        ),
    )

api/oss/src/apis/fastapi/applications/models.py:174

POST /applications/revisions/log will now reject the legacy wrapper key application. Since existing clients still send application, consider accepting it as a validation_alias to prevent a hard break while transitioning to application_revisions_log.

class ApplicationRevisionsLogRequest(BaseModel):
    """Request body for `POST /applications/revisions/log`.

    Returns the ordered list of revisions committed to a variant, newest first.
    Each entry carries commit metadata and the full revision record.
    """

    application_revisions_log: ApplicationRevisionsLog = Field(
        description=(
            "Filter for the log. Typically set `application_variant_id` to list "
            "the revision history of a single variant; optionally set "
            "`application_revision_id` + `depth` to walk back a bounded number "
            "of commits from a specific revision."
        ),
    )

api/oss/src/apis/fastapi/testsets/models.py:280

POST /testsets/revisions/log will now reject the legacy wrapper key testset_revision. If backwards compatibility is desired, accept the old key as a validation_alias while keeping the new field name for documentation.

class TestsetRevisionsLogRequest(BaseModel):
    testset_revisions_log: TestsetRevisionsLog = Field(
        description="Scope for the log: one of `testset_id`, `testset_variant_id`, or `testset_revision_id`. Optional `depth` limits how far back to walk.",
    )
    include_testcases: Optional[bool] = Field(
        default=None,
        description="Include full testcase objects for each returned revision.",
    )

api/oss/src/apis/fastapi/workflows/models.py:251

This rename makes POST /workflows/revisions/commit reject the legacy wrapper key workflow_revision, which is still used by existing clients in this repo (e.g. generated TS client). To avoid an immediate breaking change, consider accepting the old key as a validation alias while keeping the new field name in the OpenAPI schema.

class WorkflowRevisionCommitRequest(BaseModel):
    workflow_revision_commit: WorkflowRevisionCommit = Field(
        description=(
            "Revision to append to a variant's history. Requires `workflow_variant_id` "
            "and optional `message`; `data` carries the new configuration."
        ),
    )

api/oss/src/apis/fastapi/workflows/models.py:369

This rename makes POST /workflows/revisions/log reject the legacy wrapper key workflow, which is still used by existing clients. If you want a non-breaking transition, accept the old key via a Pydantic validation_alias while documenting/serializing the new name.

class WorkflowRevisionsLogRequest(BaseModel):
    workflow_revisions_log: WorkflowRevisionsLog = Field(
        description=(
            "Log query. Supply `workflow_id`, `workflow_variant_id`, or "
            "`workflow_revision_id` to scope the log, and an optional `depth`."
        ),
    )

api/oss/src/apis/fastapi/applications/models.py:174

POST /applications/revisions/log will now reject the legacy wrapper key application. Since existing clients still send application, consider accepting it as a validation_alias to prevent a hard break while transitioning to application_revisions_log.

class ApplicationRevisionsLogRequest(BaseModel):
    """Request body for `POST /applications/revisions/log`.

    Returns the ordered list of revisions committed to a variant, newest first.
    Each entry carries commit metadata and the full revision record.
    """

    application_revisions_log: ApplicationRevisionsLog = Field(
        description=(
            "Filter for the log. Typically set `application_variant_id` to list "
            "the revision history of a single variant; optionally set "
            "`application_revision_id` + `depth` to walk back a bounded number "
            "of commits from a specific revision."
        ),
    )

api/oss/src/apis/fastapi/testsets/models.py:280

POST /testsets/revisions/log will now reject the legacy wrapper key testset_revision. If backwards compatibility is desired, accept the old key as a validation_alias while keeping the new field name for documentation.

class TestsetRevisionsLogRequest(BaseModel):
    testset_revisions_log: TestsetRevisionsLog = Field(
        description="Scope for the log: one of `testset_id`, `testset_variant_id`, or `testset_revision_id`. Optional `depth` limits how far back to walk.",
    )
    include_testcases: Optional[bool] = Field(
        default=None,
        description="Include full testcase objects for each returned revision.",
    )

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. refactoring A code change that neither fixes a bug nor adds a feature labels May 28, 2026

junaway changed the title ~~refactor(api): unify revision request body field names~~ [chore] Clean up and unify (some of) the revision request field names May 28, 2026

junaway marked this pull request as draft May 28, 2026 07:36

Merge branch 'feat/add-retrieval-info-to-api-and-sdk' into refactor/u…

35bf4f6

…nify-revision-request-fields

vercel Bot deployed to Preview May 28, 2026 07:38 View deployment

Merge branch 'feat/add-retrieval-info-to-api-and-sdk' into refactor/u…

b70ec74

…nify-revision-request-fields

vercel Bot deployed to Preview May 29, 2026 16:06 View deployment

junaway requested a review from Copilot May 29, 2026 16:39

Copilot started reviewing on behalf of junaway May 29, 2026 16:39 View session

Copilot AI reviewed May 29, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[chore] Clean up and unify (some of) the revision request field names#4470

[chore] Clean up and unify (some of) the revision request field names#4470
jp-agenta wants to merge 3 commits into
feat/add-retrieval-info-to-api-and-sdkfrom
refactor/unify-revision-request-fields

jp-agenta commented May 28, 2026

Uh oh!

vercel Bot commented May 28, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 28, 2026 •

edited

Loading

Review skipped

Uh oh!

github-actions Bot commented May 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jp-agenta commented May 28, 2026

Summary

Test plan

Uh oh!

vercel Bot commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

github-actions Bot commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Railway Preview Environment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel Bot commented May 28, 2026 •

edited

Loading

coderabbitai Bot commented May 28, 2026 •

edited

Loading

github-actions Bot commented May 28, 2026 •

edited

Loading