Commit Graph

71 Commits

Author SHA1 Message Date
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 f923d08078 Add read markers
This is the spec for https://github.com/matrix-org/matrix-doc/issues/910

Fixes https://github.com/matrix-org/matrix-doc/issues/910

Some reverse engineering was required to work out the complete details as to how this works. In particular, the 405 for setting account data and the behaviour of m.read.

References:
* 405 for account data: d69decd5c7/synapse/rest/client/v2_alpha/account_data.py (L85-L90)
* m.read behaviour: d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
2018-08-30 16:21:31 -06:00
Travis Ralston a5c3924492 Merge remote matrix-org/master 2018-08-29 21:28:24 -06:00
Travis Ralston 2ab2f91088 Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0 2018-08-29 17:54:34 -06:00
Travis Ralston fa3e9a7609 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/pills 2018-08-27 18:09:19 -06:00
Travis Ralston fa96d8629b Prepare the appservice spec for an r0 release
This puts the scaffolding in place for an r0 release to happen, such as the changelog and version variables.
2018-08-27 18:04:08 -06:00
Travis Ralston ef41b5c2bf Server ACLs
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
2018-08-22 12:48:37 -06:00
Travis Ralston 9835c98544 Document how mentions (pills) work
Implements the proposal over at https://github.com/matrix-org/matrix-doc/issues/1067

Includes some specification for how matrix.to is structured, and how it is intended to be replaced.
2018-08-21 22:05:47 -06:00
Travis Ralston ba51d5960e r0.1.0 release of the Push Gateway specification
Because this is the first release, it has several moving parts to it:
* The version variables have been defined.
* The towncrier changelog has been prepared for future modifications.
* The templating has been updated to better support future versions of the specification.
* A release process document has been created.
2018-08-16 11:50:18 -06:00
Travis Ralston 8ffac01efe Document OpenID in the client-server API
Part of https://github.com/matrix-org/matrix-doc/issues/857

Reference: d69decd5c7/synapse/rest/client/v2_alpha/openid.py (L31-L58)
2018-08-07 22:10:11 -06:00
Ben Parsons 54d6d58fff naively move content from intro.rst to index.rst 2018-07-20 14:15:47 +01:00
Andrew Morgan 291a4dfc76 Third party lookup module. Fix wording 2018-07-12 16:59:30 +01:00
Andrew Morgan 114bcf1a2e Use $ref, clean up, fix errors, AS is now a C-S module. 2018-07-12 14:31:34 +01:00
Andrew Morgan cc3724b54a fix indentation, error messages. add rest of PR 2018-07-05 11:55:25 +01:00
Andrew Morgan d73b247688 3PE lookup service 2018-07-03 14:40:28 +01:00
Travis Ralston 9037f506ac Document how to report content
Fixes: https://github.com/matrix-org/matrix-doc/issues/739

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-05-27 12:19:30 -06:00
Ben Parsons e18aa30fd2 start generating new proposals page 2018-05-02 13:47:01 +01:00
Richard Lewis 8d05f80cec Sticker messages (m.sticker) () 2018-03-27 10:00:41 +01:00
Travis Ralston 331e49bd0d Improve the documentation of ignored users
* Fix the event schema to represent the real world
* Add the module to the spec targets
* Remove incomplete thought from the client behaviour
* Link to the account data API
* Minor word choice changes

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 09:00:32 -07:00
David Baker ff85ec055e Move 3pid types down 2017-11-14 15:07:22 +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
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
Richard van der Hoff da686ba4eb Specification of unpadded Base64 2017-03-01 08:50:07 +00:00
Richard van der Hoff 461bfdb0d8 Merge branch 'master' into rav/device_management 2016-11-09 14:34:04 +00:00
Richard van der Hoff 3ee75af06f Move 'Signing JSON' to appendices
Canonical JSON and JSON signing in general are common to the C-S spec. Move
them to the appendices instead of the S-S spec.
2016-10-31 12:36:47 +00:00
Richard van der Hoff a5e12814ef Split appendices up
Split appendices into multiple files
2016-10-31 12:01:37 +00:00
Richard van der Hoff af515012ea Device management API 2016-10-12 17:26:01 +01:00
Richard van der Hoff 909aef2b18 Merge pull request from matrix-org/erikj/create_room_is_direct
Spec /createRoom is_direct flag, is_direct in member event and m.direct
2016-10-06 17:19:48 +01:00
David Baker 203ea99328 Spec m.direct 2016-10-03 18:17:43 +01:00
Richard van der Hoff ebaaa7e3b3 Review feedback
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
2016-09-29 13:18:45 +01:00
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 2016-09-27 14:27:27 +01:00
Richard van der Hoff 41368dc5a7 document CAS login
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
2016-08-08 17:33:48 +01:00
Mark Haines 30a3302921 Merge pull request from matrix-org/markjh/default_rules
Update the predefined push rules in the spec
2016-06-22 16:14:21 +01:00
Richard van der Hoff 01f8173c84 Put each bit of spec in its own directory
I want to change the URLs for the spec sections on the website from
<version>/<section>.html to <section>/<version>.html, to better reflect how we
do the versioning.

This puts each bit of spec in its own directory, updates the index to point to
the right place, and fixes continuserv to deal with directories as well as
files.

This will probably require fixes to the speculator too, but I'll have to come
back to that.
2016-05-05 18:26:17 +01:00
David Baker 71cb646541 Change `id` in the push gateway poke to be `event_id` and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 2016-04-06 18:28:21 +01:00
Daniel Wagner-Hall e0c55eeccf Add initial identity server spec
More to come
2016-03-09 15:49:23 +00:00
Richard van der Hoff 68a4306773 Split room previews into a separate module
Guest access and room peeking are orthogonal
2016-02-19 15:26:28 +00:00
Mark Haines afe7638e30 Add a new title level to appease gendoc 2016-02-15 16:50:15 +00:00
Daniel Wagner-Hall 8eb84612f2 Add index page 2015-12-09 16:17:58 +00:00
Erik Johnston dd276d4c4d Add event context module 2015-12-07 16:56:03 +00:00
Daniel Wagner-Hall 63ca91f353 Move event signing to server-server spec
It's *definitely* not a client concern.

It isn't really in the right place at the moment, but s-s is very much a
work in progress whereas c-s is nearly stable.
2015-12-04 10:55:18 +00:00
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 2015-12-03 16:26:45 +00:00
Daniel Wagner-Hall c9c433bc15 Make section depths consistent 2015-11-30 14:31:24 +00:00
Daniel Wagner-Hall e401d3e262 Merge pull request from matrix-org/daniel/splitspec
Split spec into page-per-section
2015-11-27 16:46:06 +00:00
Daniel Wagner-Hall e171acf01f Split spec into page-per-section 2015-11-27 16:45:47 +00:00
Mark Haines 05c0092664 s/config/account_data/ 2015-11-19 10:38:22 +00:00
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
2015-11-16 16:51:45 +00:00
Mark Haines c3769ef75c Add a module for client config to the specification 2015-11-16 16:49:32 +00:00
Daniel Wagner-Hall e72151f2c3 Specify guest room access
This was reviewed as PR  and merged from daniel/anonymousaccess
2015-11-06 18:15:21 +00:00