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

["Ashish Chopra (Jira)" <ji...@apache.org>]

Ashish Chopra created OAK-9179:
----------------------------------

             Summary: Documentation (and comments) about rep:glob patterns in ACE restriction is confusing
                 Key: OAK-9179
                 URL: https://issues.apache.org/jira/browse/OAK-9179
             Project: Jackrabbit Oak
          Issue Type: Task
          Components: core, docs
            Reporter: Ashish Chopra
         Attachments: image-2020-08-14-17-04-51-436.png, image-2020-08-14-17-05-12-346.png, image-2020-08-14-17-10-48-466.png

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

# {{/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'

\cc: [~angela]

[0]
 !image-2020-08-14-17-04-51-436.png! 
[1]
 !image-2020-08-14-17-05-12-346.png! 
[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]
 !image-2020-08-14-17-10-48-466.png! 
[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



--
This message was sent by Atlassian Jira
(v8.3.4#803005)