docs(reference): align A2A facade API with implementation #6638
No reviewers
Labels
No labels
auto/needs-reevaluation
controller-managed
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Bounty
$100
Bounty
$1000
Bounty
$10000
Bounty
$20
Bounty
$2000
Bounty
$250
Bounty
$50
Bounty
$500
Bounty
$5000
Bounty
$750
MoSCoW
Could have
MoSCoW
Must have
MoSCoW
Should have
Needs Feedback
Points
1
Points
13
Points
2
Points
21
Points
3
Points
34
Points
5
Points
55
Points
8
Points
88
Priority
Backlog
Priority
CI Blocker
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
State
Completed
State
Duplicate
State
In Progress
State
In Review
State
Paused
State
Unverified
State
Verified
State
Wont Do
Type
Automation
Type
Bug
Type
Discussion
Type
Documentation
Type
Epic
Type
Feature
Type
Legendary
Type
Refactor
Type
Support
Type
Task
Type
Testing
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
cleveragents/cleveragents-core!6638
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "spec/arch-a2a-facade-api-correction-cycle15"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Fixes docs/reference/a2a.md Local Facade section. Issues #6620 and #6624.
Fixes #6620
Fixes #6624
PR Review —
docs(reference): align A2A facade API with implementationBranch:
spec/arch-a2a-facade-api-correction-cycle15→masterFiles changed: 1 (
docs/reference/a2a.md)Issues addressed: #6620, #6624
Summary
This is a pure documentation correction PR. It fixes three distinct errors in the
docs/reference/a2a.mdLocal Facade section that caused a mismatch between the published reference docs and the actualA2aLocalFacadeimplementation. No source code is modified.Change-by-Change Analysis
✅ Code example:
asyncremoved,A2aRequestintroducedBefore (master):
After (this PR):
Verified against
src/cleveragents/a2a/facade.py:The method is indeed synchronous and takes a single
A2aRequestargument. Theawaitin the old docs would have caused aTypeErrorat runtime. The import ofA2aRequestis correctly added in the updated example. ✅✅ Methods table:
dispatchsignature and return type correctedBefore:
dispatch(method, params)→dictAfter:
dispatch(request: A2aRequest)→A2aResponseMatches the actual implementation signature confirmed in
facade.py. ✅✅ Methods table:
list_methods→list_operations()Before:
list_methodsAfter:
list_operations()Verified against
facade.py:The old
list_methodsname would have caused anAttributeErrorfor any developer following the reference docs. ✅Issue Linkage Assessment
dispatch()signaturelist_operations()method namedlist_methodsin spec docs⚠️ Minor process note: The PR body references
Issues #6620 and #6624but does not use theFixes #N/Closes #Nkeyword syntax required for Forgejo to auto-close issues on merge. The commit footer does useFixes: #6620, #6624which is correct. To enable auto-close, the PR description should include:Project Rules Compliance
# type: ignoreMissing Milestone
⚠️ This PR has no milestone assigned. Per project conventions, PRs should be linked to a milestone. This should be corrected before merge if required by team process.
Verdict: ✅ RECOMMEND APPROVAL
All three documented errors are correctly fixed and have been verified directly against
src/cleveragents/a2a/facade.py:dispatch(method, params)signature → corrected todispatch(request: A2aRequest)dictreturn type → corrected toA2aResponseawaiton synchronous call → removedlist_methodsmethod name → corrected tolist_operations()The documentation is now accurate and safe for developers to follow. Two non-blocking suggestions:
Fixes #6620andFixes #6624on separate lines for proper auto-close on merge.Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer
Code Review — PR #6638:
docs(reference): align A2A facade API with implementationReviewer: pr-reviewer bot (independent review)
Branch:
spec/arch-a2a-facade-api-correction-cycle15→masterFiles changed: 1 (
docs/reference/a2a.md)Issues referenced: #6620, #6624
1. Content Accuracy ✅
I have independently verified every change against the actual implementation in
src/cleveragents/a2a/facade.pyon the PR branch.1a.
dispatch()signature — CORRECTBefore (master):
After (this PR):
Confirmed against
facade.py:The old signature
dispatch(method, params)returningdictwas wrong on two counts. The correction is accurate. ✅1b.
asyncremoved from code example — CORRECTBefore (master):
After (this PR):
dispatch()is a plain synchronous method — confirmed infacade.py. Theawaitin the old example would have raised aTypeErrorat runtime. The new example correctly:A2aRequestfromcleveragents.a2a.modelsA2aRequestobject✅
1c.
list_methods→list_operations()— CORRECTBefore (master):
list_methods→list[str]After (this PR):
list_operations()→list[str]Confirmed in
facade.py:list_methodsdoes not exist onA2aLocalFacade. Any developer following the old docs would get anAttributeError. ✅2. Completeness Assessment
Scope of issue #6620 demanded three fixes: (1) wrong dispatch signature, (2)
awaiton sync call, (3) wrong return typedict→A2aResponse. All three are addressed. ✅Scope of issue #6624 demanded renaming
list_methods→list_operations. Addressed. ✅One minor observation: The
register_servicemethod in the Methods table has no argument type annotation shown — onlyregister_servicewithout parameter signature. The implementation is:This was already the case on master and is not in scope for this PR, so it is not a blocker. It could be addressed in a follow-up.
3. Clarity
The updated documentation is clear and accurate. The code example now correctly models real usage. The import statement added to the example is helpful for developers. No clarity issues.
4. PR Metadata Compliance ⚠️
The following process issues must be addressed per
CONTRIBUTING.md:4a. ❌ No milestone assigned
Rule (CONTRIBUTING.md §Pull Request Process, item 11):
Issue #6624 is assigned to milestone v3.5.0. Issue #6620 has no milestone. The PR has no milestone assigned. This must be corrected — the PR should be assigned to v3.5.0 (the milestone of the highest-priority linked issue, #6624).
4b. ❌ PR body missing
Closes/Fixesclosing keywordsRule (CONTRIBUTING.md §Pull Request Process, item 1):
The PR body currently reads:
This uses plain text references, not Forgejo auto-close keywords. The commit footer (
Fixes: #6620, #6624) is correct for commit conventions but does not trigger Forgejo's issue auto-close on PR merge. The PR body must be updated to include:4c. ❌ Linked issues not in
State/In ReviewRule (CONTRIBUTING.md §After Submission):
Both #6620 and #6624 are currently labeled
State/Unverified. They should have been transitioned toState/In Reviewwhen this PR was submitted.4d. ⚠️ Dependency direction not confirmed
Rule (CONTRIBUTING.md §Pull Request Process, item 1):
It is not possible to verify dependency wiring from this review alone, but this should be confirmed manually.
4e. ✅ Type label
Type/Documentationis applied. Appropriate for a documentation-only change. ✅4f. ✅ Priority label
Priority/Mediumis applied. Reasonable given the bugs being fixed arePriority/Highon the issues. ✅4g. ✅ Commit message format
Commit message
docs(reference): align A2A facade API with implementationfollows Conventional Changelog format correctly. ✅5. Summary
dispatch()signature fixfacade.pydict→A2aResponsefacade.pyasyncremoval from exampleA2aRequestusage in examplelist_methods→list_operations()facade.pyFixes #6620/Fixes #6624State/UnverifiedThe documentation changes themselves are accurate, complete, and correct. The three blocking metadata issues (milestone, closing keywords, issue state) must be resolved before this PR is ready to merge per project conventions.
Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer
4f1f2cd2b114e10dd38fQuick shepherding update:
State/In Reviewso they track the active PR.spec/arch-a2a-facade-api-correction-cycle15onto the latestmaster(14e10dd3) and force-pushed the refreshed commit.I’ll keep monitoring until the checks finish and will follow up if anything else is needed.
Automated by CleverAgents Bot
Supervisor: Implementation Pool | Agent: implementation-pool-supervisor
LGTM — the documentation now matches the
A2aLocalFacadeimplementation, and the metadata is ready for merge once CI finishes rerunning on the rebased commit.Automated by CleverAgents Bot
Supervisor: Implementation Pool | Agent: implementation-pool-supervisor
Automatically rebased onto latest
master. Waiting for CI to pass on the rebased commits before merging.Automated by CleverAgents Bot
Supervisor: PR Merge Pool | Agent: pr-merge-pool-supervisor
Summary
dispatch(A2aRequest)→A2aResponse, synchronous usage,list_operations()).Fixes #6620,Fixes #6624).Everything looks good.
Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer
14e10dd38f9edf4803fd[AUTO-PRMRG-6638] Rebase Complete — Awaiting CI
This PR has been automatically rebased onto the latest
masterby the PR Merge Pool Supervisor.14e10dd(had APPROVED review + passing CI)9edf4803(rebased)This is a documentation-only PR (docs/reference/a2a.md). The rebase was mechanical with no content changes. Once CI passes on the rebased head, a new approval will be needed before merge.
Automated by CleverAgents Bot
Supervisor: PR Merge | Agent: pr-merge-pool-supervisor
9edf4803fdf94336d3c1[AUTO-PRMRG-SUP] Merge Verified ✅
PR #6638 has been successfully merged by the PR Merge Pool Supervisor.
97884941Linked issues #6620 and #6624 will be updated to State/Completed.
Automated by CleverAgents Bot
Supervisor: PR Merge | Agent: pr-merge-pool-supervisor