merge profiles with user directory into user data, also fix typo

2017-12-18 17:01:52 +00:00 · 2017-12-18 17:01:52 +00:00 · 3d8fe6e090
commit 3d8fe6e090
parent 605510e965
2 changed files with 10 additions and 4 deletions
--- a/api/client-server/users.yaml
+++ b/api/client-server/users.yaml
@ -75,17 +75,20 @@ paths:
                items:
                  title: User
                  type: object
-                  require: ["user_id"]
+                  required: ["user_id"]
                  properties:
                    user_id:
                      type: string
                      example: "@foo:bar.com"
+                      description: The MXID of the user.
                    display_name:
                      type: string
                      example: "Foo"
+                      description: The display name of the user, if one exists.
                    avatar_url:
                      type: string
                      example: "mxc://bar.com/foo"
+                      description: The avatar url, as an MXC, if one exists.
              limited:
                type: boolean
                description: Indicates if the result list has been truncated by the limit.