Commit Graph

885 Commits (dafea96621d6383f6b44d9368024bb95c8ab94a7)

Author SHA1 Message Date
Richard van der Hoff cdd19dca7f fix typos 8 years ago
Richard van der Hoff f942b6e5c1 remove some redundant words 8 years ago
Richard van der Hoff 001db45046 s/mxid/user id/, and other PR feedback. 8 years ago
Richard van der Hoff 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
Richard van der Hoff 8ac45d7948 Merge pull request #353 from matrix-org/rav/room_membership
Clarify the room-membership APIs
8 years ago
Richard van der Hoff 0c06ea0e67 Merge pull request #356 from matrix-org/rav/fix_redaction
Fix name of prev_content to preserve on redactions
8 years ago
Richard van der Hoff a9d3cfd13c Merge branch 'master' into rav/link_undeprecated_endpoints 8 years ago
Richard van der Hoff d92515bce3 Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
Move /room/x/initialSync to after the undeprecated APIs
8 years ago
Richard van der Hoff d8a47dbb5d Merge pull request #352 from matrix-org/rav/kill_old_sync
Remove references to intialSync etc, and rewrite syncing
8 years ago
Richard van der Hoff 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
Richard van der Hoff 1c6eed5c35 Fix name of prev_content to preserve on redactions
The field is called prev_content, not prev_state.
8 years ago
Richard van der Hoff 6bcb1798f5 Mark deprecated endpoints with their replacements
Fixes https://matrix.org/jira/browse/SPEC-415
8 years ago
Richard van der Hoff 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
Richard van der Hoff 885e6797f2 Fix double-negative in room naming 8 years ago
Richard van der Hoff 4118ce6680 Add rationale to /sync 8 years ago
Richard van der Hoff 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
Richard van der Hoff 017935d8e9 Fix typo 8 years ago
Richard van der Hoff 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
Richard van der Hoff 7b4c21fa77 Add link to room name bug 8 years ago
Richard van der Hoff d4194dd24e Clarify the room-naming behaviour
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
8 years ago
David Baker 4812be9142 Missing . 8 years ago
David Baker ead5648b8c Add requestToken endpoints
For password reset and 3pid adding
8 years ago
David Baker ef4c03894d Merge pull request #343 from matrix-org/dbkr/threepid_requesttoken
Spec for endpoint-specific 3pid verification token
8 years ago
Richard van der Hoff df3f4b4ecf Fix link to draft e2e spec 8 years ago
David Baker e4db7be8e2 Better structure for error response
& add server not trusted error
8 years ago
David Baker 572aa24a88 Add M_THREEPID_IN_USE 8 years ago
David Baker b0194a3016 Spec for endpoint-specific 3pid verification token
As per proposal https://docs.google.com/document/d/13mapDbaOnbob9ZYRDiGm1YbeZhFOBj_R1OvgBA9pA5s/edit?pref=2&pli=1#
8 years ago
Mark Haines af091ff614 Document changes to the default push rules 8 years ago
Mark Haines 30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules
Update the predefined push rules in the spec
8 years ago
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence
Update presence spec.
8 years ago
David Baker ec69f04793 Merge pull request #337 from matrix-org/rav/directory_docs
Improve documentation of directory API
8 years ago
Richard van der Hoff 7bbb664784 Improve documentation of directory API 8 years ago
David 92bb1c1b43 Update wording as per request from richvdh 8 years ago
David a7e40bed88 Add powerlevel name to value list 8 years ago
Richard van der Hoff 099d356dfb Add r0.1.0 to version list in C-S spec 8 years ago
Richard van der Hoff e7e9f5fa46 Document the /logout api
We have one, and it's useful, so we really ought to document it
8 years ago
Richard van der Hoff 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
8 years ago
Richard van der Hoff 5cc9066159 Add git versions to other parts of the spec 8 years ago
Richard van der Hoff 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.
8 years ago
Richard van der Hoff 351bbee016 Remove changelog from index.rst
... since it's explicitly unversioned.
8 years ago
Richard van der Hoff 7d20d2d903 Add old-version links to C-S API 8 years ago
Richard van der Hoff 5b010de2b3 Fix typo 8 years ago
Richard van der Hoff e68193d2e0 Attempt to clarify the spec versioning. Again. 8 years ago
Matthew Hodgson 17b8fccd4c rephrase intro 8 years ago
Jimmy Cuadra c44d61b3a9 Clarify which documents are generated from scripts. 8 years ago
Jimmy Cuadra 22b542e3f9 Fix grammar in spec index. 8 years ago
Jimmy Cuadra 5b18db9096 Make list of APIs on the index a table. 8 years ago
Jimmy Cuadra 4b27d6a7a4 Reorganize spec index. 8 years ago
Richard van der Hoff cd4e7306ca Merge pull request #305 from matrix-org/rav/show_own_leave_event
Clarify `history_visibility` behaviour
8 years ago
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. 8 years ago
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.
8 years ago
Daniel Wagner-Hall 313f09f5c0 Specify address validating and binding 8 years ago
Kegsay 506accee27 Merge pull request #288 from matrix-org/markjh/pushrule_stream
Add a snippet of documentation for a m.push_rules event.
8 years ago
Daniel Wagner-Hall fecff8afdc Specify association lookup 8 years ago
Daniel Wagner-Hall 30c9fee0b2 Specify ephemeral invitation signing 8 years ago
Daniel Wagner-Hall 097b69dc1e Loosely specify invitation storage 8 years ago
Daniel Wagner-Hall e0c55eeccf Add initial identity server spec
More to come
8 years ago
Daniel Wagner-Hall f4f186baee Add _cs suffix to client-server http APIs
I'm about to add identity service APIs, so differentiating is good.
8 years ago
Mark Haines c3c95d0c09 Fix grammar and add backticks for /sync 8 years ago
Mark Haines cc0dae3aeb Deduplicate a couple of places where "the" was written twice in a row 8 years ago
Mark Haines 5407cc8e05 Add a snippet of documentation for a m.push_rules event. 8 years ago
Erik Johnston 3d4d91a462 Reword to make sense 8 years ago
Erik Johnston 167a08a805 Allow idle timeout to be configurable 8 years ago
Erik Johnston bc68177471 Grammar 8 years ago
Erik Johnston f1a8306d08 Spec currently_active time and idle timeout behaviour 8 years ago
Richard van der Hoff 68a4306773 Split room previews into a separate module
Guest access and room peeking are orthogonal
8 years ago
Mark Haines 740f775932 Fix a couple of typos, remove .m.rule.member_event 8 years ago
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.
8 years ago
Mark Haines 5d85e3a505 Remove indents 9 years ago
Mark Haines afe7638e30 Add a new title level to appease gendoc 9 years ago
Mark Haines b16af5ef64 Fix JSON, add headers 9 years ago
Mark Haines 8a1a02a11b Update the predefined push rules in the spec 9 years ago
Matthew Hodgson 6925547875 remove the oversimplification that the WebRTC standard is based around two-oparty communication 9 years ago
Richard van der Hoff b2e0a855cc Add 'event' to event context API
also link through to the event schemas
9 years ago
Daniel Wagner-Hall 0da26cd7e1 Specify login behaviour for unknown 3pids 9 years ago
Mark Haines 245e8e8571 Add 3pid password login to the spec 9 years ago
Daniel Wagner-Hall 2e46b587b8 Require explicit un-banning 9 years ago
David Baker 169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 9 years ago
David Baker 2301a792d7 Add an error code for invalid user names. 9 years ago
Daniel Wagner-Hall 9bc07ea093 Add ID to application services 9 years ago
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.
9 years ago
Richard van der Hoff 91fa78eb53 Start development on next spec version 9 years ago
Richard van der Hoff cff1b4ae35 Merge pull request #251 from matrix-org/daniel/guestshiz
Clarify guest /events and /sync
9 years ago
Matthew Hodgson 411ab64712 fix misnamed key in example; thanks SkaveRat 9 years ago
Daniel Wagner-Hall 3edff684a1 Merge pull request #253 from matrix-org/daniel/guestupgrade
Guests can upgrade to regular accounts
9 years ago
Daniel Wagner-Hall f6b1b80678 Fix param name 9 years ago
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 9 years ago
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 9 years ago
Daniel Wagner-Hall 713415015b Remove mention that /sync takes an inline filter 9 years ago
Daniel Wagner-Hall d3f05ae49a Guests can upgrade to regular accounts 9 years ago
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
9 years ago
Paul Evans c9ecfa7643 Merge pull request #242 from matrix-org/paul/federation
Don't need to document /pdu/ any more
9 years ago
Paul "LeoNerd" Evans 1f876778b5 Don't need to document /pdu/ any more 9 years ago
Paul Evans 0a2bdb1818 Merge pull request #240 from matrix-org/paul/federation
Document the `/event` and `/backfill` S-S APIs
9 years ago
Paul "LeoNerd" Evans 116253b2f5 Document the /event/:event_id/ federation endpoint 9 years ago
Richard van der Hoff e4dd346a81 Restore 'client behaviour' section
Because it's the standard
9 years ago
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec
Fixes https://matrix.org/jira/browse/SPEC-305
9 years ago
Daniel Wagner-Hall 34bab312d3 Merge pull request #231 from matrix-org/daniel/oldversions
Add links to old releases
9 years ago
Paul "LeoNerd" Evans b9bee6ee73 Initial hack at some federation /backfill documentation 9 years ago
Matthew Hodgson f8f76794a3 fix random whitespace bug 9 years ago
Daniel Wagner-Hall 678dbbe08a s/-/_/ 9 years ago
Daniel Wagner-Hall 7f87760655 Add links to old releases 9 years ago
Daniel Wagner-Hall 8d184570a8 Mention intro before specs 9 years ago
Daniel Wagner-Hall 997f3303f3 Revert "Add links to old releases"
This reverts commit de12870791.
9 years ago
Daniel Wagner-Hall de12870791 Add links to old releases 9 years ago
Daniel Wagner-Hall 53a21fc0b6 Note why we're not versioning index and intro 9 years ago
Daniel Wagner-Hall 8eb84612f2 Add index page 9 years ago
Daniel Wagner-Hall a484f04b33 Merge pull request #221 from matrix-org/daniel/pushaway
Merge pull request #221 from matrix-org/daniel/pushaway
9 years ago
Kegan Dougal bca3add9a7 Formatting 9 years ago
Kegan Dougal d01ff6b495 Add noddy push gateway placeholder 9 years ago
Daniel Wagner-Hall f22adad02e Merge pull request #225 from matrix-org/daniel/links
Add link to speculator
9 years ago
Erik Johnston c96848d1bc Merge pull request #169 from matrix-org/erikj/search_yet_agian
Search: Document event context, groups and orders.
9 years ago
Daniel Wagner-Hall 4be078440d Don't mention server-server stuff in client-server spec 9 years ago
Erik Johnston c4085b0475 Merge pull request #139 from matrix-org/erikj/event_context_api
Add event context api swagger
9 years ago
Daniel Wagner-Hall fd3dde5e88 Add link to speculator 9 years ago
Paul "LeoNerd" Evans e32070f189 Decide that joining HS is the one that specifies the join event ID 9 years ago
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 9 years ago
Daniel Wagner-Hall 217e22fc30 Format changelog more nicely 9 years ago
Daniel Wagner-Hall 19dfafe376 Remove superfluous space
This causes a <dt> to get rendered around the <tt>s which breaks some
formatting.
9 years ago
Erik Johnston dd276d4c4d Add event context module 9 years ago
Erik Johnston 856dd9100e Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian 9 years ago
Erik Johnston 2aef684e7e Add list of required supported groupings 9 years ago
Erik Johnston c61ae86102 Specify behaviour if server does not support pagination 9 years ago
Richard van der Hoff 3939ccf20c Remove e2e drafts from master
This is now being tracked in the main spec, on the drafts/e2e branch.
9 years ago
Daniel Wagner-Hall 39f43abbb7 Add per-API changelogs 9 years ago
Daniel Wagner-Hall 705556634a Add filters 9 years ago
Daniel Wagner-Hall 72e12bc2f5 Merge pull request #205 from jimmycuadra/signing-details-typo
Fix typo in signing details
9 years ago
Jimmy Cuadra 444fc5dbcd Fix typo in signing details. 9 years ago
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 9 years ago
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.
9 years ago
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 9 years ago
Daniel Wagner-Hall 19ce17cfed Merge pull request #200 from matrix-org/daniel/redact
Merge pull request #200 from matrix-org/daniel/redact
9 years ago
Daniel Wagner-Hall 4baba85fe5 Draftify e2e in anticipation of a spec release 9 years ago
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 9 years ago
Daniel Wagner-Hall e072d215cf Specify redaction 9 years ago
Matthew Hodgson b946d39886 typo 9 years ago
Daniel Wagner-Hall c05da871ca Merge pull request #194 from matrix-org/daniel/clarify
Merge pull request # 194 from matrix-org/daniel/clarify
9 years ago
Daniel Wagner-Hall aa4ed10821 Unify v1 and v2 event schemas 9 years ago
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.
9 years ago
Daniel Wagner-Hall f6229f649a Remove confusing wording 9 years ago
Daniel Wagner-Hall fd88be1830 Merge pull request #189 from matrix-org/daniel/sections
Merge pull request # 189 from matrix-org/daniel/sections
9 years ago
Erik Johnston 23b2497743 Expand on where pagination tokens can be returned 9 years ago
Erik Johnston 46fd0b252c Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian 9 years ago
Daniel Wagner-Hall c6e0322a9e Swaggerify /account 9 years ago
Daniel Wagner-Hall c9c433bc15 Make section depths consistent 9 years ago
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
9 years ago
Daniel Wagner-Hall b479b54cd8 Add tables of contents to individual specs 9 years ago
Daniel Wagner-Hall e401d3e262 Merge pull request #184 from matrix-org/daniel/splitspec
Split spec into page-per-section
9 years ago
Daniel Wagner-Hall e171acf01f Split spec into page-per-section 9 years ago
Daniel Wagner-Hall bc514dc9c4 Merge pull request #178 from matrix-org/daniel/directory
Fix and include /directory api docs
9 years ago
Daniel Wagner-Hall 7f2813354d Swaggerify /ban 9 years ago
Mark Haines a20a49abf6 Merge pull request #168 from matrix-org/markjh/client_config
Add API for setting client config
9 years ago
Mark Haines c5f457cee9 Merge pull request #132 from matrix-org/markjh/room_tags
Document a v2 api for setting tags on rooms
9 years ago
Richard van der Hoff d9130f0e13 Merge pull request #24 from matrix-org/markjh/end_to_end_encryption
Basic specification for key distribution for end-to-end cryptography.
9 years ago
Daniel Wagner-Hall ad4d8ae7a6 Move client-server intro to client-server section 9 years ago
Richard van der Hoff 0b1ba70a32 fix rst markup
`` > `
9 years ago
Richard van der Hoff 2dbb8ba56c Fix title levels
make the title decoration consistent with the rest of the spec
9 years ago
Richard van der Hoff 51ca25a472 Merge branch 'master' into markjh/end_to_end_encryption 9 years ago
Richard van der Hoff 5f4458b2ff Merge branch 'master' into markjh/end_to_end_encryption 9 years ago
Richard van der Hoff 8d41536757 Address kegan's comments
Minor fixes to the e2e spec as raiseds by kegan
9 years ago
Daniel Wagner-Hall 5e30b5b8d7 Remove POST version of /send
PUT should always be used.
9 years ago
Daniel Wagner-Hall c25a806cef Fix and include /directory api docs 9 years ago
Mark Haines e76068a2a6 Merge branch 'markjh/room_tags' into markjh/client_config 9 years ago
Mark Haines 5bae15d47b Merge branch 'master' into markjh/room_tags
Conflicts:
	api/client-server/v2_alpha/sync.yaml
9 years ago
Richard van der Hoff d8dd380dfa Merge pull request #164 from matrix-org/rav/SPEC-254
Fix /sync documentation, post SPEC-254
9 years ago
Mark Haines 032ee75537 Update specification wording to match s/config/account_data/ 9 years ago
Mark Haines 05c0092664 s/config/account_data/ 9 years ago
Paul Evans e95a1616af Merge pull request #143 from matrix-org/paul/federation-room-join
Document the federation remote join handshake
9 years ago
Mark Haines 40f7eab73f s/private_user_data/account_data/ 9 years ago
Mark Haines 24c4b8b095 Merge branch 'markjh/room_tags' into markjh/client_config
Conflicts:
	api/client-server/v1/rooms.yaml
	api/client-server/v1/sync.yaml
	api/client-server/v2_alpha/sync.yaml
	specification/targets.yaml
9 years ago
Mark Haines fcbb985073 s/private_user_data/account_data/ 9 years ago
Richard van der Hoff 6653362f31 Unflatten 'unsigned'
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
9 years ago
Daniel Wagner-Hall 8201eaa042 Swaggerify /rooms/:room_id/leave 9 years ago
Erik Johnston 373c6c8270 Add ordering, pagination and grouping comments 9 years ago
Mark Haines c77b22778f Add some documentation on names of tags 9 years ago
Mark Haines 25769493b1 Fix template 9 years ago
Mark Haines e7fbe6f13b Limit the size of a tag 9 years ago
Mark Haines 48f35e15cb describe how to order rooms that don't have an order in their tags 9 years ago
Mark Haines 299af673da Specify how ordering of tags is supposed to work 9 years ago
Richard van der Hoff 7ff593b3de Merge branch 'rav/SPEC-254' into rav/flatten_sync
Conflicts:
	specification/events.rst
9 years ago
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
9 years ago
Richard van der Hoff 0db055b4ea Fix another reference to 'txn_id' 9 years ago
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
9 years ago
Paul "LeoNerd" Evans 233e8486bc Wording fix - objects contain keys, not list elements directly 9 years ago
Mark Haines c3769ef75c Add a module for client config to the specification 9 years ago
Paul "LeoNerd" Evans 6cbfba7011 'auth_events' is a List, not a String 9 years ago
Paul "LeoNerd" Evans 122c082fcf Comment about origin servers of invites having subsequently left the room 9 years ago
Paul "LeoNerd" Evans 923f05e554 More consistency around 'resident homeserver' 9 years ago
Paul "LeoNerd" Evans 36af793f05 s/full object/full event/ 9 years ago
Richard van der Hoff 29bd4d45ee Flatten the response to /sync
Now that we don't expect there to be duplication betwen the 'timeline' and
'state' results, there's no point in having the state map. (That does mean the
events themselves need event_id fields though).

Also:

- move the contents of the 'unsigned' dictionary into the events themselves
- replace the state list with two layers of dictionary keyed on type and
  state_key
- rename the children of the 'rooms' dict from "joined/invited/archived" to
  "join/invite/leave" to match the membership states
9 years ago
Richard van der Hoff 57995a815a Fix a number of untruths in the documentation about /sync.
Attempts to make the /sync documentation better represent fact as it currently
stands - in particular document the structure of the returned events.
9 years ago
Paul "LeoNerd" Evans 988d773476 /make_join protoevent no longer needs the pointless 'prev_state' key (SYN-517) 9 years ago
Paul "LeoNerd" Evans 885dd1e86c Explain the 'prev_events' join protoevent key 9 years ago
Paul "LeoNerd" Evans db5a90edcd Avoid using the words 'current state' when talking about the result of the /make_join request 9 years ago
Paul "LeoNerd" Evans aac45295ee Remark that the directory server step could be skipped in an invite case 9 years ago
Paul "LeoNerd" Evans d7c69fae43 Fix typo 'process' 9 years ago
Daniel Wagner-Hall ea364a108b Merge pull request #161 from matrix-org/daniel/guestdisplaynames
Merge pull request #161 from matrix-org/daniel/guestdisplaynames

Guests are allowed to set displaynames
9 years ago
Daniel Wagner-Hall 29d9c8eec6 Guests are allowed to set displaynames 9 years ago
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 9 years ago
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 9 years ago
Daniel Wagner-Hall 24c2036a35 3pid invites: remove mentions of display_name 9 years ago
Daniel Wagner-Hall e72151f2c3 Specify guest room access
This was reviewed as PR #150 and merged from daniel/anonymousaccess
9 years ago
Daniel Wagner-Hall 161441fa3a Update 3pid spec based on new implementation 9 years ago
Richard van der Hoff 8cba11b1cd Add some links to spec bugs for display names
Just added a couple of TODO comments to useful jira bugs
9 years ago
Richard van der Hoff 2fd5fc39a0 Add spec for calculating display names for rooms and users
Merged from https://github.com/matrix-org/matrix-doc/pull/145
9 years ago
Mark Haines 3953006792 Fix spelling 9 years ago
Paul "LeoNerd" Evans f6c55979e0 Remove TODO comment about SYN-490 as it's unlikely to matter for v1; we'll fix it in v2 9 years ago
Paul "LeoNerd" Evans 40fa339cf7 Draw a pretty (well at least I think it's pretty) ASCII diagram of the remote join handshake 9 years ago
Mark Haines 149890227a Fix wording 9 years ago
Mark Haines 52f55e0542 Allow room tags to have asssociated content, and return that content in the m.tag events 9 years ago
Mark Haines f557e69860 Note that m.tag events can appear in v1 initialSync and /events as well as v2 sync. Only add the room_id for v1 /events since it is redundant in v1 /initialSync 9 years ago
Mark Haines d297d83151 Mention that sender is renamed to user_id in v1 9 years ago
Mark Haines d067e50af5 Document the differences in event formatting between the v1 and v2 client APIs 9 years ago
Paul "LeoNerd" Evans 5b6f858802 Some initial notes by way of the remote join handshake; with several TODOs and unanswered questions 9 years ago
Paul "LeoNerd" Evans 745e607577 Use 'room' or 'room ID' instead of 'context' when describing federation protocol 9 years ago
Mark Haines 65066a76b3 Add the m.tags event to a ``private_user_data`` key rather than including it under the ``ephemeral`` key 9 years ago
Mark Haines 9b0d20315a Add the tags module to the specification targets 9 years ago
Mark Haines 12e33a3b09 Document a v2 api for setting tags on rooms 9 years ago
Richard van der Hoff 13eddd456f Proposal for adding full_state param to v2 sync 9 years ago
Erik Johnston 696f75d80b Rename section 9 years ago
Erik Johnston e2376e9a43 Merge branch 'erikj/login_fallback_v1' of github.com:matrix-org/matrix-doc 9 years ago
Erik Johnston 3cf431cac1 Add link 9 years ago
Kegsay a22f1cd230 Merge pull request #119 from matrix-org/paul/test-vectors
Capture cryptographic test vectors for JSON or event signing from source
9 years ago
Erik Johnston 9a5bd6d21f Use static 9 years ago
Erik Johnston 98dbf4d60b Better flow 9 years ago
Erik Johnston 0529b4a9a2 Reword 9 years ago
Erik Johnston 88c459d549 Add back in login v1 fallback API 9 years ago
Daniel Wagner-Hall 7c250f91ff Merge pull request #127 from matrix-org/daniel/exposedrooms
Allow history to be noted as world-readable
9 years ago
Kegsay 4823a133cd Merge pull request #124 from matrix-org/clarify_scale_crop
Clarify 'scale' & 'crop' resize methods
9 years ago
Richard van der Hoff f47a49de43 Merge pull request #126 from matrix-org/rav/send_events_api
Add the room send and state APIs to the spec
9 years ago
Richard van der Hoff 1945697456 Further tweaks to the room send and state APIs
- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
9 years ago
Mark Haines 1d7cb6937f Merge pull request #123 from matrix-org/markjh/list_formatting
Fix list formatting
9 years ago
Richard van der Hoff 28ab643a4e Remove duplicated registration/login APIs
Currently the spec duplicates all of the account-management APIs. There's still
work to be done here, but the complete duplication is confusing.
9 years ago
Daniel Wagner-Hall 67880686d5 Allow history to be noted as world-readable
SPEC-237
9 years ago
Richard van der Hoff 587a8ba7ce Merge branch 'master' into rav/send_events_api 9 years ago
Richard van der Hoff d18d406c41 Add the room send and state APIs to the spec 9 years ago
David Baker 01064369a4 Add some clarification on the difference between 'scale' and 'crop' resize methods 9 years ago
Mark Haines e3e8026025 Fix list formatting so that we aren't including everything in blockquotes 9 years ago
Erik Johnston f0c74a9c83 Merge pull request #96 from matrix-org/erikj/search_actual
Add search API
9 years ago
Erik Johnston 4a558ad63b Typo 9 years ago
Kegan Dougal f95d19cecd Merge branch 'master' into appservice-swagger
Conflicts:
	specification/application_service_api.rst
9 years ago
Daniel Wagner-Hall 74d42f0142 Allow rejecting invitations 9 years ago
Paul "LeoNerd" Evans e38e4788f2 Spell 'cryptographic' correctly 9 years ago
Paul "LeoNerd" Evans 228acc59aa Capture cryptographic test vectors for JSON or event signing from source code 9 years ago
Paul Evans 84a8663019 Merge pull request #115 from matrix-org/paul/event-redaction
Initial attempt at describing the event redaction algorithm
9 years ago
Paul "LeoNerd" Evans 9252b3e1a2 Fix typo s/he/the/ 9 years ago
Paul "LeoNerd" Evans bfa9937bdc Minor wording updates 9 years ago
Daniel Wagner-Hall a9a9067d7e Merge pull request #114 from matrix-org/daniel/3pidtosigned
Update 3pid invite section to reflect signed property
9 years ago
Erik Johnston 1d01f69c3c Merge remote-tracking branch 'origin/master' into erikj/search_actual 9 years ago
Erik Johnston 111ca99519 Clarify that this doesn't include events that occurred after you left the room. 9 years ago
Kegsay 6546068c63 Merge pull request #101 from matrix-org/spec-182-asapi-user-creation
SPEC-182: Make it clearer how ASes are supposed to create users
9 years ago
Kegan Dougal f3088a0674 Merge branch 'master' into spec-182-asapi-user-creation 9 years ago
Kegan Dougal 26f27d95fb Merge branch 'master' into registration-swagger
Conflicts:
	specification/client_server_api.rst
9 years ago
Kegan Dougal ae90d15b3c Add m.room.avatar 9 years ago
Daniel Wagner-Hall c70067dd1e Simplify language 9 years ago
Daniel Wagner-Hall 22fdb8f911 Merge branch 'master' into daniel/as 9 years ago
Paul "LeoNerd" Evans 29720cd152 Initial attempt at describing the event redaction algorithm 9 years ago
Daniel Wagner-Hall 6161a920b6 Update 3pid invite section to reflect signed property 9 years ago
Kegan Dougal 62d53b4f33 Review comments round III 9 years ago
Kegan Dougal 85a6a5a530 Merge branch 'master' into proofing 9 years ago
Kegan Dougal 4bb042daeb Review comments round II 9 years ago
Kegan Dougal e0fe3c42c8 Review comments 9 years ago
Kegan Dougal 6770d6b2d6 Review comments 9 years ago
Daniel Wagner-Hall 20b11281ea Remove lies about OAuth which doesn't exist 9 years ago
Erik Johnston eb59b8e9d1 Mention count 9 years ago
Erik Johnston a6cb2e4339 Mention rank 9 years ago
Kegan Dougal eca98af896 Swaggerify /register endpoint
Need to move registration/login/auth sections around once #94 lands.
9 years ago
Erik Johnston 24e36adbe3 Mention e2e encryption 9 years ago
Erik Johnston 770cfbc5de Be explicit about the events the search is performed over 9 years ago
Erik Johnston 906c59385f s/had/has/ 9 years ago
Kegan Dougal 55cc5c5bb5 Swaggerify application services 9 years ago
Kegan Dougal 3d087df538 Kill number prefixes for good 9 years ago
Kegan Dougal 6b72ddfb8c Spelling and typos 9 years ago
Kegan Dougal 08ccacae17 Merge branch 'master' into proofing
Conflicts:
	specification/0-intro.rst
9 years ago
Erik Johnston c47a94658a Mention supported keys 9 years ago
Kegsay 3146b52f83 Merge pull request #102 from matrix-org/spec-207-asapi-unique-tokens
SPEC-207: Add a warning about needing AS tokens to be unique and why
9 years ago
Kegsay 604e268add Merge pull request #105 from matrix-org/spec-177-events-max-len
Add in size limits as per SPEC-222
9 years ago
Kegan Dougal 5de63b4f45 Merge branch 'master' into proofing
Conflicts:
	specification/0-intro.rst
9 years ago
Erik Johnston af347baa68 Better phrasing 9 years ago
Erik Johnston 96a4996c76 Mention search categories 9 years ago
Kegsay 3a2c8cd4b3 Merge pull request #91 from matrix-org/module-history-vis
History visibility module
9 years ago
Kegan Dougal 5aad67f74d Review comments round III 9 years ago
Kegsay c5dc383668 Merge pull request #85 from matrix-org/module-im
Instant messaging module
9 years ago
Kegan Dougal 507cb29e39 Review comments round deux 9 years ago
Kegan Dougal f51ee70633 Review comments round 2 9 years ago
Kegan Dougal c82c07ddd2 Review comments 9 years ago
Kegan Dougal c4d1b56843 Add a comment about enforcement. 9 years ago
Kegsay 1229ad24dd Merge pull request #103 from matrix-org/spec-165-mxc-security
SPEC-165: Outline directory traversal attacks on MXC URIs
9 years ago
Kegsay bc0ab32cfd Merge pull request #99 from matrix-org/spec-144-https-examples
SPEC-144 : Use https examples not http
9 years ago
Kegan Dougal e6eb19c461 Review comments 9 years ago
Erik Johnston 728b5a7951 Add very short summary 9 years ago
Erik Johnston 007bb1a69a Add extra new line 9 years ago
Erik Johnston 5e48b0b79a Add search to targets 9 years ago
Erik Johnston 38fcc563da Spell out full title 9 years ago
Erik Johnston 0efa3fd981 Add module 9 years ago
Kegan Dougal 6a0595bc46 Add in size limits as per SPEC-222 9 years ago
Erik Johnston d8bc0c9315 Add search module 9 years ago
Kegan Dougal f0d8052951 SPEC-205: Warn about password strengths in m.login.password section 9 years ago
Kegan Dougal 44b19a8b0e SPEC-165: Outline directory traversal attacks on MXC URIs 9 years ago
Kegan Dougal 45b1d08c7e SPEC-207: Add a warning about needing AS tokens to be unique and why 9 years ago
Kegan Dougal cd34d4e19b SPEC-182: Make it clearer how ASes are supposed to create users by linkifying the right text. 9 years ago
Kegan Dougal 3608f3a282 SPEC-144 : Use https examples not http. 9 years ago
Kegan Dougal 34bd8edec5 Move related auth sections together 9 years ago
Kegan Dougal 6f6861a11d Swaggerify the createRoom API 9 years ago
Kegan Dougal 07d7a3fa3a Shuffle pagination section around 9 years ago
Kegan Dougal 7bdb71b1c9 Tweak the syncing section
Bring together disparate sections to make it more cohesive.
9 years ago
Kegan Dougal e716e81963 Add `dir` parameter to pagination. Remove path references
This section needs a lot of work to not lie.
9 years ago
Kegan Dougal e561a663d3 Tweaks to intro, start using swagger APIs in the CS API section. 9 years ago
Kegan Dougal 4170dbd5cf Review comments 9 years ago
Kegan Dougal 173d00cea0 Review comments 9 years ago
Daniel Wagner-Hall 2502ca7ac6 Merge branch 'master' into daniel/threepidinvites-2
Conflicts:
	specification/targets.yaml
9 years ago
Daniel Wagner-Hall 4a1fb74897 Review comments 9 years ago
Kegan Dougal 8f5c796884 Linkify 'pushers' 9 years ago
Kegan Dougal e378de8379 Shuffle history visibility module to be in the module format 9 years ago
Kegan Dougal f2a6950cc3 Minor tweaks; allow objects without props/parents if a title is set
This allows us to do things like {Tweaks} where Tweaks is defined somewhere
else.
9 years ago
Daniel Wagner-Hall dc3c02aff5 Review comments 9 years ago
Daniel Wagner-Hall 21a40b317d Merge branch 'master' into daniel/threepidinvites-2 9 years ago
Kegan Dougal 9c95ee5c1f Modify wording and formatting 9 years ago
Kegan Dougal 31ae4b3859 Swaggerify push notification API
Edit units.py to support nested JSON request keys
9 years ago
Kegan Dougal a9618a981b Swaggerify the /enabled endpoint 9 years ago
Kegan Dougal 56ce432399 Get profile tag keys displaying correctly. 9 years ago
Kegan Dougal db25276856 Start adding in push definitions
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
9 years ago
Kegan Dougal c5edc60c4c Add push YAML for pushers endpoint.
Also display "required" text on required JSON body request params. Also
increase the size of the request param column to support longer param names
present in the pushers API.
9 years ago
Kegan Dougal d3ed517ebf Finish laying out rough sections 9 years ago
Kegan Dougal a7400508c6 Define module titles from the template 9 years ago
Kegan Dougal 319ba8f404 Combine push files into one
We can fork it out again if it makes sense, but certainly 2/3 of the files
were very small and it just adds more complexity when refactoring.
9 years ago
Kegan Dougal 91ca36509b Flesh out IM module 9 years ago
Kegan Dougal 656bee78c4 Merge branch 'master' into module-im 9 years ago
Matthew Hodgson 7ae2573113 fix barefaced lie regarding the passivity of ASes 9 years ago
Matthew Hodgson 39faccb00d CS API is not just v1 surely 9 years ago
Kegan Dougal 8e5c832ff9 Flesh out more of the IM module 9 years ago
Kegan Dougal 47cf958b54 Merge branch 'master' into module-im 9 years ago
Erik Johnston 3b4c3522e6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/disable_federation 9 years ago
Kegsay 8c092e3d11 Merge pull request #74 from matrix-org/module-presence
Presence module
9 years ago
Kegan Dougal 417c5b53c4 Remove duplicate sentences from merge conflicts 9 years ago
Daniel Wagner-Hall b29fdebec2 Give example of verification dance 9 years ago
Kegan Dougal 458383585f Stub sections 9 years ago
Kegsay ead79614ff Merge pull request #78 from matrix-org/module-typing2
Typing module
9 years ago
Daniel Wagner-Hall 9d8dc7971d Review comments 9 years ago
Kegsay 68df99409a Merge pull request #83 from matrix-org/module-content-repo
Content Repo Module
9 years ago
Erik Johnston ccdd376f30 Merge pull request #63 from matrix-org/erikj/room_create_preset
Update the room creation API spec to include new keys: 'preset' and 'initial_state'
9 years ago
Kegan Dougal 09ac367847 Merge branch 'master' into module-content-repo
Conflicts:
	templating/matrix_templates/units.py
9 years ago
Kegan Dougal 4dabcd112e Remove redundant info now we have the http api template. Minor tweaks to display of schema with no names but a type 9 years ago
Erik Johnston 912a8ca760 Be more explicit about keys that are clobbered 9 years ago
Erik Johnston dbc72c43ac s/private_chat_shared_power/trusted_private_chat/ 9 years ago
Daniel Wagner-Hall af7d2ca9fc Update 3pid invite spec
This takes into account:
 1) That finding the existing servers of a room is hard
 2) Federation
9 years ago
Kegan Dougal 87b6dd845e Flesh out content repo; modify templating to support headers
Edit content-repo.yaml to include examples and headers.
Restructure content module to conform to the module template.
Adjust the HTTP API template to give 1 more char to the response
param to fit "Content-Disposition" correctly.
Edit the templating system to support displaying enums for
swagger APIs (before it was just JSON schema). Also add support
for introspecting headers from swagger. Finally, replace - with
_ when forming the {{ template_var }} else things whine.
9 years ago
Kegsay 8aad238cda Merge pull request #80 from matrix-org/module-receipts
Receipts module
9 years ago
Kegan Dougal da2be7eae4 Merge branch 'master' into module-voip
Conflicts:
	specification/modules/voip_events.rst
9 years ago
Kegan Dougal 1520f3647f Merge branch 'master' into module-typing2
Conflicts:
	specification/modules/typing_notifications.rst
9 years ago
Kegan Dougal cc6f256b24 Merge branch 'master' into module-presence
Conflicts:
	specification/modules/presence.rst
9 years ago
Kegan Dougal 6000887201 Merge branch 'master' into module-receipts
Conflicts:
	specification/modules/receipts.rst
9 years ago
Kegan Dougal c972dad8b3 Flesh out receipts module. Add receipts swagger
Add templating support for v2 apis.
9 years ago
Kegsay 4a7a682c0f Merge pull request #65 from matrix-org/spec-feature-profiles
Spec feature profiles
9 years ago
Kegan Dougal 365a9076b9 Add nested dict template support; Add x-pattern
For cases where event schema specify `patternProperties` it would be nice
to give that pattern a "human-readable" form rather than a raw regex. This
is now supported by specifying `x-pattern` in the value part of the specified
pattern e.g. `patternProperties:{ "^.*":{ x-pattern: "$THING", ... } }`

Templating had limited record type descriptions limited to value primitives
e.g. `{string: integer}`. It now supports inspecting the values recursively
if the value is `object`.

Updated `m.receipt` to take both these points into account to make it read
better. Tweak receipt module text.
9 years ago
Kegan Dougal 3b73b07bab Clarifications that room invites are m.call.invites not actual invites 9 years ago
Kegan Dougal e82661413e Add /turnServer endpoint 9 years ago
Kegan Dougal d092b22848 Rename to 'Managing history visibility' 9 years ago
Kegan Dougal 6c3e70d272 Start fleshing out voip module 9 years ago
Kegan Dougal 91b6347f74 Explain what 'embedded' clients are 9 years ago
Kegan Dougal be9402b66f Move feature profiles section to modules as a sub-section 9 years ago
Kegan Dougal 0320e8cef3 Table tweaks from PR 9 years ago
Kegan Dougal 097dc50180 Minor tweaks 9 years ago
Kegan Dougal a82f2ad4ac Flesh out typing module 9 years ago
Kegan Dougal 2b7e02c080 Add sections for typing. Add swagger, JSON schema and example m.typing event 9 years ago
Kegan Dougal 52f6496cf0 Merge branch 'master' into module-presence 9 years ago
Kegan Dougal 4e1e82f995 Fix paragraph CSS and adjust where paragraphs are in the RST
The CSS for `nature.css` was such that it was preventing `p` tags from
having sufficient vertical whitespace. This meant that you couldn't insert
any kind of spacing between lengthy sections (they just appeared as new lines).

This PR fixes this so you can actually have some whitespace between paragraphs.
As a result of this change, some parts of the spec appeared to have too much
whitespace. These were often sections which shouldn't have begun a new
paragraph anyway (e.g. a single sentence being an entire paragraph, `TODO`
blocks resulting in new paragraphs). This PR fixes the most offending areas
where we shouldn't have been inserting new paragraphs.
9 years ago
Kegan Dougal 069e4e39f4 Move presence specific sections from intro to presence module 9 years ago
Erik Johnston 73b4090f52 Add private_chat_shared_power 9 years ago
Kegan Dougal 0a04672d76 Start converting the presence module. Add Rationale admonition. 9 years ago
Kegan Dougal cdf9f011e9 Add room history visibility as a module. 9 years ago
Kegan Dougal 82c27884ba Make E2E optional 9 years ago
Erik Johnston 83b9497664 Add context and example 9 years ago
Kegsay c96f02c2b0 Merge pull request #69 from matrix-org/erikj/login_token
m.login.token
9 years ago
Erik Johnston 6e6bc8a5a9 Mandate macaroon 9 years ago
Erik Johnston ce53a17180 Add txn_id rationale 9 years ago
Erik Johnston 4776e0c04c Add creation_content key 9 years ago
Kegan Dougal 5abea1f2bc Minor tweaks 9 years ago
Kegan Dougal 70518ae655 Clarify template suffixes 9 years ago
Kegan Dougal 643468e914 Mention swagger. Clarify how event type template vars are formed. 9 years ago
Kegan Dougal c2fc1a2fb1 Add basic module template.
This has the core sections for events/server/client/security.
9 years ago
Kegan Dougal db8f3c0d59 Desktop clients should have a GUI 9 years ago
Erik Johnston 97154cc6b2 s/nonce/txn_id/ 9 years ago
Erik Johnston 4c9f524cab Neaten things up 9 years ago
Erik Johnston 317c2f20d3 Draft login token spec 9 years ago
Kegan Dougal 510553ee00 Remove smurf suffixes. Add anchor for feature profiles. 9 years ago
Kegan Dougal 9fac152d32 Explain what the clients are and the column reference 9 years ago
Kegan Dougal c6375ed3d1 Flesh out feature profiles section
Add table detailing the profiles. Add anchors to link through to each module
following a well-defined format (rather than the name of the module section).
Allow UTF-8 in the spec.
9 years ago
Erik Johnston 18dc7784df Mention precedence 9 years ago
Erik Johnston 078dd0165f Update the room creation API spec to include new keys: 'preset' and 'initial_state' 9 years ago
Kegan Dougal 1da64db302 Use relative depths for groups instead of absolute ones
This means the group can be agnostic to how deeply nested it is,
improving reusability of groups.
9 years ago
Kegan Dougal 29bae15790 Fix typo 9 years ago
Kegan Dougal 5115346297 Add instant_messaging module; modify batesian section rules
Previously, all `m.room.*` events were wodged into `{{room_events}}` which
isn't great when you want to pull specific ones out. Batesian had a 1:1
mapping of `render_foo()` to a section `{{foo}}`, and having to constantly
add functions for new types is a PITA. Batesian now supports returning a
`dict` instead of a section `string` where the keys are the `{{foo}}` and
the value is what will be inserted. Also add conflicting section key checks
to avoid multiple definitions of the same `{{foo}}`. Define dicts for
event schemata and swagger HTTP APIs.

Using this new feature, split out the instant messaging stuff from the events
section, and replace `{{room_events}}` with a list of specific events e.g.
`{{m_room_member_event}}`.
9 years ago
Kegan Dougal 5b134119bd Add presence module; fix relative title bug
If a relative title appeared after an HTTP API table, it
would insert the wrong level because it thought that part
of the table was a title.
9 years ago
Kegan Dougal b49cb57fe5 Move events sections to CS API 9 years ago
Kegan Dougal 16693a644a Various review fixes 9 years ago
Kegan Dougal b0eb985523 Merge branch 'master' into spec-restructure-modules 9 years ago
Kegan Dougal 0c0ac3e814 Fix common event fields template to use subtitle char 9 years ago
Kegan Dougal e8cdfcbba2 Rename spec files to not have numbers everywhere; update targets.yaml 9 years ago
Kegan Dougal f71763b0d3 Implement relative title styles
Templates don't know at what level they will be inserted. Previously, we
hard-coded the title style which is not compatible with the build target
system. Define a set of styles which will be replaced by the gendoc script
when it encounters them:
 '<' : Make this title a sub-heading
 '/' : Make this title a heading at the same level
 '>' : Make this title a super-heading

The build target system is now basically complete and functioning.
9 years ago