Mark type in AuthenticationData as optional (#989)

matrix-org · Mar 8, 2022 · 284d0e2 · 284d0e2
1 parent d199c05
commit 284d0e2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/changelogs/client_server/newsfragments/989.clarification b/changelogs/client_server/newsfragments/989.clarification
@@ -0,0 +1 @@
+Clarify that the `type` in user-interactive authentication can be omitted.
diff --git a/data/api/client-server/definitions/auth_data.yaml b/data/api/client-server/definitions/auth_data.yaml
@@ -17,16 +17,18 @@ description: |-
 type: object
 properties:
   type:
-    description: The login type that the client is attempting to complete.
+    description: |-
+      The authentication type that the client is attempting to complete.
+      May be omitted if `session` is given, and the client is reissuing a
+      request which it believes has been completed out-of-band (for example,
+      via the [fallback mechanism](#fallback)).
     type: string
   session:
     description: The value of the session key given by the homeserver.
     type: string
 additionalProperties:
   description: Keys dependent on the login type
   type: object
-required:
-  - type
 example:
   type: "example.type.foo"
   session: "xxxxx"