17b8fccd4c
rephrase intro
9 years ago
c44d61b3a9
Clarify which documents are generated from scripts.
9 years ago
22b542e3f9
Fix grammar in spec index.
9 years ago
5b18db9096
Make list of APIs on the index a table.
9 years ago
4b27d6a7a4
Reorganize spec index.
9 years ago
cd4e7306ca
Merge pull request #305 from matrix-org/rav/show_own_leave_event
...
Clarify `history_visibility` behaviour
9 years ago
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.
9 years ago
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
313f09f5c0
Specify address validating and binding
9 years ago
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
fecff8afdc
Specify association lookup
9 years ago
30c9fee0b2
Specify ephemeral invitation signing
9 years ago
097b69dc1e
Loosely specify invitation storage
9 years ago
e0c55eeccf
Add initial identity server spec
...
More to come
9 years ago
f4f186baee
Add _cs suffix to client-server http APIs
...
I'm about to add identity service APIs, so differentiating is good.
9 years ago
c3c95d0c09
Fix grammar and add backticks for /sync
9 years ago
cc0dae3aeb
Deduplicate a couple of places where "the" was written twice in a row
9 years ago
5407cc8e05
Add a snippet of documentation for a m.push_rules event.
9 years ago
3d4d91a462
Reword to make sense
9 years ago
167a08a805
Allow idle timeout to be configurable
9 years ago
bc68177471
Grammar
9 years ago
f1a8306d08
Spec currently_active time and idle timeout behaviour
9 years ago
68a4306773
Split room previews into a separate module
...
Guest access and room peeking are orthogonal
9 years ago
740f775932
Fix a couple of typos, remove .m.rule.member_event
9 years ago
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
5d85e3a505
Remove indents
9 years ago
afe7638e30
Add a new title level to appease gendoc
9 years ago
b16af5ef64
Fix JSON, add headers
9 years ago
8a1a02a11b
Update the predefined push rules in the spec
9 years ago
6925547875
remove the oversimplification that the WebRTC standard is based around two-oparty communication
9 years ago
b2e0a855cc
Add 'event' to event context API
...
also link through to the event schemas
9 years ago
0da26cd7e1
Specify login behaviour for unknown 3pids
9 years ago
245e8e8571
Add 3pid password login to the spec
9 years ago
2e46b587b8
Require explicit un-banning
9 years ago
169cc98101
M_INVALID_USERNAME to be consistent with the name of the parameter
9 years ago
2301a792d7
Add an error code for invalid user names.
9 years ago
9bc07ea093
Add ID to application services
9 years ago
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
91fa78eb53
Start development on next spec version
9 years ago
cff1b4ae35
Merge pull request #251 from matrix-org/daniel/guestshiz
...
Clarify guest /events and /sync
9 years ago
411ab64712
fix misnamed key in example; thanks SkaveRat
9 years ago
3edff684a1
Merge pull request #253 from matrix-org/daniel/guestupgrade
...
Guests can upgrade to regular accounts
9 years ago
f6b1b80678
Fix param name
9 years ago
7d9547274c
Clarify guest /events and /sync
9 years ago
5e30d75ccb
Add /_matrix/versions to spec
9 years ago
713415015b
Remove mention that /sync takes an inline filter
9 years ago
d3f05ae49a
Guests can upgrade to regular accounts
9 years ago
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
c9ecfa7643
Merge pull request #242 from matrix-org/paul/federation
...
Don't need to document /pdu/ any more
9 years ago
1f876778b5
Don't need to document /pdu/ any more
9 years ago
0a2bdb1818
Merge pull request #240 from matrix-org/paul/federation
...
Document the `/event` and `/backfill` S-S APIs
9 years ago
116253b2f5
Document the /event/:event_id/ federation endpoint
9 years ago
e4dd346a81
Restore 'client behaviour' section
...
Because it's the standard
9 years ago
b7c255a887
Tweaks/clarifications to search spec
...
Fixes https://matrix.org/jira/browse/SPEC-305
9 years ago
34bab312d3
Merge pull request #231 from matrix-org/daniel/oldversions
...
Add links to old releases
9 years ago
b9bee6ee73
Initial hack at some federation /backfill documentation
9 years ago
f8f76794a3
fix random whitespace bug
9 years ago
678dbbe08a
s/-/_/
9 years ago
7f87760655
Add links to old releases
9 years ago
8d184570a8
Mention intro before specs
9 years ago
997f3303f3
Revert "Add links to old releases"
...
This reverts commit de12870791
9 years ago
de12870791
Add links to old releases
9 years ago
53a21fc0b6
Note why we're not versioning index and intro
9 years ago
8eb84612f2
Add index page
9 years ago
a484f04b33
Merge pull request #221 from matrix-org/daniel/pushaway
...
Merge pull request #221 from matrix-org/daniel/pushaway
9 years ago
bca3add9a7
Formatting
9 years ago
d01ff6b495
Add noddy push gateway placeholder
9 years ago
f22adad02e
Merge pull request #225 from matrix-org/daniel/links
...
Add link to speculator
9 years ago
c96848d1bc
Merge pull request #169 from matrix-org/erikj/search_yet_agian
...
Search: Document event context, groups and orders.
9 years ago
4be078440d
Don't mention server-server stuff in client-server spec
9 years ago
c4085b0475
Merge pull request #139 from matrix-org/erikj/event_context_api
...
Add event context api swagger
9 years ago
fd3dde5e88
Add link to speculator
9 years ago
e32070f189
Decide that joining HS is the one that specifies the join event ID
9 years ago
a2283f5499
Remove /notify from client-server API
9 years ago
217e22fc30
Format changelog more nicely
9 years ago
19dfafe376
Remove superfluous space
...
This causes a <dt> to get rendered around the <tt>s which breaks some
formatting.
9 years ago
dd276d4c4d
Add event context module
9 years ago
856dd9100e
Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian
9 years ago
2aef684e7e
Add list of required supported groupings
9 years ago
c61ae86102
Specify behaviour if server does not support pagination
9 years ago
3939ccf20c
Remove e2e drafts from master
...
This is now being tracked in the main spec, on the drafts/e2e branch.
9 years ago
39f43abbb7
Add per-API changelogs
9 years ago
705556634a
Add filters
9 years ago
72e12bc2f5
Merge pull request #205 from jimmycuadra/signing-details-typo
...
Fix typo in signing details
9 years ago
444fc5dbcd
Fix typo in signing details.
9 years ago
873b0dcecf
Replace version numbers with release numbers
9 years ago
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
f308b7543c
Specify /admin/whois/{userId}
9 years ago
19ce17cfed
Merge pull request #200 from matrix-org/daniel/redact
...
Merge pull request #200 from matrix-org/daniel/redact
9 years ago
4baba85fe5
Draftify e2e in anticipation of a spec release
9 years ago
2f3a00fe34
Consistently spell homeserver as homeserver
9 years ago
e072d215cf
Specify redaction
9 years ago
b946d39886
typo
9 years ago
c05da871ca
Merge pull request #194 from matrix-org/daniel/clarify
...
Merge pull request # 194 from matrix-org/daniel/clarify
9 years ago
aa4ed10821
Unify v1 and v2 event schemas
9 years ago
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
f6229f649a
Remove confusing wording
9 years ago
fd88be1830
Merge pull request #189 from matrix-org/daniel/sections
...
Merge pull request # 189 from matrix-org/daniel/sections
9 years ago
23b2497743
Expand on where pagination tokens can be returned
9 years ago
46fd0b252c
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian
9 years ago
c6e0322a9e
Swaggerify /account
9 years ago
c9c433bc15
Make section depths consistent
9 years ago
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
b479b54cd8
Add tables of contents to individual specs
9 years ago
e401d3e262
Merge pull request #184 from matrix-org/daniel/splitspec
...
Split spec into page-per-section
9 years ago
e171acf01f
Split spec into page-per-section
9 years ago
bc514dc9c4
Merge pull request #178 from matrix-org/daniel/directory
...
Fix and include /directory api docs
9 years ago
7f2813354d
Swaggerify /ban
9 years ago
a20a49abf6
Merge pull request #168 from matrix-org/markjh/client_config
...
Add API for setting client config
9 years ago
c5f457cee9
Merge pull request #132 from matrix-org/markjh/room_tags
...
Document a v2 api for setting tags on rooms
9 years ago
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
ad4d8ae7a6
Move client-server intro to client-server section
9 years ago
0b1ba70a32
fix rst markup
...
`` > `
9 years ago
2dbb8ba56c
Fix title levels
...
make the title decoration consistent with the rest of the spec
9 years ago
51ca25a472
Merge branch 'master' into markjh/end_to_end_encryption
9 years ago
5f4458b2ff
Merge branch 'master' into markjh/end_to_end_encryption
9 years ago
8d41536757
Address kegan's comments
...
Minor fixes to the e2e spec as raiseds by kegan
9 years ago
5e30b5b8d7
Remove POST version of /send
...
PUT should always be used.
9 years ago
c25a806cef
Fix and include /directory api docs
9 years ago
e76068a2a6
Merge branch 'markjh/room_tags' into markjh/client_config
9 years ago
5bae15d47b
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
d8dd380dfa
Merge pull request #164 from matrix-org/rav/SPEC-254
...
Fix /sync documentation, post SPEC-254
9 years ago
032ee75537
Update specification wording to match s/config/account_data/
9 years ago
05c0092664
s/config/account_data/
9 years ago
e95a1616af
Merge pull request #143 from matrix-org/paul/federation-room-join
...
Document the federation remote join handshake
9 years ago
40f7eab73f
s/private_user_data/account_data/
9 years ago
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
fcbb985073
s/private_user_data/account_data/
9 years ago
6653362f31
Unflatten 'unsigned'
...
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
9 years ago
8201eaa042
Swaggerify /rooms/:room_id/leave
9 years ago
373c6c8270
Add ordering, pagination and grouping comments
9 years ago
c77b22778f
Add some documentation on names of tags
9 years ago
25769493b1
Fix template
9 years ago
e7fbe6f13b
Limit the size of a tag
9 years ago
48f35e15cb
describe how to order rooms that don't have an order in their tags
9 years ago
299af673da
Specify how ordering of tags is supposed to work
9 years ago
7ff593b3de
Merge branch 'rav/SPEC-254' into rav/flatten_sync
...
Conflicts:
specification/events.rst
9 years ago
3b390bff3c
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
0db055b4ea
Fix another reference to 'txn_id'
9 years ago
8f5783615c
Merge branch 'master' into markjh/client_config
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
233e8486bc
Wording fix - objects contain keys, not list elements directly
9 years ago
c3769ef75c
Add a module for client config to the specification
9 years ago
6cbfba7011
'auth_events' is a List, not a String
9 years ago
122c082fcf
Comment about origin servers of invites having subsequently left the room
9 years ago
923f05e554
More consistency around 'resident homeserver'
9 years ago
36af793f05
s/full object/full event/
9 years ago
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
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
988d773476
/make_join protoevent no longer needs the pointless 'prev_state' key (SYN-517)
9 years ago
885dd1e86c
Explain the 'prev_events' join protoevent key
9 years ago
db5a90edcd
Avoid using the words 'current state' when talking about the result of the /make_join request
9 years ago
aac45295ee
Remark that the directory server step could be skipped in an invite case
9 years ago
d7c69fae43
Fix typo 'process'
9 years ago
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
29d9c8eec6
Guests are allowed to set displaynames
9 years ago
061105c9dc
Guest users are allowed room initialSync
9 years ago
d7357ef9b7
Specify /publicRooms
9 years ago
24c2036a35
3pid invites: remove mentions of display_name
9 years ago
e72151f2c3
Specify guest room access
...
This was reviewed as PR #150 and merged from daniel/anonymousaccess
9 years ago
161441fa3a
Update 3pid spec based on new implementation
9 years ago
8cba11b1cd
Add some links to spec bugs for display names
...
Just added a couple of TODO comments to useful jira bugs
9 years ago
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
3953006792
Fix spelling
9 years ago
f6c55979e0
Remove TODO comment about SYN-490 as it's unlikely to matter for v1; we'll fix it in v2
9 years ago
40fa339cf7
Draw a pretty (well at least I think it's pretty) ASCII diagram of the remote join handshake
9 years ago
149890227a
Fix wording
9 years ago
52f55e0542
Allow room tags to have asssociated content, and return that content in the m.tag events
9 years ago
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
d297d83151
Mention that sender is renamed to user_id in v1
9 years ago
d067e50af5
Document the differences in event formatting between the v1 and v2 client APIs
9 years ago
5b6f858802
Some initial notes by way of the remote join handshake; with several TODOs and unanswered questions
9 years ago
745e607577
Use 'room' or 'room ID' instead of 'context' when describing federation protocol
9 years ago
65066a76b3
Add the m.tags event to a ``private_user_data`` key rather than including it under the ``ephemeral`` key
9 years ago
9b0d20315a
Add the tags module to the specification targets
9 years ago
12e33a3b09
Document a v2 api for setting tags on rooms
9 years ago
13eddd456f
Proposal for adding full_state param to v2 sync
9 years ago
696f75d80b
Rename section
9 years ago
e2376e9a43
Merge branch 'erikj/login_fallback_v1' of github.com:matrix-org/matrix-doc
9 years ago
3cf431cac1
Add link
9 years ago
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
9a5bd6d21f
Use static
9 years ago
98dbf4d60b
Better flow
9 years ago
0529b4a9a2
Reword
9 years ago
88c459d549
Add back in login v1 fallback API
9 years ago
7c250f91ff
Merge pull request #127 from matrix-org/daniel/exposedrooms
...
Allow history to be noted as world-readable
9 years ago
4823a133cd
Merge pull request #124 from matrix-org/clarify_scale_crop
...
Clarify 'scale' & 'crop' resize methods
9 years ago
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
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
1d7cb6937f
Merge pull request #123 from matrix-org/markjh/list_formatting
...
Fix list formatting
9 years ago
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
67880686d5
Allow history to be noted as world-readable
...
SPEC-237
9 years ago
587a8ba7ce
Merge branch 'master' into rav/send_events_api
9 years ago
d18d406c41
Add the room send and state APIs to the spec
9 years ago
01064369a4
Add some clarification on the difference between 'scale' and 'crop' resize methods
9 years ago
e3e8026025
Fix list formatting so that we aren't including everything in blockquotes
9 years ago
f0c74a9c83
Merge pull request #96 from matrix-org/erikj/search_actual
...
Add search API
9 years ago
4a558ad63b
Typo
9 years ago
f95d19cecd
Merge branch 'master' into appservice-swagger
...
Conflicts:
specification/application_service_api.rst
9 years ago
74d42f0142
Allow rejecting invitations
9 years ago
e38e4788f2
Spell 'cryptographic' correctly
9 years ago
228acc59aa
Capture cryptographic test vectors for JSON or event signing from source code
9 years ago
84a8663019
Merge pull request #115 from matrix-org/paul/event-redaction
...
Initial attempt at describing the event redaction algorithm
9 years ago
9252b3e1a2
Fix typo s/he/the/
9 years ago
bfa9937bdc
Minor wording updates
9 years ago
a9a9067d7e
Merge pull request #114 from matrix-org/daniel/3pidtosigned
...
Update 3pid invite section to reflect signed property
9 years ago
1d01f69c3c
Merge remote-tracking branch 'origin/master' into erikj/search_actual
9 years ago
111ca99519
Clarify that this doesn't include events that occurred after you left the room.
9 years ago
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
f3088a0674
Merge branch 'master' into spec-182-asapi-user-creation
9 years ago
26f27d95fb
Merge branch 'master' into registration-swagger
...
Conflicts:
specification/client_server_api.rst
9 years ago
ae90d15b3c
Add m.room.avatar
9 years ago
c70067dd1e
Simplify language
9 years ago
22fdb8f911
Merge branch 'master' into daniel/as
9 years ago
29720cd152
Initial attempt at describing the event redaction algorithm
9 years ago
6161a920b6
Update 3pid invite section to reflect signed property
9 years ago
62d53b4f33
Review comments round III
9 years ago
85a6a5a530
Merge branch 'master' into proofing
9 years ago
4bb042daeb
Review comments round II
9 years ago
e0fe3c42c8
Review comments
9 years ago
6770d6b2d6
Review comments
9 years ago
20b11281ea
Remove lies about OAuth which doesn't exist
9 years ago
eb59b8e9d1
Mention count
9 years ago
a6cb2e4339
Mention rank
9 years ago
eca98af896
Swaggerify /register endpoint
...
Need to move registration/login/auth sections around once #94 lands.
9 years ago
24e36adbe3
Mention e2e encryption
9 years ago
770cfbc5de
Be explicit about the events the search is performed over
9 years ago
906c59385f
s/had/has/
9 years ago
55cc5c5bb5
Swaggerify application services
9 years ago
3d087df538
Kill number prefixes for good
9 years ago
6b72ddfb8c
Spelling and typos
9 years ago
08ccacae17
Merge branch 'master' into proofing
...
Conflicts:
specification/0-intro.rst
9 years ago
c47a94658a
Mention supported keys
9 years ago
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
604e268add
Merge pull request #105 from matrix-org/spec-177-events-max-len
...
Add in size limits as per SPEC-222
9 years ago
5de63b4f45
Merge branch 'master' into proofing
...
Conflicts:
specification/0-intro.rst
9 years ago
af347baa68
Better phrasing
9 years ago
96a4996c76
Mention search categories
9 years ago
3a2c8cd4b3
Merge pull request #91 from matrix-org/module-history-vis
...
History visibility module
9 years ago
5aad67f74d
Review comments round III
9 years ago
c5dc383668
Merge pull request #85 from matrix-org/module-im
...
Instant messaging module
9 years ago
507cb29e39
Review comments round deux
9 years ago
f51ee70633
Review comments round 2
9 years ago
c82c07ddd2
Review comments
9 years ago
c4d1b56843
Add a comment about enforcement.
9 years ago
1229ad24dd
Merge pull request #103 from matrix-org/spec-165-mxc-security
...
SPEC-165: Outline directory traversal attacks on MXC URIs
9 years ago
bc0ab32cfd
Merge pull request #99 from matrix-org/spec-144-https-examples
...
SPEC-144 : Use https examples not http
9 years ago
e6eb19c461
Review comments
9 years ago
728b5a7951
Add very short summary
9 years ago
007bb1a69a
Add extra new line
9 years ago
5e48b0b79a
Add search to targets
9 years ago
38fcc563da
Spell out full title
9 years ago
0efa3fd981
Add module
9 years ago
6a0595bc46
Add in size limits as per SPEC-222
9 years ago
d8bc0c9315
Add search module
9 years ago
f0d8052951
SPEC-205: Warn about password strengths in m.login.password section
9 years ago
44b19a8b0e
SPEC-165: Outline directory traversal attacks on MXC URIs
9 years ago
45b1d08c7e
SPEC-207: Add a warning about needing AS tokens to be unique and why
9 years ago
cd34d4e19b
SPEC-182: Make it clearer how ASes are supposed to create users by linkifying the right text.
9 years ago
3608f3a282
SPEC-144 : Use https examples not http.
9 years ago
34bd8edec5
Move related auth sections together
9 years ago
6f6861a11d
Swaggerify the createRoom API
9 years ago
07d7a3fa3a
Shuffle pagination section around
9 years ago
7bdb71b1c9
Tweak the syncing section
...
Bring together disparate sections to make it more cohesive.
9 years ago
e716e81963
Add `dir` parameter to pagination. Remove path references
...
This section needs a lot of work to not lie.
9 years ago
e561a663d3
Tweaks to intro, start using swagger APIs in the CS API section.
9 years ago
4170dbd5cf
Review comments
9 years ago
173d00cea0
Review comments
9 years ago
2502ca7ac6
Merge branch 'master' into daniel/threepidinvites-2
...
Conflicts:
specification/targets.yaml
9 years ago
4a1fb74897
Review comments
9 years ago
8f5c796884
Linkify 'pushers'
9 years ago
e378de8379
Shuffle history visibility module to be in the module format
9 years ago
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
dc3c02aff5
Review comments
9 years ago
21a40b317d
Merge branch 'master' into daniel/threepidinvites-2
9 years ago
9c95ee5c1f
Modify wording and formatting
9 years ago
31ae4b3859
Swaggerify push notification API
...
Edit units.py to support nested JSON request keys
9 years ago
a9618a981b
Swaggerify the /enabled endpoint
9 years ago
56ce432399
Get profile tag keys displaying correctly.
9 years ago
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
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
d3ed517ebf
Finish laying out rough sections
9 years ago
a7400508c6
Define module titles from the template
9 years ago
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
91ca36509b
Flesh out IM module
9 years ago
656bee78c4
Merge branch 'master' into module-im
9 years ago
7ae2573113
fix barefaced lie regarding the passivity of ASes
9 years ago
39faccb00d
CS API is not just v1 surely
9 years ago
8e5c832ff9
Flesh out more of the IM module
9 years ago
47cf958b54
Merge branch 'master' into module-im
9 years ago
3b4c3522e6
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/disable_federation
9 years ago
8c092e3d11
Merge pull request #74 from matrix-org/module-presence
...
Presence module
9 years ago
417c5b53c4
Remove duplicate sentences from merge conflicts
9 years ago
b29fdebec2
Give example of verification dance
9 years ago
458383585f
Stub sections
9 years ago
ead79614ff
Merge pull request #78 from matrix-org/module-typing2
...
Typing module
9 years ago
9d8dc7971d
Review comments
9 years ago
68df99409a
Merge pull request #83 from matrix-org/module-content-repo
...
Content Repo Module
9 years ago
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
09ac367847
Merge branch 'master' into module-content-repo
...
Conflicts:
templating/matrix_templates/units.py
9 years ago
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
912a8ca760
Be more explicit about keys that are clobbered
9 years ago
dbc72c43ac
s/private_chat_shared_power/trusted_private_chat/
9 years ago
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
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
8aad238cda
Merge pull request #80 from matrix-org/module-receipts
...
Receipts module
9 years ago
da2be7eae4
Merge branch 'master' into module-voip
...
Conflicts:
specification/modules/voip_events.rst
9 years ago
1520f3647f
Merge branch 'master' into module-typing2
...
Conflicts:
specification/modules/typing_notifications.rst
9 years ago
cc6f256b24
Merge branch 'master' into module-presence
...
Conflicts:
specification/modules/presence.rst
9 years ago
6000887201
Merge branch 'master' into module-receipts
...
Conflicts:
specification/modules/receipts.rst
9 years ago
c972dad8b3
Flesh out receipts module. Add receipts swagger
...
Add templating support for v2 apis.
9 years ago
4a7a682c0f
Merge pull request #65 from matrix-org/spec-feature-profiles
...
Spec feature profiles
9 years ago
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
3b73b07bab
Clarifications that room invites are m.call.invites not actual invites
9 years ago
e82661413e
Add /turnServer endpoint
9 years ago
d092b22848
Rename to 'Managing history visibility'
9 years ago
6c3e70d272
Start fleshing out voip module
9 years ago
91b6347f74
Explain what 'embedded' clients are
9 years ago
be9402b66f
Move feature profiles section to modules as a sub-section
9 years ago
0320e8cef3
Table tweaks from PR
9 years ago
097dc50180
Minor tweaks
9 years ago
a82f2ad4ac
Flesh out typing module
9 years ago
2b7e02c080
Add sections for typing. Add swagger, JSON schema and example m.typing event
9 years ago
52f6496cf0
Merge branch 'master' into module-presence
9 years ago
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
069e4e39f4
Move presence specific sections from intro to presence module
9 years ago
73b4090f52
Add private_chat_shared_power
9 years ago
0a04672d76
Start converting the presence module. Add Rationale admonition.
9 years ago
cdf9f011e9
Add room history visibility as a module.
9 years ago
82c27884ba
Make E2E optional
9 years ago
83b9497664
Add context and example
9 years ago
c96f02c2b0
Merge pull request #69 from matrix-org/erikj/login_token
...
m.login.token
9 years ago
6e6bc8a5a9
Mandate macaroon
9 years ago
ce53a17180
Add txn_id rationale
9 years ago
4776e0c04c
Add creation_content key
9 years ago
5abea1f2bc
Minor tweaks
9 years ago
70518ae655
Clarify template suffixes
9 years ago
643468e914
Mention swagger. Clarify how event type template vars are formed.
9 years ago
c2fc1a2fb1
Add basic module template.
...
This has the core sections for events/server/client/security.
9 years ago
db8f3c0d59
Desktop clients should have a GUI
9 years ago
97154cc6b2
s/nonce/txn_id/
9 years ago
4c9f524cab
Neaten things up
9 years ago
317c2f20d3
Draft login token spec
9 years ago
510553ee00
Remove smurf suffixes. Add anchor for feature profiles.
9 years ago
9fac152d32
Explain what the clients are and the column reference
9 years ago
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
18dc7784df
Mention precedence
9 years ago
078dd0165f
Update the room creation API spec to include new keys: 'preset' and 'initial_state'
9 years ago
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
29bae15790
Fix typo
9 years ago
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
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
b49cb57fe5
Move events sections to CS API
9 years ago
16693a644a
Various review fixes
9 years ago
b0eb985523
Merge branch 'master' into spec-restructure-modules
9 years ago
0c0ac3e814
Fix common event fields template to use subtitle char
9 years ago
e8cdfcbba2
Rename spec files to not have numbers everywhere; update targets.yaml
9 years ago
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
067363c629
Get the desired title levels right; print out the actual level used to stdout
9 years ago
8590cc84b5
Process and extract targets in gendoc.py
9 years ago
568982ee2e
Represent nested deps in targets.yaml along with title styles
...
This will allow us to programatically position .rst snippets *anywhere*
which will for once and for all remove the horrid title level mismatch bugs.
We require this in order to allow people to re-shuffle the spec without
having to adjust the spec itself (e.g. 2 targets with different levels of
nesting).
9 years ago
703f913a47
Add a 'targets.yaml' files in /specification
...
We're well beyond the point now where a simple `cat` of .rst files to "build"
the spec is practical. We may want to slice and dice the spec in different
ways to address various cross-cutting concerns. To this end, there is now a
'targets' file which contains the "build targets" for the spec, which contains
the sorting order for the .rst files. For now, we just have a single
target: 'main'.
9 years ago
f520ac9d82
Create a modules folder to group together similar parts of the spec
9 years ago
c77ef1a2cc
Add stub files feature_profiles and modules
9 years ago
f2c952ec58
Reshuffle spec into sections roughly right as per PR #52
9 years ago
f33c0846c3
Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api
9 years ago
1f6b12b3e8
Modify and enforce the file format/structure used
...
Convert the file format to be of the form ##_##_something.rst where the
first ## is the top-level section number and the second ## is the
second-level section number, e.g. 07_01_push_cs_api.rst means
Section 7.1 - This is now enforced in gendoc.py along with the title line
style that should be used (= for top-level, - for 2nd level) which will
give helpful suggestions if you trip up. This feels much more intuitive
now looking in /specification
9 years ago
9ed39665c8
PR feedback
9 years ago
8e7b33ac99
Fix more typos/spelling errors
9 years ago
3f9d183c2a
More typo/layout fixes
...
Split out identity servers to a separate file
9 years ago
620d3dcb26
Test commit
9 years ago
faa95e172f
More formatting fixes; typos; etc
9 years ago
af32ec194a
Move VoIP events to 22_voip_events
...
20_events is a huge as it is, this makes it easier to find what section
you actually want when editing.
9 years ago
5b59c67510
Minor formatting fixes. Fix state event templating.
9 years ago
7eb8b4fde2
Add new-style docs for the APIs for getting events for a room
9 years ago
59a4e84361
s/registration/login/
9 years ago
b8e2ac5c1b
Swaggerify /login
9 years ago
e788f565f8
Merge pull request #36 from matrix-org/daniel/threepidinvites
...
Swagger /room/{roomId}/invite
9 years ago
3011823c51
Merge pull request #27 from matrix-org/receipts
...
Document receipts
9 years ago
2797fac3aa
Swagger /room/{roomId}/invite
...
This is a transcription of the current spec, with nothing new or
controversial in it.
9 years ago
04b2b2588f
Fix up formatting and typos
9 years ago
d53943c8c2
Spec /room/{roomId}/join
...
This is just replacing the existing spec with a swagger version.
Subsequent pull requests will add 3pid join to this, as well as specing
the invite, leave, ban, and kick endpoints.
9 years ago
80bb51d9bb
Make it clearer
9 years ago
4b24b887c7
Document m.room.history_visibility
9 years ago
83dfc2bf61
Fix some mistakes/typos
9 years ago
0dc22e7217
Document receipts
9 years ago
49c52a96a7
Rename 'perspective server' to 'notary server' as that's what the Perspectives Project calls them too
9 years ago
880bf20403
Merge pull request #21 from matrix-org/paul/fixes
...
Three small fixes
9 years ago
7d805f105e
Mention that Olm uses AES in CBC mode
9 years ago
88176ef148
Add notes on algorithm naming. Fix some typos
9 years ago
c6f2f711de
Mention AAAA as well as A records; remark on default port 8448 for no-SRV fallback
9 years ago
d06580a481
Spelling
9 years ago
e1f201f9e6
Add description of the olm type and body JSON keys
9 years ago
c83e8480e8
Fix JSON syntax
9 years ago
6597aaa448
Start describing the plaintext payload format for encrypted messages, add the exact URLs used for key queries from clients and for key queries for federation
9 years ago
41d204e72c
Name the key 'ciphertext' rather than 'ciphertexts'
9 years ago
6f69707c71
Update e2e spec: Group ciphertext by device key rather than device id, add return to docs for /keys/upload, Use "m.room.encrypted" for now, rather than trying to add an encrypted content to arbitrary event types
9 years ago
42ad1f8612
Add a link to signing JSON section of the spec. Fixup the markup a bit
10 years ago
01927cee9b
Rename "take" to "claim". Hyphenate "one-time".
10 years ago
36e035c79e
Add some specification for end-to-end
10 years ago
f08588bf7e
typo
10 years ago
5f391b5617
Also document the directory server federation API
10 years ago
fc1e01f373
Add a small note about the meaning of the 'target' field
10 years ago
af1616ba9a
Merge branch 'master' into paul/fixes
10 years ago
28894ac1b7
Bugfix to embedded sign_json() python code
10 years ago
9b046cbc04
Tiny fix to embedded YAML fragment
10 years ago
e572cc662a
Restructure the first few sections.
...
Remove unecessary sections; put presnece/profile sections on the right level.
Move Living Standard warning to the top of the Introduction section.
10 years ago
71e200a063
Remove version section.
10 years ago
e10859a887
Replace presence API with new template.
10 years ago
ec631c60d4
Add link to github commit for the spec as per request.
10 years ago
bb9537b824
Add a CHANGELOG. Modify table CSS.
...
Hook up templating system to read the CHANGELOG for version and changelog info.
Modified nature.css to make it clearer on table headings/sub-headings. Use the
full _matrix/client path on title links to make it clear it is for v1.
10 years ago
f134728268
Link to msgtypes from the description of m.room.message.
10 years ago
51df65bb49
Remove old power level references. Link to m.room.power_levels.
10 years ago
ac7ccfa622
Add {{presence_events}}. Factor out common code in MatrixSections.
10 years ago
6f330bd879
Gut the old msgtypes section and replace with {{msgtype_events}}
10 years ago
f5059057b3
Update AS API docs (wording/layout tweaks, rationale).
10 years ago
9d532f30e8
Add {{voip_events}}. Add more info on sections when asked via build.py -s
10 years ago
89083b3a86
Add {{spec_version}}. Update build.py module docs.
10 years ago
96671ce833
Use the templating system to set {{git_version}}. Restructure sections code.
...
Restructured the sections code to be slightly more encapsulated than before.
This will be expanded to more clearly separate the templating system from
the specific implementation of the spec templates.
10 years ago
ed4ce6950c
Template up common event fields from the 'core' json schema file.
10 years ago
02c44a889e
Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars.
10 years ago
e729a9e425
Merge pull request #16 from matrix-org/key_v2_fixes
...
Add minimum_valid_until_ts to key/v2 API
10 years ago
fa1ec93c78
typo
10 years ago
39b3de1df3
remove AS register/unregister APIs from the spec for now, but keep the useful info intact
10 years ago
580b4a1787
Merge pull request #15 from matrix-org/csauth
...
Document CS API V2 auth changes and new APIs.
10 years ago
9752dc399e
Update 30_server_server_api.rst
...
Missing '$'
10 years ago
9bfbbce0f4
Update 30_server_server_api.rst
...
Use a query parameter for minimum_valid_until_ts for the GET version of the query api.
10 years ago
cdcaf69fb5
Update 30_server_server_api.rst
10 years ago
deb17914ca
Link syntax
10 years ago
199bb87ffa
Add link to v1 docs.
10 years ago
3343b7f84d
Clarify n-factor auth and add the diagram back in as an example
10 years ago
e7d334c5cd
Kill all camels
10 years ago
233522b612
Fix typo
10 years ago
a52819ba69
Clarify dummy auth
10 years ago
fa8d8a9f95
Remove spurious array in error example
10 years ago
cfbc58c4fb
Forgot bind_email param on register.
10 years ago
52692931d7
fix typos
10 years ago
e52146e47f
V2PREFIX
10 years ago
dd12d901af
Oops: missed recaptcha. Also make list in the same order as the details.
10 years ago
b71aaddad0
Try & fix RST errors
10 years ago
c583bf9570
wrong title level
10 years ago
8495d9451e
Document CS API V2 auth changes and new APIs.
10 years ago
04086975bd
fix header depth
10 years ago
4255058680
typo
10 years ago
dacf93b405
oooooops, apparently I forgot to 'git add' these when I refactored the spec last month :-/
10 years ago
6f269890be
Add a brief reference to the perspectives project and mention what should happen if a server goes offline
10 years ago
0db3182159
Describe what the expired_ts is
10 years ago
4422e9ca2b
Add a short summary of how the v2 key api is supposed to be used
10 years ago
ed21f50cc3
Add version 2 of the server key distribution API
10 years ago
3f5a94484f
Update spec where I changed it to allow omiting value for highlight
10 years ago
0f1514febb
standardise on <foo> rather than :foo
10 years ago
c0e55bb99e
make intro match order of sections as per max g-j feedback
10 years ago
07c4d6cd21
Add append flag to pushers to support multiple accounts.
10 years ago
c1d7e82d29
rst fail
10 years ago
9ff5456b5e
fix sections a bit more
10 years ago
0c6bd900a3
fix sections a bit
10 years ago
c3f29ea720
Merge branch 'master' into ua925_reshuffle
10 years ago
58c28598af
lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13
10 years ago
598e9b3113
big reshuffle:
...
* try to make 00_basis slightly more accessible and less terse
* move CS API before Events, as it's meaningless to dive into specific events if you haven't been introduced to how the CS API works
* Try to improve the beginning of the CS API by merging back in some of kegan's original v1 content (which has subsequently been deleted somewhere along the line?)
* document m.presence event consistently
* move typing from drafts to spec
* move push stuff from drafts to spec
...and lots of other stuff
move push & typing from drafts into main spec.
10 years ago
d552a043f8
remove LI section entirely until we decide how best to discourage it, otherwise it looks like we're endorsing it
10 years ago
006932c70f
Be clearer when specifying the version of the spec.
10 years ago
5a0e40b984
Mark CS API as v1 in the spec.
10 years ago
4b0e858529
Add $GIT_VERSION to the spec which is replaced by the gendoc script.
10 years ago
42857df26f
Syntax fixes
10 years ago
8e75c5ed67
Add in passive application services
10 years ago
f60c0ac96b
Fix indentation levels on specification.
10 years ago
a9a4c46a57
Add spec for m.notice (SPEC-18)
10 years ago
62471348ca
This is a comment, not a directive. Remove ::
10 years ago
109c8a97a8
Use title heading sizings of =,-,~,+ since that is what most of our docs use. Inconsistent use breaks when you try to merge them.
10 years ago
5d177b0e18
mention event deduplication
10 years ago
cef1e784f9
general editing throughout the overview section; merge in bits of erik's model to overview section and split the original back out into drats
10 years ago
e2b49cc20f
remove spurious sender_ts info and spec out m.file
10 years ago
b3f99f9bf7
typo
10 years ago
3fd1833bc5
Add more reasonable example for unsigned data in json signing example
10 years ago
2d5bb01a63
add in version, improve AS API a bit, move eventstream to the right place
10 years ago
b2295b9bc7
Add docs on server discovery
10 years ago
b7708a9b88
Move the request signing docs to the right bit of the spec
10 years ago
3873a219f9
SPEC-33: Add server to server request authorization to the specification
10 years ago
f4df22f7ef
shuffle the server-server chapters a bit, and split out security model and other miscellanei into a new appendices chapter. Add a vestigial application services section
10 years ago
2c9707633e
tone down warning
10 years ago
2f1f37cc4c
formatting, whitespace, and some rephrasing for clarity
10 years ago
64f56a15d7
fix english and whitespace
10 years ago
e5cb7aae07
Add some documentation for event signing
10 years ago
b73645ad8f
Try turning on syntax high-lighting for JSON examples
10 years ago
19e326d305
Reword introduction to federation API to mention event signing
10 years ago
36fa322c5d
Improve formatting and update PDU and transaction key names
10 years ago
5e4b8798a4
Nicer formatting for the PDU field documentation
10 years ago
ae27cbe1a4
Put client-server links into the correct file
10 years ago
7e244e8a0d
remove trailing whitespace
10 years ago
969cc408f1
Spelling and removing WIP warnings (as everything is equally WIP)
10 years ago
eeb596b20b
merge core_model into spec
10 years ago
8b4a35e341
as per the big spec meeting, split specification.rst into 4 chapters. merge in specification-NOTHAVE and spec-additions.rst whilst at it.
10 years ago
556e3f8a71
move matrix-generic documentation from synapse/docs into new matrix-doc project
10 years ago
Matthew Hodgson