docs(api): fix smart list available options - #900
Open
rectifyer wants to merge 1 commit into
Open
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.
Summary
Fixes the smart lists documentation inaccuracies reported in #881. The docs described path and query params the API does not implement, and two endpoints linked to an items method that does not exist.
Changes
Fixed broken doc links. The "Get smart list" and "Get a user's smart lists" descriptions pointed to
/users/:id/smart-lists/:list_id/items, which was never implemented. Smart list slugs are globally unique, so items are served by the top-level/smart-lists/:list_id/itemsmethod. Both links now point there.Removed the
type,sort_by, andsort_howpath params from "Get smart list items". Audited against the worker implementation: the route declares all three as optional and the handler never reads them. They had no effect on the response. A smart list is targeted to a singlemedia_type, so its items always match that type and a type filter is not meaningful. The canonical path is now/smart-lists/:list_id/items.Removed unsupported query params.
start_date,end_date, andignore_collectedare not parsed by the worker's filter handling, so they are omitted from the items query schema. The shared schemas are untouched for other endpoints.Verification
deno fmt --checkanddeno lintpass on the edited filesdeno checkpasses on both contract filesdeno task openapi:validatepassesCloses #881