wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
5254 commits 4 branches 0 tags 17 MiB
Commit graph

61 commits

Author SHA1 Message Date
Travis Ralston
284b15495b Clarify what format the country is on phone number inputs 
Fixes https://github.com/matrix-org/matrix-doc/issues/1982
 2019-11-04 15:25:49 -07:00
Travis Ralston
d813b8e12c Mention M_INVALID_PARAM 2019-09-10 09:35:37 -06:00
Travis Ralston
6cfd761204 Spec the v2 lookup API 
Spec for [MSC2134](https://github.com/matrix-org/matrix-doc/pull/2134)
 2019-09-09 19:58:06 -06:00
Travis Ralston
afd5018494 Spec the terms of service handling for identity servers 
Part of MSC2140

Convert status codes to strings if there is a string status code. Fixes a build error when we mix 4xx and 403 in the same definition. We also have to correct stringified numbers to pass the build.
 2019-09-03 14:04:05 -06:00
Travis Ralston
4d0ea64121 Define authentication, ripping off the client-server API description 2019-08-28 15:46:58 -06:00
Travis Ralston
ca4d9d8636 Deprecate the v1 IS API 2019-08-28 14:19:13 -06:00
Travis Ralston
a47c5aeb42 v2-ify the v2 api 
Note that ping and pubkey doesn't require auth - see MSC2140 for more information.
 2019-08-28 14:17:51 -06:00
Travis Ralston
5b53b3d0b8 Clone v1 APIs verbatim 2019-08-28 14:01:36 -06:00
Travis Ralston
b8a3f970ee Add security definition for access token 2019-08-28 13:40:48 -06:00
Travis Ralston
cac72ff873
Merge pull request #2126 from matrix-org/travis/403-id-unbind 
Add 403 error to IS unbind
 2019-06-13 06:25:28 -06:00
Travis Ralston
67ea3b9ce8 Add 403 error to IS unbind 
Fixes https://github.com/matrix-org/matrix-doc/issues/2117
 2019-06-12 15:41:10 -06:00
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
Andrew Morgan
d1fde0837a Consolidate id_server into ref. id_server/next_link are ignored 2019-06-10 09:06:13 +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
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
010757c01d
Merge pull request #2057 from matrix-org/anoa/clarify_email_sending 
Clarify what the client should receiving on email resending
 2019-06-03 11:05:28 -06:00
Andrew Morgan
0b42a17352
Update api/identity/definitions/request_email_validation.yaml 
Co-Authored-By: Travis Ralston <travpc@gmail.com>
 2019-06-03 09:48:38 +01:00
Andrew Morgan
c0c4629993
Slight word change 2019-05-30 12:31:26 +01:00
Andrew Morgan
6ae7e49522
Clarify what the client should receiving on email resending 
It was a little unclear what the client should do when asked to send a validation email and provides a `send_attempt` value that is not greater than previous attempts. As this is intended to be for when a client mistakenly sends the request twice, it makes logical sense that the implication was to simply resend a success value so the client doesn't error even when an email may have been sent on the first attempt.

This behaviour was also mimicked in Synapse/Sydent.
 2019-05-30 12:30:43 +01:00
Travis Ralston
15b8011f63 Add missing aesthetic parameters to /store-invite 
Fixes https://github.com/matrix-org/matrix-doc/issues/2048
 2019-05-29 13:37:58 -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
aqtusia
24e0ec4bce
Replace /bind with /3pid/bind 2019-04-14 18:17:44 +02:00
Travis Ralston
00578547c0
Merge pull request #1644 from matrix-org/rav/is_token_grammar 
Spec grammars for IS things
 2018-08-31 16:05:23 -06:00
Richard van der Hoff
79974b152c s/identity service/identity server 2018-08-31 22:44:36 +01:00
Travis Ralston
2af09655ce Fix the stragglers 2018-08-31 15:44:23 -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
Richard van der Hoff
cb1e687196 spec the format of an IS invite token 2018-08-31 21:16:32 +01:00
Richard van der Hoff
69c30ef156 spec the format of a client_secret 2018-08-31 21:11:11 +01:00
Richard van der Hoff
dced3d5707 Notes on the format of IS session IDs and tokens 2018-08-31 21:06:51 +01: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
4bd23a9086 send_attempt is no longer optional 2018-08-30 22:28:50 -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
d57b977a55 Merge branch 'm-master' into travis/general/3pid_invite 2018-08-30 15:01:31 -06:00
Travis Ralston
f030d19f3c Clean up identity service swagger 
* Add `consumes` (swagger)
* Remove `http` as a supported scheme (the spec specifically says clients MUST use https)
* Clarify various descriptions
  * Full stops
  * Additional wording
  * s/older versions/previous drafts - we haven't had a release yet
* Indentation on examples
 2018-08-29 21:02:13 -06:00
Travis Ralston
684d80c422 Revert changes to 3pid lookup types in the IS spec 
The validator doesn't know what a "3PID Medium" is, for example, so it throws exceptions. This does reduce clarity in the spec though.
 2018-08-29 17:52:02 -06:00
Travis Ralston
dafea96621 Fix indentation and schema references in the identity service spec 2018-08-24 15:53:27 -06:00
Travis Ralston
4abd618147 Flag response fields in the Identity Service spec as required 2018-08-24 15:53:00 -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
3de50cbc7f Clarify how /isvalid is meant to always be truthful 2018-08-17 09:49:09 -06:00
Travis Ralston
88b35d1be5 Clarify how third party invites work 
This adds several diagrams to the Client-Server API about how invites
are handled, including what the server is expected to do. This helps
implementors know what they are supposed to do in the common cases,
and infer where needed to get the more complex cases correct.

Although lacking in some areas, this is how third party invites work
today.

A link to the now-improved client-server documentation for third party
invites has been added to the server-server specification. The existing
server-server specification needed no further changes on the subject.

Fixes https://github.com/matrix-org/matrix-doc/issues/1366
 2018-08-13 16:29:50 -06:00
Hubert Chathi
cd4fed509c
convert IS endpoints to Swagger (#1427) 2018-08-10 16:21:06 -04:00
Maxime Dor
c8393306d1 Add IS ping endpoint 2018-02-27 17:54:42 +01:00
Kitsune Ral
828086a86c Supply operationId for freshly added IS and AS operations 2017-11-15 07:53:36 +09:00
Kitsune Ral
b53083732b Merge remote-tracking branch 'remotes/origin/master' 2017-11-15 07:32:44 +09:00
David Baker
5147a3b975 Fix broken links & grammar 2017-11-14 17:14:56 +00:00
David Baker
45af878e11 Merge remote-tracking branch 'origin/master' into dbkr/is_bulk_lookup 2017-11-14 17:11:39 +00:00
Maxime Dor
836e6c81d1 Fix spelling 2017-11-14 15:15:49 +00:00