Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mark type in AuthenticationData as optional #989

Merged
merged 1 commit into from
Mar 8, 2022
Merged

Mark type in AuthenticationData as optional #989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/989.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that the `type` in user-interactive authentication can be omitted.
8 changes: 5 additions & 3 deletions data/api/client-server/definitions/auth_data.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down