Travis Ralston
2eab07ade4
Fix header in server-server API
6 years ago
Travis Ralston
2aa0e7b00f
Merge pull request #1483 from turt2live/travis/s2s/typing
...
Document how typing notifications work over federation
6 years ago
Travis Ralston
94091a12fb
Merge pull request #1506 from turt2live/travis/general/pushers
...
Improve documentation for pushers and push gateways
6 years ago
Travis Ralston
ef7570e62d
Changelog
6 years ago
Travis Ralston
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)
* Power level content overrides:
* 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
Travis Ralston
d6c54b0278
unaccessible isn't a word
6 years ago
Travis Ralston
ca87876f1b
Clarify that the Authorization header is preferred
6 years ago
Travis Ralston
b159f21857
changelog
6 years ago
Travis Ralston
25d01aa431
Dedicate a section on how to use access tokens
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1042 .
6 years ago
Travis Ralston
ae02e8834d
changelog
6 years ago
Travis Ralston
7751750396
changelog
6 years ago
Travis Ralston
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
Travis Ralston
de961fb7d6
Improve wording on push gateways
6 years ago
Hubert Chathi
a264120b38
put server discovery as its own section
6 years ago
Hubert Chathi
fcca80dad8
various minor fixes
...
- formatting fixes
- add examples to homeserver/identity server discovery schema
- replace DNS name with hostname
6 years ago
Hubert Chathi
6a3cf10be9
Merge remote-tracking branch 'origin/master' into well-known
6 years ago
Travis Ralston
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
Travis Ralston
669d526ea7
Merge pull request #1503 from QMatrixClient/support_oneOf
...
Support oneOf
6 years ago
Kitsune Ral
b41eb26124
Document OpenAPI extension
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
6 years ago
Kitsune Ral
9be78f3aa7
Better support enums when they come among oneOf types
6 years ago
Kitsune Ral
88d97b06ae
Support oneOf
6 years ago
Hubert Chathi
cd4fed509c
convert IS endpoints to Swagger ( #1427 )
6 years ago
Hubert Chathi
292d334509
document new login identifier object ( #1390 )
6 years ago
Travis Ralston
efb1787391
Merge pull request #1478 from turt2live/travis/s2s/doc-cleanup
...
General clean up on the s2s spec
6 years ago
Travis Ralston
25c77ab2d0
Define authorization requirements on federation swagger APIs
6 years ago
Travis Ralston
50fc1c4d16
Move backfill/get events so that joins, leaves, and invites are together
6 years ago
Travis Ralston
83ea90f7ba
Move the Authentication section higher in the spec
...
It forms the foundation for all the requests under it, so it should appear before the endpoints that need it.
6 years ago
Travis Ralston
32178bb07e
Tidy up the specification
...
* Minor word choice changes
* Remove the now-empty "Protocol URLs" section
6 years ago
Travis Ralston
56dbeeb22a
Merge pull request #1469 from turt2live/travis/s2s/backfill
...
Improve documentation for backfilling rooms
6 years ago
Travis Ralston
721be47eb1
Describe how get_missing_events actually works
...
The original text wasn't far off, except for being wrong about what the fields actually do. This commit also adds a bit of clarity for how the server is expected to behave.
6 years ago
Travis Ralston
c8a8fdfa8d
Merge pull request #1493 from turt2live/travis/s2s/media
...
Mention how the content repository works over federation
6 years ago
Travis Ralston
0a7e670715
Document how typing notifications work over federation
...
Relevant synapse code: d69decd5c7/synapse/handlers/typing.py (L221-L230)
6 years ago
Travis Ralston
e03bfbc47b
Document how read receipts work over federation
...
Federation format: d69decd5c7/synapse/handlers/receipts.py (L153-L166)
Population of the fields that the above uses to construct the EDU: d69decd5c7/synapse/handlers/receipts.py (L48-L56)
6 years ago
Travis Ralston
05a2427c73
Document how presence EDUs work between servers
...
It's worth noting that Synapse does not make use of the `poll` or `unpoll` fields, and therefore the wording has been updated to permit servers to reject users. In the case of synapse, it would automatically reject everyone in the list by nature of ignoring it.
6 years ago
Travis Ralston
a77975ba68
Merge pull request #1450 from turt2live/travis/s2s/inviting-rooms
...
Improve documentation for how non-third party invites work
6 years ago
Travis Ralston
0f8954d839
Merge pull request #1463 from turt2live/travis/s2s/pdus-and-edus
...
Improve documentation around EDUs and PDUs
6 years ago
Travis Ralston
57eeddd849
Remove unused origin and destination on EDUs
6 years ago
Travis Ralston
dcae88c290
Document OpenID in the server-server API
...
Part of https://github.com/matrix-org/matrix-doc/issues/857
Reference: d69decd5c7/synapse/federation/transport/server.py (L543-L557)
6 years ago
Travis Ralston
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
Travis Ralston
cdcd72c0e3
Fix stray hash on client-server API link
...
This shouldn't be here, and nothing appears to need it. Removing it now because it has been noticed.
6 years ago
Travis Ralston
0858e7bd23
Mention how the content repository works over federation
...
We might want to consider promoting the media repo to it's own API, and maybe consider calling it the Media Repo rather than Content Repo.
Source of information: experience.
6 years ago
Travis Ralston
cfdbee5fc2
EDU origin and destinations aren't required
6 years ago
Travis Ralston
7ada91787a
age_ts isn't real
6 years ago
Travis Ralston
521dcdd5d5
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/backfill
6 years ago
Travis Ralston
35f15ba3d8
Merge pull request #1477 from turt2live/travis/s2s/public-rooms
...
Document the /publicRooms endpoint for federation
6 years ago
Travis Ralston
d712bfc73d
Merge pull request #1479 from turt2live/travis/s2s/server-discovery
...
Federation: Document the Host header; Clarify how literal IP addresses are handled
6 years ago
Travis Ralston
8724ed99ad
Merge pull request #1480 from turt2live/travis/s2s/swagger-consumes-json
...
Specify which federation swagger APIs consume JSON
6 years ago
Travis Ralston
e10770ae8b
Merge pull request #1475 from turt2live/travis/s2s/event-auth
...
Document /event_auth and /query_auth
6 years ago
Richard van der Hoff
eb45419431
Merge pull request #1490 from matrix-org/dbkr/room_tag_grammar
...
Fix grammar in room tag spec
6 years ago
Matthew Hodgson
f14640acf2
Merge pull request #1491 from florianjacob/1472-spelling-mistake
...
Fix minor spelling mistake in event retrieval endpoints
6 years ago