diff --git a/changelogs/client_server/newsfragments/1776.clarification b/changelogs/client_server/newsfragments/1776.clarification new file mode 100644 index 00000000..4d2def20 --- /dev/null +++ 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 index 6ae5d3a8..b37d1742 100644 --- 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: