4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid
...
Document OpenID in the client-server and server-server APIs
6 years ago
5b30d33b89
Simpler language
6 years ago
c891e4a957
Require the push gateway URL to be of a specific path
6 years ago
45c68e323a
Add general clarity to the /createRoom endpoint
...
This commit does a number of things:
* Minor formatting/alignment changes
* Document the room_alias response key. This could be deprecated now, or forfeited, if needed.
* Remove the guest_can_join parameter - it is not actually supported
* Document the previously undocumented power_level_content_override parameter
* Clarify that the room_id is required on the response
* More clearly spell out which events are created as part of the request
* Clarify how the room alias becomes the canonical alias
* Clarify how the `visibility` may be used to determine a default preset to apply
* Document the `m.federate` creation content parameter, adding an option for the homeserver to define a default value
References:
* Preset being inferred by the visibility: cd32c19a60/synapse/handlers/room.py (L172-L177)https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L198
* https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L335-L359
* Aliases becoming canonical: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L366-L370
* `m.federate` landing in the create event: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L311-L315
Fixes https://github.com/matrix-org/matrix-doc/issues/1243
Fixes https://github.com/matrix-org/matrix-doc/issues/1471
Inspired by https://github.com/matrix-org/matrix-doc/issues/1213
6 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
6 years ago
de961fb7d6
Improve wording on push gateways
6 years ago
fcca80dad8
various minor fixes
...
- formatting fixes
- add examples to homeserver/identity server discovery schema
- replace DNS name with hostname
6 years ago
6a3cf10be9
Merge remote-tracking branch 'origin/master' into well-known
6 years ago
6ad71f785e
Improve documentation for pushers and push gateways
...
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format
Note: this does not attempt to document push rules, just pushers.
Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
6 years ago
292d334509
document new login identifier object ( #1390 )
6 years ago
8ffac01efe
Document OpenID in the client-server API
...
Part of https://github.com/matrix-org/matrix-doc/issues/857
Reference: d69decd5c7/synapse/rest/client/v2_alpha/openid.py (L31-L58)
6 years ago
2ac80d38d7
Document the /publicRooms endpoint for federation
...
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476
The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.
The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
6 years ago
54a88eebf0
Merge pull request #1414 from matrix-org/anoa/third_party_cleanup
...
Clarification on third party fields
6 years ago
5f8967c074
Move TODO. field1, field2... -> fields...
6 years ago
a2e2ced03b
Add reverse-lookup examples.
6 years ago
d785ac78a3
Remove explode and replace with TODO, require auth on CS
6 years ago
53137a3c53
c/p bug, fix operationIds, move rst docs to md
6 years ago
273acb277c
Change fields to use new extended query array syntax
6 years ago
5ddf5374db
Missing comma
6 years ago
e4fd088fcc
Fix room tags spec
6 years ago
05fb94e195
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
6 years ago
d2b0b1bbda
Merge pull request #1379 from turt2live/travis/preset-guests
...
Document guest_access in /createRoom presets; Make presets a table
6 years ago
1829589d23
Convert 3pn errors to new definition
6 years ago
197c36c520
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
6 years ago
91c59e7384
Merge pull request #1353 from matrix-org/anoa/as_thirdparty_lookup
...
Thirdparty Entity Lookup API
6 years ago
291a4dfc76
Third party lookup module. Fix wording
6 years ago
6e3993effe
Merge remote-tracking branch 'matrix-org/master' into travis/preset-guests
6 years ago
84e07a0c10
Convert errors in presence.yaml
6 years ago
16125f16f5
Spec retry_after_ms on ratelimit errors
6 years ago
8b513b9f8e
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
6 years ago
8999887245
Path -> query params
6 years ago
9bde78ac28
$ref needs to be under a schema:
6 years ago
114bcf1a2e
Use $ref, clean up, fix errors, AS is now a C-S module.
6 years ago
fbee83d5cf
Clarify some of the properties on the search result
...
Fixes https://github.com/matrix-org/matrix-doc/issues/773
6 years ago
d7a979da63
Merge remote-tracking branch 'matrix-org/master' into travis/all-the-auth
6 years ago
516000bdc3
Fix error reference in media repo
6 years ago
ab75fc4b20
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
6 years ago
e7a6ff1064
Merge branch 'master' into travis/spec-reason
6 years ago
1722734a51
Merge pull request #1364 from turt2live/travis/server-name-join
...
Document the server_name query parameter on /join/{roomIdOrAlias}
6 years ago
ff3c379339
Merge pull request #1189 from Half-Shot/hs/upload-limits
...
GET media/config 🎉
6 years ago
77f4ac54aa
Wordy intro sentence for description
6 years ago
2e6cc8045c
Better indent of description
6 years ago
d5ce87e956
Split summary up into description and summary
6 years ago
bbf63d116c
Fix reference to error.yaml in forget room API
6 years ago
55c27d6212
Merge branch 'master' into travis/better-errors
6 years ago
4485b2f025
Merge branch 'master' into travis/server-name-join
6 years ago
c1c1f28c79
Merge branch 'master' into travis/dont-forget-to-leave
6 years ago
3935861445
Merge pull request #1380 from turt2live/travis/define-roomevent
...
Define RoomEvent on /rooms/{roomId}/messages
6 years ago
16860ddd22
De-quote
6 years ago
4c38012122
I can spell
6 years ago
e6218b56ab
Switch properties to schema
6 years ago
a6dad76c01
Fix indentation
6 years ago
cc3724b54a
fix indentation, error messages. add rest of PR
6 years ago
dfdc5f9bef
search.yaml: Rename some titles to avoid confusion between request and response schemas
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
436b410698
Document the error code when someone tries to forget a room they are in
6 years ago
9b1f3a1f47
Document guest_access in /createRoom presets; Make presets a table
...
Previously the presets ended up being rendered as one long string (the indentation was not respected). This was hard to read and wasn't very clear.
Now that there's a larger amount of information, it makes some sense to put it into a table. Tables don't work nicely when nested in another table, so the preset definitions have been moved into the general route description.
This commit also updates the documentation to reference `preset`, not `presets` given the param is singular.
Fixes https://github.com/matrix-org/matrix-doc/issues/881
6 years ago
ce1e2c0904
incorporate feedback from reviewers
6 years ago
9e796192e4
Document that clients must leave before forgetting rooms
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1011
6 years ago
5bc29eb11c
remove accidentally-committed backup file
6 years ago
05c85fd840
Spec the 403 on GET /presence/{userId}/status
6 years ago
981d1004bc
Add a missing $ref
6 years ago
442ad99727
Merge pull request #1273 from QMatrixClient/content-repo-use-default
...
Add 'default' to formally enforce the description
6 years ago
caa6d4d9ad
Give all errors a schema reference
...
This just helps keep an overall structure
6 years ago
7cd22f5690
Describe the rate limit error everywhere
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
6 years ago
1f12637d3f
Getting presence requires authentication
6 years ago
a6b0125da6
Our swagger doesn't support explode yet
6 years ago
d279fdafa6
Document the server_name query parameter on /join/{roomIdOrAlias}
...
Fixes https://github.com/matrix-org/matrix-doc/issues/904
6 years ago
7d94aaace8
Explicitly declare that the kick/ban reason will be on the membership event
...
Fixes https://github.com/matrix-org/matrix-doc/issues/798
6 years ago
2409c84968
Document the GET version of /login
...
Fixes https://github.com/matrix-org/matrix-doc/issues/677
6 years ago
0dd330962d
initial draft of .well-known discovery
6 years ago
a1309d636c
Remove "Clients should handle gracefully" sentence
6 years ago
41c18bed0f
+repository
6 years ago
21e957edfb
Better note for /config
6 years ago
1820df02d9
media => content repository
6 years ago
091b2a6771
Hard limit on requiring accessToken. Rephrased some sections
6 years ago
eeaf4385d7
Speling is my weakniss
6 years ago
80935eadcf
Update content-repo.yaml
6 years ago
ddc152347b
Extending words and rate limiting
6 years ago
f032d6d1c3
Update keys.yaml
...
Fixed an end to end document bug , a format misleading in an claim response
6 years ago
1140c0c05b
Document StateEvent for /createRoom ( #1329 )
7 years ago
6d0a56d190
Suggestions by Travis tend to be sensible ones
7 years ago
6b9640bcb4
upload_size => m.upload.size
7 years ago
077cd04a6d
/limits => /config
7 years ago
df5455de1f
re-arrange fields in example /search request to make them a valid request.
7 years ago
64f97c5b78
add example of highlights field in /search response
7 years ago
4ff5887c91
spec the highlights field in /search response
7 years ago
42fba1a87e
Add 'default' to formally enforce the description
...
A quick follow up on #1265 .
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
7 years ago
3dc54b20c6
Merge branch 'master' into travis/clarify-routing-loops
7 years ago
8610effad7
Merge branch 'master' into travis/reporting
7 years ago
7cc15f3315
Document the allow_remote query param on the media repo
...
Fixes https://github.com/matrix-org/matrix-doc/issues/837
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
9037f506ac
Document how to report content
...
Fixes: https://github.com/matrix-org/matrix-doc/issues/739
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
4278cd56a4
Document /logout/all
...
Fixes https://github.com/matrix-org/matrix-doc/issues/700
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
cc54a4f8cb
/rooms/{roomId}/members: specify access_token requirement
...
as the behaviour of which members the users see is user-specific
and therefore requires authentication.
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
7 years ago
bb39bea44d
Merge pull request #1169 from mujx/event-id-format
...
Use the correct event_id format on examples
7 years ago
55b512c968
add delete_devices endpoint
...
fix #1041
7 years ago
34140a785d
fix typo in delete device
7 years ago
ffc8ee298a
a upload > an upload
7 years ago
de6fe1b76e
Add note about auth
7 years ago
c9abf36097
size > upload_size
7 years ago
2783820f98
Initial draft of GET media/limits
7 years ago
048de9803e
Fix typo.
7 years ago
7448ef0db0
Use the correct event_id format on examples
...
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
7 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>
7 years ago
2644e5657d
Merge pull request #1152 from turt2live/travis/clarify-whoami
...
Improve documentation around /account/whoami
7 years ago
159ab7313f
Fix typos in whoami.yaml
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
b7f8f20de9
Reword the appservice portion of /account/whoami
...
Credit goes to richvdh - suggestions taken with edits.
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
6ba5d7ca92
Reword appservice requirements for /account/whoami
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
a549baa01d
registration.yaml: fix typo
...
it's -> its
7 years ago
2e4e5e25e8
Improve documentation around /account/whoami
...
Clarifies: https://github.com/matrix-org/matrix-doc/issues/1135
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
15cdde3f49
Add GET /register/available
...
Adds https://github.com/matrix-org/matrix-doc/issues/911
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
d88a1308c2
Formatting and remove DELETE /directory/list
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
5cbfa73fe4
Improve documentation of /directory/list
...
* 404 for room not found instead of 400
* GET doesn't require an access token
* PUT (and therefore DELETE) can have it's own access control checks
* DELETE is implemented because of synapse
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
595667d15d
Spec /directory/list
...
Adds https://github.com/matrix-org/matrix-doc/issues/417
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
de6d2c96fe
Minor grammar fix.
7 years ago
f7bbcd1678
Merge pull request #1110 from t3chguy/rooms/event
...
Document new rooms/$/event/$ API for fetching a single event (no ctx)
7 years ago
04eb6c7b65
link to both context and event in depr notice as per review
7 years ago
c5816a80af
move /rooms/{roomId}/event/{eventId} and update depr notice
7 years ago
06911d4fab
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into t3chguy/search_defaults
7 years ago
a9c3d94f24
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into rooms/event
7 years ago
a5374c7df7
Document new rooms/$/event/$ API for fetching a single event (no ctx)
7 years ago
dc27323d8b
Document the defaults for the /search API
7 years ago
59e4c625b3
Merge pull request #1093 from CromFr/guest_can_join
...
Add createRoom guest_can_join parameter
7 years ago
fa0eb2405f
all rooms, not any, and remove extra words
7 years ago
ca09415e80
Fix /keys/changes response to reflect reality
7 years ago
bb0bbedb87
indenting
7 years ago
1674b0e3b5
Doc /keys/query 'token' param
7 years ago
784adade9b
changes based on Pull Request feedback
7 years ago
3d8fe6e090
merge profiles with user directory into user data, also fix typo
7 years ago
605510e965
Merge branch 'master' into user_directory
7 years ago
d219cbc978
apply points from review
7 years ago
00b28495a6
Explain how to split an mxid
7 years ago
d9a4ddbf65
Mark `home_server` field deprecated
...
This is spelt wrong, and is redundant to user_id, so let's stop people using
it.
7 years ago
97445195f6
add user_directory
7 years ago
e9622bf9e4
Fix example in email based registration endpoint
...
The spec says `send_attempt` should be a number, but the example shows it as a string.
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
7 years ago
b270233549
Add createRoom guest_can_join parameter
7 years ago
5e2a48f709
createRoom StateEvent.content should be an object
7 years ago
a68b7e1bbd
Supply operationId with freshly added operations
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
b53083732b
Merge remote-tracking branch 'remotes/origin/master'
7 years ago
0f5a4efce6
Spec URL previews ( #1064 )
...
* Spec URL previews
* Require authentication on /upload and /preview_url
7 years ago
2468c38482
Add required property to whoami
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
41db12713d
Update whoami endpoint
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
9cf2b59f4e
Make it less obvious where this was copy/pasted from
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
b1801ea6db
Spec /account/whoami
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
66268260c7
Merge remote-tracking branch 'remotes/origin/master'
7 years ago
1d4410b638
operationid -> operationId
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
88fb2e9abd
Merge pull request #1045 from maxidor/max/cs/unknow_filter_status
...
Add status for unknown user's filter ID
7 years ago
099a7e90ae
Change return code following feedback
7 years ago
dcaaf84395
Be clear that event_id is not applicable everywhere
7 years ago
efa9b5a8f1
Add missing required key for sync format
7 years ago
0fea380625
Add status for unknown user's filter ID
7 years ago
Travis Ralston