From 2cc631e30a7a3241bad460e89cbc9b48408e08a8 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travisr@matrix.org>
Date: Thu, 2 Jun 2022 13:41:23 -0600
Subject: [PATCH] Try to clarify the return of /relations

---
 data/api/client-server/relations.yaml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/data/api/client-server/relations.yaml b/data/api/client-server/relations.yaml
index 1731abce..4c7d97d5 100644
--- a/data/api/client-server/relations.yaml
+++ b/data/api/client-server/relations.yaml
@@ -142,7 +142,8 @@ paths:
                 type: array
                 required: true
                 description: |-
-                  The child events which point to the parent event, after applicable filters.
+                  The child events of the requested event. If a `relType` or `eventType` was
+                  supplied on the URL, the events returned will match those details.
                 items:
                   allOf:
                     - "$ref": "definitions/client_event.yaml"