Document and type allowed property names for calendar property searches #29661
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
For API users it looked like any properties could be searched. But it turned out to be a hand picked list of properties that we index and then use for the search. To prevent application errors where special props are not found, I suggest we document and type the allowed values. Signed-off-by: Christoph Wurst <[email protected]>
ChristophWurst
requested review from
a team,
miaulalala,
st3iny and
tcitworld
ChristophWurst
requested review from
juliusknorr,
nickvergessen and
skjnldsv
and removed request for
a team
Member
|
Why not directly reference consts from OCP in the dav backend ? |
Member
Author
Thought about that but the values in the caldav backend are not only used for this but also other types of searches, unrelated to the new php calendar search API. |
miaulalala
approved these changes
Nov 11, 2021
juliusknorr
approved these changes
Nov 11, 2021
juliusknorr
added
4. to release
st3iny
approved these changes
Nov 11, 2021
skjnldsv
approved these changes
Nov 11, 2021
| * | ||
| * @see \OCP\Calendar\ICalendarQuery | ||
| */ | ||
| private const INDEXED_PROPERTIES = [ |
Member
There was a problem hiding this comment.
Any problem with public, so it can be used in apps, etc?
Member
Author
There was a problem hiding this comment.
That is what we have ICalendarQuery for. This class here is private API. Apps must not access the class directly.
ChristophWurst
deleted the
enhancement/calendar-search-properties-api
branch
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.
For API users it looked like any properties could be searched. But it
turned out to be a hand picked list of properties that we index and then
use for the search. To prevent application errors where special props
are not found, I suggest we document and type the allowed values.
Follow-up of #28970