e5005b2d0f
document E2E events
...
This was written by Richard van der Hoff.
6 years ago
68b78dc5d8
complete Megolm documentation
6 years ago
669605b24a
add Olm missing properties
6 years ago
76071bae98
explain how to verify sender_key ownership
6 years ago
8274f91b0b
document device verification
...
This was written by Richard van der Hoff.
6 years ago
a28f243ed7
document left parameter of device_lists in sync response
...
fix #1171
6 years ago
10c3307427
document device_one_time_keys_count in /sync/ response
...
fix #1157
6 years ago
2686b99080
fix json indent
6 years ago
07e3de3c61
add megolm messaging algorithm subsection
...
This was written by Richard van der Hoff.
6 years ago
33802dbbaf
add olm messaging algorithm subsection
...
This was written by Richard van der Hoff.
6 years ago
e210f8b050
add e2e messaging algorithms section intro
...
This was written by Richard van der Hoff.
6 years ago
4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid
...
Document OpenID in the client-server and server-server APIs
6 years ago
de961fb7d6
Improve wording on push gateways
6 years ago
6ad71f785e
Improve documentation for pushers and push gateways
...
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format
Note: this does not attempt to document push rules, just pushers.
Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
6 years ago
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
6 years ago
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)
6 years ago
803ef536ba
Fix grammar in room tag spec
...
Have removed the second clause about how the client interprets them:
I was trying to think how to rephrase it but I think in reality it's
probably just redundant.
6 years ago
2dc51d416d
Ignore stuff in `m.` you don't understand
6 years ago
f90ed4b77d
Make non-namespaced tags verboten
6 years ago
e4fd088fcc
Fix room tags spec
6 years ago
07aeaadef9
update links which used to point to docs/spec/intro
6 years ago
291a4dfc76
Third party lookup module. Fix wording
6 years ago
114bcf1a2e
Use $ref, clean up, fix errors, AS is now a C-S module.
6 years ago
9037f506ac
Document how to report content
...
Fixes: https://github.com/matrix-org/matrix-doc/issues/739
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
2a6895e759
Fix typo.
7 years ago
2802fdea7e
Fix typo.
7 years ago
8d05f80cec
Sticker messages (m.sticker) ( #1158 )
7 years ago
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>
7 years ago
d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list
7 years ago
e862ef60ae
Spec ignoring users
...
Adds https://github.com/matrix-org/matrix-doc/issues/528
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
a3f006353c
Tag ordering is defined as a number between 0 and 1, not strings
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
ac861d9b97
Correct CAS spec link
...
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
7 years ago
cc8128edad
Specify namespaces for tags
...
This is a proposition for closing #931 .
This should be a fairly uncontroversial addition (apart from bike-shedding), which only defines behavior for clients that want use tags or expose tagging functionality to their users.
The idea of adding this to the spec is to ensure clients can peacefully share the tag namespace without conflicting with each other, using rules similar to namespaces for state keys.
7 years ago
5e7df0e87c
Update instant_messaging.rst
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
da6938b818
Key management APIs ( #894 )
...
Spec the e2e key-management APIs.
8 years ago
5537f7a832
Allow guest access to E2E endpoints
8 years ago
4abdcc6f05
Merge pull request #402 from matrix-org/rav/device_management
...
Device management API
8 years ago
461bfdb0d8
Merge branch 'master' into rav/device_management
8 years ago
7025793ca8
Say that thumbnails should be 'mxc://'
8 years ago
41f4661d1b
Fix API path in pushrules examples
8 years ago
af515012ea
Device management API
8 years ago
42616f839c
Merge pull request #396 from matrix-org/dbkr/notifs_api
...
Spec notifs API
8 years ago
909aef2b18
Merge pull request #389 from matrix-org/erikj/create_room_is_direct
...
Spec /createRoom is_direct flag, is_direct in member event and m.direct
8 years ago
83b89aa1ce
dm: clarify client behaviour
8 years ago
ed2d364440
consistency
8 years ago
96b6fb0129
'In the m.room.member' event
8 years ago
301595c071
Linkify account_data API
...
Also change other links because it turns out the .. isn't part
of the syntax
8 years ago
2a987c3369
Linkify endpoints properly
8 years ago
2259a00ba2
links
8 years ago
3f66ba713c
Reference m.room.member section
8 years ago
e2024e5829
Add note on how to use the account data event
8 years ago
d791f35007
Remove unnecessary paragraph
8 years ago
4480553bf9
Move m.direct description to the swagger
...
Also change the swagger to yaml so I can put that description in it
without having to figure out how to embed that in json.
8 years ago
c16ba9488f
Spec notifs API
8 years ago
8e096bdc48
Link to createRoom, not initialsync
8 years ago
85bc989c02
pr feedback
8 years ago
976d41351e
spelling
8 years ago
d39f662df5
PR feedback
8 years ago
203ea99328
Spec m.direct
8 years ago
ebaaa7e3b3
Review feedback
...
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
8 years ago
ccd7bb32d5
Specification for direct-to-device messages
8 years ago
9a1db01d92
Clarify `highlight` and `sound` tweaks.
8 years ago
fd888fcbda
Merge pull request #373 from matrix-org/dbkr/contains_display_name_override
...
Make the display name rule an override rule
8 years ago
b65b0d049e
Make the display name rule an override rule
8 years ago
6592646ee9
Add dot prefix to .rule.master
...
It's a default rule, so it needs a dot
8 years ago
1f1dfdd91c
More clarifications
8 years ago
ec81b4c9fe
More PR feedback
...
Add a couple of TODO sections
8 years ago
4b0e546eeb
PR feedback
...
Fix some typos, and clarify several aspects of server behaviour.
8 years ago
41368dc5a7
document CAS login
...
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
8 years ago
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
885e6797f2
Fix double-negative in room naming
8 years ago
7b4c21fa77
Add link to room name bug
8 years ago
d4194dd24e
Clarify the room-naming behaviour
...
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
9 years ago
df3f4b4ecf
Fix link to draft e2e spec
9 years ago
af091ff614
Document changes to the default push rules
9 years ago
30a3302921
Merge pull request #274 from matrix-org/markjh/default_rules
...
Update the predefined push rules in the spec
9 years ago
e80e32173f
Merge pull request #278 from matrix-org/erikj/presence
...
Update presence spec.
9 years ago
b59d16c4d1
Clarify `history_visibility` behaviour
...
Clear up some lies in the history_visibility section, and clarify behaviour for
`m.room.history_visibility` and the user's own `m.room.member` events.
9 years ago
506accee27
Merge pull request #288 from matrix-org/markjh/pushrule_stream
...
Add a snippet of documentation for a m.push_rules event.
9 years ago
f4f186baee
Add _cs suffix to client-server http APIs
...
I'm about to add identity service APIs, so differentiating is good.
9 years ago
c3c95d0c09
Fix grammar and add backticks for /sync
9 years ago
5407cc8e05
Add a snippet of documentation for a m.push_rules event.
9 years ago
3d4d91a462
Reword to make sense
9 years ago
167a08a805
Allow idle timeout to be configurable
9 years ago
bc68177471
Grammar
9 years ago
f1a8306d08
Spec currently_active time and idle timeout behaviour
9 years ago
68a4306773
Split room previews into a separate module
...
Guest access and room peeking are orthogonal
9 years ago
740f775932
Fix a couple of typos, remove .m.rule.member_event
9 years ago
3db6980e0b
Remove references to device specific push rules
...
Since they weren't implemented on the servers and weren't
used by the clients.
9 years ago
5d85e3a505
Remove indents
9 years ago
b16af5ef64
Fix JSON, add headers
9 years ago
8a1a02a11b
Update the predefined push rules in the spec
9 years ago
6925547875
remove the oversimplification that the WebRTC standard is based around two-oparty communication
9 years ago
b2e0a855cc
Add 'event' to event context API
...
also link through to the event schemas
9 years ago
cff1b4ae35
Merge pull request #251 from matrix-org/daniel/guestshiz
...
Clarify guest /events and /sync
9 years ago
3edff684a1
Merge pull request #253 from matrix-org/daniel/guestupgrade
...
Guests can upgrade to regular accounts
9 years ago
7d9547274c
Clarify guest /events and /sync
9 years ago
713415015b
Remove mention that /sync takes an inline filter
9 years ago
d3f05ae49a
Guests can upgrade to regular accounts
9 years ago
ca67aa7b4f
Tidy up guest access spec
...
* Mention that /leave is allowed
* Mention that /sync is allowed
* Re-order such that the whole list of APIs fits on one screen
9 years ago
e4dd346a81
Restore 'client behaviour' section
...
Because it's the standard
9 years ago
b7c255a887
Tweaks/clarifications to search spec
...
Fixes https://matrix.org/jira/browse/SPEC-305
9 years ago
f8f76794a3
fix random whitespace bug
9 years ago
a484f04b33
Merge pull request #221 from matrix-org/daniel/pushaway
...
Merge pull request #221 from matrix-org/daniel/pushaway
9 years ago
c96848d1bc
Merge pull request #169 from matrix-org/erikj/search_yet_agian
...
Search: Document event context, groups and orders.
9 years ago
a2283f5499
Remove /notify from client-server API
9 years ago
dd276d4c4d
Add event context module
9 years ago
856dd9100e
Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian
9 years ago
2aef684e7e
Add list of required supported groupings
9 years ago
c61ae86102
Specify behaviour if server does not support pagination
9 years ago
3939ccf20c
Remove e2e drafts from master
...
This is now being tracked in the main spec, on the drafts/e2e branch.
9 years ago
873b0dcecf
Replace version numbers with release numbers
9 years ago
f308b7543c
Specify /admin/whois/{userId}
9 years ago
4baba85fe5
Draftify e2e in anticipation of a spec release
9 years ago
2f3a00fe34
Consistently spell homeserver as homeserver
9 years ago
b946d39886
typo
9 years ago
f6229f649a
Remove confusing wording
9 years ago
23b2497743
Expand on where pagination tokens can be returned
9 years ago
46fd0b252c
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian
9 years ago
6c66bfc755
Flatten out v1 and v2_alpha directories
...
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
9 years ago
e401d3e262
Merge pull request #184 from matrix-org/daniel/splitspec
...
Split spec into page-per-section
9 years ago
e171acf01f
Split spec into page-per-section
9 years ago
a20a49abf6
Merge pull request #168 from matrix-org/markjh/client_config
...
Add API for setting client config
9 years ago
c5f457cee9
Merge pull request #132 from matrix-org/markjh/room_tags
...
Document a v2 api for setting tags on rooms
9 years ago
0b1ba70a32
fix rst markup
...
`` > `
9 years ago
2dbb8ba56c
Fix title levels
...
make the title decoration consistent with the rest of the spec
9 years ago
51ca25a472
Merge branch 'master' into markjh/end_to_end_encryption
9 years ago
5f4458b2ff
Merge branch 'master' into markjh/end_to_end_encryption
9 years ago
5e30b5b8d7
Remove POST version of /send
...
PUT should always be used.
9 years ago
032ee75537
Update specification wording to match s/config/account_data/
9 years ago
05c0092664
s/config/account_data/
9 years ago
40f7eab73f
s/private_user_data/account_data/
9 years ago
24c4b8b095
Merge branch 'markjh/room_tags' into markjh/client_config
...
Conflicts:
api/client-server/v1/rooms.yaml
api/client-server/v1/sync.yaml
api/client-server/v2_alpha/sync.yaml
specification/targets.yaml
9 years ago
fcbb985073
s/private_user_data/account_data/
9 years ago
373c6c8270
Add ordering, pagination and grouping comments
9 years ago
c77b22778f
Add some documentation on names of tags
9 years ago
25769493b1
Fix template
9 years ago
e7fbe6f13b
Limit the size of a tag
9 years ago
48f35e15cb
describe how to order rooms that don't have an order in their tags
9 years ago
299af673da
Specify how ordering of tags is supposed to work
9 years ago
3b390bff3c
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
8f5783615c
Merge branch 'master' into markjh/client_config
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
c3769ef75c
Add a module for client config to the specification
9 years ago
ea364a108b
Merge pull request #161 from matrix-org/daniel/guestdisplaynames
...
Merge pull request #161 from matrix-org/daniel/guestdisplaynames
Guests are allowed to set displaynames
9 years ago
29d9c8eec6
Guests are allowed to set displaynames
9 years ago
061105c9dc
Guest users are allowed room initialSync
9 years ago
24c2036a35
3pid invites: remove mentions of display_name
9 years ago
e72151f2c3
Specify guest room access
...
This was reviewed as PR #150 and merged from daniel/anonymousaccess
9 years ago
161441fa3a
Update 3pid spec based on new implementation
9 years ago
8cba11b1cd
Add some links to spec bugs for display names
...
Just added a couple of TODO comments to useful jira bugs
9 years ago
Valentin Deniaud