Document the Lineup API (read model + project schedule editing) - #442
Document the Lineup API (read model + project schedule editing)#442jeremy wants to merge 1 commit into
Conversation
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.
🟡 Changes recommended
The documentation must originate in bc3 and be regenerated through the repository’s sync process.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Documents Lineup retrieval and project schedule management.
Changes:
- Adds Lineup endpoint documentation and examples.
- Adds Lineup to the endpoint index.
[!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/lineup.md |
Documents Lineup and project schedule endpoints. |
README.md |
Adds Lineup to the endpoint index. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| - [Hill charts](sections/hill_charts.md#hill-charts) | ||
| - [Inbox replies](sections/inbox_replies.md#inbox-replies) | ||
| - [Inboxes](sections/inboxes.md#inboxes) | ||
| - [Lineup](sections/lineup.md#lineup) |
| @@ -0,0 +1,129 @@ | |||
| Lineup | |||
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5c94eae025
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1,129 @@ | |||
| Lineup | |||
There was a problem hiding this comment.
This commit adds sections/lineup.md and edits README.md, but its description lacks the required sync footer and instead says it merely pairs with a bc3 implementation PR. That identifies this as an off-target edit that will diverge from bc3/doc/api and be overwritten by the next sync; land the documentation in bc3 and run script/api/sync_to_bc3_api before merging.
AGENTS.md reference: AGENTS.md:L22-L31
Useful? React with 👍 / 👎.
|
Closing — the API docs belong in bc3's source-of-truth |
Adds
sections/lineup.mddocumenting the new Lineup JSON API and registers it in the README index (before "Lineup Markers").Covers:
GET /lineup.json— the account-wide read model: timeframe, scheduled projects with their ranges and status, and markers. Documents the optionaltimeframe=START..ENDparam and the default window.GET /lineup/projects/:project_id/schedule.json— a project's start/end dates.PUT /lineup/projects/:project_id/schedule.json— editing those dates, with the422invalid-dates response and the topic-only / no-clients / edit-permission rules.Pairs with the bc3 implementation PR basecamp/bc3#13128. Cards: Agent Accessibility "BC API Gaps" — 9671195038 and 9671195121.