Skip to content

Everything to-do/card endpoints are the canonical API paths - #425

Merged
jeremy merged 1 commit into
masterfrom
sync-everything-api-only
Jul 29, 2026
Merged

Everything to-do/card endpoints are the canonical API paths#425
jeremy merged 1 commit into
masterfrom
sync-everything-api-only

Conversation

@jeremy

@jeremy jeremy commented Jul 28, 2026

Copy link
Copy Markdown
Member

The standalone all-to-dos and all-cards pages are being removed from the Basecamp 5 web app — the combined /tasks report is where to-dos and cards are browsed now. Nothing changes for API clients, and the Everything docs now say so explicitly:

  • The filtered sub-routes — /todos/{open,completed,overdue,unassigned,no_due_date}.json and /cards/{open,completed,overdue,unassigned,no_due_date,not_now}.json — are preserved as the canonical API paths, unchanged in shape and behavior. Each section now carries a note to that effect.
  • The preamble states the collection contract plainly: there is no /todos.json, /cards.json, or /tasks.json collection API. Use the filtered sub-routes.
  • The bare /todos and /cards web paths no longer exist. They were never part of the API.

Synced from bc3 doc/api/ by script/api/sync_to_bc3_api — not a hand-edit.

Copilot AI review requested due to automatic review settings July 28, 2026 23:14

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the Basecamp 5 “Everything” API documentation to explicitly clarify that there is no unfiltered collection API for to-dos/cards/tasks, and that the existing filtered sub-routes remain the canonical API JSON endpoints, despite web UI route changes.

Tip

If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.

Changes:

  • Updates the “Most collections…” preamble to state there is no /todos.json, /cards.json, or /tasks.json collection API.
  • Adds notes under the to-do/card filter sections (and overdue sections) clarifying the web UI pages were removed while API endpoints remain canonical.
Comments suppressed due to low confidence (1)

sections/everything.md:12821

  • Pronoun mismatch: this sentence starts with "These endpoints" (plural) but later says "shows this" (singular).
These endpoints are preserved as the canonical API paths; the standalone
all-cards web page was removed — the BC5 web app shows this in the combined
`/tasks` report.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread sections/everything.md Outdated
Comment thread sections/everything.md Outdated
The standalone all-to-dos and all-cards web pages are gone; the filtered
sub-routes remain as the documented API surface. State the contract
plainly: no /todos.json, /cards.json, or /tasks.json collection API, and
each to-do/card section notes its endpoints are preserved.
Copilot AI review requested due to automatic review settings July 29, 2026 02:26
@jeremy
jeremy force-pushed the sync-everything-api-only branch from d15cc91 to c98a765 Compare July 29, 2026 02:26

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@jeremy
jeremy merged commit 190db77 into master Jul 29, 2026
1 check passed
@jeremy
jeremy deleted the sync-everything-api-only branch July 29, 2026 04:53
jeremy added a commit that referenced this pull request Jul 29, 2026
* origin/master:
  Schedule entries: participants are only replaced when addressed (#424)
  Everything to-do/card endpoints are the canonical API paths (#425)
  Everything to-do/card endpoints: assignee and due filters, presentation notes (#423)
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