Skip to content

docs(docs): remove instagram scrape endpoints#163

Merged
sweetmantech merged 1 commit intomainfrom
migrate/remove-instagram-scrape-docs
Apr 27, 2026
Merged

docs(docs): remove instagram scrape endpoints#163
sweetmantech merged 1 commit intomainfrom
migrate/remove-instagram-scrape-docs

Conversation

@arpitgupta1214
Copy link
Copy Markdown
Collaborator

@arpitgupta1214 arpitgupta1214 commented Apr 24, 2026

Removes GET /api/instagram/profiles and GET /api/instagram/comments from the public docs. They become internal function calls inside mono/api's Apify webhook chain and are no longer callable endpoints.

Test plan

  • jq validates social.json and docs.json
  • grep shows no remaining refs to removed paths
  • InstagramErrorResponse schema removed; ApifyRunResult retained (still used by /api/socials/{id}/scrape)

Summary by cubic

Removed GET /api/instagram/profiles and GET /api/instagram/comments from the public docs and OpenAPI spec. These Instagram scrapers now run internally in the Apify webhook chain and are no longer callable endpoints.

  • Migration
    • Remove any client calls to the removed endpoints.
    • Use /api/socials/{id}/scrape to start scrapes and /api/apify/runs/{runId} to poll results (returns ApifyRunResult).

Written for commit 94d839d. Summary will update on new commits.

Summary by CodeRabbit

  • Chores
    • Removed Instagram comments API endpoint
    • Removed Instagram profiles API endpoint
    • Removed related API documentation and references

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: da0493e6-2f7b-4fb5-82d6-b0f2fcb97257

📥 Commits

Reviewing files that changed from the base of the PR and between 20d6593 and 94d839d.

📒 Files selected for processing (4)
  • api-reference/instagram/comments.mdx
  • api-reference/instagram/profiles.mdx
  • api-reference/openapi/social.json
  • docs.json
💤 Files with no reviewable changes (4)
  • api-reference/instagram/profiles.mdx
  • api-reference/instagram/comments.mdx
  • docs.json
  • api-reference/openapi/social.json

📝 Walkthrough

Walkthrough

The 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

Cohort / File(s) Summary
Instagram Documentation Pages
api-reference/instagram/comments.mdx, api-reference/instagram/profiles.mdx
Removed YAML frontmatter (page title and OpenAPI reference mappings) from both MDX files.
OpenAPI Specification
api-reference/openapi/social.json
Removed GET /api/instagram/comments and GET /api/instagram/profiles endpoint definitions along with their request parameters and response schemas. Deleted InstagramErrorResponse schema from components.
Documentation Configuration
docs.json
Removed the Instagram section from the Social Media tab navigation, including page entries for comments and profiles.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • sweetmantech

Poem

🐰 Hop, skip, and away they go,
Instagram endpoints bid adieu,
Cleaned-up specs and docs so neat,
The API slims down quite sweet!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(docs): remove instagram scrape endpoints' accurately describes the main change—removing Instagram API endpoints and their documentation across multiple files.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch migrate/remove-instagram-scrape-docs

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.

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}": {
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot Apr 24, 2026

Choose a reason for hiding this comment

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

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>
Fix with Cubic

@sweetmantech sweetmantech merged commit 8c86eda into main Apr 27, 2026
3 checks passed
@sweetmantech sweetmantech deleted the migrate/remove-instagram-scrape-docs branch April 27, 2026 16:34
sidneyswift added a commit that referenced this pull request May 6, 2026
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>
sidneyswift added a commit that referenced this pull request May 6, 2026
…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>
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.

2 participants