Sync API docs from bc3: example fixes and join-a-project wording - #447
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approved
The synchronized documentation changes are consistent, correctly marked, and match the stated scope.
Pull request overview
Syncs authoritative bc3 API documentation updates into this mirror.
Changes:
- Aligns template request/response examples and ordering.
- Adds missing event-feed route markers.
- Clarifies project access and deleted-agent behavior.
[!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/card_table_templates.md |
Corrects example ordering and identifiers. |
sections/event_feed.md |
Adds response route markers. |
sections/people.md |
Clarifies project access and agent-token behavior. |
sections/template_library.md |
Aligns names, ordering, and copy IDs. |
sections/timeline.md |
Documents tombstones for deleted agents. |
Review details
- Files reviewed: 5/5 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This syncs bc3's
doc/api/at master2ee862e469to bump the mirror. It carries two things and nothing else: no other team's unsynced doc changes show up in the copy.card_table_templates.mdandtemplate_library.mdnow show the response before the cURL, and the copy example uses the same id in its request and response.event_feed.md: its three HTTP response examples now have route markers.timeline.md:performed_byisAgent, orTombstoneonce the agent is deleted.people.mdnow says "has access to" instead of "has joined".403.After this,
sections/andREADME.mdmatch bc3doc/api/exactly.Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.