Sync API docs from bc3: starred alongside bookmarked on projects - #441
Merged
Conversation
Projects now expose `starred` next to `bookmarked`, per basecamp/bc3#13042. `bookmarked` is true whenever the project is pinned to the current user's home page (starred or filed into a stack); `starred` only when it carries a star. Both example payloads on Get all projects and Get a project gain the field, and Get a project's example now shows `bookmarked` too. Synced from bc3 `doc/api/` by `script/api/sync_to_bc3_api` — not a hand-edit.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
Pull request overview
Documents the live starred project flag alongside bookmarked.
Changes:
- Clarifies home-page flag semantics.
- Adds both flags to project response examples.
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.
💡 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.
Forward sync of the
starredproject flag shipped in bc3#13042:projects.md: prose on Get all projects distinguishing the two home-page flags —bookmarkedistruewhenever the project is pinned there (starred or filed into a stack),starredonly when it carries a starprojects.md:"starred": falseadded to both example payloads on Get all projects, and"bookmarked"/"starred"to the Get a project example (which previously omittedbookmarked), with a cross-reference line back to the index prosebc3#13042 is merged, so this is live. Sync output is exactly
sections/projects.md— no other mirror drift rode along.Note: #440 (recent projects, waiting on bc3#13043) also touches
sections/projects.md. The two don't overlap textually, and whichever merges second gets a refresh from the sync script rather than a hand-resolved conflict.Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.