This is an automated email from the ASF dual-hosted git repository.
davidb pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature.git
The following commit(s) were added to refs/heads/master by this push:
new 820452f Clarify the 'global' region
820452f is described below
commit 820452f38173cb13d9e910ef29fd16629bc6de95
Author: David Bosschaert <[email protected]>
AuthorDate: Fri Jul 13 12:17:26 2018 +0200
Clarify the 'global' region
---
apicontroller.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/apicontroller.md b/apicontroller.md
index eab064a..c7bc669 100644
--- a/apicontroller.md
+++ b/apicontroller.md
@@ -15,7 +15,9 @@ We can generalize this by saying that API is either globally
visible (to every c
Without any further information, API is globally visible by default. However,
for platform features we want the opposite as we want to ensure that newly
added API is not world-wide visible by default. Therefore we'll add an
additional build time check (analyzer) that checks that each platform feature
has an api controller configuration as below.
-A feature can have an additional extension JSON named api-regions. This
example exposes some packages to the global region and an additional package to
the platform region. Exports declared earlier in the api-regions array also
apply to later elements in the array, so the platform region also contains all
exports declared for the global region.
+A feature can have an additional extension JSON named api-regions. The
following example exposes some packages to the global region and an additional
package to the platform region. Exports declared earlier in the api-regions
array also apply to later elements in the array, so the platform region also
contains all exports declared for the global region.
+
+Note that the 'global' region is a predefined region that exports the listed
packages to everyone. Other region names can be chosen freely. Packages listed
in these other regions are only exposed to bundles in features that are in the
same region.
"api-regions:JSON|false" : [
{
