3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
7 years ago
6612dbecf1
tweak wording for validation
7 years ago
d6c54b0278
unaccessible isn't a word
7 years ago
ca87876f1b
Clarify that the Authorization header is preferred
7 years ago
25d01aa431
Dedicate a section on how to use access tokens
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1042 .
7 years ago
fde48e7ee8
Specify how room versioning works
...
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425
Room version upgrades are not part of MSC1425.
Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions
Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
7 years ago
a264120b38
put server discovery as its own section
7 years ago
fcca80dad8
various minor fixes
...
- formatting fixes
- add examples to homeserver/identity server discovery schema
- replace DNS name with hostname
7 years ago
6a3cf10be9
Merge remote-tracking branch 'origin/master' into well-known
7 years ago
292d334509
document new login identifier object ( #1390 )
7 years ago
07aeaadef9
update links which used to point to docs/spec/intro
7 years ago
423d5593f5
Generify how OPTIONS and CORS are handled
8 years ago
ce1e2c0904
incorporate feedback from reviewers
8 years ago
0779d81e52
Clarify which requests should have CORS headers
...
Spoilers: all of them.
8 years ago
4ca54404fa
Document the CORS/preflight headers
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1006
8 years ago
0dd330962d
initial draft of .well-known discovery
8 years ago
cd26c170de
Specify token used in /login is not an Access Token ( #1155 )
...
* Specify token used in /login is not an Access Token
While working through the implementation of /login in Dendrite, it was
confusing what the contents of the token attribute in the login request
body referred to. Initially, I thought it was an access token, which led
to further confusion. This commit explicitly states that the token is a
login token, which is separate from an access token, hopefully reducing
confusion for future readers.
Signed-off-by: Andrew Morgan (https://amorgan.xyz ) <andrew@amorgan.xyz>
8 years ago
4d90d2b495
fix depr link
8 years ago
7e94cd5a0b
Typo in client-server spec: ether -> either
8 years ago
784adade9b
changes based on Pull Request feedback
8 years ago
3d8fe6e090
merge profiles with user directory into user data, also fix typo
8 years ago
97445195f6
add user_directory
8 years ago
e9c1b87a1d
Remove `git log` reference
...
We keep the changelog up to date anyway, so there's not much point in trying to
get people to use `git log`
8 years ago
0ce58fdb28
Prepare for next spec dev cycle
8 years ago
b1801ea6db
Spec /account/whoami
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
8 years ago
c2b1b7a10e
mention that we can send tokens via headers
8 years ago
6b23b7fc0b
Merge branch 'client_server/r0.2.0_updates'
8 years ago
b94c4a9f36
Sneaky update to 0.2.0 spec to link unstable
...
This doesn't count as a spec release, right??
8 years ago
a8afbfd27d
Avoid external link in search swagger
8 years ago
bf3b49f13c
document joined_members and joined_rooms endpoints ( #999 )
8 years ago
1e3f5683c8
Make clear that the /sync timeout is zero by default
8 years ago
750d980bc0
Room member ( #950 )
...
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
9 years ago
da6938b818
Key management APIs ( #894 )
...
Spec the e2e key-management APIs.
9 years ago
8a9629167a
httpsify the speculator link
9 years ago
461bfdb0d8
Merge branch 'master' into rav/device_management
9 years ago
22777970da
Fix speculator link
...
the link to the 'latest version' was broken
9 years ago
9265b03008
Client device doc
...
Document client devices, and the mods to the login and register apis to support
them.
9 years ago
cbc5774ade
JSON key names also use underscores.
9 years ago
8523af1385
Document convention of using underscores in APIs
...
Everybody has agreed to it. Now we just have to remember to do it.
9 years ago
6c88d698ae
uia fallback example: check event origin
9 years ago
e850fd718d
window.postmessage for Interactive Auth fallback
...
Require that User-Interactive auth fallback pages call
`window.postMessage` to notify apps of completion.
9 years ago
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
9 years ago
301595c071
Linkify account_data API
...
Also change other links because it turns out the .. isn't part
of the syntax
9 years ago
2a987c3369
Linkify endpoints properly
9 years ago
a8d35b2409
UI Auth: servers should 401 when a request fails
...
(ref https://matrix.org/jira/browse/SYN-744 )
9 years ago
37fb1ceb65
Merge pull request #395 from matrix-org/rav/kill_refresh_tokens
...
Remove references to refresh tokens and tokenrefresh
9 years ago
f4c7fdfd03
Remove references to refresh tokens and tokenrefresh
...
refresh tokens are dead.
9 years ago
ebaaa7e3b3
Review feedback
...
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
9 years ago
cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 years ago
77b668a5dc
Fix some obsolete uses of user_id key in events
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 years ago
2fa7aac3be
Merge pull request #377 from Ralith/typos
...
Fix typo
9 years ago
80bfbbdd33
Fix typo
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 years ago
c51c4acf7f
Clarifications to authentication mechanisms
...
* Make the purpose of the `auth` key in /register requests explicit, and say
that it should be empty at first.
* Restructure the UA-auth section a bit.
* In the UA-auth section, say that clients should submit no `auth` to start
with, and add 'Stage 0' representing this to the example.
* s/{stage,login} type/authentication type/ in the UA-auth section. Seems
clearer to me.
* Try to distinguish the example responses from the example requests by giving
an HTTP header.
9 years ago
0248afe6ac
login with invalid token gives a 403
9 years ago
1f1dfdd91c
More clarifications
9 years ago
41368dc5a7
document CAS login
...
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
9 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.
10 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.
10 years ago
a64f9bbb63
C-S spec: Fix 'unstable' in link to /context API
10 years ago
b5f9e896ba
C-S spec: Fix 'unstable' in link to /context API
10 years ago
a2ab6854ff
CS spec: Add r0.2.0 to historical version list
10 years ago
8ac45d7948
Merge pull request #353 from matrix-org/rav/room_membership
...
Clarify the room-membership APIs
10 years ago
0c06ea0e67
Merge pull request #356 from matrix-org/rav/fix_redaction
...
Fix name of prev_content to preserve on redactions
10 years ago
a9d3cfd13c
Merge branch 'master' into rav/link_undeprecated_endpoints
10 years ago
d92515bce3
Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
...
Move /room/x/initialSync to after the undeprecated APIs
10 years ago
d8a47dbb5d
Merge pull request #352 from matrix-org/rav/kill_old_sync
...
Remove references to intialSync etc, and rewrite syncing
10 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).
10 years ago
1c6eed5c35
Fix name of prev_content to preserve on redactions
...
The field is called prev_content, not prev_state.
10 years ago
6bcb1798f5
Mark deprecated endpoints with their replacements
...
Fixes https://matrix.org/jira/browse/SPEC-415
10 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.
10 years ago
4118ce6680
Add rationale to /sync
10 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
10 years ago
017935d8e9
Fix typo
10 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 ).
10 years ago
4812be9142
Missing .
10 years ago
ead5648b8c
Add requestToken endpoints
...
For password reset and 3pid adding
10 years ago
e4db7be8e2
Better structure for error response
...
& add server not trusted error
10 years ago
572aa24a88
Add M_THREEPID_IN_USE
10 years ago
ec69f04793
Merge pull request #337 from matrix-org/rav/directory_docs
...
Improve documentation of directory API
10 years ago
7bbb664784
Improve documentation of directory API
10 years ago
92bb1c1b43
Update wording as per request from richvdh
10 years ago
a7e40bed88
Add powerlevel name to value list
10 years ago
099d356dfb
Add r0.1.0 to version list in C-S spec
10 years ago
e7e9f5fa46
Document the /logout api
...
We have one, and it's useful, so we really ought to document it
10 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
10 years ago
351bbee016
Remove changelog from index.rst
...
... since it's explicitly unversioned.
10 years ago
7d20d2d903
Add old-version links to C-S API
10 years ago
f4f186baee
Add _cs suffix to client-server http APIs
...
I'm about to add identity service APIs, so differentiating is good.
10 years ago
cc0dae3aeb
Deduplicate a couple of places where "the" was written twice in a row
10 years ago
0da26cd7e1
Specify login behaviour for unknown 3pids
10 years ago
245e8e8571
Add 3pid password login to the spec
10 years ago
2e46b587b8
Require explicit un-banning
10 years ago
169cc98101
M_INVALID_USERNAME to be consistent with the name of the parameter
10 years ago
2301a792d7
Add an error code for invalid user names.
10 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.
10 years ago
5e30d75ccb
Add /_matrix/versions to spec
10 years ago
678dbbe08a
s/-/_/
10 years ago
4be078440d
Don't mention server-server stuff in client-server spec
10 years ago
217e22fc30
Format changelog more nicely
10 years ago
19dfafe376
Remove superfluous space
...
This causes a <dt> to get rendered around the <tt>s which breaks some
formatting.
10 years ago
39f43abbb7
Add per-API changelogs
10 years ago
705556634a
Add filters
10 years ago
873b0dcecf
Replace version numbers with release numbers
10 years ago
19ce17cfed
Merge pull request #200 from matrix-org/daniel/redact
...
Merge pull request #200 from matrix-org/daniel/redact
10 years ago
2f3a00fe34
Consistently spell homeserver as homeserver
10 years ago
e072d215cf
Specify redaction
10 years ago
c6e0322a9e
Swaggerify /account
10 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.
10 years ago
b479b54cd8
Add tables of contents to individual specs
10 years ago
bc514dc9c4
Merge pull request #178 from matrix-org/daniel/directory
...
Fix and include /directory api docs
10 years ago
7f2813354d
Swaggerify /ban
10 years ago
ad4d8ae7a6
Move client-server intro to client-server section
10 years ago
c25a806cef
Fix and include /directory api docs
10 years ago
8201eaa042
Swaggerify /rooms/:room_id/leave
10 years ago
d7357ef9b7
Specify /publicRooms
10 years ago
13eddd456f
Proposal for adding full_state param to v2 sync
10 years ago
696f75d80b
Rename section
10 years ago
3cf431cac1
Add link
10 years ago
9a5bd6d21f
Use static
10 years ago
98dbf4d60b
Better flow
10 years ago
0529b4a9a2
Reword
10 years ago
88c459d549
Add back in login v1 fallback API
10 years ago
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
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
1d7cb6937f
Merge pull request #123 from matrix-org/markjh/list_formatting
...
Fix list formatting
10 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.
10 years ago
d18d406c41
Add the room send and state APIs to the spec
10 years ago
e3e8026025
Fix list formatting so that we aren't including everything in blockquotes
10 years ago
74d42f0142
Allow rejecting invitations
10 years ago
26f27d95fb
Merge branch 'master' into registration-swagger
...
Conflicts:
specification/client_server_api.rst
10 years ago
62d53b4f33
Review comments round III
10 years ago
85a6a5a530
Merge branch 'master' into proofing
10 years ago
3d087df538
Kill number prefixes for good
10 years ago
Travis Ralston