Skip to content

docs(dav): clarify CalDAV object backend contracts - #64663

Open
joshtrichards wants to merge 2 commits into
masterfrom
jtr/docs-CalDAVBackend-retrievalContracts
Open

joshtrichards wants to merge 2 commits into
masterfrom
jtr/docs-CalDAVBackend-retrievalContracts

Conversation

@joshtrichards

@joshtrichards joshtrichards commented Sep 22, 2026 •

Copy link
Copy Markdown
Member
  • Resolves: #

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

  • Clarify that getCalendarObjects() returns metadata only and excludes soft-deleted objects.
  • Document the UID-keyed result behavior of getLimitedCalendarObjects().
  • Clarify that getCalendarObject() includes calendardata and may return soft-deleted objects.
  • Add the native ?array return type to getCalendarObject().
  • Add setMaxResults(1) to getCalendarObject() to document intent.
  • Clarify that getMultipleCalendarObjects() performs a bulk lookup, chunks URI parameters, excludes soft-deleted objects, and does not guarantee input ordering.
  • Remove or replace generic Sabre backend wording where it does not accurately describe the concrete implementation.

TODO

  • ...

Checklist

AI (if applicable)

  • The content of this PR was partly or fully generated using AI

Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3. to review Waiting for reviews developer experience feature: caldav Related to CalDAV internals technical debt 🧱 🤔🚀

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants