docs(agents): add GET /api/agents endpoint and update navigation#190
docs(agents): add GET /api/agents endpoint and update navigation#190ahmednahima0-beep wants to merge 2 commits intomainfrom
Conversation
- Introduced a new GET endpoint for retrieving agent linkage by social IDs, including detailed request parameters and response schemas. - Updated the documentation to include the new endpoint in the Agents Onboarding navigation group, enhancing the API reference for better accessibility. Co-authored-by: Claude Opus 4.7 (1M context)
📝 WalkthroughWalkthroughThis PR adds documentation for a new GET /api/agents endpoint to the accounts API reference. It introduces the endpoint specification and schemas in the OpenAPI schema file, creates the corresponding MDX documentation page, and integrates it into the Agent Onboarding navigation. ChangesAgent Linkage API Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@api-reference/agents/get.mdx`:
- Line 3: The frontmatter uses a file-prefixed openapi value; update the openapi
frontmatter key to the required "METHOD /path" form by replacing the current
value with openapi: 'GET /api/agents' so the page uses the canonical openapi
frontmatter format (modify the openapi frontmatter entry in this MDX).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 84c445e7-8644-4adb-bc9b-3b739fbda1f1
📒 Files selected for processing (3)
api-reference/agents/get.mdxapi-reference/openapi/accounts.jsondocs.json
- Simplified the OpenAPI path in the documentation for the GET /api/agents endpoint to enhance clarity and consistency.
Summary by cubic
Adds docs for
GET /api/agentsto list agent links by artist social IDs, places it under Agent Onboarding, and aligns the OpenAPI path for clarity.New Features
api-reference/agents/get(“List agent links by social IDs”).accounts.json: addsGET /api/agentswith repeatedsocialIdquery param (UUID),apiKeyAuth/bearerAuth, 200/400/401/500 responses, and schemasGetAgentsItem,GetAgentsResponse,AgentsGetErrorResponse.docs.json: adds the page to the Agent Onboarding group.Refactors
GET /api/agentsfor consistency.Written for commit 529f77d. Summary will update on new commits.
Summary by CodeRabbit
New Features
Documentation