d91dc6fbf6
Fixup
6 years ago
4d653748d6
Add note back in
6 years ago
8e6c8ba59e
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/spec_3pid_ruls
6 years ago
a1aedb386a
Actually use proper sentences like a proper adult
6 years ago
0adfd1ebb0
Merge pull request #1591 from matrix-org/erikj/fixup_auth_rules
...
Fix up auth rules
6 years ago
d63184ebac
Fixup
6 years ago
3c53e1910d
Fixup
6 years ago
1a45bc4a85
Reword
6 years ago
59f86ec8f2
Reindent as RST requires sublists to be three spaces
6 years ago
f4706c8889
Require creator field
6 years ago
f3aea32a24
Be consistent with 'If..., reject'
6 years ago
6c8a45c165
Full stops
6 years ago
ebb044674f
Remove duplicated explanation about event rejection
6 years ago
caaa688e37
Fix links to client-server spec
6 years ago
219b27b182
Merge remote matrix-org/master
6 years ago
0f84c69805
Merge branch 'master' into rav/clarify_event_signing
6 years ago
d57b977a55
Merge branch 'm-master' into travis/general/3pid_invite
6 years ago
f09db16027
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/key-mgmt
6 years ago
2753d24302
Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep
6 years ago
ab14f33060
Add link to the client-server ACLs module
6 years ago
5c2b8e3569
Explain how to handle rejeceted events
6 years ago
db644ca522
add some clarifications
6 years ago
55c4307f12
Rewrite the section on signing events
...
... for clarity and de-duplication. And to say a bit about validating the
signatures.
6 years ago
6ba50fe2f6
Merge pull request #1588 from matrix-org/rav/fix_server_name
...
Specify that server names cannot be %-encoded
6 years ago
9b94e588e6
document new state resolution algorithm
6 years ago
c7a228bf7b
Don't make the major version a variable
...
We are likely to want to maintain v1 when we release a v2, so we'll avoid a variable for now.
6 years ago
e7a69a6a6d
Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep
6 years ago
196159be91
We should include the Host header if the port was explicit.
6 years ago
f2d02c9559
Take out device management section for now
...
This will be handled by the implementation of https://github.com/matrix-org/matrix-doc/issues/1212
6 years ago
8950f0b2cc
Spelling
6 years ago
d921b81c70
Reject events with superfluous auth_events entries
6 years ago
073ebb051b
Spec third party invites in auth rules
6 years ago
5d40af7ecf
Update rules on which events to add to `auth_events`
6 years ago
86b5486445
Add missing clauses to and fix authorization rules
...
They are still missing third party invites.
6 years ago
0b7b3bfcb0
Reindent auth rules section
...
RST expects sub lists to be indented by three or more spaces. By doing
so we can then rely on `#.` for automatic numbering.
6 years ago
d493c82e82
even more clarification
6 years ago
7327656965
Merge pull request #1581 from matrix-org/erikj/limit_txn_size
...
Specify a limit on the number of EDUs and PDUs a transaction can contain
6 years ago
78d8118846
Further server_name clarification
6 years ago
f15eafae7f
Remove trailing spaces
6 years ago
08fba5de51
Link to grammar rather than duplicating.
6 years ago
fc1fdc95af
Specify a limit on the number of EDUs and PDUs a transaction can contain
6 years ago
cff5b8b205
More versioned links
6 years ago
be97e95dc1
Promote device management to be a dedicated section
6 years ago
8069981252
Add federation /user/* endpoints
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1438
6 years ago
d370a2c6fd
Prepare the identity service and server-server APIs for r0
...
* Create the changelog scaffolding
* Set up the variables for versioning
6 years ago
ef41b5c2bf
Server ACLs
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
6 years ago
ebca4c7d86
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
6 years ago
21dc6f823a
Merge pull request #1484 from turt2live/travis/s2s/read-receipts
...
Document how read receipts work over federation
6 years ago
44d1f8dbe5
s/timeline/event graph
6 years ago
a53fa9300d
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
6 years ago
ff1afaa8f7
Add a note about how presence lists work
6 years ago
e7aed3da26
Remove poll/unpoll from presence
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
2eab07ade4
Fix header in server-server API
6 years ago
2aa0e7b00f
Merge pull request #1483 from turt2live/travis/s2s/typing
...
Document how typing notifications work over federation
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
50fc1c4d16
Move backfill/get events so that joins, leaves, and invites are together
6 years ago
83ea90f7ba
Move the Authentication section higher in the spec
...
It forms the foundation for all the requests under it, so it should appear before the endpoints that need it.
6 years ago
32178bb07e
Tidy up the specification
...
* Minor word choice changes
* Remove the now-empty "Protocol URLs" section
6 years ago
56dbeeb22a
Merge pull request #1469 from turt2live/travis/s2s/backfill
...
Improve documentation for backfilling rooms
6 years ago
c8a8fdfa8d
Merge pull request #1493 from turt2live/travis/s2s/media
...
Mention how the content repository works over federation
6 years ago
0a7e670715
Document how typing notifications work over federation
...
Relevant synapse code: d69decd5c7/synapse/handlers/typing.py (L221-L230)
6 years ago
e03bfbc47b
Document how read receipts work over federation
...
Federation format: d69decd5c7/synapse/handlers/receipts.py (L153-L166)d69decd5c7/synapse/handlers/receipts.py (L48-L56)
6 years ago
05a2427c73
Document how presence EDUs work between servers
...
It's worth noting that Synapse does not make use of the `poll` or `unpoll` fields, and therefore the wording has been updated to permit servers to reject users. In the case of synapse, it would automatically reject everyone in the list by nature of ignoring it.
6 years ago
a77975ba68
Merge pull request #1450 from turt2live/travis/s2s/inviting-rooms
...
Improve documentation for how non-third party invites work
6 years ago
0f8954d839
Merge pull request #1463 from turt2live/travis/s2s/pdus-and-edus
...
Improve documentation around EDUs and PDUs
6 years ago
dcae88c290
Document OpenID in the server-server API
...
Part of https://github.com/matrix-org/matrix-doc/issues/857
Reference: d69decd5c7/synapse/federation/transport/server.py (L543-L557)
6 years ago
cdcd72c0e3
Fix stray hash on client-server API link
...
This shouldn't be here, and nothing appears to need it. Removing it now because it has been noticed.
6 years ago
0858e7bd23
Mention how the content repository works over federation
...
We might want to consider promoting the media repo to it's own API, and maybe consider calling it the Media Repo rather than Content Repo.
Source of information: experience.
6 years ago
521dcdd5d5
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/backfill
6 years ago
35f15ba3d8
Merge pull request #1477 from turt2live/travis/s2s/public-rooms
...
Document the /publicRooms endpoint for federation
6 years ago
d712bfc73d
Merge pull request #1479 from turt2live/travis/s2s/server-discovery
...
Federation: Document the Host header; Clarify how literal IP addresses are handled
6 years ago
e10770ae8b
Merge pull request #1475 from turt2live/travis/s2s/event-auth
...
Document /event_auth and /query_auth
6 years ago
e7cebf670e
Fix minor spelling mistake from #1472
...
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
6 years ago
dcb39f8890
Fix wording from bad merge
6 years ago
c826edf23b
Remove dns_name from S2S Api
6 years ago
7a46bdae02
Spacing
6 years ago
632101dcde
Merge branch 'master' into hs/dns-to-be-hostname
6 years ago
5fbaa1deb5
Federation: Document the Host header; Clarify how literal IP addresses are handled
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1161
The IP address clarification is to add an explicit mention of how to handle the case. The prior documentation assumed that all servers would be resolvable with DNS, and does technically have a fallback to use the fallback port, however making it clear feels like a good idea.
6 years ago
2ac80d38d7
Document the /publicRooms endpoint for federation
...
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476
The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.
The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
6 years ago
73958ecbff
Document /event_auth and /query_auth
...
/event_auth is a fairly easy endpoint to determine the use case of. /query_auth is a little harder to investigate and has a fairly interesting purpose: it appears to be used for the sending server to admit defeat and shop around for the right auth chain, correcting it's own perspective as it goes.
/query_auth is based off the following research points in synapse:
* 43ecfe0b10/synapse/handlers/federation.py (L1947-L1990)43ecfe0b10/synapse/handlers/federation.py (L2049-L2187)43ecfe0b10/synapse/handlers/federation.py (L1716-L1761)43ecfe0b10/synapse/federation/federation_server.py (L393-L446)https://github.com/matrix-org/synapse/blob/master/synapse/federation/transport/server.py#L482-L487
6 years ago
6b67d501e4
Merge branch 'master' into travis/s2s/query
6 years ago
3a9fb11c9b
Merge branch 'master' into travis/s2s/backfill
6 years ago
1578da453b
Merge branch 'master' into travis/s2s/get-event
6 years ago
86d7f42173
Merge pull request #1455 from turt2live/travis/s2s/leaving-rooms
...
Document how leaving rooms/rejecting invites over federation works
6 years ago
d48f1e1713
Merge pull request #1461 from turt2live/travis/s2s/transactions
...
Improve documentation on how Transactions work
6 years ago
cda88f3b3d
Document /get_missing_events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1385
6 years ago
05bb7e1050
Spelling and word choice
6 years ago
53d4003d3a
manual merge of master into travis/s2s/query
6 years ago
48972addbf
Merge pull request #1428 from turt2live/travis/s2s/joining-rooms
...
Improve the documentation for joining rooms
6 years ago
a9258ed195
an -> a
6 years ago
9d474bb819
Document event retrieval endpoints in more detail
...
This also adds a previously-undocumented endpoint: /state_ids
Backfill is technically not part of this section, however it is being left untouched to make the merge with #1469 easier (which moves it out of the file).
Reference material:
* Some calls to synapse on these endpoints with a relatively simple private room.
6 years ago
5aef545128
Improve documentation for backfilling rooms
...
There's not a whole lot to improve here - most of the changes are about reorganization and minor clarifications.
6 years ago
5027a9a59a
Improve documentation around EDUs and PDUs
...
Clarify fields, improve examples, and make the tables in the spec be generated rather than duplicated.
6 years ago
7679b4f1d1
Improve documentation on how Transactions work
...
The response is based upon various sections of the Synapse code in how it generates a response.
There are no new fields added to the transaction. Originally, `previous_ids` and `pdu_failures` were to be documented however neither of these are used in the real world.
6 years ago
8f1a4ae0ea
Formatting
6 years ago
9fdd8a6f96
Document how leaving rooms/rejecting invites over federation works
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1401
This is very similar to the joining rooms handshake, and much of it is a near copy/paste of the make_join and send_join API. The major difference is the send_leave API doesn't return anything.
References:
* Handling of make_leave: d69decd5c7/synapse/handlers/federation.py (L1285-L1310)d69decd5c7/synapse/federation/transport/client.py (L267)d69decd5c7/synapse/federation/transport/server.py (L396)d69decd5c7/synapse/handlers/federation.py (L1346)
6 years ago
f873bae0cc
Improve documentation for how non-third party invites work
...
The details are fairly straightforward. An `event` has been added to the response body because that's what Synapse returns, despite the spec saying otherwise until now: d69decd5c7/synapse/federation/federation_server.py (L339)
6 years ago
c2f1c6e78d
Improve the joining rooms handshake documentation
...
There isn't a whole lot to this section that needed work. The section overall lost the table schema in favour of having the endpoints close by.
The directory query is improved in https://github.com/matrix-org/matrix-doc/pull/1443
6 years ago
8e97b0ca81
Improve the server key exchange portion of the s2s specification
...
Most of the text has been shuffled into the swagger definitions to bring it closer to where it matters.
This also attempts to clarify what is out in the wild. Most importantly, the first version of the key exchange is outright removed from the specification. Other research points/questions are:
* What is a "Key ID"?
* 1241156c82/synapse/rest/key/v2/local_key_resource.py (L81-L83)1241156c82/synapse/rest/key/v2/local_key_resource.py (L88-L91)1241156c82/synapse/rest/key/v2/remote_key_resource.py (L227-L229)1241156c82/synapse/rest/key/v2/remote_key_resource.py (L192)
6 years ago
Erik Johnston