docs(dav): clarify CalDAV object backend contracts - #64663
Open
joshtrichards wants to merge 2 commits into
Open
joshtrichards wants to merge 2 commits into
joshtrichards wants to merge 2 commits into
Conversation
Signed-off-by: Josh <josh.t.richards@gmail.com>
joshtrichards
requested review from
ChristophWurst,
SebastianKrupinski and
tcitworld
as code owners
September 22, 2026 16:23
SebastianKrupinski
approved these changes
Sep 23, 2026
Signed-off-by: Josh <josh.t.richards@gmail.com>
miaulalala
approved these changes
Sep 23, 2026
This branch has not been deployed
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
Fix inaccuracies in and clarify the documentation and return type for calendar object retrieval methods in
CalDavBackend.The existing docblocks combine inherited SabreDAV guidance with implementation-specific behavior. This makes important differences between the single-object, multi-object, limited-field, and collection methods difficult to determine.
The updated documentation describes the observable behavior without duplicating the complete array shapes, reducing the risk of future documentation drift.
Changes
getCalendarObjects()returns metadata only and excludes soft-deleted objects.getLimitedCalendarObjects().getCalendarObject()includescalendardataand may return soft-deleted objects.?arrayreturn type togetCalendarObject().setMaxResults(1)togetCalendarObject()to document intent.getMultipleCalendarObjects()performs a bulk lookup, chunks URI parameters, excludes soft-deleted objects, and does not guarantee input ordering.TODO
Checklist
3. to review, feature component)stable32)AI (if applicable)