wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Mark type in AuthenticationData as optional (#989)

Browse source
This commit is contained in:
Richard van der Hoff 2022-03-08 18:42:05 +00:00 • committed by GitHub
parent d199c05e97
commit 284d0e201f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/989.clarification Normal file
View file

@ -0,0 +1 @@
Clarify that the `type` in user-interactive authentication can be omitted.

8
data/api/client-server/definitions/auth_data.yaml
View file

@ -17,7 +17,11 @@ description: |-
type: object type: object
properties: properties:
type: 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 type: string
session: session:
description: The value of the session key given by the homeserver. description: The value of the session key given by the homeserver.
@ -25,8 +29,6 @@ properties:
additionalProperties: additionalProperties:
description: Keys dependent on the login type description: Keys dependent on the login type
type: object type: object
required:
- type
example: example:
type: "example.type.foo" type: "example.type.foo"
session: "xxxxx" session: "xxxxx"