Sync API docs from bc3: spotlights, questions 403 note, schedule entries 422 note - #439
Conversation
![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: 4b35ecb9a6
ℹ️ 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".
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
Syncs authoritative bc3 API documentation into this read-only documentation mirror.
Changes:
- Adds Spotlights endpoint documentation and index entry.
- Documents Questions update authorization behavior.
- Documents Schedule Entry validation errors.
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.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
README.md |
Adds Spotlights to the endpoint index. |
sections/spotlights.md |
Documents spotlight creation, removal, and legacy routes. |
sections/questions.md |
Documents client-user update restrictions. |
sections/schedule_entries.md |
Documents 422 validation responses. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Forward sync of the bc3-ahead half of the docs drift:
sections/spotlights.md) plus its README index entryquestions.md: client users may only update their own question —403 Forbiddenotherwiseschedule_entries.md: failed validation on create returns422 Unprocessable Entitywith anerrorspayloadCompanion to bc3#13040, which ports #436's delegated-events docs back into bc3's
doc/api/— with that port in place, this sync leavesevents.md/webhooks.mduntouched (exact convergence, nothing deleted). Merge after bc3#13040 lands.Tracking: bc3 ↔ bc-api docs drift card
Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.