8e97b0ca81
Improve the server key exchange portion of the s2s specification
...
Most of the text has been shuffled into the swagger definitions to bring it closer to where it matters.
This also attempts to clarify what is out in the wild. Most importantly, the first version of the key exchange is outright removed from the specification. Other research points/questions are:
* What is a "Key ID"?
* 1241156c82/synapse/rest/key/v2/local_key_resource.py (L81-L83)1241156c82/synapse/rest/key/v2/local_key_resource.py (L88-L91)1241156c82/synapse/rest/key/v2/remote_key_resource.py (L227-L229)1241156c82/synapse/rest/key/v2/remote_key_resource.py (L192)
6 years ago
d914c402e2
Improve the profile query to have more sane responses
...
This is a mix of Synapse and Dendrite behaviour, mostly Dendrite. Synapse returns `null` for field values that aren't set, however Dendrite just doesn't return them and instead opts for an empty object.
Further, synapse is lacking in error codes in this area. Dendrite does some additional validation on this API which introduces more errors for bad requests, instead of defaulting to empty objects/200 OK responses.
Likewise, Dendrite returns a 404 when the user is not found while Synapse returns 200 OK/empty object.
6 years ago
0ddf578b61
Combine all queries into their own section
...
This removes the Directory and Profile sections, instead opting to document them as Queries.
The behaviour of profile queries is based on Synapse's behaviour. A few issues have been opened to improve the behaviour:
* https://github.com/matrix-org/matrix-doc/issues/1434
* https://github.com/matrix-org/matrix-doc/issues/1435
* https://github.com/matrix-org/matrix-doc/issues/1436
* https://github.com/matrix-org/matrix-doc/issues/1437
This fixes https://github.com/matrix-org/matrix-doc/issues/1404
6 years ago
b0744aa1e9
Merge pull request #1413 from turt2live/travis/s2s/join-swagger
...
Convert joins/invites to swagger
6 years ago
af0629a520
Full stop
6 years ago
9f399a08fe
Full stops
...
I'm never going to remember these
6 years ago
0d1b82a601
Add the event_id to unsigned PDUs
...
This went missing in the swagger conversion. The example already has an event_id.
6 years ago
eaf175056f
Full stops
6 years ago
797aca87bd
Update the check_examples.py script to resolve references
...
The script previously wasn't chasing down valid references in examples.
6 years ago
7314405904
Update comment
6 years ago
45ec8269e6
Fill out the required fields in all the examples
6 years ago
9c1c541a38
Remove extra "required" declarations
...
"required" is something that is handled as an array, and these are invalid. The `type` in both cases is covered by a required array elsewhere
6 years ago
004998b98f
Convert invites to swagger
...
The whole section reads like a description for the endpoint, and has been replaced by the swagger definition now (rather than at a later stage). All the same information should be kept.
6 years ago
f09c4fd286
Convert joins to swagger
6 years ago
cb4fcd1d09
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger
6 years ago
88beaf4ad8
Completely remove /pull
...
It's not been in use for years - we can safely let it disappear
6 years ago
21c4af70a9
Fix schema definitions (spelling, attributes)
6 years ago
2aafde4549
Merge pull request #1419 from turt2live/travis/s2s/3pinvites-swagger
...
Convert third party invite exchange to swagger
6 years ago
89384c96c1
Full stops, language.
6 years ago
e226b60c7f
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger
6 years ago
bafdcf3640
Full stops, spelling, and operation IDs.
6 years ago
7cb918407d
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/keys-swagger
6 years ago
05fb94e195
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
6 years ago
272f3d8432
Fix documentation link
6 years ago
cf93c88337
Convert third party invite exchange to swagger
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
e5da1e1741
Improve upon the transaction schema and examples
...
Reduces data duplication and makes the objects more reusable for other areas of the spec
6 years ago
51faf8ed2e
Convert the general query API to swagger
...
Includes "moving" the directory query API into the same area. This will make more sense once the other query types are specified.
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
374ec00046
Convert things that mention "Transaction" to swagger
...
There's two kinds of transactions currently: one with EDUs and one without. The one with EDUs is only used on /send, however the schema is still somewhat worth splitting out for simplicity.
The examples are brought apart to make them slightly more reusable for when they get dumped into the relevant sections of the spec (see TODO in server_server_api.rst)
Further, the Transactions stuff introduces tuples to the spec. The units.py has been updated to support this.
6 years ago
3e13ec2841
Fix required properties in POST /query
6 years ago
96889f16e9
Split out and fix the /server and /query key APIs
6 years ago
bd2c0b7c98
Convert server keys to swagger
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
e81e0328c2
Fix single protocol metadata endpoint path, remove 500s
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
d73b247688
3PE lookup service
6 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
5ab5fe08d1
Small grammatical and stylistic fixes
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
e4f7ba70f5
Merge branch 'master' into travis/spec-directory-list
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
c8393306d1
Add IS ping endpoint
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
9d2e18cca1
Adapt paths as per feedback
7 years ago
d1e64daa10
Fix yaml title for directory api
7 years ago
28c09aed62
Properly mark required response keys to pass tests
7 years ago
8a6103798e
Fix for tests
7 years ago
bb50ec2e88
Document directory query endpoint
7 years ago
2128924933
Merge pull request #1072 from maxidor/max/ss/version
...
Document federation version endpoint
7 years ago
1045bc721d
Document federation version endpoint
7 years ago
828086a86c
Supply operationId for freshly added IS and AS operations
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
868af0a7a1
Provide doc-comments with makeHandler(); cleanup
7 years ago
5147a3b975
Fix broken links & grammar
7 years ago
45af878e11
Merge remote-tracking branch 'origin/master' into dbkr/is_bulk_lookup
7 years ago
d728e67751
Merge pull request #1068 from matrix-org/dbkr/threepid_add_msisdn
...
Document threepids
7 years ago
836e6c81d1
Fix spelling
7 years ago
e80675c9e9
Link in markdown, not swagger
7 years ago
493b936209
Make these links more specific too
7 years ago
cdfff67878
Create spec for IS bulk lookup
7 years ago
0f5a4efce6
Spec URL previews ( #1064 )
...
* Spec URL previews
* Require authentication on /upload and /preview_url
7 years ago
6edb90a08e
Document threepids
...
Adds the /msisdn' 3pid type and generally fleshes out what a 3pid
is and how they work.
This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039
with some tweaks and additions.
7 years ago
33463e3907
Factor out parser.validate callback
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
77a9daccec
Validation that operationId is present
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
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
56c3e5a627
README.rst: Add notes on how to build the spec
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
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
Travis Ralston