docs(docs): remove instagram scrape endpoints#163
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
💤 Files with no reviewable changes (4)
📝 WalkthroughWalkthroughThe pull request removes Instagram-related API endpoints and documentation by deleting two MDX documentation pages' frontmatter, removing endpoint definitions and error schemas from the OpenAPI specification, and deleting the Instagram section from the documentation navigation configuration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 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 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.
1 issue found across 4 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/social.json">
<violation number="1" location="api-reference/openapi/social.json:513">
P2: Custom agent: **Flag AI Slop and Fabricated Changes**
OpenAPI text still references removed Instagram endpoints, leaving non-existent route references after this PR.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| } | ||
| } | ||
| }, | ||
| "/api/apify/runs/{runId}": { |
There was a problem hiding this comment.
P2: Custom agent: Flag AI Slop and Fabricated Changes
OpenAPI text still references removed Instagram endpoints, leaving non-existent route references after this PR.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At api-reference/openapi/social.json, line 513:
<comment>OpenAPI text still references removed Instagram endpoints, leaving non-existent route references after this PR.</comment>
<file context>
@@ -510,121 +510,6 @@
- }
- }
- },
"/api/apify/runs/{runId}": {
"get": {
"description": "Check the status and retrieve results from Apify scraper runs. This endpoint uses the Apify API Client to fetch the current status of a scraper run and its results if available. Use the runId returned from endpoints like Instagram Comments, Instagram Profiles, Social Scrape, or Artist Socials Scrape to poll for results.",
</file context>
PR #174's nav was written Apr 27. On Apr 28, main #163 ("docs: remove instagram scrape endpoints") deleted these two MDX files entirely: - api-reference/instagram/comments.mdx - api-reference/instagram/profiles.mdx The combined PR's nav still pointed at them, which would 404 in production. Removing the nav entries to match main's intent. Co-authored-by: Cursor <cursoragent@cursor.com>
…scription A customer's agent reviewing prod docs hit null URLs trying to fetch "Instagram Comments" and "Instagram Profiles" — the description text on the apify scraper endpoint named them as if they were dedicated pages, but main #163 deleted those pages on Apr 28. Three lines in social.json mentioned them by name: 1. Endpoint description for /api/apify/runs/{runId}: now lists the actual surviving trigger endpoints (POST /api/social/scrape, POST /api/artist/socials-scrape) instead of legacy named endpoints. 2. runId parameter description: same fix. 3. Result-array description: clarified that the Apify "scraper type" (Instagram profile scraper, Instagram comments scraper, TikTok scraper) is what determines the response shape — these are upstream Apify scraper identifiers, not Recoup endpoint pages. Fixes the customer's friction point #1: "A few endpoint URLs returned null specifically the fans, social posts, and Instagram." The fans/ social/posts endpoints still exist (api-reference/fans/get, api-reference/posts/get) — only the description text was misleading. Co-authored-by: Cursor <cursoragent@cursor.com>
Removes
GET /api/instagram/profilesandGET /api/instagram/commentsfrom the public docs. They become internal function calls inside mono/api's Apify webhook chain and are no longer callable endpoints.Test plan
jqvalidatessocial.jsonanddocs.jsongrepshows no remaining refs to removed pathsInstagramErrorResponseschema removed;ApifyRunResultretained (still used by/api/socials/{id}/scrape)Summary by cubic
Removed
GET /api/instagram/profilesandGET /api/instagram/commentsfrom the public docs and OpenAPI spec. These Instagram scrapers now run internally in the Apify webhook chain and are no longer callable endpoints./api/socials/{id}/scrapeto start scrapes and/api/apify/runs/{runId}to poll results (returnsApifyRunResult).Written for commit 94d839d. Summary will update on new commits.
Summary by CodeRabbit