Skip to content

docs(agents): add GET /api/agents endpoint and update navigation#190

Open
ahmednahima0-beep wants to merge 2 commits intomainfrom
feature/docs-chat-agents-get
Open

docs(agents): add GET /api/agents endpoint and update navigation#190
ahmednahima0-beep wants to merge 2 commits intomainfrom
feature/docs-chat-agents-get

Conversation

@ahmednahima0-beep
Copy link
Copy Markdown
Collaborator

@ahmednahima0-beep ahmednahima0-beep commented May 6, 2026

  • 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.

Summary by cubic

Adds docs for GET /api/agents to list agent links by artist social IDs, places it under Agent Onboarding, and aligns the OpenAPI path for clarity.

  • New Features

    • New page api-reference/agents/get (“List agent links by social IDs”).
    • OpenAPI accounts.json: adds GET /api/agents with repeated socialId query param (UUID), apiKeyAuth/bearerAuth, 200/400/401/500 responses, and schemas GetAgentsItem, GetAgentsResponse, AgentsGetErrorResponse.
    • docs.json: adds the page to the Agent Onboarding group.
  • Refactors

    • Simplified the OpenAPI path reference to GET /api/agents for consistency.

Written for commit 529f77d. Summary will update on new commits.

Summary by CodeRabbit

  • New Features

    • Added GET /api/agents endpoint to retrieve agent linkage information using artist social IDs.
  • Documentation

    • Added API reference documentation page for the new agent lookup endpoint.
    • Updated navigation to include agent endpoint reference in Agent Onboarding section.

- 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)
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

📝 Walkthrough

Walkthrough

This 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.

Changes

Agent Linkage API Documentation

Layer / File(s) Summary
API Specification
api-reference/openapi/accounts.json
New GET /api/agents endpoint added to fetch agent linkage for one or more artist social IDs. Supports API key or Bearer authentication. Three new schemas defined: GetAgentsItem, GetAgentsResponse, and AgentsGetErrorResponse for response and error handling.
Documentation Page
api-reference/agents/get.mdx
MDX file created with frontmatter referencing the OpenAPI spec for the new endpoint (title: "List agent links by social IDs").
Navigation Integration
docs.json
Agent Onboarding pages updated to include api-reference/agents/get after the verify page in the onboarding sequence.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • recoupable/docs#121: Related — both change api-reference/openapi/accounts.json and MDX OpenAPI frontmatter references for agents endpoints.

Suggested reviewers

  • sweetmantech

Poem

🐰 A new path blooms in the API garden,
Where agents link by social IDs with pardon,
The spec is written, docs are dressed in lace,
And nav finds its proper place,
Documentation hops with grace! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main changes: adding a new GET /api/agents endpoint documentation and updating the navigation structure to include it.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/docs-chat-agents-get

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between fd3e389 and 904bb00.

📒 Files selected for processing (3)
  • api-reference/agents/get.mdx
  • api-reference/openapi/accounts.json
  • docs.json

Comment thread api-reference/agents/get.mdx Outdated
- Simplified the OpenAPI path in the documentation for the GET /api/agents endpoint to enhance clarity and consistency.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant