Commit graph

541 commits

Author SHA1 Message Date
Jimmy Cuadra c44d61b3a9 Clarify which documents are generated from scripts. 2016-05-04 02:30:44 -07:00
Jimmy Cuadra 22b542e3f9 Fix grammar in spec index. 2016-05-04 02:27:29 -07:00
Jimmy Cuadra 5b18db9096 Make list of APIs on the index a table. 2016-05-04 01:42:01 -07:00
Jimmy Cuadra 4b27d6a7a4 Reorganize spec index. 2016-05-04 01:42:01 -07:00
Richard van der Hoff cd4e7306ca Merge pull request #305 from matrix-org/rav/show_own_leave_event
Clarify `history_visibility` behaviour
2016-04-08 11:47:17 +01:00
David Baker 71cb646541 Change id in the push gateway poke to be event_id and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 2016-04-06 18:28:21 +01:00
Richard van der Hoff 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.
2016-04-06 17:55:01 +01:00
Daniel Wagner-Hall 313f09f5c0 Specify address validating and binding 2016-03-10 16:54:38 +00:00
Kegsay 506accee27 Merge pull request #288 from matrix-org/markjh/pushrule_stream
Add a snippet of documentation for a m.push_rules event.
2016-03-10 14:05:42 +00:00
Daniel Wagner-Hall fecff8afdc Specify association lookup 2016-03-10 13:59:34 +00:00
Daniel Wagner-Hall 30c9fee0b2 Specify ephemeral invitation signing 2016-03-10 13:57:45 +00:00
Daniel Wagner-Hall 097b69dc1e Loosely specify invitation storage 2016-03-09 17:27:44 +00:00
Daniel Wagner-Hall e0c55eeccf Add initial identity server spec
More to come
2016-03-09 15:49:23 +00:00
Daniel Wagner-Hall f4f186baee Add _cs suffix to client-server http APIs
I'm about to add identity service APIs, so differentiating is good.
2016-03-08 17:42:41 +00:00
Mark Haines c3c95d0c09 Fix grammar and add backticks for /sync 2016-03-08 10:17:27 +00:00
Mark Haines cc0dae3aeb Deduplicate a couple of places where "the" was written twice in a row 2016-03-07 11:31:49 +00:00
Mark Haines 5407cc8e05 Add a snippet of documentation for a m.push_rules event. 2016-03-04 14:41:30 +00:00
Erik Johnston 3d4d91a462 Reword to make sense 2016-03-01 16:15:59 +00:00
Erik Johnston 167a08a805 Allow idle timeout to be configurable 2016-03-01 16:13:41 +00:00
Erik Johnston bc68177471 Grammar 2016-03-01 16:07:25 +00:00
Erik Johnston f1a8306d08 Spec currently_active time and idle timeout behaviour 2016-02-23 11:25:47 +00:00
Richard van der Hoff 68a4306773 Split room previews into a separate module
Guest access and room peeking are orthogonal
2016-02-19 15:26:28 +00:00
Mark Haines 740f775932 Fix a couple of typos, remove .m.rule.member_event 2016-02-18 18:36:08 +00:00
Mark Haines 3db6980e0b Remove references to device specific push rules
Since they weren't implemented on the servers and weren't
used by the clients.
2016-02-18 16:05:47 +00:00
Mark Haines 5d85e3a505 Remove indents 2016-02-15 16:53:08 +00:00
Mark Haines afe7638e30 Add a new title level to appease gendoc 2016-02-15 16:50:15 +00:00
Mark Haines b16af5ef64 Fix JSON, add headers 2016-02-15 16:41:47 +00:00
Mark Haines 8a1a02a11b Update the predefined push rules in the spec 2016-02-15 16:28:43 +00:00
Matthew Hodgson 6925547875 remove the oversimplification that the WebRTC standard is based around two-oparty communication 2016-02-11 18:34:28 +00:00
Richard van der Hoff b2e0a855cc Add 'event' to event context API
also link through to the event schemas
2016-02-01 17:45:45 +00:00
Daniel Wagner-Hall 0da26cd7e1 Specify login behaviour for unknown 3pids 2016-01-29 16:49:54 +00:00
Mark Haines 245e8e8571 Add 3pid password login to the spec 2016-01-29 14:42:18 +00:00
Daniel Wagner-Hall 2e46b587b8 Require explicit un-banning 2016-01-15 14:08:40 +00:00
David Baker 169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 2016-01-15 10:04:29 +00:00
David Baker 2301a792d7 Add an error code for invalid user names. 2016-01-14 17:19:04 +00:00
Daniel Wagner-Hall 9bc07ea093 Add ID to application services 2016-01-13 16:04:01 +00:00
Daniel Wagner-Hall 1e2b63763e /join and /room/:roomId/join aren't exact aliases
Separate them, clarify their differences.

Also, fix some links which weren't being properly populated.
2016-01-13 15:55:51 +00:00
Richard van der Hoff 91fa78eb53 Start development on next spec version 2016-01-11 15:52:08 +00:00
Richard van der Hoff cff1b4ae35 Merge pull request #251 from matrix-org/daniel/guestshiz
Clarify guest /events and /sync
2016-01-08 00:47:57 +00:00
Matthew Hodgson 411ab64712 fix misnamed key in example; thanks SkaveRat 2016-01-07 23:15:33 +00:00
Daniel Wagner-Hall 3edff684a1 Merge pull request #253 from matrix-org/daniel/guestupgrade
Guests can upgrade to regular accounts
2016-01-07 16:39:35 +00:00
Daniel Wagner-Hall f6b1b80678 Fix param name 2016-01-07 13:18:19 +00:00
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 2016-01-07 11:59:38 +00:00
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 2016-01-06 17:43:20 +00:00
Daniel Wagner-Hall 713415015b Remove mention that /sync takes an inline filter 2016-01-06 15:51:07 +00:00
Daniel Wagner-Hall d3f05ae49a Guests can upgrade to regular accounts 2016-01-05 17:30:55 +00:00
Daniel Wagner-Hall 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
2016-01-05 13:45:04 +00:00
Paul Evans c9ecfa7643 Merge pull request #242 from matrix-org/paul/federation
Don't need to document /pdu/ any more
2015-12-22 13:48:42 +00:00
Paul "LeoNerd" Evans 1f876778b5 Don't need to document /pdu/ any more 2015-12-21 16:50:56 +00:00
Paul Evans 0a2bdb1818 Merge pull request #240 from matrix-org/paul/federation
Document the `/event` and `/backfill` S-S APIs
2015-12-21 16:50:21 +00:00
Paul "LeoNerd" Evans 116253b2f5 Document the /event/:event_id/ federation endpoint 2015-12-17 20:45:57 +00:00
Richard van der Hoff e4dd346a81 Restore 'client behaviour' section
Because it's the standard
2015-12-17 14:07:35 +00:00
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec
Fixes https://matrix.org/jira/browse/SPEC-305
2015-12-17 13:40:22 +00:00
Daniel Wagner-Hall 34bab312d3 Merge pull request #231 from matrix-org/daniel/oldversions
Add links to old releases
2015-12-17 11:24:28 +01:00
Paul "LeoNerd" Evans b9bee6ee73 Initial hack at some federation /backfill documentation 2015-12-14 20:00:49 +00:00
Matthew Hodgson f8f76794a3 fix random whitespace bug 2015-12-14 08:40:41 +00:00
Daniel Wagner-Hall 678dbbe08a s/-/_/ 2015-12-09 17:17:45 +00:00
Daniel Wagner-Hall 7f87760655 Add links to old releases 2015-12-09 16:45:56 +00:00
Daniel Wagner-Hall 8d184570a8 Mention intro before specs 2015-12-09 16:40:47 +00:00
Daniel Wagner-Hall 997f3303f3 Revert "Add links to old releases"
This reverts commit de12870791.
2015-12-09 16:38:40 +00:00
Daniel Wagner-Hall de12870791 Add links to old releases 2015-12-09 16:32:36 +00:00
Daniel Wagner-Hall 53a21fc0b6 Note why we're not versioning index and intro 2015-12-09 16:29:11 +00:00
Daniel Wagner-Hall 8eb84612f2 Add index page 2015-12-09 16:17:58 +00:00
Daniel Wagner-Hall a484f04b33 Merge pull request #221 from matrix-org/daniel/pushaway
Merge pull request #221 from matrix-org/daniel/pushaway
2015-12-09 14:04:02 +00:00
Kegan Dougal bca3add9a7 Formatting 2015-12-08 16:38:48 +00:00
Kegan Dougal d01ff6b495 Add noddy push gateway placeholder 2015-12-08 16:37:51 +00:00
Daniel Wagner-Hall f22adad02e Merge pull request #225 from matrix-org/daniel/links
Add link to speculator
2015-12-08 16:19:17 +00:00
Erik Johnston c96848d1bc Merge pull request #169 from matrix-org/erikj/search_yet_agian
Search: Document event context, groups and orders.
2015-12-08 16:11:03 +00:00
Daniel Wagner-Hall 4be078440d Don't mention server-server stuff in client-server spec 2015-12-08 15:42:37 +00:00
Erik Johnston c4085b0475 Merge pull request #139 from matrix-org/erikj/event_context_api
Add event context api swagger
2015-12-08 15:24:57 +00:00
Daniel Wagner-Hall fd3dde5e88 Add link to speculator 2015-12-08 14:42:10 +00:00
Paul "LeoNerd" Evans e32070f189 Decide that joining HS is the one that specifies the join event ID 2015-12-08 14:04:40 +00:00
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 2015-12-08 13:25:31 +00:00
Daniel Wagner-Hall 217e22fc30 Format changelog more nicely 2015-12-08 13:18:36 +00:00
Daniel Wagner-Hall 19dfafe376 Remove superfluous space
This causes a <dt> to get rendered around the <tt>s which breaks some
formatting.
2015-12-08 10:34:48 +00:00
Erik Johnston dd276d4c4d Add event context module 2015-12-07 16:56:03 +00:00
Erik Johnston 856dd9100e Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian 2015-12-07 16:28:14 +00:00
Erik Johnston 2aef684e7e Add list of required supported groupings 2015-12-07 16:02:22 +00:00
Erik Johnston c61ae86102 Specify behaviour if server does not support pagination 2015-12-07 16:00:15 +00:00
Richard van der Hoff 3939ccf20c Remove e2e drafts from master
This is now being tracked in the main spec, on the drafts/e2e branch.
2015-12-07 14:45:46 +00:00
Daniel Wagner-Hall 39f43abbb7 Add per-API changelogs 2015-12-07 14:24:10 +00:00
Daniel Wagner-Hall 705556634a Add filters 2015-12-04 19:46:45 +00:00
Daniel Wagner-Hall 72e12bc2f5 Merge pull request #205 from jimmycuadra/signing-details-typo
Fix typo in signing details
2015-12-04 11:17:49 +00:00
Jimmy Cuadra 444fc5dbcd Fix typo in signing details. 2015-12-04 03:15:23 -08:00
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall 63ca91f353 Move event signing to server-server spec
It's *definitely* not a client concern.

It isn't really in the right place at the moment, but s-s is very much a
work in progress whereas c-s is nearly stable.
2015-12-04 10:55:18 +00:00
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 2015-12-03 16:26:45 +00:00
Daniel Wagner-Hall 19ce17cfed Merge pull request #200 from matrix-org/daniel/redact
Merge pull request #200 from matrix-org/daniel/redact
2015-12-03 15:57:52 +00:00
Daniel Wagner-Hall 4baba85fe5 Draftify e2e in anticipation of a spec release 2015-12-03 11:52:11 +00:00
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
Daniel Wagner-Hall e072d215cf Specify redaction 2015-12-02 15:27:25 +00:00
Matthew Hodgson b946d39886 typo 2015-12-02 01:25:07 +00:00
Daniel Wagner-Hall c05da871ca Merge pull request #194 from matrix-org/daniel/clarify
Merge pull request # 194 from matrix-org/daniel/clarify
2015-12-01 18:46:39 +00:00
Daniel Wagner-Hall aa4ed10821 Unify v1 and v2 event schemas 2015-12-01 17:23:58 +00:00
Daniel Wagner-Hall 97fd1fdd62 Embed client and server release numbers
Note that this also removes the changelog - I'm going to re-add the
changelog differently soon.
2015-12-01 17:08:02 +00:00
Daniel Wagner-Hall f6229f649a Remove confusing wording 2015-12-01 16:58:40 +00:00
Daniel Wagner-Hall fd88be1830 Merge pull request #189 from matrix-org/daniel/sections
Merge pull request # 189 from matrix-org/daniel/sections
2015-12-01 16:43:17 +00:00
Erik Johnston 23b2497743 Expand on where pagination tokens can be returned 2015-12-01 15:31:35 +00:00
Erik Johnston 46fd0b252c Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian 2015-12-01 15:06:13 +00:00
Daniel Wagner-Hall c6e0322a9e Swaggerify /account 2015-12-01 13:53:03 +00:00