feat: add canonical workflow result models

This commit is contained in:
lda
2026-07-30 21:02:53 +07:00 Verified
parent 005a96c9ff
commit 93e690c4d0
18 changed files with 746 additions and 156 deletions
@@ -1,9 +1,18 @@
from __future__ import annotations
"""Deployment JSON-RPC method registration.
from typing import Any
Return annotations stay eagerly evaluated because fastapi-jsonrpc captures them
while registering nested handlers for response validation and OpenRPC output.
"""
import fastapi_jsonrpc as jsonrpc
from wf_api.models import (
DeleteDeploymentResult,
ListDeploymentsResult,
SaveDeploymentResult,
ValidateDeploymentResult,
WorkflowDeploymentPayload,
)
from wf_server import WorkflowServer
from ..errors import WorkflowRpcError, raise_workflow_rpc_error
@@ -26,7 +35,7 @@ def register_methods(
@entrypoint.method(name="workflow.deployments.save", errors=[WorkflowRpcError])
async def workflow_deployments_save(
params: SaveDeploymentParams = RpcParams(),
) -> dict[str, Any]:
) -> SaveDeploymentResult:
try:
return await server.api.save_deployment(params.deployment)
except (ValueError, KeyError, LookupError, FileNotFoundError) as exc:
@@ -35,7 +44,7 @@ def register_methods(
@entrypoint.method(name="workflow.deployments.validate", errors=[WorkflowRpcError])
async def workflow_deployments_validate(
params: ValidateDeploymentParams = RpcParams(),
) -> dict[str, Any]:
) -> ValidateDeploymentResult:
try:
return await server.api.validate_deployment(
deployment_id=params.deployment_id,
@@ -47,7 +56,7 @@ def register_methods(
@entrypoint.method(name="workflow.deployments.list", errors=[WorkflowRpcError])
async def workflow_deployments_list(
params: ListDeploymentsParams = RpcParams(),
) -> dict[str, Any]:
) -> ListDeploymentsResult:
try:
return await server.api.list_deployments()
except (ValueError, KeyError, LookupError, FileNotFoundError) as exc:
@@ -56,7 +65,7 @@ def register_methods(
@entrypoint.method(name="workflow.deployments.inspect", errors=[WorkflowRpcError])
async def workflow_deployments_inspect(
params: InspectDeploymentParams = RpcParams(),
) -> dict[str, Any]:
) -> WorkflowDeploymentPayload:
try:
return await server.api.inspect_deployment(
deployment_id=params.deployment_id,
@@ -67,7 +76,7 @@ def register_methods(
@entrypoint.method(name="workflow.deployments.delete", errors=[WorkflowRpcError])
async def workflow_deployments_delete(
params: DeleteDeploymentParams = RpcParams(),
) -> dict[str, Any]:
) -> DeleteDeploymentResult:
try:
return await server.api.delete_deployment(
deployment_id=params.deployment_id,
+10 -7
View File
@@ -1,9 +1,12 @@
from __future__ import annotations
"""Run JSON-RPC method registration.
from typing import Any
Return annotations stay eagerly evaluated because fastapi-jsonrpc captures them
while registering nested handlers for response validation and OpenRPC output.
"""
import fastapi_jsonrpc as jsonrpc
from wf_api.models import ListRunsResult, RunResult, RunTraceResult
from wf_server import WorkflowServer
from ..errors import WorkflowRpcError, raise_workflow_rpc_error
@@ -26,7 +29,7 @@ def register_methods(
@entrypoint.method(name="workflow.runs.list", errors=[WorkflowRpcError])
async def workflow_runs_list(
params: ListRunsParams = RpcParams(),
) -> dict[str, Any]:
) -> ListRunsResult:
try:
return await server.api.list_runs(
status=params.status,
@@ -39,7 +42,7 @@ def register_methods(
@entrypoint.method(name="workflow.runs.start", errors=[WorkflowRpcError])
async def workflow_runs_start(
params: StartRunParams = RpcParams(),
) -> dict[str, Any]:
) -> RunResult:
try:
return await server.api.run_deployment(
deployment_id=params.deployment_id,
@@ -56,7 +59,7 @@ def register_methods(
@entrypoint.method(name="workflow.runs.inspect", errors=[WorkflowRpcError])
async def workflow_runs_inspect(
params: InspectRunParams = RpcParams(),
) -> dict[str, Any]:
) -> RunResult:
try:
return await server.api.inspect_run(run_id=params.run_id)
except (ValueError, KeyError, LookupError, FileNotFoundError) as exc:
@@ -65,7 +68,7 @@ def register_methods(
@entrypoint.method(name="workflow.runs.trace", errors=[WorkflowRpcError])
async def workflow_runs_trace(
params: ReadRunTraceParams = RpcParams(),
) -> dict[str, Any]:
) -> RunTraceResult:
try:
return await server.api.read_run_trace(
run_id=params.run_id,
@@ -77,7 +80,7 @@ def register_methods(
@entrypoint.method(name="workflow.runs.resume", errors=[WorkflowRpcError])
async def workflow_runs_resume(
params: ResumeRunParams = RpcParams(),
) -> dict[str, Any]:
) -> RunResult:
try:
return await server.api.resume_run(
run_id=params.run_id,