Skip to content

Commit 93e0bdf

Browse files
authored
DOC-10545-renamed sync function folder, updated context wildcard (#903)
1 parent 3141fbf commit 93e0bdf

19 files changed

+32
-31
lines changed

modules/ROOT/nav.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,17 @@
4949
** xref:access-control/channels.adoc[Channels]
5050
** xref:access-control/roles.adoc[Roles]
5151
** xref:access-control/users.adoc[Users]
52-
* xref:access-control/sync-function-api/sync-function.adoc[Sync Function]
53-
** xref:access-control/sync-function-api/sync-function-api.adoc[API Reference]
54-
*** xref:access-control/sync-function-api/sync-function-api-access-cmd.adoc[access()]
55-
*** xref:access-control/sync-function-api/sync-function-api-channel-cmd.adoc[channel()]
56-
*** xref:access-control/sync-function-api/sync-function-api-expiry-cmd.adoc[expiry()]
57-
*** xref:access-control/sync-function-api/sync-function-api-require-access-cmd.adoc[requireAccess()]
58-
*** xref:access-control/sync-function-api/sync-function-api-require-admin-cmd.adoc[requireAdmin()]
59-
*** xref:access-control/sync-function-api/sync-function-api-require-role-cmd.adoc[requireRole()]
60-
*** xref:access-control/sync-function-api/sync-function-api-require-user-cmd.adoc[requireUser()]
61-
*** xref:access-control/sync-function-api/sync-function-api-role-cmd.adoc[role()]
62-
*** xref:access-control/sync-function-api/sync-function-api-throw-cmd.adoc[throw()]
52+
* xref:access-control/sync-function/sync-function.adoc[Sync Function]
53+
** xref:access-control/sync-function/sync-function-api.adoc[API Reference]
54+
*** xref:access-control/sync-function/sync-function-api-access-cmd.adoc[access()]
55+
*** xref:access-control/sync-function/sync-function-api-channel-cmd.adoc[channel()]
56+
*** xref:access-control/sync-function/sync-function-api-expiry-cmd.adoc[expiry()]
57+
*** xref:access-control/sync-function/sync-function-api-require-access-cmd.adoc[requireAccess()]
58+
*** xref:access-control/sync-function/sync-function-api-require-admin-cmd.adoc[requireAdmin()]
59+
*** xref:access-control/sync-function/sync-function-api-require-role-cmd.adoc[requireRole()]
60+
*** xref:access-control/sync-function/sync-function-api-require-user-cmd.adoc[requireUser()]
61+
*** xref:access-control/sync-function/sync-function-api-role-cmd.adoc[role()]
62+
*** xref:access-control/sync-function/sync-function-api-throw-cmd.adoc[throw()]
6363
* xref:access-control/access-control-how.adoc[How-to]
6464
** xref:access-control/access-control-how-create-users.adoc[Create Users]
6565
** xref:access-control/access-control-how-create-roles.adoc[Create Roles]

modules/ROOT/pages/_partials/_define_page_index.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -737,33 +737,33 @@ endif::xref--pfx-sgw[]
737737
:supported-environments--page: supported-environments.adoc
738738
:supported-environments--xref: {sgw--xref}{supported-environments--page}[Supported OS]
739739

740-
:sync-function-overview--page: access-control/sync-function-api/sync-function-overview.adoc
740+
:sync-function-overview--page: access-control/sync-function/sync-function-overview.adoc
741741
:sync-function-overview--xref: {sgw--xref}{sync-function-overview--page}[Sync Function Overview]
742-
:sync-function--page: access-control/sync-function-api/sync-function.adoc
742+
:sync-function--page: access-control/sync-function/sync-function.adoc
743743
:sync-function--xref: {sgw--xref}{sync-function--page}[Sync Function]
744744

745-
:sync-function-api--page: access-control/sync-function-api/sync-function-api.adoc
745+
:sync-function-api--page: access-control/sync-function/sync-function-api.adoc
746746
:sync-function-api--xref: {sgw--xref}{sync-function-api--page}[Sync Function API]
747747

748748

749749

750-
:sync-function-api-access-cmd--page: access-control/sync-function-api/sync-function-api-access-cmd.adoc
750+
:sync-function-api-access-cmd--page: access-control/sync-function/sync-function-api-access-cmd.adoc
751751
:sync-function-api-access-cmd--xref: {sgw--xref}{sync-function-api-access-cmd--page}[access()]
752-
:sync-function-api-channel-cmd--page: access-control/sync-function-api/sync-function-api-channel-cmd.adoc
752+
:sync-function-api-channel-cmd--page: access-control/sync-function/sync-function-api-channel-cmd.adoc
753753
:sync-function-api-channel-cmd--xref: {sgw--xref}{sync-function-api-channel-cmd--page}[channel()]
754-
:sync-function-api-expiry-cmd--page: access-control/sync-function-api/sync-function-api-expiry-cmd.adoc
754+
:sync-function-api-expiry-cmd--page: access-control/sync-function/sync-function-api-expiry-cmd.adoc
755755
:sync-function-api-expiry-cmd--xref: {sgw--xref}{sync-function-api-expiry-cmd--page}[expiry()]
756-
:sync-function-api-require-access-cmd--page: access-control/sync-function-api/sync-function-api-require-access-cmd.adoc
756+
:sync-function-api-require-access-cmd--page: access-control/sync-function/sync-function-api-require-access-cmd.adoc
757757
:sync-function-api-require-access-cmd--xref: {sgw--xref}{sync-function-api-require-access-cmd--page}[requireAccess()]
758-
:sync-function-api-require-admin-cmd--page: access-control/sync-function-api/sync-function-api-require-admin-cmd.adoc
758+
:sync-function-api-require-admin-cmd--page: access-control/sync-function/sync-function-api-require-admin-cmd.adoc
759759
:sync-function-api-require-admin-cmd--xref: {sgw--xref}{sync-function-api-require-admin-cmd--page}[requireAdmin()]
760-
:sync-function-api-require-role-cmd--page: access-control/sync-function-api/sync-function-api-require-role-cmd.adoc
760+
:sync-function-api-require-role-cmd--page: access-control/sync-function/sync-function-api-require-role-cmd.adoc
761761
:sync-function-api-require-role-cmd--xref: {sgw--xref}{sync-function-api-require-role-cmd--page}[requireRole()]
762-
:sync-function-api-require-user-cmd--page: access-control/sync-function-api/sync-function-api-require-user-cmd.adoc
762+
:sync-function-api-require-user-cmd--page: access-control/sync-function/sync-function-api-require-user-cmd.adoc
763763
:sync-function-api-require-user-cmd--xref: {sgw--xref}{sync-function-api-require-user-cmd--page}[requireUser()]
764-
:sync-function-api-role-cmd--page: access-control/sync-function-api/sync-function-api-role-cmd.adoc
764+
:sync-function-api-role-cmd--page: access-control/sync-function/sync-function-api-role-cmd.adoc
765765
:sync-function-api-role-cmd--xref: {sgw--xref}{sync-function-api-role-cmd--page}[role()]
766-
:sync-function-api-throw-cmd--page: access-control/sync-function-api/sync-function-api-throw-cmd.adoc
766+
:sync-function-api-throw-cmd--page: access-control/sync-function/sync-function-api-throw-cmd.adoc
767767
:sync-function-api-throw-cmd--xref: {sgw--xref}{sync-function-api-throw-cmd--page}[throw()]
768768
// :sync-function-api-require-channel: {sgw--xref}{sync-function-api--page}#lbl-require-channel[requireChannel()role]
769769

modules/ROOT/pages/_partials/block_related_content_menulists.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Blog Entries
116116
// tag::concept-syncfunc[]
117117
* xref:configuration/configuration-schema-access-control.adoc[Access Control]
118118
* xref:rest_api_admin.adoc#tag/Database-Configuration/operation/put_keyspace-_config-sync[Add/Update Sync Function]
119-
* xref:access-control/sync-function-api/sync-function-overview.adoc[Sync Function Overview]
119+
* xref:access-control/sync-function/sync-function-overview.adoc[Sync Function Overview]
120120
// end::concept-syncfunc[]
121121

122122

modules/ROOT/pages/_partials/sync-api/sync-function-api-access.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ This grants access to the specified channel(s) for all users assigned that role.
3232

3333
The effects of all access calls by all active documents are effectively combined in a union, so if _any_ document grants a user access to a channel, that user has access to the channel.
3434

35-
You can use the _all channels_ wildcard ('***') to grant the user access to all documents in all channels.
35+
NOTE: The sync function `access()` call does not support the wildcard ('***') for granting access to all channels.
36+
To grant a user access to all channels, use the REST API channel grant endpoint.
3637

3738
== Use
3839

0 commit comments

Comments
 (0)