docs: content & OpenAPI cleanup#171
Conversation
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (8)
✨ Finishing Touches🧪 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 |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 8 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="api-reference/openapi/content.json">
<violation number="1" location="api-reference/openapi/content.json:619">
P2: `/api/content/create` description documents `run_id`, but the response contract uses `runIds` (array). Align the description with the actual response shape.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Three classes of fixes to the API reference and content-agent docs. All fixes were verified against the OpenAPI spec — no fictional endpoints or paths remain. OpenAPI hygiene (api-reference/openapi/*.json): - research.json: replace internal "memories" wording with "messages" in chat endpoint descriptions and schema fields. Database tables remain named `memories` internally; this only affects what API consumers see in docs. - releases.json: align PATCH /api/tasks summary "Update scheduled task" → "Update Task" so it matches the visible MDX page title in the sidebar. - content.json: surface legacy framing in operation descriptions for POST /api/content/create, GET /api/image/generate, and POST /api/transcribe — explains what each does, why it predates the current /api/content/* primitives, and links to the recommended modern endpoint. Avoids breaking the AGENTS.md "api-reference MDX pages must be frontmatter-only" rule (which a previous attempt at inline <Note> blocks would have violated). API reference page titles: - api-reference/research/search.mdx: "Search" → "Artist Search" - api-reference/spotify/search.mdx: "Search" → "Spotify Search" - api-reference/image/generation.mdx: "Generate Image" → "Generate Image (Legacy)" - api-reference/transcribe/audio.mdx: "Transcribe Audio" → "Transcribe Audio (Legacy)" These four pages previously had titles that were either duplicates of other pages (Search, Generate Image, Transcribe Audio) or didn't indicate the legacy status. Renames disambiguate them in the sidebar and in autocomplete. Content Agent page (content-agent.mdx): - Refactored the architecture and data-flow sections to match the current Slack-bot implementation. - Endpoint table updated to use the canonical short paths from the OpenAPI spec (POST /api/content/image, /video, /caption, /transcribe; PATCH /api/content; POST /api/content/analyze) rather than the descriptive variants that don't actually exist in the spec. - Marked POST /api/content/create as legacy inline. - Standardized the "Endpoints it uses" heading to match the convention used on every skills/* page. Made-with: Cursor
recoupableorg
force-pushed
the
feat/docs-content-cleanup
branch
from
f4c914f to
da329ff
Compare
2 participants
Summary
Three classes of fixes to the API reference and content-agent docs. All verified against the OpenAPI spec — no fictional endpoints or paths remain.
Changes
OpenAPI hygiene
research.json— replace internal "memories" wording with "messages" in chat endpoint descriptions. (Database tables remain namedmemoriesinternally; this is doc-only.)releases.json— alignPATCH /api/taskssummary to "Update Task" so it matches the visible MDX page title.content.json— surface legacy framing inside operation descriptions forPOST /api/content/create,GET /api/image/generate, andPOST /api/transcribe. Each description now explains what the endpoint does, why it predates the modern/api/content/*primitives, and links to the recommended replacement. This avoids breaking the AGENTS.md "api-reference MDX pages must be frontmatter-only" rule.API reference page titles
research/search.mdxspotify/search.mdximage/generation.mdxtranscribe/audio.mdxDisambiguates duplicates and signals legacy status without violating frontmatter-only convention.
Content Agent page
POST /api/content/image,/video,/caption,/transcribe;PATCH /api/content;POST /api/content/analyze).POST /api/content/createmarked legacy inline.skills/*page.Stack
PR 4 of 7. Replaces #145.
Made with Cursor