Skip to content

Sync API docs from bc3 - #446

Merged
jorgemanrubia merged 1 commit into
masterfrom
sync-person-types
Sep 17, 2026
Merged

jorgemanrubia merged 1 commit into
masterfrom
sync-person-types

Conversation

@jorgemanrubia

Copy link
Copy Markdown
Member

This is a full sync of bc3's doc/api/ at master 821ea0352f. 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

  • Person types (bc3#13381, the reason for this sync)
    • A new "Person types" section in README.md: which person objects include personable_type, what each current type means, and that new types may appear, so clients should handle an unknown value gracefully.
    • A note in sections/people.md that points to that section.
  • Account event feed
  • Card table and to-do list templates (bc3#13312)
    • New sections/card_table_templates.md and sections/templatifications.md, plus their README.md index entries.
    • Changes to sections/projects.md and sections/template_library.md, including copying a template by naming its destination project.
  • Authorization document (bc3#13317): sections/authentication.md.
  • Over-long boosts (bc3#13357): sections/boosts.md, which now documents a 422.
  • Agents in the timeline (bc3#12314): sections/timeline.md.
  • Changing your email address (bc3#13217): sections/people.md now 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.

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

Copilot AI balanced review requested due to automatic review settings September 17, 2026 04:42

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.

🟡 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 run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to 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: 1 and a /copies/1.json URL, but these START/END markers label it as copy 2. Change both markers to /copies/1.json and add the required ###### Example JSON Response heading (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.

Comment thread sections/card_table_templates.md
Comment thread sections/event_feed.md
Comment thread sections/template_library.md
Comment thread sections/timeline.md
@jorgemanrubia

Copy link
Copy Markdown
Member Author

🤖 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 doc/api/, so the fixes go into bc3 as their own PR, and then this branch gets re-synced. I'll reply on each thread and resolve it once the re-sync is pushed.

@jorgemanrubia
jorgemanrubia merged commit d60f9fc into master Sep 17, 2026
1 check passed
@jorgemanrubia
jorgemanrubia deleted the sync-person-types branch September 17, 2026 05:01
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