Clarify why avatar_url and displayname can't be returned as null

matrix-org · Feb 21, 2025 · dd4ea94 · dd4ea94
1 parent 50eab35
commit dd4ea94
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/data/api/client-server/profile.yaml b/data/api/client-server/profile.yaml
@@ -262,7 +262,8 @@ paths:
       summary: Get all profile information for a user.
       description: |-
         Get the complete profile for a user. The response includes `avatar_url`
-        and `displayname` (unless set to `null`) plus any custom profile fields.
+        and `displayname` (unless set to `null`, as they can only be strings)
+        plus any custom profile fields.
 
         **Note**: The complete profile must be under 64 KiB.
       operationId: getUserProfile