44fc033624
Fix broken links in the intro
7 years ago
c08e6616c7
Try to make the intro link more obvious
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1031 .
7 years ago
628e723483
Move the MXID spec to the appendices
...
Also link to them from the /register API doc.
7 years ago
0a85fbb4f5
Allow slashes in MXIDs
...
Because apparently we like slashes now.
7 years ago
5fee8e54eb
Document the event auth rules ( #1027 )
...
These are a necessary precursor to state resolution.
7 years ago
c4bcd0a713
Merge pull request #1007 from turt2live/travis/m.room.pinned_events
...
Add spec for m.room.pinned_events
7 years ago
5e7df0e87c
Update instant_messaging.rst
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
f1139b5b13
fix inter-spec link
7 years ago
5d473ced58
Merge pull request #1023 from matrix-org/rav/event_size
...
Specify max event size more precisely
7 years ago
a8afbfd27d
Avoid external link in search swagger
7 years ago
bf4936d6d7
Specify max event size more precisely
...
This is somewhat inelegant, and will please nobody, but I think it's more
important that we specify the current state of the onion than worry about what
would have been nice, and introduce incompatibilities while we do so.
7 years ago
bf3b49f13c
document joined_members and joined_rooms endpoints ( #999 )
7 years ago
cfb547b474
Fix perspectives project link
...
The perspectives project seems to be dead :/. We can at least link to the
wayback machine.
7 years ago
6b6a941e36
Phrasing
7 years ago
8de93147b1
Typo
7 years ago
c71575c94d
Remove useless blank line
7 years ago
4a99691108
Move link to the bottom of the file
7 years ago
9d90fa2cae
Specify third-party invites
7 years ago
af961321e9
Specify remote invite
7 years ago
997e76fcf7
Update JSON body for 3PID onbind requests
7 years ago
883767a905
Merge pull request #984 from matrix-org/rav/sync_timeout
...
Make clear that the /sync timeout is zero by default
7 years ago
1e3f5683c8
Make clear that the /sync timeout is zero by default
7 years ago
6570a5c6a3
Update link to WHATWG's Living Standard FAQ entry
7 years ago
750d980bc0
Room member ( #950 )
...
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
7 years ago
da6938b818
Key management APIs ( #894 )
...
Spec the e2e key-management APIs.
8 years ago
0a6886e73c
Fix broken link in spec
8 years ago
6296d676c8
Remove unused ID server file
8 years ago
da686ba4eb
Specification of unpadded Base64
8 years ago
a091d86707
Merge pull request #775 from superdump/superdump/fed-pdu-state-update-fix
...
server-server api: Fix swapped pdu state update field descriptions
8 years ago
db26877eee
server-server api: Fix swapped pdu state update field descriptions
...
Signed-off-by: Robert Swain <robert.swain@gmail.com>
8 years ago
5855bf4b16
server-server: PDUs are signed by the origin server's private key
...
Not the public key.
Signed-off-by: Robert Swain <robert.swain@gmail.com>
8 years ago
5537f7a832
Allow guest access to E2E endpoints
8 years ago
8a9629167a
httpsify the speculator link
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
aecac4f931
Merge pull request #723 from matrix-org/markjh/thumbnail_url
...
Move m.* thumbnail_url to be inside info to match m.video
8 years ago
7025793ca8
Say that thumbnails should be 'mxc://'
8 years ago
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.
8 years ago
a5e12814ef
Split appendices up
...
Split appendices into multiple files
8 years ago
e8915215a2
Merge pull request #405 from matrix-org/dbkr/push_examples_api_path
...
Fix API path in pushrules examples
8 years ago
22777970da
Fix speculator link
...
the link to the 'latest version' was broken
8 years ago
41f4661d1b
Fix API path in pushrules examples
8 years ago
af515012ea
Device management API
8 years ago
9265b03008
Client device doc
...
Document client devices, and the mods to the login and register apis to support
them.
8 years ago
cbc5774ade
JSON key names also use underscores.
8 years ago
8523af1385
Document convention of using underscores in APIs
...
Everybody has agreed to it. Now we just have to remember to do it.
8 years ago
7ed7944ddc
Merge pull request #399 from matrix-org/dbkr/identity_api_right_path
...
Use the right path for the identity API
8 years ago
49ee00c361
Use the right path for the identity API
8 years ago
6c88d698ae
uia fallback example: check event origin
8 years ago
e850fd718d
window.postmessage for Interactive Auth fallback
...
Require that User-Interactive auth fallback pages call
`window.postMessage` to notify apps of completion.
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
a8d35b2409
UI Auth: servers should 401 when a request fails
...
(ref https://matrix.org/jira/browse/SYN-744 )
8 years ago
c16ba9488f
Spec notifs API
8 years ago
37fb1ceb65
Merge pull request #395 from matrix-org/rav/kill_refresh_tokens
...
Remove references to refresh tokens and tokenrefresh
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
f4c7fdfd03
Remove references to refresh tokens and tokenrefresh
...
refresh tokens are dead.
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
cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
77b668a5dc
Fix some obsolete uses of user_id key in events
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
2fa7aac3be
Merge pull request #377 from Ralith/typos
...
Fix typo
8 years ago
80bfbbdd33
Fix typo
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
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
c51c4acf7f
Clarifications to authentication mechanisms
...
* Make the purpose of the `auth` key in /register requests explicit, and say
that it should be empty at first.
* Restructure the UA-auth section a bit.
* In the UA-auth section, say that clients should submit no `auth` to start
with, and add 'Stage 0' representing this to the example.
* s/{stage,login} type/authentication type/ in the UA-auth section. Seems
clearer to me.
* Try to distinguish the example responses from the example requests by giving
an HTTP header.
8 years ago
9cb626982a
s/user/username/ typo
8 years ago
0248afe6ac
login with invalid token gives a 403
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
ec20f15407
/tokenrefresh should expire the access token
...
It's possible for clients to call /tokenrefresh before the access_token has
expired, potentially leading to a proliferation of valid access_tokens.
8 years ago
2370a4c970
Spell out the state algorithm for createRoom
...
Fixes https://matrix.org/jira/browse/SPEC-429 .
Synapse currently follows the specified ordering, but does *not* give the
specified error when the state is invalid (instead it creates the room anyway
but gives a 403 M_FORBIDDEN). Still, I don't think that should be a real
problem for any real clients, and nothing would break if we changed this in
synapse, so it might as well go in the spec anyway.
8 years ago
c0490f2db2
cosmetics
8 years ago
a64f9bbb63
C-S spec: Fix 'unstable' in link to /context API
8 years ago
b5f9e896ba
C-S spec: Fix 'unstable' in link to /context API
8 years ago
a2ab6854ff
CS spec: Add r0.2.0 to historical version list
8 years ago
ae489260a1
Merge pull request #359 from matrix-org/rav/mxid_grammar
...
Define MXID grammar
8 years ago
72449294bc
Moar TODO
8 years ago
a2f1c6a7a6
Add a TODO about defining non-latin login creds
8 years ago
cdd19dca7f
fix typos
8 years ago
f942b6e5c1
remove some redundant words
8 years ago
001db45046
s/mxid/user id/, and other PR feedback.
8 years ago
e628edfdc6
Define MXID grammar
...
Quick! Write down the decisions on the grammar before we get a chance to change
our minds!
Also some placeholder sections for other types of identifier.
8 years ago
8ac45d7948
Merge pull request #353 from matrix-org/rav/room_membership
...
Clarify the room-membership APIs
8 years ago
0c06ea0e67
Merge pull request #356 from matrix-org/rav/fix_redaction
...
Fix name of prev_content to preserve on redactions
8 years ago
a9d3cfd13c
Merge branch 'master' into rav/link_undeprecated_endpoints
8 years ago
d92515bce3
Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
...
Move /room/x/initialSync to after the undeprecated APIs
8 years ago
d8a47dbb5d
Merge pull request #352 from matrix-org/rav/kill_old_sync
...
Remove references to intialSync etc, and rewrite syncing
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
1c6eed5c35
Fix name of prev_content to preserve on redactions
...
The field is called prev_content, not prev_state.
8 years ago
6bcb1798f5
Mark deprecated endpoints with their replacements
...
Fixes https://matrix.org/jira/browse/SPEC-415
8 years ago
9d267795e0
Move /room/x/initialSync to after the undeprecated APIs
...
It's a bit incongruous to have to read through the deprecated /initialSync to
get to the good stuff. Separate out intialSync so that we can move it later in
the spec.
8 years ago
885e6797f2
Fix double-negative in room naming
8 years ago
4118ce6680
Add rationale to /sync
8 years ago
7186ecba7f
Clarify the room-membership APIs
...
* give join/invite their own subsection
* move ban/unban into the banning section
* document forgettting and kicking
8 years ago
017935d8e9
Fix typo
8 years ago
6dfc923c1d
Remove references to intialSync etc, and rewrite syncing
...
The 'Events' section of the C-S spec was full of outdated references to the v1
sync api, which is long dead. (https://matrix.org/jira/browse/SPEC-414 ).
Also, try to clarify why /sync distinguishes state and timeline
(https://matrix.org/jira/browse/SPEC-423 ).
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.
8 years ago
4812be9142
Missing .
8 years ago
ead5648b8c
Add requestToken endpoints
...
For password reset and 3pid adding
8 years ago
ef4c03894d
Merge pull request #343 from matrix-org/dbkr/threepid_requesttoken
...
Spec for endpoint-specific 3pid verification token
8 years ago
df3f4b4ecf
Fix link to draft e2e spec
9 years ago
e4db7be8e2
Better structure for error response
...
& add server not trusted error
9 years ago
572aa24a88
Add M_THREEPID_IN_USE
9 years ago
b0194a3016
Spec for endpoint-specific 3pid verification token
...
As per proposal https://docs.google.com/document/d/13mapDbaOnbob9ZYRDiGm1YbeZhFOBj_R1OvgBA9pA5s/edit?pref=2&pli=1#
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
ec69f04793
Merge pull request #337 from matrix-org/rav/directory_docs
...
Improve documentation of directory API
9 years ago
7bbb664784
Improve documentation of directory API
9 years ago
92bb1c1b43
Update wording as per request from richvdh
9 years ago
a7e40bed88
Add powerlevel name to value list
9 years ago
099d356dfb
Add r0.1.0 to version list in C-S spec
9 years ago
e7e9f5fa46
Document the /logout api
...
We have one, and it's useful, so we really ought to document it
9 years ago
3bce28a15c
Clarifications to the 'Client authentication' section
...
* Use the terminology 'login type' everywhere instead of mixing up 'stage type'
and 'login type'
* Don't have a separate 'APIs using the User-Interactive Authentication
mechanism' section, because (a) it doesn't make much sense to organise the
APIs this way, and (b) it was a set of lies anyway.
* Move '/account/password' definition into registration.yaml so that register
and password can share a section in the spec; remove duplicate doc for
/password.
* Write some words on using 3pids for /login
9 years ago
5cc9066159
Add git versions to other parts of the spec
9 years ago
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.
9 years ago
351bbee016
Remove changelog from index.rst
...
... since it's explicitly unversioned.
9 years ago
7d20d2d903
Add old-version links to C-S API
9 years ago
5b010de2b3
Fix typo
9 years ago
e68193d2e0
Attempt to clarify the spec versioning. Again.
9 years ago
17b8fccd4c
rephrase intro
9 years ago
c44d61b3a9
Clarify which documents are generated from scripts.
9 years ago
22b542e3f9
Fix grammar in spec index.
9 years ago
5b18db9096
Make list of APIs on the index a table.
9 years ago
4b27d6a7a4
Reorganize spec index.
9 years ago
cd4e7306ca
Merge pull request #305 from matrix-org/rav/show_own_leave_event
...
Clarify `history_visibility` behaviour
9 years ago
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.
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
313f09f5c0
Specify address validating and binding
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
Richard van der Hoff