afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
...
Update the room tagging documentation
6 years ago
c127eed7e7
Merge pull request #1600 from turt2live/travis/c2s/media-csp
...
Specify the minimum CSP for media
6 years ago
9646d99c9e
Merge pull request #1602 from turt2live/travis/general/redactions
...
Add the other fields the server is expected to keep on events
6 years ago
080845ac1c
Add link to previous section
6 years ago
bbca5ce43a
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/limit_auth_events
6 years ago
b6ed25e4b4
Fix incorrect indent
6 years ago
f3a13eed76
Merge pull request #1593 from matrix-org/erikj/auth_events
...
Update rules on which events to add to `auth_events`
6 years ago
86891ca7e4
Merge pull request #1625 from matrix-org/erikj/auth_rejections
...
Explain how to handle rejected events
6 years ago
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
d57b40d0cc
Clarify how the client should treat errors
...
This is based on observation and rough interpretation and may need additional review from people.
Fixes https://github.com/matrix-org/matrix-doc/issues/1188
6 years ago
e6adf9f6b9
Document known client-server error codes
...
Covers part of https://github.com/matrix-org/matrix-doc/issues/603 (updating all the endpoints is being done as a separate PR/commit).
Reference: 74854a9719/synapse/api/errors.py (L30-L61)
6 years ago
caaa688e37
Fix links to client-server spec
6 years ago
219b27b182
Merge remote matrix-org/master
6 years ago
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)d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
6 years ago
0f84c69805
Merge branch 'master' into rav/clarify_event_signing
6 years ago
98a445890c
Render a warning if the spec is unstable
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1499
This is done by using magic variables in the RST. The magic variables are generated based on the substitutions available, making them available for use at build-time.
Magic variables were chosen because it allows people to continue working on the spec and release process without having to worry about removing a chunk of text from the top of the file. Originally, this was attempted by using jinja2 if-statements, however the substitutions are replaced *after* the template is executed, so the condition would never match.
The format of the variable is to make the templating happy. Using colons or percent signs results in the templator thinking something else is going on, and then complaining about format.
6 years ago
d57b977a55
Merge branch 'm-master' into travis/general/3pid_invite
6 years ago
1f6499d563
Fix typo
6 years ago
356626845c
Remove unhelpful arrow from the 3rd party invite sequence dance
...
This doesn't add anything in terms of clarity.
6 years ago
5e6a2c30a2
Comment out the part where identity services can revoke their keys
...
They can't because otherwise 3rd party invites can be rejected by homeservers, as per https://github.com/matrix-org/matrix-doc/issues/1633
6 years ago
cee0a5ac7b
Merge pull request #1557 from turt2live/travis/general/r0-prep
...
Prepare the identity service and server-server APIs for r0
6 years ago
32cde24bcf
Fix server-server link in IS spec
6 years ago
e82c22b060
Merge pull request #1615 from turt2live/travis/is/touchups
...
Touch up more of the identity service specification
6 years ago
b8f2c721dc
Clarify which attributes should be valid
6 years ago
2d18b0d2d8
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-html-again
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
440841d1ff
Recommend a CSP rather than require it.
6 years ago
70f72b5b3b
Merge pull request #1628 from turt2live/travis/as/external_url
...
Clarify how external_url is supposed to work
6 years ago
cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
...
Version all appservice endpoints and provide a fallback
6 years ago
326ff6b1a1
Merge branch 'master' into travis/as/external_url
6 years ago
0f2e01f5b5
Merge pull request #1555 from turt2live/travis/as/cleanup
...
Application service spec cleanup; Security definitions; r0 prep
6 years ago
1a3f112337
Clarify that the external_url is unsafe
6 years ago
be5c566028
Version all appservice endpoints and provide a fallback
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
6 years ago
a48f7b9278
Clarify how external_url is supposed to work
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1624
6 years ago
05b017276c
Don't accidentally limit application services to one homeserver
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
56f6640c07
Merge pull request #1618 from turt2live/travis/c2s/initalsync
...
Remove references to initialSync from account data and receipts module
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
bd93481013
Reference that transaction IDs may be used to echo
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1462
6 years ago
78487a01ec
Remove references to initialSync from account data and receipts module
...
Fixes https://github.com/matrix-org/matrix-doc/issues/695
Note: This commit leaves the /join endpoints alone because they say "and /sync" rather than just initialSync
6 years ago
e227095fb4
Add rich replies
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1234
The notable parts of this are:
* The titles go to insane levels. Rich replies are fairly complex and need some splitting apart to be understandable.
* The allowed HTML tags now have an exception for `<mx-reply>`
Please note that the event example is intended to be fixed by a PR that fixes all event examples.
6 years ago
a5c3924492
Merge remote matrix-org/master
6 years ago
4230e375fa
Merge pull request #1465 from Zil0/key_sharing
...
Document key sharing events
6 years ago
dc602b74d2
Reference the server-server specification for /onbind
6 years ago
0387da51e2
Clarify how sessions work when establishing associations
6 years ago
039cefdbea
Say that identity services should be nice to web browsers (CORS/OPTIONS)
6 years ago
bbba7dedd6
Clean up identity service RST
...
* Title casing
* s/identity server/identity service
* Rough column limit enforcement
* Add some links (used by future commits)
6 years ago
0130620cc1
Merge pull request #1596 from uhoreg/e2e_sessions
...
specify how to handle multiple olm sessions with the same device
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
a46783eb24
Revert "Take out the reference to the current version from the changelog"
...
This reverts commit 2a20c11467
6 years ago
2a20c11467
Take out the reference to the current version from the changelog
6 years ago
2ab2f91088
Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0
6 years ago
196159be91
We should include the Host header if the port was explicit.
6 years ago
abb91508be
Merge pull request #1556 from turt2live/travis/is/cleanup
...
Identity Service API cleanup
6 years ago
c03f2f8d79
Minor touchups to the room tagging API
...
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
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
2234e0b097
Mention that clients should not be producing invalid HTML
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1595
6 years ago
8e88d82a4b
fix typo in anchor. fixes #1603
6 years ago
348b549f9f
Add the other fields the server is expected to keep on events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/839
Reference: d69decd5c7/synapse/events/utils.py (L44-L91)
6 years ago
ec20c43220
Specify the minimum CSP for media
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1066
6 years ago
73feee5d73
Merge pull request #1586 from turt2live/travis/as/comment-ts-section
...
Comment out the timestamp massaging section for now
6 years ago
25b34e1d7b
Mention that ts massaging was in a draft, but not in the release
6 years ago
39ef845a53
Merge pull request #1547 from turt2live/travis/c2s/pills
...
Document how mentions (pills) work
6 years ago
5019fb7c49
Merge pull request #1359 from uhoreg/well-known
...
.well-known discovery
6 years ago
688c8ebcd3
specify how to handle multiple olm sessions with the same device
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
120bb8dc8e
s/host/hostname/
6 years ago
8679a642b4
clarity
6 years ago
7f9524f801
s/--/—/
6 years ago
6f3b42a457
Server names cannot be %-encoded
...
They aren't URLs; it was a thinko to refer to the URL spec for this.
6 years ago
85b9769cd9
Comment out the timestamp massaging section for now
...
Pending discussion on https://github.com/matrix-org/matrix-doc/issues/1585
6 years ago
fc1fdc95af
Specify a limit on the number of EDUs and PDUs a transaction can contain
6 years ago
28ced3b0a4
fixup! document encrypted attachments
6 years ago
72c6fa2aaf
More versioned links
6 years ago
cff5b8b205
More versioned links
6 years ago
e4f8c23972
Merge pull request #1562 from turt2live/travis/c2s/html-formatting
...
Define the supported HTML subset for message events
6 years ago
39e674ccb3
Clarify what matrix.to is and mention that room IDs are not routable
...
Also actually render the warning saying that this scheme is temporary.
6 years ago
fa3e9a7609
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/pills
6 years ago
6f80db5ddf
Include the "other versions" section of the changelog
6 years ago
07153c22a9
Misc. cleanup of the appservice spec
6 years ago
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.
6 years ago
17e0ef4b91
Remove empty file and now-empty section from the appservice spec
...
This commit has approval under https://github.com/matrix-org/matrix-doc/pull/1555 although is being included in this branch/PR so the build passes, permitting a merge.
6 years ago
51193cac39
Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events
6 years ago
4e885c3f77
Merge pull request #1550 from turt2live/travis/general/acls
...
Server ACLs
6 years ago
a0b17e6ed6
Merge pull request #1551 from turt2live/travis/c2s/push-rules
...
General improvements to the push rules module
6 years ago
090f852fdf
Merge pull request #1262 from matrix-org/anoa/document_as_options
...
Document new application service registration file options
6 years ago
54032964fc
Misc clarity for 3rd party appservice protocols/locations
6 years ago
bac0392a2d
General clarity for push rule defaults and where to get information
...
Include moving a roaming condition that was under the wrong rule.
6 years ago
d7397ccd56
Provide additional rationale for kicking users when they are ACLd
6 years ago
76afef79f8
Clarify the rationale and motive for blanket IP banning and port exclusion
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
89daa3c5ce
Clarify that clients aren't required to render all the tags
...
This commit also includes minor clarifications to surrounding text.
6 years ago
5bf99aeb34
Add a note that formatted_body is not forever
6 years ago
c7822cc9a8
Link to the content repo when referencing MXC URIs in images
6 years ago
d7d28f7e5b
Remove nl as a supported HTML tag
6 years ago
aa294fac06
Define the supported HTML subset for message events
...
Also clarify that `m.notice` messages can support HTML.
Fixes https://github.com/matrix-org/matrix-doc/issues/1559
Fixes https://github.com/matrix-org/matrix-doc/issues/1560
6 years ago
312799ae78
General clarification for mention and how matrix.to URIs are meant to work
6 years ago
b7577ea237
document encrypted attachments
...
Fix #461 .
6 years ago
f6b5aee3e2
explain how to use key sharing events
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
dafea96621
Fix indentation and schema references in the identity service spec
6 years ago
811998735c
Define common error codes in the Identity Service API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1407
6 years ago
017d6db737
Document third party network/protocol directories (for appservices)
...
Fixes https://github.com/matrix-org/matrix-doc/issues/869
6 years ago
9eda1a6971
Move the third party network API to it's own section
6 years ago
bbd33c1461
Move appservice transaction API to the right section
...
Part of https://github.com/matrix-org/matrix-doc/issues/1532
6 years ago
ab0be04571
Fix titles
6 years ago
7ec3cc4343
General improvements to the push rules module
...
This commit does a few things:
* Add 3 undocumented push rules to the spec for encrypted events and at-room notifications.
* Require unrecognized conditions to not match, ensuring that future conditions do not cause clients to accidentally notify users.
* Clarify that push rules should be enabled when created.
* Document a new condition required for at-room notifications.
Fixes https://github.com/matrix-org/matrix-doc/issues/1163
Fixes https://github.com/matrix-org/matrix-doc/issues/1034
Fixes https://github.com/matrix-org/matrix-doc/issues/676
Fixes https://github.com/matrix-org/matrix-doc/issues/1033
Relates to https://github.com/matrix-org/matrix-doc/issues/1101
6 years ago
ef41b5c2bf
Server ACLs
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
6 years ago
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.
6 years ago
2d8a321b46
document key sharing and m.room_key_request
6 years ago
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
6 years ago
6172d5986a
Merge pull request #1537 from turt2live/travis/as/user-alias-query
...
Clean up user and alias querying for application services
6 years ago
997562786b
Merge pull request #1534 from turt2live/travis/as/auth-impersonation
...
Encourage appservices to use the Authorization header
6 years ago
1102fc59b2
Spelling
6 years ago
389fa87e6e
English
6 years ago
1d7ea314d4
Merge pull request #1482 from turt2live/travis/s2s/presence
...
Document how presence EDUs work between servers
6 years ago
339a2748e8
Take out groups for now; Move namespace mention
...
Groups aren't landing in the spec yet, so we shouldn't include them yet.
6 years ago
24edec67c3
Merge remote-tracking branch 'matrix-org/master' into anoa/document_as_options
6 years ago
06157c6336
Merge branch 'master' into anoa/document_as_options
6 years ago
7e5160c7c2
Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query
6 years ago
13a1628f59
Improve wording about how masquerading works
6 years ago
7ad22b2454
Merge pull request #1533 from turt2live/travis/as/general
...
General/small improvements to the application service API specification
6 years ago
c8ba2e098c
Wording improvements for appservices
6 years ago
fca1c0b7f8
Guests should support /context and /event
6 years ago
9ec914956f
Merge pull request #1536 from turt2live/travis/as/user-namespace
...
Recommend that application services use an underscore for namespacing
6 years ago
d468ae0fa3
Merge pull request #1535 from turt2live/travis/as/no-sync
...
Add a note that application services cannot /sync normally
6 years ago
26746cf785
Merge pull request #1517 from turt2live/travis/c2s/auth-header
...
Dedicate a section on how to use access tokens
6 years ago
9430f2c7f9
room ID is included in Megolm plaintext, not Olm
6 years ago
8ba19b51ab
complete Olm documentation
6 years ago
b2316ba782
enforce unique namespacing in new algorithms experiments
6 years ago
eb8ea0e85a
remove warning pointing at outdated doc
6 years ago
4e0f107ef7
document changed field behavior in e2e sync extension
6 years ago
248786681e
fix typo
6 years ago
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
0863c5452e
Take out the false third party network endpoints
...
Fixes https://github.com/matrix-org/matrix-doc/issues/800
6 years ago
95b2b7c2bc
Move query APIs to the right heading
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1325
Addresses some of https://github.com/matrix-org/matrix-doc/issues/1532
6 years ago
069a2f7481
Split the query user and room APIs out to their own files
6 years ago
954498bf78
Recommend that application services use an underscore for namespacing
...
Fixes https://github.com/matrix-org/matrix-doc/issues/689
6 years ago
205b326e4a
Add a note that application services cannot /sync normally
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1144
6 years ago
857bcc0fe7
Encourage appservices to use the Authorization header
...
This also throws in a mention about how to handle a request with a lack of user_id.
The request samples now encourage the use of the header over the query string, and have had their sample values added for some readability.
Fixes https://github.com/matrix-org/matrix-doc/issues/1296
Fixes https://github.com/matrix-org/matrix-doc/issues/1424
6 years ago
7caad61b86
Clearly state how the users namespace relates to interest in events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1307
6 years ago
fd101b6ac9
Misc language changes
6 years ago
f5dc0eaed2
document msisdn-related endpoints in IS ( #1507 )
...
* add msisdn endpoints in Identity Server spec
* add in CS endpoints that use the IS msisdn endpoints
6 years ago
6612dbecf1
tweak wording for validation
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
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.
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
d6c54b0278
unaccessible isn't a word
6 years ago
ca87876f1b
Clarify that the Authorization header is preferred
6 years ago
25d01aa431
Dedicate a section on how to use access tokens
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1042 .
6 years ago
fde48e7ee8
Specify how room versioning works
...
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425
Room version upgrades are not part of MSC1425.
Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions
Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
6 years ago
de961fb7d6
Improve wording on push gateways
6 years ago
a264120b38
put server discovery as its own section
6 years ago
fcca80dad8
various minor fixes
...
- formatting fixes
- add examples to homeserver/identity server discovery schema
- replace DNS name with hostname
6 years ago
6a3cf10be9
Merge remote-tracking branch 'origin/master' into well-known
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
cd4fed509c
convert IS endpoints to Swagger ( #1427 )
6 years ago
292d334509
document new login identifier object ( #1390 )
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
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
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
eb45419431
Merge pull request #1490 from matrix-org/dbkr/room_tag_grammar
...
Fix grammar in room tag spec
6 years ago
e7cebf670e
Fix minor spelling mistake from #1472
...
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
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
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
b96ee3e393
Merge pull request #1423 from turt2live/travis/s2s/keys
...
Improve the server key exchange portion of the s2s specification
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
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
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
0ddf578b61
Combine all queries into their own section
...
This removes the Directory and Profile sections, instead opting to document them as Queries.
The behaviour of profile queries is based on Synapse's behaviour. A few issues have been opened to improve the behaviour:
* https://github.com/matrix-org/matrix-doc/issues/1434
* https://github.com/matrix-org/matrix-doc/issues/1435
* https://github.com/matrix-org/matrix-doc/issues/1436
* https://github.com/matrix-org/matrix-doc/issues/1437
This fixes https://github.com/matrix-org/matrix-doc/issues/1404
6 years ago
bdb881420c
Merge branch 'master' into hs/dns-to-be-hostname
6 years ago
004998b98f
Convert invites to swagger
...
The whole section reads like a description for the endpoint, and has been replaced by the swagger definition now (rather than at a later stage). All the same information should be kept.
6 years ago
f09c4fd286
Convert joins to swagger
6 years ago
24e531a896
Merge pull request #1406 from turt2live/travis/s2s/transactions-swagger
...
Convert things that mention "Transaction" to swagger
6 years ago
2790c1f069
Merge pull request #1289 from matrix-org/t3chguy/group_id
...
basic spec for group IDs, mostly copied from User IDs as they share grammar
6 years ago
cb4fcd1d09
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger
6 years ago
26505533dd
drop dns_name = host in favour of host
6 years ago
01d01cfbbb
Merge pull request #1440 from matrix-org/benp/clarifyintro
...
Improve discoverability of /docs/spec/intro/ document by including content in /docs/spec/
6 years ago
07aeaadef9
update links which used to point to docs/spec/intro
6 years ago
2aafde4549
Merge pull request #1419 from turt2live/travis/s2s/3pinvites-swagger
...
Convert third party invite exchange to swagger
6 years ago
e7c79f2bd4
avoid .rst link conflict warnings
6 years ago
54d6d58fff
naively move content from intro.rst to index.rst
6 years ago
e226b60c7f
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger
6 years ago
7cb918407d
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/keys-swagger
6 years ago
cf93c88337
Convert third party invite exchange to swagger
6 years ago
51faf8ed2e
Convert the general query API to swagger
...
Includes "moving" the directory query API into the same area. This will make more sense once the other query types are specified.
6 years ago
91c59e7384
Merge pull request #1353 from matrix-org/anoa/as_thirdparty_lookup
...
Thirdparty Entity Lookup API
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
374ec00046
Convert things that mention "Transaction" to swagger
...
There's two kinds of transactions currently: one with EDUs and one without. The one with EDUs is only used on /send, however the schema is still somewhat worth splitting out for simplicity.
The examples are brought apart to make them slightly more reusable for when they get dumped into the relevant sections of the spec (see TODO in server_server_api.rst)
Further, the Transactions stuff introduces tuples to the spec. The units.py has been updated to support this.
6 years ago
96889f16e9
Split out and fix the /server and /query key APIs
6 years ago
bd2c0b7c98
Convert server keys to swagger
6 years ago
423d5593f5
Generify how OPTIONS and CORS are handled
6 years ago
dd9414472b
Merge remote-tracking branch 'matrix-org/master' into travis/cors
6 years ago
8e22e9e85a
Fix title underline length
6 years ago
cc3724b54a
fix indentation, error messages. add rest of PR
6 years ago
92f3989f2b
Dirty replace of DNS name -> hostname
6 years ago
ce1e2c0904
incorporate feedback from reviewers
6 years ago
0779d81e52
Clarify which requests should have CORS headers
...
Spoilers: all of them.
6 years ago
2fc2926461
Clearly say that the server/server API is unstable and subject to change
6 years ago
4ca54404fa
Document the CORS/preflight headers
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1006
6 years ago
0dd330962d
initial draft of .well-known discovery
6 years ago
d73b247688
3PE lookup service
6 years ago
d647169806
Add more strength to the suggestion to find existing issues
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
fc402c296b
Don't suggest reusing old issues for spec proposals
...
In practice this was confusing for people, so instead we should encourage people to create new issues and reference the existing ones.
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
54c3003b74
newly joined -> newly-joined
7 years ago
5ab5fe08d1
Small grammatical and stylistic fixes
7 years ago
2e5cdaf51c
Fix typo
...
"To stream events all the events" -> "To stream all the events"
7 years ago
c3f66e1814
basic spec for group IDs, mostly copied from User IDs as they share grammar
7 years ago
72282577bf
Add back proposals.rst with a link to the actual location
7 years ago
18ba0d6d81
remove propsals.rst as it will be regenerated
7 years ago
a552c1853e
update for MSC 701
7 years ago
cefd1a832e
server_server_api: fix typo in auth section
...
fixes "destintation" typo
7 years ago
ffb8037af2
update MSC list
7 years ago
ee98082a60
update MSC1270
7 years ago
8610effad7
Merge branch 'master' into travis/reporting
7 years ago
7a44351a34
update following rvdh spec blitz
7 years ago
34090b24c4
prepare proposals.py for CI
7 years ago
d6fb5afd16
Clarified group_id group visibility, url possibilities, regex starters
...
Changed Application Service capatalization to be consistent with the
rest of the document.
7 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
9ca62edda0
Document new application service registration file options.
7 years ago
c3062b7db6
Include Proposals Page Title, update MSC1256
7 years ago
434e2949f9
include #1256
7 years ago
8d550d2166
force re-render
7 years ago
0b776b0e9c
link to proposals page from index
7 years ago
2a6895e759
Fix typo.
7 years ago
663e1a5ebe
Update some text
7 years ago
9873a2a0ac
link from the spec intro page
7 years ago
38adc7df06
latest generated proposals
7 years ago
8440179ecf
clarify shepherds and clarify 'greater benefit'
...
as per https://github.com/matrix-org/matrix-doc/pull/1240#discussion_r188459957
7 years ago
4d3c4225b2
include proposal template link
7 years ago
84524df783
spell out requirements for doc editing
7 years ago
73b28612ec
updates from feedback on pull
7 years ago
4c0743ef65
fix wording
7 years ago
10a8cb3f67
put handwavey timings on state transitions
7 years ago
4cdb4f105c
clarify architecture
7 years ago
8096bf0039
perms and apostrophes
7 years ago
3e10a5a24a
enter #matrix-spec:matrix.org
7 years ago
42fd3f34e4
shift stuff from contributing.rst to the new proposals page
7 years ago
3b736388ce
clarify governance
7 years ago
3cef79f31d
sublist formatting
7 years ago
e27f674fb9
incept dates
7 years ago
29348c6190
improve wording
7 years ago
714767c95a
explain proposal neutrality
7 years ago
755c9473fb
more tweaks
7 years ago
07bf61b33b
more tweaks
7 years ago
93681458d6
more tweaks
7 years ago
cb882ba12d
more tweaks
7 years ago
8c469e51cb
lots of tweaks to the MSC verbiage
7 years ago
b8f38b21a7
update introductory text
7 years ago
120fa92078
update intro
7 years ago
867307af8b
new flow
7 years ago
866b0b6348
I mostly play with ascii art
7 years ago
9e37d15c8f
little ascii diagram of process
7 years ago
e18aa30fd2
start generating new proposals page
7 years ago
2802fdea7e
Fix typo.
7 years ago
8d05f80cec
Sticker messages (m.sticker) ( #1158 )
7 years ago
cd26c170de
Specify token used in /login is not an Access Token ( #1155 )
...
* Specify token used in /login is not an Access Token
While working through the implementation of /login in Dendrite, it was
confusing what the contents of the token attribute in the login request
body referred to. Initially, I thought it was an access token, which led
to further confusion. This commit explicitly states that the token is a
login token, which is separate from an access token, hopefully reducing
confusion for future readers.
Signed-off-by: Andrew Morgan (https://amorgan.xyz ) <andrew@amorgan.xyz>
7 years ago
4f5ad35865
fixed minor typo
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
a0dda3cae2
Merge branch 'master' into travis/m.tag
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
c8393306d1
Add IS ping endpoint
7 years ago
3dfa643b8b
Fix membership state names
...
It's called 'join', not 'joined'.
7 years ago
4d90d2b495
fix depr link
7 years ago
7e94cd5a0b
Typo in client-server spec: ether -> either
7 years ago
73118b6b29
Merge pull request #1096 from t3chguy/user_directory
...
add user_directory
7 years ago
784adade9b
changes based on Pull Request feedback
7 years ago
15ca952cc3
remove spurious word
7 years ago
1fb7647021
send_join: clarify auth_chain description
...
The auth_chain field should contain all of the auth events required to auth the
state events, as well as those required to auth the join event itself.
(cf https://github.com/matrix-org/synapse/blob/e148438/synapse/handlers/federation.py#L1076-L1077 ).
7 years ago
3d8fe6e090
merge profiles with user directory into user data, also fix typo
7 years ago
605510e965
Merge branch 'master' into user_directory
7 years ago
a36f8ba00d
Forbid colons in MXIDs
...
There is a single (AS) user on matrix.org who has a colon in their localpart,
but I suspect that is an artifact of old bridge code and won't work over
federation anyway.
Colons in MXIDs are particularly harmful because they make it impossible to
split mxids into local- and remote-parts
7 years ago
97445195f6
add user_directory
7 years ago
08d137a588
We sign the request body, not the JSON
...
when signing federation requests, we put the actual request body into the
canonicaljson to be signed, not the JSON representation of it.
7 years ago
56f878842c
Add a warning that state resolution has problems
7 years ago
5ab9ee6b88
Link to auth rules
7 years ago
0960229a80
Document the state resolution algorithm
...
or at least, my understanding of it.
7 years ago
e8af5622a7
Use proper room event type for redaction
7 years ago
ec1a12d21b
Merge pull request #1080 from maxidor/max/ss/auth_rules
...
Fix auth rules to allow first PL event
7 years ago
96d93e11d7
Tweak wording of auth rules slightly
7 years ago
a0455eb5b1
Threat Model: Wrong word: Banning users is a threat only if you're not authorized
...
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
7 years ago
306b3f5d62
Threat Model: Align indentation of Spying Threats.
...
“Disclosure to Servers Within Chatroom” was indented lesser
than the surrounding threats.
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
7 years ago
c4f53f58d7
Fix auth rules to allow first PL event
7 years ago
52dba5d89a
Merge pull request #1076 from florianjacob/fix-cas-url
...
Correct CAS spec link
7 years ago
58a3fa3d60
Merge pull request #1075 from matrix-org/rav/pdu_fields
...
Improve documentation of Transactions and PDUs
7 years ago
ac861d9b97
Correct CAS spec link
...
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
7 years ago
6a653b742c
Document auth_events
7 years ago
632ba032af
Improve Transaction and PDU documentation
...
Fix a bunch of lies about the fields in these structures.
7 years ago
8a446fa6df
Modify event auth rules not to rely on depth
...
Signed-off-by: Marcus Medom Ryding <mrok4a@gmail.com>
7 years ago
f88185ed89
Merge pull request #1073 from maxidor/max/ss/directory
...
Document directory query endpoint
7 years ago
e9c1b87a1d
Remove `git log` reference
...
We keep the changelog up to date anyway, so there's not much point in trying to
get people to use `git log`
7 years ago
0ce58fdb28
Prepare for next spec dev cycle
7 years ago
bb50ec2e88
Document directory query endpoint
7 years ago
9b0bdb799e
Merge pull request #1054 from vberger/patch-2
...
Specify namespaces for tags
7 years ago
1045bc721d
Document federation version endpoint
7 years ago
14df31458b
Attempt to clarify example a little
7 years ago
9c5972ffe3
More formatting / grammar
7 years ago
e12c0b54ff
Formatting & grammar
7 years ago
4526ff2ea6
Double backticks in rst :/
7 years ago
1e4cba6b55
Don't linkify email addresses in examples
7 years ago
3487f5d75a
Spell out what we mean by a 3pid
...
(and consequently rejig all the fixed-width formatting)
7 years ago
ff85ec055e
Move 3pid types down
7 years ago
8d557ec9dc
Actually this isn't necessary in this section
7 years ago
e80675c9e9
Link in markdown, not swagger
7 years ago
b789f61522
Make link more specific
7 years ago
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.
7 years ago
b1801ea6db
Spec /account/whoami
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
68e12feec7
Add explicit examples for JSON encoding
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
c2b1b7a10e
mention that we can send tokens via headers
7 years ago
6b23b7fc0b
Merge branch 'client_server/r0.2.0_updates'
7 years ago
b94c4a9f36
Sneaky update to 0.2.0 spec to link unstable
...
This doesn't count as a spec release, right??
7 years ago
6282a53ca9
Merge pull request #1032 from matrix-org/rav/mxid_grammar
...
Indentifier grammar updates
7 years ago
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
Travis Ralston