[OAK-9179] Documentation (and comments) about rep:glob patterns in ACE restriction is confusing

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.34.0
• Component/s: core, docs
• Assignee: Angela Schreiber
• Reporter: Ashish Chopra
• Created: 14/Aug/20 11:42
• Updated: 10/Sep/20 15:45
• Resolved: 19/Aug/20 13:57

Description

There appears to be a bit of disconnect (or at least language differences) between what the documentation says and what actually happens

1. /cat/ and /cat/* seem to behave identically
   • FWIW, that's what documentation also seems to suggest, but the terminology is confusing [0] [1]
   • the tests [2] [3], though not exactly the same, seem imply the equivalence
   • 'descendants' implies "all", so we should either add "all" to both [0] and [1], or remove it altogether for consistency - essentially, we should use the exact same description for both the patterns if they are equivalent in all respects, or update the language to highlight/contrast the difference
2. /cat says "the node and all its child items" [4].
   • the test [5] indicates that descendants can be accessed as well
   • For consistency, we should consider replacing child-items with 'descendants'

[0]
[1]
[2]
https://github.com/apache/jackrabbit-oak/blob/762764e0c7120557c1515c54322d6a0936ae04db/oak-core/src/test/java/org/apache/jackrabbit/oak/security/authorization/restriction/GlobPatternTest.java#L401-L402
[3] https://github.com/apache/jackrabbit-oak/blob/762764e0c7120557c1515c54322d6a0936ae04db/oak-core/src/test/java/org/apache/jackrabbit/oak/security/authorization/restriction/GlobPatternTest.java#L231-L232
[4]
[5] https://github.com/apache/jackrabbit-oak/blob/762764e0c7120557c1515c54322d6a0936ae04db/oak-core/src/test/java/org/apache/jackrabbit/oak/security/authorization/restriction/GlobPatternTest.java#L383-L384