Commit graph

74 commits

Author SHA1 Message Date
Travis Ralston b8f1f37927 Remove incorrect id_server param from IS spec
Fixes https://github.com/matrix-org/matrix-doc/issues/2118
2019-06-12 15:29:25 -06:00
Travis Ralston fbdb56a29f
Merge pull request #2101 from matrix-org/anoa/hs_3pid_tokens
Add submit_url field to requestToken responses, clarify HS's can send tokens themselves
2019-06-11 09:25:53 -06:00
Travis Ralston f047e235df Merge branch 'master' into travis/1.0/event-ids 2019-06-10 10:52:34 -06:00
Andrew Morgan 7116f9334e More consolidation 2019-06-10 09:09:26 +01:00
Andrew Morgan ab0c1bc054 Add changelog, update imperative check, rename sid.yaml 2019-06-10 08:41:35 +01:00
Andrew Morgan fe23de7d7f A SMS -> An SMS 2019-06-10 05:20:15 +01:00
Andrew Morgan 046a834488 Slight code cleanup 2019-06-09 22:04:58 +01:00
Andrew Morgan 525bedf8e1 Fix refs 2019-06-09 20:10:44 +01:00
Andrew Morgan fba61941af Move submit_url responses to ref 2019-06-09 20:02:57 +01:00
Andrew Morgan 0ded484276 Address review comments 2019-06-09 16:10:44 +01:00
Andrew Morgan 1776ba28d3 Address review comments 2019-06-08 18:52:38 +01:00
Andrew Morgan a8edb066aa Clear up some wording 2019-06-07 18:00:12 +01:00
Andrew Morgan 8a6ef187db more object! 2019-06-07 17:52:17 +01:00
Travis Ralston 906d3cd447
Merge pull request #2055 from matrix-org/travis/1.0/registration-clarification
Clarify guest accounts and `auth` usage on /register
2019-06-07 10:05:56 -06:00
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
2019-06-07 15:55:04 +01:00
Andrew Morgan 3148184052 HS' can send 3PID token. Add a new submit_url field 2019-06-07 15:54:51 +01:00
Travis Ralston 9cf03325b9
Merge pull request #2046 from matrix-org/travis/1.0/msc1915-unbind
Spec 3PID unbind API
2019-06-07 07:33:33 -06:00
Travis Ralston e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn
Spec MSISDN UIA support
2019-06-06 10:24:34 -06:00
Travis Ralston 976f32fcab Clarify that /register must produce valid Matrix User IDs
Fixes https://github.com/matrix-org/matrix-doc/issues/1793
2019-06-05 23:23:23 -06:00
Travis Ralston fc4965f274 Stronger spec words 2019-06-05 10:40:51 -06:00
Travis Ralston 2ed37f5bf4 Clarify guest accounts and auth usage on /register
Fixes https://github.com/matrix-org/matrix-doc/issues/1980
Fixes https://github.com/matrix-org/matrix-doc/issues/1984
2019-05-29 21:03:19 -06:00
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.
2019-05-28 15:05:41 -06:00
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.
2019-05-26 21:49:46 -06:00
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
2019-05-26 21:21:58 -06:00
Travis Ralston 7d34995ece It's actually an "identity server implementing the Identity Service API"
Also add a note about appservices being special.
2018-08-31 15:35:32 -06:00
Travis Ralston 7ac76fa27c Actually we're going with "identity server" afterall 2018-08-31 15:04:00 -06:00
Travis Ralston ec248b436f Identity Service is lowercase 2018-08-31 15:04:00 -06:00
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.
2018-08-31 15:04:00 -06:00
Travis Ralston a1f655e5be Fix more error wording 2018-08-31 14:53:59 -06:00
Travis Ralston 1261da209d Fix wording for the homeserver not allowing a particular 3pid 2018-08-31 14:38:22 -06:00
Travis Ralston 824ce22caa Add additional clarity to the requestToken errors 2018-08-31 11:41:46 -06:00
Travis Ralston 7f1b94c211 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/id-server 2018-08-31 10:29:09 -06:00
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
2018-08-30 18:18:08 -06:00
Travis Ralston 1051aff108 Document the inhibit_login registration option
Fixes https://github.com/matrix-org/matrix-doc/issues/1351
2018-08-28 18:36:07 -06:00
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
2018-08-26 21:32:44 -06:00
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
2018-08-17 12:00:13 -04:00
Travis Ralston caa6d4d9ad Give all errors a schema reference
This just helps keep an overall structure
2018-07-04 13:54:52 -06:00
Travis Ralston 7cd22f5690 Describe the rate limit error everywhere
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
2018-07-04 13:45:34 -06:00
Richard van der Hoff a549baa01d
registration.yaml: fix typo
it's -> its
2018-03-06 21:53:16 +00:00
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>
2018-03-06 13:16:07 -07:00
Richard van der Hoff 00b28495a6 Explain how to split an mxid 2017-12-18 14:48:56 +00:00
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.
2017-12-18 13:34:26 +00:00
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>
2017-12-15 13:14:26 +01:00
Kitsune Ral 66268260c7 Merge remote-tracking branch 'remotes/origin/master' 2017-11-13 07:46:29 +09:00
Richard van der Hoff 628e723483 Move the MXID spec to the appendices
Also link to them from the /register API doc.
2017-10-23 00:51:40 +01:00
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>
2017-10-11 01:58:31 +09:00
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.
2017-09-27 08:04:24 +01:00
Richard van der Hoff c83a556097 Set default account 'kind' to 'user'
Fixes https://github.com/matrix-org/matrix-doc/issues/736
2016-11-21 17:54:47 +00:00
Richard van der Hoff 9265b03008 Client device doc
Document client devices, and the mods to the login and register apis to support
them.
2016-10-12 17:26:01 +01:00
Richard van der Hoff f4c7fdfd03 Remove references to refresh tokens and tokenrefresh
refresh tokens are dead.
2016-10-03 17:05:56 +01:00