docs(events): describe the paginated share-review source API - #15592
Draft
AndyScherzinger wants to merge 1 commit into
Draft
docs(events): describe the paginated share-review source API#15592AndyScherzinger wants to merge 1 commit into
AndyScherzinger wants to merge 1 commit into
Conversation
Document the Nextcloud 36 additions to the share-review events: the IPaginatedShareReviewSource interface collected through RegisterShareReviewSourceEvent (page-wise listing with sorting, search, filters and counts, keyed lookup, localized label, optional remediation and snapshot capabilities) and the action, acting user and scope carried by ShareReviewAccessCheckEvent. Assisted-by: Claude Code:claude-opus-5 Signed-off-by: Andy Scherzinger <info@andy-scherzinger.de>
10 tasks
Contributor
📖 Documentation Preview📄 1 changed documentation pageLast updated: Tue, 08 Sep 2026 17:50:14 GMT |
Member
Author
|
/backport to stable35 |
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
1 participant
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.
☑️ Resolves
OCP\Share\ShareReviewAPI for paginated share sources), the follow-up to feat(share): add public share-review API under OCP\Share\ShareReview server#61543 which added the 34.0.2 API documented here today.Two entries on the OCP events page are updated:
ShareReviewAccessCheckEventgains a.. versionchanged:: 36note: the event now carries the operation being authorized (getAction()— delete, remediate, restore), the acting user (getActingUserId()) and the scope (getScope()— operator or self, where a listener must additionally verify initiatorship). It records how those values reach the owning app (through the optionalShareReviewActionContextthat a share-review app passes to the mutators, forwarded into the event verbatim), and what a listener written against 34.0.2 sees: it keeps failing closed for non-operators, but for operators the new actions extend the granted capability set, so a listener that distinguishes delete-only reviewers has to checkgetAction()and deny what it does not recognise.RegisterShareReviewSourceEventgains a.. versionchanged:: 36note forIPaginatedShareReviewSource:queryShares()with theShareReviewQueryfilter set,countShares()/countSharesByType()/countSharesByInitiator()for counts without rows,getShare()for a keyed lookup, andgetDisplayName()next to agetName()that stays a stable untranslated id. It also states the rules an implementation must honour (secondary sort on the primary key, NULLs last, LIKE escaping, exact token comparison, empty list matches nothing, oneGROUP BYscan per grouped count) and describes the two optional capability interfaces, including why remediation applies to link and mail shares only.🖼️ Screenshots
✅ Checklist
codespellor similar and addressed any spelling issuesThis PR was written with AI assistance; the commit carries an
Assisted-bytrailer.🤖 Generated with Claude Code