Remove enum for POST /login type definition (#1776)

Since the enum is not exhaustive, improve the description of the property instead.
matrix-org · Apr 9, 2024 · 2ea8e0f · 2ea8e0f
1 parent efe72d3
commit 2ea8e0f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/changelogs/client_server/newsfragments/1776.clarification b/changelogs/client_server/newsfragments/1776.clarification
@@ -0,0 +1 @@
+Clarify that the `type` of the `POST /login` request must be one of the types returned by the `GET /login` response.
diff --git a/data/api/client-server/login.yaml b/data/api/client-server/login.yaml
@@ -109,10 +109,12 @@ paths:
               properties:
                 type:
                   type: string
-                  enum:
-                    - m.login.password
-                    - m.login.token
-                  description: The login type being used.
+                  description: |-
+                    The login type being used.
+
+                    This must be a type returned in one of the flows of the
+                    response of the [`GET /login`](/client-server-api/#get_matrixclientv3login)
+                    endpoint, like `m.login.password` or `m.login.token`.
                 identifier:
                   $ref: definitions/user_identifier.yaml
                 user:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Clarify that the `type` of the `POST /login` request must be one of the types returned by the `GET /login` response.