Repository navigation
Document restricted sort options on documents.viewed - #63
Merged
Merged
Conversation
The documents.viewed endpoint now sorts by the view record rather than the document, limiting the sort field to updatedAt or createdAt with a default of updatedAt and direction defaulting to DESC. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DcHFf6NC3154BwgEXvEMRU
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
2 participants
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
Updates the API documentation to reflect a change to the
documents.viewedendpoint in outline/outline#13970.The endpoint now sorts by the view record rather than the document itself, so the accepted
sortvalues are restricted to an enum:sort— limited toupdatedAtorcreatedAt, defaulting toupdatedAt(previously accepted any document column via the genericSortingschema)direction— defaults toDESCThe shared
Sortingschema was left untouched since it is used by many other endpoints; the restricted options are inlined into thedocuments.viewedrequest body instead.Only
spec3.ymlwas hand-edited;spec3.jsonwas regenerated by the pre-commit hook.Review of other recently merged PRs
Other PRs merged in the last day were reviewed and found to not require documentation changes:
passkeys.*andusers.updateEmailtoAuthenticationType.APPonly, making them internal endpoints (not documented).🤖 Generated with Claude Code
https://claude.ai/code/session_01DcHFf6NC3154BwgEXvEMRU
Generated by Claude Code