06b0c1762a
Move the send_join response to its own definition
...
Both APIs need clarification, so dedupe the changes.
We should also probably deprecate some of this stuff so we can eventually remove it.
5 years ago
200212ffd7
Clarify that a creation event and member event are needed for createRoom
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2494
5 years ago
36ed6e94a2
Re-introduce signature schemas
5 years ago
6a8ba9b1d6
improve description of key object in CS and include a link in Fed
5 years ago
5b38c04e19
make definition of signatures fields more consistent
5 years ago
12ecf9f383
Merge pull request #2561 from matrix-org/travis/doc-2xx-format
...
Mention that we use OpenAPI 3's response code format
5 years ago
b11cf560b5
Add spec for new alias handling (client-server)
...
MSC: https://github.com/matrix-org/matrix-doc/pull/2432
This commit does not deal with areas which will be covered by the room version specifications (namely the redaction algorithm).
It feels a bit overly cruel to completely obliterate all mentions of `m.room.aliases` from the spec as client/server developers may encounter the event type in the wild. To ensure that CTRL+F still works, a brief mention that they do nothing has been put in place, leaving no other references (except the redaction algorithm - see previous paragraph).
5 years ago
1388742a52
Mention that we use OpenAPI 3's response code format
...
See comments of https://github.com/matrix-org/matrix-doc/pull/2238
5 years ago
74b627ac0b
Fix the response format of the `/send` endpoint
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
5 years ago
fc91946e5a
Update api/server-server/backfill.yaml
...
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
5 years ago
9765116c47
Make backfill wording clearer
5 years ago
05e83f2e7d
Fix more describes -> describe
5 years ago
0e771c7b07
Merge pull request #2547 from matrix-org/travis/spec/1802-fix-200
...
Spec v2 send_join and send_leave endpoints
5 years ago
7c0046ffc7
describes -> describe
5 years ago
d419e3b38a
Remove extraneous spaces
5 years ago
28d460fb62
Fix Typo
5 years ago
a2a1694c35
Spec v2 send_join and send_leave endpoints
...
MSC: https://github.com/matrix-org/matrix-doc/pull/1802
Fixes https://github.com/matrix-org/matrix-doc/issues/2541
This also adds the v2 invite endpoint to the ACL protected list as that appears to be an omission.
5 years ago
d24f15a3a9
Spec soft-logout per MSC1466
...
MSC: https://github.com/matrix-org/matrix-doc/issues/1466
5 years ago
fae1165e1c
spec what to do if you try to delete a backup that's already deleted
5 years ago
bd95568c8c
remove duplicate key
5 years ago
1bae8ea633
we actually don't support the GET /room_key/versions/ with trailing slash
5 years ago
42ae5c966a
Clarify the limits of prev_events and auth_events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2307
These restrictions are due to a Synapse change which never made it to the spec prior to the MSC process. This is therefore documenting an omission.
Synapse's numbers are verified here: 207b1737ee/synapse/handlers/federation.py (L1183-L1213)207b1737ee/synapse/handlers/federation.py (L829-L837)https://github.com/matrix-org/matrix-doc/pull/1594 should render the `auth_events` limitation unnecessary.
No changes are required to the the "checks on receipt of a PDU" section of the server-server spec as it starts with "must be a valid event", to which an event is invalid if it contains too many prev or auth events.
5 years ago
ff59fc1905
/keys/query: Add a title in the response
...
The device keys structure in queryKeys is not the same as the one
defined in device_keys.yaml (it adds things on top of it).
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
5 years ago
77783b8fc3
Remove extraneous quotes, fix a typo
...
filter.yaml: quotes under |- were taken literally.
notifications.yaml: it's a number in the example, not a string
5 years ago
a896729ac2
some more clarifications and indentation fixes
5 years ago
6b8b31ce63
correct use of required annotation in json-schema
...
https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.3
5 years ago
0145191d43
add links to endpoints and add delete endpoint
5 years ago
5f3ee44cfb
add more suggestions from review
5 years ago
8ff1c26ef2
fix indentation
5 years ago
e0b4a3c912
Apply suggestions from code review
...
Co-authored-by: Travis Ralston <travpc@gmail.com>
5 years ago
0d2924841b
Merge pull request #2524 from uhoreg/e2e_misc_fixes_202005
...
misc fixes in e2ee spec
5 years ago
6e33954256
client-server: Mark the event_id when putting room events as required.
5 years ago
e89521d195
some fixes (spelling, RST, and naming)
5 years ago
1e330c9423
Clarify revocation behavior.
5 years ago
0c582ea8c7
Apply suggestions from code review
...
Co-authored-by: Travis Ralston <travpc@gmail.com>
5 years ago
958e1b4a2e
Make the spec changes for MSC 2457.
5 years ago
202bf8abb1
Cleanup summaries and descriptions
5 years ago
fc03f7faa6
Remove query_auth from the specification per MSC2451.
5 years ago
4d808762da
Change formatting from italics to code
5 years ago
e151ba96ac
Fix typo for upgrade
...
Signed-off-by: Örjan Fors <orion@29k.org>
5 years ago
41072fcaa9
Apply suggestions from code review
...
Co-Authored-By: Matthew Hodgson <matthew@arasphere.net>
5 years ago
8e888b916c
Fix spelling mistakes.
5 years ago
f59aa563dd
Add missing tags to push rules endpoints
...
Without the tags, the endpoints don't end up in the swagger. No changelog for this because it doesn't affect the spec itself.
5 years ago
a62c817745
Apply suggestions from code review
...
Co-Authored-By: Matthew Hodgson <matthew@arasphere.net>
5 years ago
4cde800ea1
fix validation errors
5 years ago
59e337187b
remove duplicated line
5 years ago
e658b17070
initial version of spec for key backups
5 years ago
c2ffef051f
Clarify description of user directory
...
Signed off by Stuart Mumford <stuart@cadair.com>
5 years ago
14d609e766
Merge pull request #2344 from matrix-org/travis/spec/fix-2338
...
Add filter query param to /context
5 years ago
9f01850f7a
Add some words about where the filter is applied
5 years ago
a1e5a96cf8
Update api/client-server/event_context.yaml
...
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
5 years ago
8e6e47ae7d
Merge pull request #2343 from matrix-org/travis/spec/fix-2120
...
Recommend that clients don't preview URLs in encrypted rooms
5 years ago
e59bb20dc3
Try to clarify the filter information on /context
5 years ago
ef957b990d
Merge pull request #2341 from matrix-org/travis/spec/fix-2298
...
Clarify that submit_url is without authentication
5 years ago
f012da17a1
Explain why e2e previews are bad
5 years ago
a50e828509
Merge pull request #2342 from matrix-org/travis/spec/fix-1982
...
Clarify what format the `country` is on phone number inputs
5 years ago
3d954f93b5
Clarify that the room ID is the object key in /sync responses
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2269
5 years ago
021c056efc
Add filter query param to /context
...
This was missed as part of lazy-loading.
Fixes https://github.com/matrix-org/matrix-doc/issues/2338
5 years ago
b662a33081
Recommend that clients don't preview URLs in encrypted rooms
...
Any stronger of a recommendation would probably require a MSC due to the behaviour change.
Fixes https://github.com/matrix-org/matrix-doc/issues/2120
5 years ago
284b15495b
Clarify what format the `country` is on phone number inputs
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1982
5 years ago
e95eafb2ba
Clarify that submit_url is without authentication
...
The request is authorized by its parameters, not by an additional access token.
Fixes https://github.com/matrix-org/matrix-doc/issues/2298
5 years ago
2bca44a2e5
Remove extraneous backwards compatibility note
5 years ago
f5f12a29e0
Spec MSC2290: 3PID binding split
5 years ago
3d60e04c6a
Merge pull request #2310 from matrix-org/travis/spec/2263-deprecate-id-server
...
Deprecate id_server and make it optional
5 years ago
48b8a95df6
Deprecate id_server and make it optional
...
As per [MSC2263](https://github.com/matrix-org/matrix-doc/pull/2263 )
5 years ago
6b37bb1dd9
Merge remote-tracking branch 'remotes/origin/master' into kitsune-map-to-enum-support
5 years ago
8d865ca53a
Add s2s POST /publicRooms per MSC2197
...
See https://github.com/matrix-org/matrix-doc/pull/2197
5 years ago
2c88f02daa
Merge pull request #2287 from matrix-org/travis/spec/lookup-v2
...
Spec the v2 lookup API
5 years ago
d813b8e12c
Mention M_INVALID_PARAM
5 years ago
6cfd761204
Spec the v2 lookup API
...
Spec for [MSC2134](https://github.com/matrix-org/matrix-doc/pull/2134 )
5 years ago
642be6c677
Fix unbind wording
5 years ago
30a9de7e02
Merge branch 'master' into travis/spec/is-unbind
5 years ago
a24bcc2c0a
Merge pull request #2258 from matrix-org/travis/spec/is-terms
...
Spec IS terms of service
5 years ago
1881a255c2
Clarify that id_access_token is optional for r0.5
5 years ago
185c564a13
Spec client-server IS unbind API
...
As per [MSC2140](https://github.com/matrix-org/matrix-doc/pull/2140 )
Note: this modifies the endpoint in MSC2140 to be more in line with the remainder of the proposal.
5 years ago
2d784d93ef
Merge branch 'master' into travis/spec/is-auth
5 years ago
001c51a740
/3pid/delete and /deactivate don't take an id_access_token
5 years ago
52e6868f50
Remove bind_* params on /register as per MSC2140
...
See https://github.com/matrix-org/matrix-doc/pull/2140
See https://github.com/matrix-org/matrix-doc/issues/2253
5 years ago
afd5018494
Spec the terms of service handling for identity servers
...
Part of MSC2140
Convert status codes to strings if there is a string status code. Fixes a build error when we mix 4xx and 403 in the same definition. We also have to correct stringified numbers to pass the build.
5 years ago
0408373cf9
Litter the client-server API with id_access_token
5 years ago
4d0ea64121
Define authentication, ripping off the client-server API description
5 years ago
e40d9e296d
Split OpenID token info out verbatim
5 years ago
ca4d9d8636
Deprecate the v1 IS API
5 years ago
a47c5aeb42
v2-ify the v2 api
...
Note that ping and pubkey doesn't require auth - see MSC2140 for more information.
5 years ago
5b53b3d0b8
Clone v1 APIs verbatim
5 years ago
b8a3f970ee
Add security definition for access token
5 years ago
65cd10249c
Render enums inside additionalProps as one more table
...
Closes #2242 .
5 years ago
92c6f4c38e
Add M_USER_DEACTIVATED to list of error codes ( #2234 )
...
Spec PR for [MSC 2181](https://github.com/matrix-org/matrix-doc/pull/2181 ).
Adds the `M_USER_DEACTIVATED` error code and a short description to the client-server API.
5 years ago
a63fab20ee
Fix some typos
...
Signed-off-by: Dominic Fischer <dominicfischer7@gmail.com>
5 years ago
af60889eee
Clarify that /rooms/{roomId}/event/{eventId}'s 404 should be M_NOT_FOUND ( #2204 )
...
No error code is specified for this endpoint's 404. State that it should be an `M_NOT_FOUND`.
5 years ago
2a2dddab94
Merge pull request #2151 from reivilibre/push_id_event_id
...
Fix Push Gateway API example: Field renamed to event_id
5 years ago
9ed19a37ad
Client-server: Fix upload keys example request
...
Contributes to #1733
Signed-off-by: Alexey Andreyev <aa13q@ya.ru>
5 years ago
4c65660b96
Clarify `.m.rule.room_one_to_one` push rule
...
This clarifies the `.m.rule.room_one_to_one` push rule by adding a condition on
event type. Some parts of the spec already had this info, while others were
missing it. Synapse has had this behaviour since the push rule appeared.
Fixes https://github.com/matrix-org/matrix-doc/issues/2150
5 years ago
8033ab1c86
Fix Push Gateway API example: Field renamed to event_id
...
I believe this was forgotten in:
71cb646541
5 years ago
cac72ff873
Merge pull request #2126 from matrix-org/travis/403-id-unbind
...
Add 403 error to IS unbind
6 years ago
67ea3b9ce8
Add 403 error to IS unbind
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2117
6 years ago
b8f1f37927
Remove incorrect id_server param from IS spec
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2118
6 years ago
8f1f8b4fe5
Fix references to filtering
...
We can't have two different backlinks for the same text, so use LL as the label
6 years ago
8ac555f870
Merge pull request #2083 from matrix-org/travis/1.0/key-object
...
Clarify the key object definition for the key management API
6 years ago
8b7887dfc2
Link to key algorithms section
6 years ago
Travis Ralston