Add some explanation to application_services.md (matrix-org#7091)

Signed-off-by: Simon Körner <[email protected]>
globekeeper · Apr 27, 2020 · aa24929 · aa24929
1 parent cc9eceb
commit aa24929
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/changelog.d/7091.doc b/changelog.d/7091.doc
@@ -0,0 +1 @@
+Improve the documentation of application service configuration files.
diff --git a/docs/application_services.md b/docs/application_services.md
@@ -23,9 +23,13 @@ namespaces:
   users:  # List of users we're interested in
     - exclusive: <bool>
       regex: <regex>
+      group_id: <group>
     - ...
   aliases: []  # List of aliases we're interested in
   rooms: [] # List of room ids we're interested in
 ```
 
+`exclusive`: If enabled, only this application service is allowed to register users in its namespace(s).
+`group_id`: All users of this application service are dynamically joined to this group. This is useful for e.g user organisation or flairs.
+
 See the [spec](https://matrix.org/docs/spec/application_service/unstable.html) for further details on how application services work.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Improve the documentation of application service configuration files.