Document the My Bookmarks API#421
Open
jeremy wants to merge 1 commit into
Open
Conversation
Every recording already returns a bookmark_url, but there was no documented way to work with bookmarks. This adds a My bookmarks section covering the endpoints for listing your bookmarked recordings and for checking, creating, and removing the bookmark on an individual recording.
There was a problem hiding this comment.
Pull request overview
Adds documentation for the “My bookmarks” API so integrators can list a user’s bookmarks and bookmark/unbookmark individual recordings, complementing the existing bookmark_url field on recordings.
Changes:
- Added a new
sections/my_bookmarks.mdsection documenting list/status/create/delete bookmark endpoints with examples. - Linked the new “My bookmarks” section from the README endpoint index.
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 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sections/my_bookmarks.md | Introduces full documentation for bookmark listing and bookmark/unbookmark operations. |
| README.md | Adds the new “My bookmarks” entry to the API endpoint index. |
Comments suppressed due to low confidence (1)
sections/my_bookmarks.md:216
- To keep section cross-links consistent with the rest of sections/, define reference-style links at the bottom of the file (after the final cURL block), e.g. [recordings]: recordings.md#recordings and [pagination]: ../README.md#pagination. This also avoids inline ../README.md#pagination links in the prose.
This endpoint returns `204 No Content` if the removal was a success. Deleting a
bookmark that doesn't exist will also return `204 No Content`.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Every recording returned by the API already includes a
bookmark_url, but there was no documented way to actually work with bookmarks. This documents them.Bookmarks are personal — a bookmark links you to a single recording (a message, to-do, document, card, and so on), and is visible only to you.
Endpoints
GET/my/bookmarks.jsonGET/recordings/:recording_id/bookmark.json{ "bookmarked": true | false }POST/recordings/:recording_id/bookmark.json201 CreatedDELETE/recordings/:recording_id/bookmark.json204 No ContentCreating and deleting are both idempotent: re-bookmarking a recording you've already bookmarked returns the existing bookmark without creating a duplicate, and deleting a bookmark that isn't there still returns
204.The list endpoint is paginated — see pagination for the
X-Total-CountandLinkresponse headers.Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.