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
ec20f15407
/tokenrefresh should expire the access token
...
It's possible for clients to call /tokenrefresh before the access_token has
expired, potentially leading to a proliferation of valid access_tokens.
8 years ago
2370a4c970
Spell out the state algorithm for createRoom
...
Fixes https://matrix.org/jira/browse/SPEC-429 .
Synapse currently follows the specified ordering, but does *not* give the
specified error when the state is invalid (instead it creates the room anyway
but gives a 403 M_FORBIDDEN). Still, I don't think that should be a real
problem for any real clients, and nothing would break if we changed this in
synapse, so it might as well go in the spec anyway.
8 years ago
c0490f2db2
cosmetics
8 years ago
a64f9bbb63
C-S spec: Fix 'unstable' in link to /context API
8 years ago
b5f9e896ba
C-S spec: Fix 'unstable' in link to /context API
8 years ago
a2ab6854ff
CS spec: Add r0.2.0 to historical version list
8 years ago
ae489260a1
Merge pull request #359 from matrix-org/rav/mxid_grammar
...
Define MXID grammar
8 years ago
72449294bc
Moar TODO
8 years ago
a2f1c6a7a6
Add a TODO about defining non-latin login creds
8 years ago
cdd19dca7f
fix typos
8 years ago
f942b6e5c1
remove some redundant words
8 years ago
001db45046
s/mxid/user id/, and other PR feedback.
8 years ago
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
8ac45d7948
Merge pull request #353 from matrix-org/rav/room_membership
...
Clarify the room-membership APIs
8 years ago
0c06ea0e67
Merge pull request #356 from matrix-org/rav/fix_redaction
...
Fix name of prev_content to preserve on redactions
8 years ago
a9d3cfd13c
Merge branch 'master' into rav/link_undeprecated_endpoints
8 years ago
d92515bce3
Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
...
Move /room/x/initialSync to after the undeprecated APIs
8 years ago
d8a47dbb5d
Merge pull request #352 from matrix-org/rav/kill_old_sync
...
Remove references to intialSync etc, and rewrite syncing
8 years ago
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
1c6eed5c35
Fix name of prev_content to preserve on redactions
...
The field is called prev_content, not prev_state.
8 years ago
6bcb1798f5
Mark deprecated endpoints with their replacements
...
Fixes https://matrix.org/jira/browse/SPEC-415
8 years ago
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
885e6797f2
Fix double-negative in room naming
8 years ago
4118ce6680
Add rationale to /sync
8 years ago
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
017935d8e9
Fix typo
8 years ago
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
7b4c21fa77
Add link to room name bug
8 years ago
d4194dd24e
Clarify the room-naming behaviour
...
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
8 years ago
4812be9142
Missing .
9 years ago
ead5648b8c
Add requestToken endpoints
...
For password reset and 3pid adding
9 years ago
ef4c03894d
Merge pull request #343 from matrix-org/dbkr/threepid_requesttoken
...
Spec for endpoint-specific 3pid verification token
9 years ago
df3f4b4ecf
Fix link to draft e2e spec
9 years ago
e4db7be8e2
Better structure for error response
...
& add server not trusted error
9 years ago
572aa24a88
Add M_THREEPID_IN_USE
9 years ago
b0194a3016
Spec for endpoint-specific 3pid verification token
...
As per proposal https://docs.google.com/document/d/13mapDbaOnbob9ZYRDiGm1YbeZhFOBj_R1OvgBA9pA5s/edit?pref=2&pli=1#
9 years ago
af091ff614
Document changes to the default push rules
9 years ago
30a3302921
Merge pull request #274 from matrix-org/markjh/default_rules
...
Update the predefined push rules in the spec
9 years ago
e80e32173f
Merge pull request #278 from matrix-org/erikj/presence
...
Update presence spec.
9 years ago
ec69f04793
Merge pull request #337 from matrix-org/rav/directory_docs
...
Improve documentation of directory API
9 years ago
7bbb664784
Improve documentation of directory API
9 years ago
92bb1c1b43
Update wording as per request from richvdh
9 years ago
a7e40bed88
Add powerlevel name to value list
9 years ago
099d356dfb
Add r0.1.0 to version list in C-S spec
9 years ago
e7e9f5fa46
Document the /logout api
...
We have one, and it's useful, so we really ought to document it
9 years ago
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
9 years ago
5cc9066159
Add git versions to other parts of the spec
9 years ago
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.
9 years ago
351bbee016
Remove changelog from index.rst
...
... since it's explicitly unversioned.
9 years ago
7d20d2d903
Add old-version links to C-S API
9 years ago
5b010de2b3
Fix typo
9 years ago
e68193d2e0
Attempt to clarify the spec versioning. Again.
9 years ago
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
Richard van der Hoff