Commit Graph

38 Commits

Author SHA1 Message Date
Travis Ralston 00578547c0
Merge pull request 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 ()
* 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 () 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
David Baker e80675c9e9 Link in markdown, not swagger 2017-11-14 15:03:51 +00:00
David Baker 493b936209 Make these links more specific too 2017-11-14 15:01:58 +00:00
Maxime Dor cdfff67878 Create spec for IS bulk lookup 2017-11-14 14:55:16 +00:00
David Baker 6edb90a08e Document threepids
Adds the /msisdn' 3pid type and generally fleshes out what a 3pid
is and how they work.

This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039
with some tweaks and additions.
2017-11-14 14:36:38 +00: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
David Baker 49ee00c361 Use the right path for the identity API 2016-10-07 18:17:45 +01:00
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).
2016-07-12 17:28:30 +01:00
David Baker 1d6c405f62 Fix presumably c+p fail 2016-04-06 21:00:12 +01:00
Daniel Wagner-Hall fecff8afdc Specify association lookup 2016-03-10 13:59:34 +00:00
Daniel Wagner-Hall e0c55eeccf Add initial identity server spec
More to come
2016-03-09 15:49:23 +00:00