[LA-36814] Doc status filter + item channels endpoints#51
Merged
Conversation
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.
Jira
https://learnamp.atlassian.net/browse/LA-36814
What
Documents two parts of the public API that already exist in code but were missing from the docs:
GET /v1/items/:id/channels— new "List Channels Containing an Item" section in_items.md, mirroring the existing "List Learnlists Containing an Item". Returns the channels (Carousels) containing an item; response is{ "channels": [{ "id", "title" }] }, paginated,items:readscope.filters[status]onGET /v1/users— new row in the View All Users filter table in_users.md. Multi-value; possible values: not_invited, invite_scheduled, invite_pending, confirmed, deactivated.Why
Part of LA-36515 (Filter parity on list APIs). Customers (Namecheap, Winc Academy) need these documented to use them. The
/items/:id/channelsendpoint (LA-36812) and thestatusfilter (LA-36813) are delivered in sibling learnamp PRs #23667 and #23668.filters[no_team]and/items/:id/learnlistswere already documented, so they're untouched here.Note
Low Risk
Markdown-only API documentation; no runtime or security behavior changes.
Overview
Documents two public API capabilities that already ship in the product but were missing from the docs.
Items: Adds a List Channels Containing an Item section for
GET /v1/items/{itemId}/channels, aligned with the existing learnlists section—curl/Ruby examples,items:readscope, pagination, and a{ "channels": [{ "id", "title" }] }response plus 404.Users: Adds
filters[status][]to the View All Users filter table so callers can filter by one or more statuses (not_invited,invite_scheduled,invite_pending,confirmed,deactivated) via repeated query params.Reviewed by Cursor Bugbot for commit d4bfbfd. Bugbot is set up for automated code reviews on this repo. Configure here.