Commit Graph

387 Commits (5374030cc0644dadb40bb53a7cde63cb58353376)

Author SHA1 Message Date
Travis Ralston 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
David Baker 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
David Baker 2dc51d416d Ignore stuff in `m.` you don't understand 6 years ago
David Baker f90ed4b77d Make non-namespaced tags verboten 6 years ago
David Baker e4fd088fcc Fix room tags spec 6 years ago
Ben Parsons 07aeaadef9 update links which used to point to docs/spec/intro 6 years ago
Andrew Morgan 291a4dfc76 Third party lookup module. Fix wording 6 years ago
Andrew Morgan 114bcf1a2e Use $ref, clean up, fix errors, AS is now a C-S module. 6 years ago
Travis Ralston 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
Jason Volk 2a6895e759 Fix typo. 7 years ago
Jason Volk 2802fdea7e Fix typo. 7 years ago
Richard Lewis 8d05f80cec Sticker messages (m.sticker) (#1158) 7 years ago
Travis Ralston 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
Travis Ralston d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list 7 years ago
Travis Ralston 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
Travis Ralston 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
Florian Jacob ac861d9b97 Correct CAS spec link
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
7 years ago
Victor Berger 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
Travis Ralston 5e7df0e87c Update instant_messaging.rst
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Richard van der Hoff da6938b818 Key management APIs (#894)
Spec the e2e key-management APIs.
8 years ago
Richard van der Hoff 5537f7a832 Allow guest access to E2E endpoints 8 years ago
Richard van der Hoff 4abdcc6f05 Merge pull request #402 from matrix-org/rav/device_management
Device management API
8 years ago
Richard van der Hoff 461bfdb0d8 Merge branch 'master' into rav/device_management 8 years ago
Mark Haines 7025793ca8 Say that thumbnails should be 'mxc://' 8 years ago
David Baker 41f4661d1b Fix API path in pushrules examples 8 years ago
Richard van der Hoff af515012ea Device management API 8 years ago
Richard van der Hoff 42616f839c Merge pull request #396 from matrix-org/dbkr/notifs_api
Spec notifs API
8 years ago
Richard van der Hoff 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
Richard van der Hoff 83b89aa1ce dm: clarify client behaviour 8 years ago
David Baker ed2d364440 consistency 8 years ago
David Baker 96b6fb0129 'In the m.room.member' event 8 years ago
David Baker 301595c071 Linkify account_data API
Also change other links because it turns out the .. isn't part
of the syntax
8 years ago
David Baker 2a987c3369 Linkify endpoints properly 8 years ago
David Baker 2259a00ba2 links 8 years ago
David Baker 3f66ba713c Reference m.room.member section 8 years ago
David Baker e2024e5829 Add note on how to use the account data event 8 years ago
David Baker d791f35007 Remove unnecessary paragraph 8 years ago
David Baker 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
David Baker c16ba9488f Spec notifs API 8 years ago
David Baker 8e096bdc48 Link to createRoom, not initialsync 8 years ago
David Baker 85bc989c02 pr feedback 8 years ago
David Baker 976d41351e spelling 8 years ago
David Baker d39f662df5 PR feedback 8 years ago
David Baker 203ea99328 Spec m.direct 8 years ago
Richard van der Hoff ebaaa7e3b3 Review feedback
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
8 years ago
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 8 years ago
David Baker 9a1db01d92 Clarify `highlight` and `sound` tweaks. 8 years ago
David Baker fd888fcbda Merge pull request #373 from matrix-org/dbkr/contains_display_name_override
Make the display name rule an override rule
8 years ago
David Baker b65b0d049e Make the display name rule an override rule 8 years ago
David Baker 6592646ee9 Add dot prefix to .rule.master
It's a default rule, so it needs a dot
8 years ago
Richard van der Hoff 1f1dfdd91c More clarifications 8 years ago
Richard van der Hoff ec81b4c9fe More PR feedback
Add a couple of TODO sections
8 years ago
Richard van der Hoff 4b0e546eeb PR feedback
Fix some typos, and clarify several aspects of server behaviour.
8 years ago
Richard van der Hoff 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
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).
9 years ago
Richard van der Hoff 885e6797f2 Fix double-negative in room naming 9 years ago
Richard van der Hoff 7b4c21fa77 Add link to room name bug 9 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.
9 years ago
Richard van der Hoff df3f4b4ecf Fix link to draft e2e spec 9 years ago
Mark Haines af091ff614 Document changes to the default push rules 9 years ago
Mark Haines 30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules
Update the predefined push rules in the spec
9 years ago
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence
Update presence spec.
9 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.
9 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.
9 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.
9 years ago
Mark Haines c3c95d0c09 Fix grammar and add backticks for /sync 9 years ago
Mark Haines 5407cc8e05 Add a snippet of documentation for a m.push_rules event. 9 years ago
Erik Johnston 3d4d91a462 Reword to make sense 9 years ago
Erik Johnston 167a08a805 Allow idle timeout to be configurable 9 years ago
Erik Johnston bc68177471 Grammar 9 years ago
Erik Johnston f1a8306d08 Spec currently_active time and idle timeout behaviour 9 years ago
Richard van der Hoff 68a4306773 Split room previews into a separate module
Guest access and room peeking are orthogonal
9 years ago
Mark Haines 740f775932 Fix a couple of typos, remove .m.rule.member_event 9 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.
9 years ago
Mark Haines 5d85e3a505 Remove indents 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
Richard van der Hoff cff1b4ae35 Merge pull request #251 from matrix-org/daniel/guestshiz
Clarify guest /events and /sync
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 7d9547274c Clarify guest /events and /sync 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
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
Matthew Hodgson f8f76794a3 fix random whitespace bug 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
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 a2283f5499 Remove /notify from client-server API 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 873b0dcecf Replace version numbers with release numbers 9 years ago
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 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
Matthew Hodgson b946d39886 typo 9 years ago
Daniel Wagner-Hall f6229f649a Remove confusing wording 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 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 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
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 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
Daniel Wagner-Hall 5e30b5b8d7 Remove POST version of /send
PUT should always be used.
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
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
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
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
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
Mark Haines c3769ef75c Add a module for client config to the specification 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 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
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 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
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
Daniel Wagner-Hall 67880686d5 Allow history to be noted as world-readable
SPEC-237
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
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
Kegan Dougal ae90d15b3c Add m.room.avatar 9 years ago
Daniel Wagner-Hall c70067dd1e Simplify language 9 years ago
Daniel Wagner-Hall 6161a920b6 Update 3pid invite section to reflect signed property 9 years ago
Erik Johnston eb59b8e9d1 Mention count 9 years ago
Erik Johnston a6cb2e4339 Mention rank 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
Erik Johnston c47a94658a Mention supported keys 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
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
Erik Johnston 728b5a7951 Add very short summary 9 years ago
Erik Johnston 007bb1a69a Add extra new line 9 years ago
Erik Johnston d8bc0c9315 Add search module 9 years ago
Kegan Dougal 44b19a8b0e SPEC-165: Outline directory traversal attacks on MXC URIs 9 years ago
Kegan Dougal 3608f3a282 SPEC-144 : Use https examples not http. 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 8e5c832ff9 Flesh out more of the IM module 9 years ago
Kegan Dougal 47cf958b54 Merge branch 'master' into module-im 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