Sync API docs from bc3 - #446
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Several examples have mismatched resource IDs or missing required markers, and timeline attribution omits valid tombstoned performers.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Syncs accumulated API documentation from bc3, covering person types, event feeds, templates, authorization, and related examples.
Changes:
- Documents person types and delegated agent attribution.
- Adds event-feed, card-table-template, and templatification APIs.
- Refreshes authorization, project, boost, and template-library documentation.
[!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 |
|---|---|
README.md |
Adds person types and endpoint index entries. |
sections/authentication.md |
Updates Basecamp authorization documents. |
sections/boosts.md |
Documents boost length validation. |
sections/card_table_templates.md |
Adds card-table template APIs. |
sections/event_feed.md |
Adds account event-feed documentation. |
sections/people.md |
Documents person types and email-token requirements. |
sections/projects.md |
Refreshes project response examples. |
sections/template_library.md |
Expands to-do template and copy APIs. |
sections/templatifications.md |
Adds asynchronous templatification APIs. |
sections/timeline.md |
Documents delegated event performers. |
Review details
Suppressed comments (3)
sections/event_feed.md:445
- This response example lacks the matching route comments required by
AGENTS.md:43. Wrap it with<!-- START GET /inbox.json -->and<!-- END GET /inbox.json -->so it participates in the repository's standard example-maintenance flow.
###### Example JSON Response
sections/card_table_templates.md:521
- The completed copy has
id: 1and a/copies/1.jsonURL, but these START/END markers label it as copy2. Change both markers to/copies/1.jsonand add the required###### Example JSON Responseheading (AGENTS.md:43) so extraction and rendered documentation identify this example correctly.
<!-- START GET /template_library/copies/2.json (card table) -->
sections/event_feed.md:510
- This response example lacks the matching route comments required by
AGENTS.md:43. Wrap the JSON block with<!-- START POST /events/stream_ticket.json -->and<!-- END POST /events/stream_ticket.json -->to keep the new endpoint consistent with the documented section format.
###### Example JSON Response
- Files reviewed: 10/10 changed files
- Comments generated: 4
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
🤖 Copilot's four findings are real. They're in docs carried over from bc3, not in the person-types change. This repo only mirrors bc3's |
This is a full sync of bc3's
doc/api/at master821ea0352f. The person-types change prompted it, but the copy also brings over every earlier bc3 doc change that had not yet been mirrored here. Each one is listed below with the bc3 PR it came from, so its owner can review their part.What this carries
README.md: which person objects includepersonable_type, what each current type means, and that new types may appear, so clients should handle an unknown value gracefully.sections/people.mdthat points to that section.sections/event_feed.md, plus its entry in theREADME.mdindex.sections/card_table_templates.mdandsections/templatifications.md, plus theirREADME.mdindex entries.sections/projects.mdandsections/template_library.md, including copying a template by naming its destination project.sections/authentication.md.sections/boosts.md, which now documents a 422.sections/timeline.md.sections/people.mdnow says it needs an identity-wide token.No files are removed.
Overlap with #437
#437 (join a project) edits
sections/people.md, and so does this PR.masteron that file, so this PR doesn't create the conflict.doc/apihas no admissions section.Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.