436544b8f8
Clarify behaviour of `?set_presence=unavailable` for /sync
6 years ago
adef7babfa
Merge remote-tracking branch 'matrix-org/master' into mujx/missing-enum-fields
6 years ago
ad068bcd22
Fix the appservice directory visibility type parameter type
6 years ago
e9579a7840
The `rank` in search results is actually a floating point number
...
This was accidentally changed in https://github.com/matrix-org/matrix-doc/pull/1571 and appears to be the only instance.
6 years ago
6cdb463829
Merge pull request #1571 from turt2live/travis/general/number-to-int
...
Replace applicable types of 'number' to 'integer'
6 years ago
f9c7014a65
Merge pull request #1577 from turt2live/travis/c2s/search-filter
...
Specify the type of filter the search API expects
6 years ago
03065b0584
Merge pull request #1572 from turt2live/travis/c2s/sync-left-account-data
...
Add `account_data` to left rooms in /sync
6 years ago
f2332d242a
Add some SHOULDs and MUSTs to the user directory requirements
6 years ago
bb515d15a4
Clarify which collation to use for user directory searching
6 years ago
9527ce31f5
Merge pull request #1570 from turt2live/travis/c2s/sync-filtering
...
Update filtering API documentation
6 years ago
87133d8505
Merge pull request #1574 from turt2live/travis/c2s/fix-directory-put
...
Clean up PUT /directory/room
6 years ago
a0b17e6ed6
Merge pull request #1551 from turt2live/travis/c2s/push-rules
...
General improvements to the push rules module
6 years ago
97508d5dc5
Merge pull request #1554 from turt2live/travis/general/appservice-directories
...
Application service room directories (and other third party network things)
6 years ago
32ac81c588
Spelling
6 years ago
5fa6b49365
Specify the type of filter the search API expects
...
Note: This is badly named until https://github.com/matrix-org/matrix-doc/pull/1570 lands
Fixes https://github.com/matrix-org/matrix-doc/issues/598
6 years ago
e60b44e27f
Clean up PUT /directory/room
...
Fixes https://github.com/matrix-org/matrix-doc/issues/933
The issue references two problems: a `roomInfo` and lack of a `room_id`. It appears the `room_id` has been fixed since reporting, however the `roomInfo` remained (and is now fixed).
6 years ago
55c0b968b5
Fix event schemas for /sync
...
This commit clarifies the required keys for each type of event that appears in sync, fixes the core event schema not declaring 'content' as required, and includes a mention that events may not have a room_id when appearing in /sync.
Fixes https://github.com/matrix-org/matrix-doc/issues/595
Fixes https://github.com/matrix-org/matrix-doc/issues/909
6 years ago
008ebb8c1a
Add `account_data` to left rooms in /sync
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1392
6 years ago
667fa082af
Replace applicable types of 'number' to 'integer'
...
`number` implies/represents a float where `integer` does not.
The only remaining `type: number` in the project appear on power levels: those have been left untouched pending clarification.
Fixes https://github.com/matrix-org/matrix-doc/issues/746
6 years ago
b68ed5d594
Define the default for the contains_url filter param
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1553
6 years ago
1cbcaba2c7
Clean up examples in filter.yaml
...
Indentation, excess examples.
6 years ago
26a7a341f0
Mark the filter_id in the response of POST /filter as required
6 years ago
97e3dd443b
Update room_event_filter.yaml to use the OpenAPI allOf definition
...
This is just maintenance.
6 years ago
7d08ef73d0
Fix naming of the Filter schemas
...
EventFilter !== Filter
Fixes https://github.com/matrix-org/matrix-doc/issues/1509
6 years ago
1bc0f63bfb
Clarify the homeserver's behaviour for user searching
...
The homeserver can implement its own algorithm, but is suggested to ensure the requesting user can reasonably see the other users.
The text is intentionally left vague for whether or not the API is local users only to give the homeserver some flexibility in this area.
General cleanup is also included in this commit.
Fixes https://github.com/matrix-org/matrix-doc/issues/1108
6 years ago
b4be11af42
Document POST /account/3pid/delete
...
Fixes https://github.com/matrix-org/matrix-doc/issues/985
Includes documentation for https://github.com/matrix-org/synapse/pull/3667
Raises https://github.com/matrix-org/matrix-doc/issues/1566
6 years ago
a803d9d077
Document `validated_at` and `added_at` on GET /3pid
...
Fixes https://github.com/matrix-org/matrix-doc/issues/661
6 years ago
c879eb950f
client-server/openid.yaml: Fix a type'o
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
017d6db737
Document third party network/protocol directories (for appservices)
...
Fixes https://github.com/matrix-org/matrix-doc/issues/869
6 years ago
7ec3cc4343
General improvements to the push rules module
...
This commit does a few things:
* Add 3 undocumented push rules to the spec for encrypted events and at-room notifications.
* Require unrecognized conditions to not match, ensuring that future conditions do not cause clients to accidentally notify users.
* Clarify that push rules should be enabled when created.
* Document a new condition required for at-room notifications.
Fixes https://github.com/matrix-org/matrix-doc/issues/1163
Fixes https://github.com/matrix-org/matrix-doc/issues/1034
Fixes https://github.com/matrix-org/matrix-doc/issues/676
Fixes https://github.com/matrix-org/matrix-doc/issues/1033
Relates to https://github.com/matrix-org/matrix-doc/issues/1101
6 years ago
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
6 years ago
e4f5c3d55e
Merge pull request #1518 from turt2live/travis/c2s/create-room-improvements
...
Add general clarity to the /createRoom endpoint
6 years ago
8dc6f092ef
Define the type of the power_level_content_override field
6 years ago
7e6ca5fef8
Take out the room_alias response field
...
The argument is that this isn't really needed at this time.
6 years ago
1fd7c99461
Clarify that the creation event can have other keys in it
6 years ago
6c7a93d2f5
Move description about which preset to use when none is specified
6 years ago
7d14309b63
Move the power level event schema to where it was
6 years ago
10c3307427
document device_one_time_keys_count in /sync/ response
...
fix #1157
6 years ago
8afc82c14b
fix /keys/claim request example
...
It didn't correspond to the example response.
6 years ago
ab3272045e
add missing v1 to m.olm in /keys/upload
6 years ago
f5dc0eaed2
document msisdn-related endpoints in IS ( #1507 )
...
* add msisdn endpoints in Identity Server spec
* add in CS endpoints that use the IS msisdn endpoints
6 years ago
8ac6cea58b
Merge pull request #1522 from turt2live/travis/c2s/http-push-gw-required-path
...
Require the push gateway URL to be of a specific path
6 years ago
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>
7 years ago
436b410698
Document the error code when someone tries to forget a room they are in
7 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
7 years ago
ce1e2c0904
incorporate feedback from reviewers
7 years ago
9e796192e4
Document that clients must leave before forgetting rooms
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1011
7 years ago
5bc29eb11c
remove accidentally-committed backup file
7 years ago
05c85fd840
Spec the 403 on GET /presence/{userId}/status
7 years ago
981d1004bc
Add a missing $ref
7 years ago
442ad99727
Merge pull request #1273 from QMatrixClient/content-repo-use-default
...
Add 'default' to formally enforce the description
7 years ago
caa6d4d9ad
Give all errors a schema reference
...
This just helps keep an overall structure
7 years ago
7cd22f5690
Describe the rate limit error everywhere
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
7 years ago
1f12637d3f
Getting presence requires authentication
7 years ago
a6b0125da6
Our swagger doesn't support explode yet
7 years ago
d279fdafa6
Document the server_name query parameter on /join/{roomIdOrAlias}
...
Fixes https://github.com/matrix-org/matrix-doc/issues/904
7 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
7 years ago
2409c84968
Document the GET version of /login
...
Fixes https://github.com/matrix-org/matrix-doc/issues/677
7 years ago
0dd330962d
initial draft of .well-known discovery
7 years ago
a1309d636c
Remove "Clients should handle gracefully" sentence
7 years ago
41c18bed0f
+repository
7 years ago
21e957edfb
Better note for /config
7 years ago
1820df02d9
media => content repository
7 years ago
091b2a6771
Hard limit on requiring accessToken. Rephrased some sections
7 years ago
eeaf4385d7
Speling is my weakniss
7 years ago
80935eadcf
Update content-repo.yaml
7 years ago
ddc152347b
Extending words and rate limiting
7 years ago
f032d6d1c3
Update keys.yaml
...
Fixed an end to end document bug , a format misleading in an claim response
7 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
628e723483
Move the MXID spec to the appendices
...
Also link to them from the /register API doc.
7 years ago
b4e24d443a
Clarify what happens when there is no power_levels event
7 years ago
a8afbfd27d
Avoid external link in search swagger
7 years ago
004a4d5148
Added/updated operationIds according to today's updates in the spec
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
24afe7987c
Add operationId to all endpoints of all APIs
...
To facilitate generation of API stubs from the spec.
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
bf3b49f13c
document joined_members and joined_rooms endpoints ( #999 )
7 years ago
820704a16a
Format examples as raw objects
...
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).
The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
7 years ago
a84a34ee6c
GETting a filter requires auth ( #1003 )
7 years ago
1e3f5683c8
Make clear that the /sync timeout is zero by default
7 years ago
fee65dbacb
Fix response format and 404 example for room alias lookup
7 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
7 years ago
da6938b818
Key management APIs ( #894 )
...
Spec the e2e key-management APIs.
8 years ago
09a768763d
Add missing enum fields for the set_presence parameter
...
Signed-off-by: Konstantinos Sideris <siderisk@auth.gr>
8 years ago
7adf95b4ad
Merge pull request #740 from matrix-org/rav/fix_736
...
Set default account 'kind' to 'user'
8 years ago
c83a556097
Set default account 'kind' to 'user'
...
Fixes https://github.com/matrix-org/matrix-doc/issues/736
8 years ago
c175039a08
Final public_rooms clarifications
...
* order by *joined* members
* clarify pagination direction behaviour
8 years ago
dca1d0c745
Merge branch 'master' into erikj/public_rooms
8 years ago
2bf0abcb9d
Add missing tag to PUT /devices/{deviceId}
8 years ago
b26c84a290
Fix schema validation fail
8 years ago
07dbf6fcf6
Add doc for PUT /devices/{deviceId}
...
Oops, forgot this.
8 years ago
d66792d5ca
Mention order of returned results
8 years ago
af515012ea
Device management API
8 years ago
9265b03008
Client device doc
...
Document client devices, and the mods to the login and register apis to support
them.
8 years ago
a69d6c63c6
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/public_rooms
8 years ago
cafa9a01fd
Move explanation of lack of direction param
8 years ago
71c1fc5ec0
Remove spurious 400 result
8 years ago
de68c167b6
Add tags for GET endpoint
8 years ago
9d0960b206
Better wording
8 years ago
42616f839c
Merge pull request #396 from matrix-org/dbkr/notifs_api
...
Spec notifs API
8 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
8 years ago
e0a434b248
Aaha, found a syntax that swagger will accept!
8 years ago
bd753d4bf4
Re-add required flags the correct way
8 years ago
af2c74c186
Revert `required`s
...
They're not boolean flags for object fields
8 years ago
14944fe237
More PR feedback
8 years ago
fd8c1a43c7
ms, not s. Also add required flags
8 years ago
b789251f70
More PR feedback
8 years ago
4a020025bc
Make swagger happpy
...
These aren't strings, but 'any' causes swagger to break and
leaving it out makes the doc fail to build.
8 years ago
b4c89accb2
Params in query, not path
8 years ago
a463820d83
Typo
8 years ago
c1fa342b90
Swagger is failing on type 'any'
8 years ago
136d5dc9ad
Almost valid...
8 years ago
595b75f299
Try & make example closer to valid
8 years ago
41781e95b2
Attempt valid json
8 years ago
c16ba9488f
Spec notifs API
8 years ago
37fb1ceb65
Merge pull request #395 from matrix-org/rav/kill_refresh_tokens
...
Remove references to refresh tokens and tokenrefresh
8 years ago
1d7531e9a1
Typo
8 years ago
d39f662df5
PR feedback
8 years ago
556ced36a4
Merge remote-tracking branch 'origin/master' into rav/store_and_forward
8 years ago
8fe8bd6a81
Add is_direct to member event spec.
8 years ago
f4c7fdfd03
Remove references to refresh tokens and tokenrefresh
...
refresh tokens are dead.
8 years ago
5fedc64230
double space
8 years ago
ae1c576648
Merge remote-tracking branch 'origin/master' into erikj/create_room_is_direct
8 years ago
069aa86a10
Update wording and add example to filter param
8 years ago
7919e8e159
Update wording.
8 years ago
a5bb182c67
Explicitly mention that directio of pagination is specified by the token
8 years ago
a66a744c45
Fix typo. Change responses in both places
8 years ago
06649b652d
Mark booleans as required. Remove mention that things may be null
8 years ago
b121feebce
Comment what the is_direct flag actually does
8 years ago
e8b21f357f
Explicitlty mention total_room_count_estimate
8 years ago
e854757c98
Mark required fields as required
8 years ago
0dc94d5c14
Expand on description of pagination tokens
8 years ago
37f6769a3c
Spec filter param on /messagse
8 years ago
085131b617
Add contains_url filter option
8 years ago
ebaaa7e3b3
Review feedback
...
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
8 years ago
3a5cbd14c3
Add /createRoom is_direct flag
8 years ago
c05ee18f58
Add title and update description
8 years ago
130ea85576
Spec POST /publicRooms
8 years ago
877a6cfeb4
Spec new query params for /publicRooms
8 years ago
d81d0dbd1d
Spec canonical alias key
8 years ago
ccd7bb32d5
Specification for direct-to-device messages
8 years ago
cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
7478e7f3cf
Add top-level account_data to /sync response
8 years ago
77b668a5dc
Fix some obsolete uses of user_id key in events
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
978d9ea6dd
fix the descriptions of the /room/.../state APIs to not be the wrong way round
8 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.
8 years ago
4b0e546eeb
PR feedback
...
Fix some typos, and clarify several aspects of server behaviour.
8 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.
8 years ago
d2fe2f1ff6
Fix jenkins
8 years ago
618f94699b
Document the optional parameter for specifying a filename to download an attachment as
8 years ago
8328e485ea
Clean up the pushrules API doc
...
* make it clearer which fields go in which parts of the rule
* the example given appeared to be for a content rule, so use a content rule
consistently through the examples.
8 years ago
7ac2f51e4a
/upload: fix example for filename
...
The example shouldn't be encoded, else it will be double-encoded by swagger.
8 years ago
3e2dea4c52
Document filename query parameter for uploads
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
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
a48437ced8
Spec /account/deactivate API
9 years ago
a9d3cfd13c
Merge branch 'master' into rav/link_undeprecated_endpoints
9 years ago
d92515bce3
Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
...
Move /room/x/initialSync to after the undeprecated APIs
9 years ago
7080fd0618
Merge pull request #348 from Ralith/room-messages
...
Add missing "to" parameter to /messages
9 years ago
dc7fc0309e
Add missing "to" parameter to /messages
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 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).
9 years ago
6bcb1798f5
Mark deprecated endpoints with their replacements
...
Fixes https://matrix.org/jira/browse/SPEC-415
9 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.
9 years ago
e91214e78e
More links
...
Also remove now redundant anchor
9 years ago
cf13c8997c
Merge branch 'dbkr/dont_line_wrap_rst' into dbkr/more_requesttokens
9 years ago
7c8651480a
Some PR feedback corrections
...
Including adding a hyperlink, although this requires a separate fix that I'll do on a different branch
9 years ago
19a59bc210
Merge pull request #345 from Ralith/require-prev_batch
...
Supply prev_batch unconditionally in timelines
9 years ago
c109da5b78
Attempt to make things clearer
9 years ago
86db820bb1
Expand on summaries for requestToken endpoints
9 years ago
191cb08a3a
Add response section otherwise the checker fails
9 years ago
d74a320edd
Stray tab
9 years ago
ead5648b8c
Add requestToken endpoints
...
For password reset and 3pid adding
9 years ago
ee5054fb42
Supply prev_batch unconditionally in timelines
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 years ago
14ff3862e3
More PR feedback
9 years ago
e4db7be8e2
Better structure for error response
...
& add server not trusted error
9 years ago
3dddc0dcdf
Explain why not erroring on dup 3pid is desireable
9 years ago
a600386c05
Consistent working for error response
...
Also format json example better
9 years ago
60293af83a
PR feedback
9 years ago
6a0c9edb49
Add the id_server param
9 years ago
Travis Ralston