Specify guest accounts

2015-11-02 15:26:06 +00:00 · 2015-11-02 15:26:06 +00:00 · 2e3a0b4e00
commit 2e3a0b4e00
parent 6c1df04b4b
2 changed files with 24 additions and 0 deletions
--- a/api/client-server/v2_alpha/registration.yaml
+++ b/api/client-server/v2_alpha/registration.yaml
@ -17,7 +17,24 @@ paths:
      summary: Register for an account on this homeserver.
      description: |-
        Register for an account on this homeserver.
+
+        There are two kinds of user account:
+
+        - `user` accounts. These accounts may use the full API described in this specification.
+
+        - `guest` accounts. These accounts may have limited permissions and may not be supported by all servers.
+
      parameters:
+        - in: query
+          name: kind
+          type: string
+          x-example: guest
+          required: false
+          default: user
+          enum:
+            - guest
+            - user
+          description: The kind of account to register. Defaults to `user`.
        - in: body
          name: body
          schema: