Andrew Morgan
fba61941af
Move submit_url responses to ref
6 years ago
Andrew Morgan
0ded484276
Address review comments
6 years ago
Andrew Morgan
1776ba28d3
Address review comments
6 years ago
Andrew Morgan
a8edb066aa
Clear up some wording
6 years ago
Andrew Morgan
8a6ef187db
more object!
6 years ago
Andrew Morgan
62910a28cc
Merge branch 'master' into anoa/hs_3pid_tokens
...
* master:
Update example
Fix 404s in links from room v1 spec
Provide a more complete example of a "minimally-sized event"
Revert signature change for redactable event test
Clarify how many PDUs are in a given transaction object
Clarify that the server shouldn't process retries for UIA
Clarify when authorization and rate-limiting are not applicable
Skip over partial event definitions in examples
Rename example to invite_room_state
Shorten references to StrippedState in s2s spec
Fix examples of StrippedState in s2s spec
Clarify exactly what StrippedState is
Clarify that UIA stages cannot be attempted twice
Fix test vectors with invalid JSON and signature
Spec 3PID unbind API
Spec MSISDN UIA support
6 years ago
Andrew Morgan
3148184052
HS' can send 3PID token. Add a new submit_url field
6 years ago
Travis Ralston
9cf03325b9
Merge pull request #2046 from matrix-org/travis/1.0/msc1915-unbind
...
Spec 3PID unbind API
6 years ago
Travis Ralston
e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn
...
Spec MSISDN UIA support
6 years ago
Travis Ralston
0463084924
Spec 3PID unbind API
...
As per [MSC1915](https://github.com/matrix-org/matrix-doc/pull/1915 )
Implementation proof:
* https://github.com/matrix-org/synapse/pull/4982
* https://github.com/matrix-org/sydent/pull/160
The only alteration made which differs from the proposal is clarity on how to handle homeservers not knowing the `id_server`. All other differences are unintentional.
6 years ago
Travis Ralston
1bda3fe2b2
Spec MSISDN UIA support
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1702
1702 describes the lack of `bind_msisdn` parameter, however the whole login type was missing from UIA.
6 years ago
Travis Ralston
1d33adf62d
Add rationale for UIA on change password, and how access tokens behave
...
Fixes https://github.com/matrix-org/matrix-doc/issues/680
6 years ago
Travis Ralston
7d34995ece
It's actually an "identity server implementing the Identity Service API"
...
Also add a note about appservices being special.
6 years ago
Travis Ralston
7ac76fa27c
Actually we're going with "identity server" afterall
6 years ago
Travis Ralston
ec248b436f
Identity Service is lowercase
6 years ago
Travis Ralston
cc0badaaa1
Fix all naming cases of "identity service"
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1396
Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
6 years ago
Travis Ralston
a1f655e5be
Fix more error wording
6 years ago
Travis Ralston
1261da209d
Fix wording for the homeserver not allowing a particular 3pid
6 years ago
Travis Ralston
824ce22caa
Add additional clarity to the requestToken errors
6 years ago
Travis Ralston
7f1b94c211
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/id-server
6 years ago
Travis Ralston
dfaed5b525
Clean up and flesh out all three editions of the /requestToken API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1634
Addresses some of https://github.com/matrix-org/matrix-doc/issues/1396
6 years ago
Travis Ralston
1051aff108
Document the inhibit_login registration option
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1351
6 years ago
Travis Ralston
667fa082af
Replace applicable types of 'number' to 'integer'
...
`number` implies/represents a float where `integer` does not.
The only remaining `type: number` in the project appear on power levels: those have been left untouched pending clarification.
Fixes https://github.com/matrix-org/matrix-doc/issues/746
6 years ago
Hubert Chathi
f5dc0eaed2
document msisdn-related endpoints in IS ( #1507 )
...
* add msisdn endpoints in Identity Server spec
* add in CS endpoints that use the IS msisdn endpoints
6 years ago
Travis Ralston
caa6d4d9ad
Give all errors a schema reference
...
This just helps keep an overall structure
6 years ago
Travis Ralston
7cd22f5690
Describe the rate limit error everywhere
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
6 years ago
Richard van der Hoff
a549baa01d
registration.yaml: fix typo
...
it's -> its
7 years ago
Travis Ralston
15cdde3f49
Add GET /register/available
...
Adds https://github.com/matrix-org/matrix-doc/issues/911
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Richard van der Hoff
00b28495a6
Explain how to split an mxid
7 years ago
Richard van der Hoff
d9a4ddbf65
Mark `home_server` field deprecated
...
This is spelt wrong, and is redundant to user_id, so let's stop people using
it.
7 years ago
Gergely Polonkai
e9622bf9e4
Fix example in email based registration endpoint
...
The spec says `send_attempt` should be a number, but the example shows it as a string.
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
7 years ago
Kitsune Ral
66268260c7
Merge remote-tracking branch 'remotes/origin/master'
7 years ago
Richard van der Hoff
628e723483
Move the MXID spec to the appendices
...
Also link to them from the /register API doc.
7 years ago
Kitsune Ral
24afe7987c
Add operationId to all endpoints of all APIs
...
To facilitate generation of API stubs from the spec.
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
Richard van der Hoff
820704a16a
Format examples as raw objects
...
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).
The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
7 years ago
Richard van der Hoff
c83a556097
Set default account 'kind' to 'user'
...
Fixes https://github.com/matrix-org/matrix-doc/issues/736
8 years ago
Richard van der Hoff
9265b03008
Client device doc
...
Document client devices, and the mods to the login and register apis to support
them.
8 years ago
Richard van der Hoff
f4c7fdfd03
Remove references to refresh tokens and tokenrefresh
...
refresh tokens are dead.
8 years ago
Richard van der Hoff
c51c4acf7f
Clarifications to authentication mechanisms
...
* Make the purpose of the `auth` key in /register requests explicit, and say
that it should be empty at first.
* Restructure the UA-auth section a bit.
* In the UA-auth section, say that clients should submit no `auth` to start
with, and add 'Stage 0' representing this to the example.
* s/{stage,login} type/authentication type/ in the UA-auth section. Seems
clearer to me.
* Try to distinguish the example responses from the example requests by giving
an HTTP header.
8 years ago
Erik Johnston
a48437ced8
Spec /account/deactivate API
8 years ago
Richard van der Hoff
49cd65dd58
Add a license to the spec
...
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
8 years ago
David Baker
e91214e78e
More links
...
Also remove now redundant anchor
8 years ago
David Baker
7c8651480a
Some PR feedback corrections
...
Including adding a hyperlink, although this requires a separate fix that I'll do on a different branch
8 years ago
David Baker
c109da5b78
Attempt to make things clearer
8 years ago
David Baker
86db820bb1
Expand on summaries for requestToken endpoints
8 years ago
David Baker
191cb08a3a
Add response section otherwise the checker fails
8 years ago
David Baker
ead5648b8c
Add requestToken endpoints
...
For password reset and 3pid adding
8 years ago
David Baker
14ff3862e3
More PR feedback
8 years ago
David Baker
e4db7be8e2
Better structure for error response
...
& add server not trusted error
9 years ago
David Baker
3dddc0dcdf
Explain why not erroring on dup 3pid is desireable
9 years ago