From 284d0e201f8f43b7dca1e0e0602f82c83163bc52 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Date: Tue, 8 Mar 2022 18:42:05 +0000
Subject: [PATCH] Mark `type` in `AuthenticationData` as optional (#989)

---
 changelogs/client_server/newsfragments/989.clarification | 1 +
 data/api/client-server/definitions/auth_data.yaml        | 8 +++++---
 2 files changed, 6 insertions(+), 3 deletions(-)
 create mode 100644 changelogs/client_server/newsfragments/989.clarification

diff --git a/changelogs/client_server/newsfragments/989.clarification b/changelogs/client_server/newsfragments/989.clarification
new file mode 100644
index 00000000..fd9ff69a
--- /dev/null
+++ 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
index c37c6a48..4bfbf62b 100644
--- a/data/api/client-server/definitions/auth_data.yaml
+++ b/data/api/client-server/definitions/auth_data.yaml
@@ -17,7 +17,11 @@ 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.
@@ -25,8 +29,6 @@ properties:
 additionalProperties:
   description: Keys dependent on the login type
   type: object
-required:
-  - type
 example:
   type: "example.type.foo"
   session: "xxxxx"