Schedule entries: document join links, highlights, and their sparse-update behavior - #430
Merged
Conversation
…pdate behavior Add the url/join_url and highlighted parameters to the schedule entry docs, show both fields in the example responses, and document that omitting them on update keeps the entry's current values.
![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: e1edb804da
ℹ️ 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".
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.
Documents two schedule entry parameters that were missing from the docs:
url— a join link for the entry, such as a video-call URL. Returned asjoin_urlin the payload (the top-levelurlis the entry's own Basecamp API URL).highlighted— whether the entry is highlighted on the schedule.Both example responses now include the new fields, and the update section documents their sparse-update behavior: omit either parameter and the entry keeps its current value; send
"url": ""to clear the join link or"highlighted": falseto remove the highlight.Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.