aboutsummaryrefslogtreecommitdiff
path: root/userapi
diff options
context:
space:
mode:
Diffstat (limited to 'userapi')
-rw-r--r--userapi/userapi.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/userapi/userapi.go b/userapi/userapi.go
index f1db007d..6b6dac88 100644
--- a/userapi/userapi.go
+++ b/userapi/userapi.go
@@ -36,6 +36,9 @@ import (
// NewInternalAPI returns a concrete implementation of the internal API. Callers
// can call functions directly on the returned API or via an HTTP interface using AddInternalRoutes.
+//
+// Creating a new instance of the user API requires a roomserver API with a federation API set
+// using its `SetFederationAPI` method, other you may get nil-dereference errors.
func NewInternalAPI(
processContext *process.ProcessContext,
dendriteCfg *config.Dendrite,