From faa34541ca0259e768915506dc3123600c749fb8 Mon Sep 17 00:00:00 2001 From: lub Date: Tue, 17 Mar 2020 15:01:44 +0100 Subject: [PATCH 1/4] Add some explanation to application_services.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Simon Körner --- docs/application_services.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/application_services.md b/docs/application_services.md index 06cb79f1f9ce..5a6d521ce73b 100644 --- a/docs/application_services.md +++ b/docs/application_services.md @@ -23,9 +23,13 @@ namespaces: users: # List of users we're interested in - exclusive: regex: + group_id: - ... aliases: [] # List of aliases we're interested in rooms: [] # List of room ids we're interested in ``` +`exclusive`: If enabled registrations of users in that namespace are only allowed for the application service +`group_id`: All users of this application service are dynamically registered for this group to e.g. use it as flair + See the [spec](https://matrix.org/docs/spec/application_service/unstable.html) for further details on how application services work. From b3c356651c294843f8570741c819ccf4f9a2fd6a Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Tue, 21 Apr 2020 07:13:30 -0400 Subject: [PATCH 2/4] Add a newsfragement. --- changelog.d/7091.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/7091.doc diff --git a/changelog.d/7091.doc b/changelog.d/7091.doc new file mode 100644 index 000000000000..9a4116324db2 --- /dev/null +++ b/changelog.d/7091.doc @@ -0,0 +1 @@ +Improve the documentation of application services configuration files. From b67ecf427beccea4d47e01e9499d2d0dab8a6bc2 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Tue, 21 Apr 2020 07:13:50 -0400 Subject: [PATCH 3/4] Apply suggestions from code review Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> --- docs/application_services.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/application_services.md b/docs/application_services.md index 5a6d521ce73b..23b702790996 100644 --- a/docs/application_services.md +++ b/docs/application_services.md @@ -29,7 +29,7 @@ namespaces: rooms: [] # List of room ids we're interested in ``` -`exclusive`: If enabled registrations of users in that namespace are only allowed for the application service -`group_id`: All users of this application service are dynamically registered for this group to e.g. use it as flair +`exclusive`: If enabled, only this application service is allowed to register users in that namespace +`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. From f2c204ad51c18e3fc9c61188722d7e63fd38163d Mon Sep 17 00:00:00 2001 From: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Date: Mon, 27 Apr 2020 14:55:57 +0100 Subject: [PATCH 4/4] Apply suggestions from code review --- changelog.d/7091.doc | 2 +- docs/application_services.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/changelog.d/7091.doc b/changelog.d/7091.doc index 9a4116324db2..463536c8128d 100644 --- a/changelog.d/7091.doc +++ b/changelog.d/7091.doc @@ -1 +1 @@ -Improve the documentation of application services configuration files. +Improve the documentation of application service configuration files. diff --git a/docs/application_services.md b/docs/application_services.md index 23b702790996..e4592010a2b5 100644 --- a/docs/application_services.md +++ b/docs/application_services.md @@ -29,7 +29,7 @@ namespaces: rooms: [] # List of room ids we're interested in ``` -`exclusive`: If enabled, only this application service is allowed to register users in that namespace +`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.