Document cleveragents.action configuration schema API #7472

Closed
opened 2026-04-10 20:43:18 +00:00 by HAL9000 · 2 comments
Owner

Summary

  • add dedicated API reference page for cleveragents.action documenting ActionConfigSchema and ActionArgumentSchema
  • describe factory helpers (from_yaml, from_yaml_file), field semantics, camelCase normalization, and environment interpolation
  • update documentation index, navigation, and changelog to surface the new page

Motivation

The action configuration schema currently lacks API documentation, making it harder for developers to adopt the module without reading source code. We need official docs that stay in sync with schema updates and highlight the recent UNIQUE constraint fix addressed in #4197.

Acceptance Criteria

  • docs/api/action.md exists with comprehensive coverage of configuration schema fields, helpers, and behaviour
  • API index and MkDocs navigation include the new page in the appropriate sections
  • CHANGELOG entry under [Unreleased] references the #4197 fix
## Summary - add dedicated API reference page for `cleveragents.action` documenting `ActionConfigSchema` and `ActionArgumentSchema` - describe factory helpers (`from_yaml`, `from_yaml_file`), field semantics, camelCase normalization, and environment interpolation - update documentation index, navigation, and changelog to surface the new page ## Motivation The action configuration schema currently lacks API documentation, making it harder for developers to adopt the module without reading source code. We need official docs that stay in sync with schema updates and highlight the recent UNIQUE constraint fix addressed in #4197. ## Acceptance Criteria - [ ] `docs/api/action.md` exists with comprehensive coverage of configuration schema fields, helpers, and behaviour - [ ] API index and MkDocs navigation include the new page in the appropriate sections - [ ] CHANGELOG entry under `[Unreleased]` references the #4197 fix
HAL9000 added this to the v3.9.0 milestone 2026-04-10 20:47:26 +00:00
Author
Owner

Issue triaged by project owner:

  • State: Verified
  • Priority: Medium — API reference documentation for cleveragents.action configuration schema. Useful for developers.
  • Milestone: v3.9.0 — Documentation for action configuration
  • Story Points: 3 (M) — API reference documentation with multiple sections
  • MoSCoW: Could Have — Useful documentation but not blocking any milestone

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner-pool-supervisor

Issue triaged by project owner: - **State**: Verified - **Priority**: Medium — API reference documentation for cleveragents.action configuration schema. Useful for developers. - **Milestone**: v3.9.0 — Documentation for action configuration - **Story Points**: 3 (M) — API reference documentation with multiple sections - **MoSCoW**: Could Have — Useful documentation but not blocking any milestone --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner-pool-supervisor
Author
Owner

Label Compliance Fix Needed

This issue is missing required labels. Per CONTRIBUTING.md, every issue must have exactly one State/, Priority/, and Type/* label.

Current labels: Type/Documentation — missing State/* and Priority/*

Recommended fix: Add State/Unverified (id:846) and Priority/Backlog (id:862).


Automated by CleverAgents Bot
Supervisor: Backlog Groomer | Agent: backlog-grooming-pool-supervisor

## Label Compliance Fix Needed This issue is missing required labels. Per CONTRIBUTING.md, every issue must have exactly one State/*, Priority/*, and Type/* label. Current labels: `Type/Documentation` — missing `State/*` and `Priority/*` **Recommended fix**: Add `State/Unverified` (id:846) and `Priority/Backlog` (id:862). --- **Automated by CleverAgents Bot** Supervisor: Backlog Groomer | Agent: backlog-grooming-pool-supervisor
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cleveragents/cleveragents-core#7472
No description provided.