From 8c93135124953e21aa616c7b608ffe8d99db4e3c Mon Sep 17 00:00:00 2001
From: Denis Arh <denis.arh@gmail.com>
Date: Sun, 19 Apr 2020 10:16:14 +0200
Subject: [PATCH] Describe settings/current endpoint

---
 compose/rest/settings.go   | 3 +++
 messaging/rest/settings.go | 5 +++++
 system/rest/settings.go    | 5 +++++
 3 files changed, 13 insertions(+)

diff --git a/compose/rest/settings.go b/compose/rest/settings.go
index 0846d0040..91e36a50d 100644
--- a/compose/rest/settings.go
+++ b/compose/rest/settings.go
@@ -47,6 +47,9 @@ func (ctrl *Settings) Get(ctx context.Context, r *request.SettingsGet) (interfac
 	}
 }
 
+// Current settings, structured
+//
+// This is available to all authenticated users
 func (ctrl *Settings) Current(ctx context.Context, r *request.SettingsCurrent) (interface{}, error) {
 	return service.CurrentSettings, nil
 }
diff --git a/messaging/rest/settings.go b/messaging/rest/settings.go
index dc0359d8b..42328d2d5 100644
--- a/messaging/rest/settings.go
+++ b/messaging/rest/settings.go
@@ -47,6 +47,11 @@ func (ctrl *Settings) Get(ctx context.Context, r *request.SettingsGet) (interfac
 	}
 }
 
+// Current settings, structured
+//
+// This is available to all authenticated users
+//
+// @todo selectively apply subset of user's own settings (like ui.*)
 func (ctrl *Settings) Current(ctx context.Context, r *request.SettingsCurrent) (interface{}, error) {
 	return service.CurrentSettings, nil
 }
diff --git a/system/rest/settings.go b/system/rest/settings.go
index 297a8de05..7cc3a4cb8 100644
--- a/system/rest/settings.go
+++ b/system/rest/settings.go
@@ -47,6 +47,11 @@ func (ctrl *Settings) Get(ctx context.Context, r *request.SettingsGet) (interfac
 	}
 }
 
+// Current settings, structured
+//
+// This is available to all authenticated users
+//
+// @todo selectively apply subset of user's own settings (like ui.one.panes.*)
 func (ctrl *Settings) Current(ctx context.Context, r *request.SettingsCurrent) (interface{}, error) {
 	return service.CurrentSettings, nil
 }