-
Notifications
You must be signed in to change notification settings - Fork 29
fix: ensure consistent graph descriptions across all API endpoints #312
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
- Fix missing description field in agent graph POST/PUT endpoints - Remove fallback "Agent graph: {name}" pattern from A2A agent cards - Add comprehensive tests for description consistency - Ensure CRUD endpoints return raw database values Fixes issue where different API endpoints returned inconsistent descriptions for the same graph, with some endpoints showing fallback patterns instead of the stored description. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Claude finished @amikofalvy's task —— View job Code Review Complete ✅Technical Review Summary: This PR addresses a legitimate inconsistency issue where different API endpoints were returning different descriptions for the same agent graph. The fix is well-implemented and comprehensive. Strengths✅ Problem Identification & Solution Design
✅ Code Quality & Implementation
✅ Testing Strategy
Areas for Consideration
// Worth checking: do these schemas properly validate description?
AgentGraphApiInsertSchema.extend({ description: z.string().optional() })
AgentGraphApiUpdateSchema.extend({ description: z.string().optional() })
Architecture Assessment✅ Consistent Data Contracts
✅ API Design Principles
Customer Impact✅ Positive Impact
Recommendations
Final AssessmentThis is a well-executed fix for a real API consistency issue. The implementation is clean, properly tested, and follows good engineering practices. The comprehensive test suite gives confidence that the fix works as intended across all affected endpoints. Recommended Action: ✅ Approve with the minor recommendations above for completeness. |
Summary
Fixes inconsistent graph descriptions between different API endpoints where some endpoints returned fallback patterns instead of the stored description.
Linear Issue: PRD-4654
Linear URL: https://linear.app/inkeep/issue/PRD-4654/discrepancy-in-graph-description-between-endpoints
Problem
/tenants/{tenantId}/projects/{projectId}/agent-graphs
): Returned stored description:"this is my graph"
"Agent graph My graph"
The discrepancy was caused by:
Changes
Fixed CRUD Endpoints
/agent-graphs
: Now includesdescription
field when creating graphs/agent-graphs/{id}
: Now includesdescription
field when updating graphsFixed A2A Agent Discovery
dbGraph.description || \
Agent graph: ${dbGraph.name}`to
dbGraph.description || ''`Added Comprehensive Tests
Result
All graph-related endpoints now return consistent descriptions that match what's stored in the database:
Test Plan
Closes: PRD-4654
🤖 Generated with Claude Code