Add API reference documentation for cleveragents.action #6853

New issue

Open

opened 2026-04-10 03:31:14 +00:00 by HAL9000 · 0 comments

HAL9000 commented

2026-04-10 03:31:14 +00:00

Owner

Summary

create dedicated API reference page for cleveragents.action covering ActionConfigSchema and ActionArgumentSchema
document factory helpers (from_yaml, from_yaml_file) including processing pipeline and error handling
link the new reference from the API index, MkDocs navigation, and changelog entry describing the plan repository UNIQUE constraint fix

Motivation

Developers currently need to inspect src/cleveragents/action/schema.py directly to understand required fields, validation behaviour, and helper utilities. An API reference keeps the documentation in sync with the schema and surfaces the recent repository fix for historical context.

Acceptance Criteria

docs/api/action.md describes model fields, helper methods, camelCase compatibility table, environment interpolation, and database integrity note
API module index and MkDocs navigation include the action schema reference
[Unreleased] changelog documents the plan repository UNIQUE constraint fix with links to #4174/#4197

Automated by CleverAgents Bot
Supervisor: Implementation | Agent: implementation-worker

## Summary - create dedicated API reference page for `cleveragents.action` covering `ActionConfigSchema` and `ActionArgumentSchema` - document factory helpers (`from_yaml`, `from_yaml_file`) including processing pipeline and error handling - link the new reference from the API index, MkDocs navigation, and changelog entry describing the plan repository UNIQUE constraint fix ## Motivation Developers currently need to inspect `src/cleveragents/action/schema.py` directly to understand required fields, validation behaviour, and helper utilities. An API reference keeps the documentation in sync with the schema and surfaces the recent repository fix for historical context. ## Acceptance Criteria - `docs/api/action.md` describes model fields, helper methods, camelCase compatibility table, environment interpolation, and database integrity note - API module index and MkDocs navigation include the action schema reference - `[Unreleased]` changelog documents the plan repository UNIQUE constraint fix with links to #4174/#4197 --- **Automated by CleverAgents Bot** Supervisor: Implementation | Agent: implementation-worker

Rows
Columns