Withdraw the account-wide boosts feed - #427
Conversation
GET /boosts.json is withdrawn while we rework how it queries at scale. The rest of the Everything feeds and the project-scoped boosts endpoints are unchanged.
There was a problem hiding this comment.
🟢 Ready to approve
The withdrawn endpoint is fully removed from the Everything docs without leaving broken references, and the remaining feeds are unchanged.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
Withdraws the account-wide Everything boosts feed (GET /boosts.json) from the Basecamp API documentation due to scalability concerns, while keeping the rest of the Everything feeds and project-scoped boosts documentation intact.
Changes:
- Removed
/boosts.jsonfrom the list of account-wide Everything root collections. - Removed the “Boosts / Get boosts” endpoint section (including example response and cURL) from
sections/everything.md. - Cleaned up related endpoint/link references in the Everything section.
[!TIP]
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or rungh pr ready --undo.
Click "Ready for review" or rungh pr readyto reengage.
File summaries
| File | Description |
|---|---|
| sections/everything.md | Removes the account-wide /boosts.json feed documentation from the Everything endpoints section. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Low
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
| `/files.json`, and `/boosts.json` each return a recency-ordered, [paginated] | ||
| [pagination] JSON collection directly. The to-do and card collections are the | ||
| `/comments.json`, `/checkins.json`, `/forwards.json`, and `/files.json` each | ||
| return a recency-ordered, [paginated][pagination] JSON collection directly. The to-do and card collections are the |
The account-wide boosts feed,
GET /boosts.json, is withdrawn. The endpoint's current query doesn't hold up on our largest accounts, so we're pulling it while we rework how it fetches boosts at scale. We expect to bring it back.Everything else is unchanged: the other Everything feeds (
/messages.json,/comments.json,/checkins.json,/forwards.json,/files.json, and the to-do/card filters), the project-scoped boosts endpoints underbuckets/…/recordings/…/boosts.json, and theboosts_count/boosts_urlattributes on recording payloads all remain as documented.Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.