Commit Graph

518 Commits (ac006f8e1e2ea0dfbaada4989fe27f4864e33269)

Author SHA1 Message Date
Paul Evans e95a1616af Merge pull request #143 from matrix-org/paul/federation-room-join
Document the federation remote join handshake
10 years ago
Mark Haines 40f7eab73f s/private_user_data/account_data/ 10 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
10 years ago
Mark Haines fcbb985073 s/private_user_data/account_data/ 10 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.
10 years ago
Daniel Wagner-Hall 8201eaa042 Swaggerify /rooms/:room_id/leave 10 years ago
Erik Johnston 373c6c8270 Add ordering, pagination and grouping comments 10 years ago
Mark Haines c77b22778f Add some documentation on names of tags 10 years ago
Mark Haines 25769493b1 Fix template 10 years ago
Mark Haines e7fbe6f13b Limit the size of a tag 10 years ago
Mark Haines 48f35e15cb describe how to order rooms that don't have an order in their tags 10 years ago
Mark Haines 299af673da Specify how ordering of tags is supposed to work 10 years ago
Richard van der Hoff 7ff593b3de Merge branch 'rav/SPEC-254' into rav/flatten_sync
Conflicts:
	specification/events.rst
10 years ago
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
10 years ago
Richard van der Hoff 0db055b4ea Fix another reference to 'txn_id' 10 years ago
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
10 years ago
Paul "LeoNerd" Evans 233e8486bc Wording fix - objects contain keys, not list elements directly 10 years ago
Mark Haines c3769ef75c Add a module for client config to the specification 10 years ago
Paul "LeoNerd" Evans 6cbfba7011 'auth_events' is a List, not a String 10 years ago
Paul "LeoNerd" Evans 122c082fcf Comment about origin servers of invites having subsequently left the room 10 years ago
Paul "LeoNerd" Evans 923f05e554 More consistency around 'resident homeserver' 10 years ago
Paul "LeoNerd" Evans 36af793f05 s/full object/full event/ 10 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
10 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.
10 years ago
Paul "LeoNerd" Evans 988d773476 /make_join protoevent no longer needs the pointless 'prev_state' key (SYN-517) 10 years ago
Paul "LeoNerd" Evans 885dd1e86c Explain the 'prev_events' join protoevent key 10 years ago
Paul "LeoNerd" Evans db5a90edcd Avoid using the words 'current state' when talking about the result of the /make_join request 10 years ago
Paul "LeoNerd" Evans aac45295ee Remark that the directory server step could be skipped in an invite case 10 years ago
Paul "LeoNerd" Evans d7c69fae43 Fix typo 'process' 10 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
10 years ago
Daniel Wagner-Hall 29d9c8eec6 Guests are allowed to set displaynames 10 years ago
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 10 years ago
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 10 years ago
Daniel Wagner-Hall 24c2036a35 3pid invites: remove mentions of display_name 10 years ago
Daniel Wagner-Hall e72151f2c3 Specify guest room access
This was reviewed as PR #150 and merged from daniel/anonymousaccess
10 years ago
Daniel Wagner-Hall 161441fa3a Update 3pid spec based on new implementation 10 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
10 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
10 years ago
Mark Haines 3953006792 Fix spelling 10 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 10 years ago
Paul "LeoNerd" Evans 40fa339cf7 Draw a pretty (well at least I think it's pretty) ASCII diagram of the remote join handshake 10 years ago
Mark Haines 149890227a Fix wording 10 years ago
Mark Haines 52f55e0542 Allow room tags to have asssociated content, and return that content in the m.tag events 10 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 10 years ago
Mark Haines d297d83151 Mention that sender is renamed to user_id in v1 10 years ago
Mark Haines d067e50af5 Document the differences in event formatting between the v1 and v2 client APIs 10 years ago
Paul "LeoNerd" Evans 5b6f858802 Some initial notes by way of the remote join handshake; with several TODOs and unanswered questions 10 years ago
Paul "LeoNerd" Evans 745e607577 Use 'room' or 'room ID' instead of 'context' when describing federation protocol 10 years ago
Mark Haines 65066a76b3 Add the m.tags event to a ``private_user_data`` key rather than including it under the ``ephemeral`` key 10 years ago
Mark Haines 9b0d20315a Add the tags module to the specification targets 10 years ago
Mark Haines 12e33a3b09 Document a v2 api for setting tags on rooms 10 years ago
Richard van der Hoff 13eddd456f Proposal for adding full_state param to v2 sync 10 years ago
Erik Johnston 696f75d80b Rename section 10 years ago
Erik Johnston e2376e9a43 Merge branch 'erikj/login_fallback_v1' of github.com:matrix-org/matrix-doc 10 years ago
Erik Johnston 3cf431cac1 Add link 10 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
10 years ago
Erik Johnston 9a5bd6d21f Use static 10 years ago
Erik Johnston 98dbf4d60b Better flow 10 years ago
Erik Johnston 0529b4a9a2 Reword 10 years ago
Erik Johnston 88c459d549 Add back in login v1 fallback API 10 years ago
Daniel Wagner-Hall 7c250f91ff Merge pull request #127 from matrix-org/daniel/exposedrooms
Allow history to be noted as world-readable
10 years ago
Kegsay 4823a133cd Merge pull request #124 from matrix-org/clarify_scale_crop
Clarify 'scale' & 'crop' resize methods
10 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
10 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
10 years ago
Mark Haines 1d7cb6937f Merge pull request #123 from matrix-org/markjh/list_formatting
Fix list formatting
10 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.
10 years ago
Daniel Wagner-Hall 67880686d5 Allow history to be noted as world-readable
SPEC-237
10 years ago
Richard van der Hoff 587a8ba7ce Merge branch 'master' into rav/send_events_api 10 years ago
Richard van der Hoff d18d406c41 Add the room send and state APIs to the spec 10 years ago
David Baker 01064369a4 Add some clarification on the difference between 'scale' and 'crop' resize methods 10 years ago
Mark Haines e3e8026025 Fix list formatting so that we aren't including everything in blockquotes 10 years ago
Erik Johnston f0c74a9c83 Merge pull request #96 from matrix-org/erikj/search_actual
Add search API
10 years ago
Erik Johnston 4a558ad63b Typo 10 years ago
Kegan Dougal f95d19cecd Merge branch 'master' into appservice-swagger
Conflicts:
	specification/application_service_api.rst
10 years ago
Daniel Wagner-Hall 74d42f0142 Allow rejecting invitations 10 years ago
Paul "LeoNerd" Evans e38e4788f2 Spell 'cryptographic' correctly 10 years ago
Paul "LeoNerd" Evans 228acc59aa Capture cryptographic test vectors for JSON or event signing from source code 10 years ago
Paul Evans 84a8663019 Merge pull request #115 from matrix-org/paul/event-redaction
Initial attempt at describing the event redaction algorithm
10 years ago
Paul "LeoNerd" Evans 9252b3e1a2 Fix typo s/he/the/ 10 years ago
Paul "LeoNerd" Evans bfa9937bdc Minor wording updates 10 years ago
Daniel Wagner-Hall a9a9067d7e Merge pull request #114 from matrix-org/daniel/3pidtosigned
Update 3pid invite section to reflect signed property
10 years ago
Erik Johnston 1d01f69c3c Merge remote-tracking branch 'origin/master' into erikj/search_actual 10 years ago
Erik Johnston 111ca99519 Clarify that this doesn't include events that occurred after you left the room. 10 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
10 years ago
Kegan Dougal f3088a0674 Merge branch 'master' into spec-182-asapi-user-creation 10 years ago
Kegan Dougal 26f27d95fb Merge branch 'master' into registration-swagger
Conflicts:
	specification/client_server_api.rst
10 years ago
Kegan Dougal ae90d15b3c Add m.room.avatar 10 years ago
Daniel Wagner-Hall c70067dd1e Simplify language 10 years ago
Daniel Wagner-Hall 22fdb8f911 Merge branch 'master' into daniel/as 10 years ago
Paul "LeoNerd" Evans 29720cd152 Initial attempt at describing the event redaction algorithm 10 years ago
Daniel Wagner-Hall 6161a920b6 Update 3pid invite section to reflect signed property 10 years ago
Kegan Dougal 62d53b4f33 Review comments round III 10 years ago
Kegan Dougal 85a6a5a530 Merge branch 'master' into proofing 10 years ago
Kegan Dougal 4bb042daeb Review comments round II 10 years ago
Kegan Dougal e0fe3c42c8 Review comments 10 years ago
Kegan Dougal 6770d6b2d6 Review comments 10 years ago
Daniel Wagner-Hall 20b11281ea Remove lies about OAuth which doesn't exist 10 years ago
Erik Johnston eb59b8e9d1 Mention count 10 years ago
Erik Johnston a6cb2e4339 Mention rank 10 years ago
Kegan Dougal eca98af896 Swaggerify /register endpoint
Need to move registration/login/auth sections around once #94 lands.
10 years ago
Erik Johnston 24e36adbe3 Mention e2e encryption 10 years ago
Erik Johnston 770cfbc5de Be explicit about the events the search is performed over 10 years ago
Erik Johnston 906c59385f s/had/has/ 10 years ago
Kegan Dougal 55cc5c5bb5 Swaggerify application services 10 years ago
Kegan Dougal 3d087df538 Kill number prefixes for good 10 years ago
Kegan Dougal 6b72ddfb8c Spelling and typos 10 years ago
Kegan Dougal 08ccacae17 Merge branch 'master' into proofing
Conflicts:
	specification/0-intro.rst
10 years ago
Erik Johnston c47a94658a Mention supported keys 10 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
10 years ago
Kegsay 604e268add Merge pull request #105 from matrix-org/spec-177-events-max-len
Add in size limits as per SPEC-222
10 years ago
Kegan Dougal 5de63b4f45 Merge branch 'master' into proofing
Conflicts:
	specification/0-intro.rst
10 years ago
Erik Johnston af347baa68 Better phrasing 10 years ago
Erik Johnston 96a4996c76 Mention search categories 10 years ago
Kegsay 3a2c8cd4b3 Merge pull request #91 from matrix-org/module-history-vis
History visibility module
10 years ago
Kegan Dougal 5aad67f74d Review comments round III 10 years ago
Kegsay c5dc383668 Merge pull request #85 from matrix-org/module-im
Instant messaging module
10 years ago
Kegan Dougal 507cb29e39 Review comments round deux 10 years ago
Kegan Dougal f51ee70633 Review comments round 2 10 years ago
Kegan Dougal c82c07ddd2 Review comments 10 years ago
Kegan Dougal c4d1b56843 Add a comment about enforcement. 10 years ago
Kegsay 1229ad24dd Merge pull request #103 from matrix-org/spec-165-mxc-security
SPEC-165: Outline directory traversal attacks on MXC URIs
10 years ago
Kegsay bc0ab32cfd Merge pull request #99 from matrix-org/spec-144-https-examples
SPEC-144 : Use https examples not http
10 years ago
Kegan Dougal e6eb19c461 Review comments 10 years ago
Erik Johnston 728b5a7951 Add very short summary 10 years ago
Erik Johnston 007bb1a69a Add extra new line 10 years ago
Erik Johnston 5e48b0b79a Add search to targets 10 years ago
Erik Johnston 38fcc563da Spell out full title 10 years ago
Erik Johnston 0efa3fd981 Add module 10 years ago
Kegan Dougal 6a0595bc46 Add in size limits as per SPEC-222 10 years ago
Erik Johnston d8bc0c9315 Add search module 10 years ago
Kegan Dougal f0d8052951 SPEC-205: Warn about password strengths in m.login.password section 10 years ago
Kegan Dougal 44b19a8b0e SPEC-165: Outline directory traversal attacks on MXC URIs 10 years ago
Kegan Dougal 45b1d08c7e SPEC-207: Add a warning about needing AS tokens to be unique and why 10 years ago
Kegan Dougal cd34d4e19b SPEC-182: Make it clearer how ASes are supposed to create users by linkifying the right text. 10 years ago
Kegan Dougal 3608f3a282 SPEC-144 : Use https examples not http. 10 years ago
Kegan Dougal 34bd8edec5 Move related auth sections together 10 years ago
Kegan Dougal 6f6861a11d Swaggerify the createRoom API 10 years ago
Kegan Dougal 07d7a3fa3a Shuffle pagination section around 10 years ago
Kegan Dougal 7bdb71b1c9 Tweak the syncing section
Bring together disparate sections to make it more cohesive.
10 years ago
Kegan Dougal e716e81963 Add `dir` parameter to pagination. Remove path references
This section needs a lot of work to not lie.
10 years ago
Kegan Dougal e561a663d3 Tweaks to intro, start using swagger APIs in the CS API section. 10 years ago
Kegan Dougal 4170dbd5cf Review comments 10 years ago
Kegan Dougal 173d00cea0 Review comments 10 years ago
Daniel Wagner-Hall 2502ca7ac6 Merge branch 'master' into daniel/threepidinvites-2
Conflicts:
	specification/targets.yaml
10 years ago
Daniel Wagner-Hall 4a1fb74897 Review comments 10 years ago
Kegan Dougal 8f5c796884 Linkify 'pushers' 10 years ago
Kegan Dougal e378de8379 Shuffle history visibility module to be in the module format 10 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.
10 years ago
Daniel Wagner-Hall dc3c02aff5 Review comments 10 years ago
Daniel Wagner-Hall 21a40b317d Merge branch 'master' into daniel/threepidinvites-2 10 years ago
Kegan Dougal 9c95ee5c1f Modify wording and formatting 10 years ago
Kegan Dougal 31ae4b3859 Swaggerify push notification API
Edit units.py to support nested JSON request keys
10 years ago
Kegan Dougal a9618a981b Swaggerify the /enabled endpoint 10 years ago
Kegan Dougal 56ce432399 Get profile tag keys displaying correctly. 10 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.
10 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.
10 years ago
Kegan Dougal d3ed517ebf Finish laying out rough sections 10 years ago
Kegan Dougal a7400508c6 Define module titles from the template 10 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.
10 years ago
Kegan Dougal 91ca36509b Flesh out IM module 10 years ago
Kegan Dougal 656bee78c4 Merge branch 'master' into module-im 10 years ago
Matthew Hodgson 7ae2573113 fix barefaced lie regarding the passivity of ASes 10 years ago
Matthew Hodgson 39faccb00d CS API is not just v1 surely 10 years ago
Kegan Dougal 8e5c832ff9 Flesh out more of the IM module 10 years ago
Kegan Dougal 47cf958b54 Merge branch 'master' into module-im 10 years ago
Erik Johnston 3b4c3522e6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/disable_federation 10 years ago
Kegsay 8c092e3d11 Merge pull request #74 from matrix-org/module-presence
Presence module
10 years ago
Kegan Dougal 417c5b53c4 Remove duplicate sentences from merge conflicts 10 years ago
Daniel Wagner-Hall b29fdebec2 Give example of verification dance 10 years ago
Kegan Dougal 458383585f Stub sections 10 years ago
Kegsay ead79614ff Merge pull request #78 from matrix-org/module-typing2
Typing module
10 years ago
Daniel Wagner-Hall 9d8dc7971d Review comments 10 years ago
Kegsay 68df99409a Merge pull request #83 from matrix-org/module-content-repo
Content Repo Module
10 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'
10 years ago
Kegan Dougal 09ac367847 Merge branch 'master' into module-content-repo
Conflicts:
	templating/matrix_templates/units.py
10 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 10 years ago
Erik Johnston 912a8ca760 Be more explicit about keys that are clobbered 10 years ago
Erik Johnston dbc72c43ac s/private_chat_shared_power/trusted_private_chat/ 10 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
10 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.
10 years ago
Kegsay 8aad238cda Merge pull request #80 from matrix-org/module-receipts
Receipts module
10 years ago
Kegan Dougal da2be7eae4 Merge branch 'master' into module-voip
Conflicts:
	specification/modules/voip_events.rst
10 years ago
Kegan Dougal 1520f3647f Merge branch 'master' into module-typing2
Conflicts:
	specification/modules/typing_notifications.rst
10 years ago
Kegan Dougal cc6f256b24 Merge branch 'master' into module-presence
Conflicts:
	specification/modules/presence.rst
10 years ago
Kegan Dougal 6000887201 Merge branch 'master' into module-receipts
Conflicts:
	specification/modules/receipts.rst
10 years ago
Kegan Dougal c972dad8b3 Flesh out receipts module. Add receipts swagger
Add templating support for v2 apis.
10 years ago
Kegsay 4a7a682c0f Merge pull request #65 from matrix-org/spec-feature-profiles
Spec feature profiles
10 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.
10 years ago
Kegan Dougal 3b73b07bab Clarifications that room invites are m.call.invites not actual invites 10 years ago
Kegan Dougal e82661413e Add /turnServer endpoint 10 years ago
Kegan Dougal d092b22848 Rename to 'Managing history visibility' 10 years ago
Kegan Dougal 6c3e70d272 Start fleshing out voip module 10 years ago
Kegan Dougal 91b6347f74 Explain what 'embedded' clients are 10 years ago
Kegan Dougal be9402b66f Move feature profiles section to modules as a sub-section 10 years ago
Kegan Dougal 0320e8cef3 Table tweaks from PR 10 years ago
Kegan Dougal 097dc50180 Minor tweaks 10 years ago
Kegan Dougal a82f2ad4ac Flesh out typing module 10 years ago
Kegan Dougal 2b7e02c080 Add sections for typing. Add swagger, JSON schema and example m.typing event 10 years ago
Kegan Dougal 52f6496cf0 Merge branch 'master' into module-presence 10 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.
10 years ago