Commit graph

143 commits

Author SHA1 Message Date
Kévin Commaille
4534124742
Include examples inline instead of using a reference for invite endpoint definitions (#1349)
The OpenAPI 3 spec doesn't allow building examples by composition.
Either the whole example must be a reference, or it has to be included.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2022-11-22 15:56:39 +00:00
Patrick Cloke
eeb43043ad
Add standard error responses (MSC3743). (#1347) 2022-11-22 15:51:29 +00:00
Kévin Commaille
dfc8a2e184
Fix POST _matrix/federation/v1/user/keys/claim response schema (#1351)
The syntax was not compliant with the Swagger spec.
It also lacked one level of nesting.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2022-11-22 15:50:28 +00:00
Travis Ralston
5f2fac89af Matrix 1.5 2022-11-17 08:22:20 -07:00
Richard van der Hoff
4d0c912acf changelogs 2022-11-08 18:56:13 +00:00
Travis Ralston
7a591366c1 v1.4 changelog 2022-09-29 07:03:48 -06:00
Travis Ralston
227757d499
Threads: Read receipts & notifications (#1255)
* Spec MSC3771: Threaded read receipts

Note: this builds on a (as of writing) non-existent "threading" section, which is part of a different commit.

* Spec MSC3773: Threaded notifications

* changelog

* Various clarifications per review
2022-09-28 14:49:25 -06:00
David Robertson
69ff51c017
Tweak style of <code> samples in rendered tables (#1179)
* Tweak style of `<code>` samples in rendered tables

This has been subtly irritating me for aaaaaaages

* Changelogs
2022-08-02 14:49:27 +01:00
Richard van der Hoff
b232148821
Clarify the use of JSON in requests and responses (#1185)
Fixes #1182
2022-07-28 13:45:54 +01:00
Richard van der Hoff
5f3b34448d
Add HTML ids for object definitions in the formatted specification (#1174)
* Remove redundant call to resolve-allof

All of the callers to resolve-additional-types already call resolve-allof (or
if not, they should), so this is redundant.

* Update `resolve-additional-types` to take a dict

I want to add more params to this, so first make it take a dict.

* `render-object-table`: take a "title" rather than a "caption"

... which means we can use the result from resolve-additional-types directly.

* render-object-table: support adding an anchor to generated tables.

* resolve-additional-types: generate an id for each returned type

* render-event: pass an anchor_base into resolve-additional-types

This means that it will generate an anchor for each type, whihc will then be
passed into render-object-table and used as an `id` for the table.

* render-operation: pass an anchor_base into resolve-additional-types

* newsfiles
2022-07-19 13:25:30 -06:00
Travis Ralston
98db9a6d04 v1.3 changelog generation 2022-06-16 08:31:07 -06:00
Travis Ralston
f14e18131b
Specify room version 10: knock_restricted and int power levels (#1099)
* Clarification on historical power level handling

* Revert "Clarification on historical power level handling"

This reverts commit f443b3d5a9afac3095b14a72ec471ba06f4cc78b.

* Clean up

* Let us try this again not using VS Code

* Markdown is full of mysteries

* Move stringy power levels to room versions

* Describe range

* Fix minor issues with previous room version stuff

* Copy/paste v9 into v10

* Describe deprecated formatting

* Paste unmodified auth rules from v8 into v10

* Move 9.1 to 9.3, add 9.1 and 9.2 for integer enforcement

* Add knock_restricted to v10 auth

* Misc cleanup and clarification for fragments

* Describe `knock_restricted` client changes

* Changelogs

* spelling

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Apply code review suggestions manually

* Fix v9 redactions

* Fix auth rules clarity issues

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Remove false integer requirements

Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2022-06-08 15:22:47 -06:00
Nicolas Werner
e70045f4cc
room_type is not a required parameter in practice (#1110)
* room_type is not a required parameter in practice

In practice servers seem to mirror what the room create event does and
leave out the room_type when unset.

Signed-off-by: Nicolas Werner <n.werner@famedly.com>

* Add changelog

Signed-off-by: Nicolas Werner <n.werner@famedly.com>

* Also make room_type and allowed_room_ids optional in the openapi

They are optional according to the text, but the openapi marks them as
required instead.

Signed-off-by: Nicolas Werner <n.werner@famedly.com>

* Fix copy and paste error of newsfragment

Signed-off-by: Nicolas Werner <n.werner@famedly.com>
2022-06-07 17:27:53 -06:00
Travis Ralston
515269b2e3
Unify & standardize the v1.3 changelog (#1102)
* Reference MSCs where MSCs were not being referenced.
* Alter language to appear consistent and from a single voice.
* Bundle and group various changes together (will affect the final changelog - the rendered one still doesn't bundle appropriately).
* Move entries to the spec area they are intended to be in.
2022-05-31 09:24:06 -06:00
Hubert Chathi
2780055198
clarify federation Authorization header an add destination property (#1067)
* clarify federation Authorization header an add destination property

* add changelogs

* some clarifications

* more clarifications, fixes

* use HTML in the added-in/changed-in shortcodes

* Apply suggestions from code review

Co-authored-by: Travis Ralston <travpc@gmail.com>
2022-05-30 15:33:56 -06:00
David Robertson
3f7b0e80a3
Minor drive-by state res clarifications (#1042)
* Opinionated rewrite of unconflicted state map

* Define auth chain
2022-05-30 14:13:55 +01:00
David Robertson
c4e54509db
PDU check 5 should consult state before an event (#1070) 2022-05-23 18:22:33 +01:00
Hubert Chathi
58f960e5cc
Merge pull request #1055 from progval/valid_until_ts
Clarify that valid_until_ts is in milliseconds, like other timestamps used in Matrix
2022-05-17 13:03:32 -04:00
David Robertson
9ede29a01d
Attempt to define a valid event (#1045)
* Attempt to define a valid event

Resolves #1044.

Well, maybe.

* Changelog

* link to /rooms, thanks Travis

Co-authored-by: Travis Ralston <travpc@gmail.com>

Co-authored-by: Travis Ralston <travpc@gmail.com>
2022-05-10 13:51:23 -06:00
Valentin Lorentz
34589078fd Clarify that valid_until_ts is in milliseconds, like other timestamps used in Matrix
Signed-off-by: Valentin Lorentz <progval+git@progval.net>
2022-05-10 19:34:22 +02:00
Travis Ralston
b6f2b172a6 Clarify that the X-Matrix validation uses the parsed request body (#3727) 2022-05-09 01:28:17 -06:00
Denis Kasak
2857511a02 Changelog 2022-04-29 17:11:31 +02:00
Richard van der Hoff
614680675f
Fix broken links to matrix-doc (#1032)
The spec has moved to https://github.com/matrix-org/matrix-spec, so there were
a lot of broken links here.
2022-04-20 16:36:14 +01:00
Jonas Platte
ac9bee3f88
Remove origin from unsigned_pdu_base.yaml (#998)
It doesn't serve a useful purpose, is not enforced to be present by Synapse
and already being omitted by at least one homeserver implementation.
2022-03-29 16:47:56 +01:00
Richard van der Hoff
7293744a5e
Rename changelogs/server_server/3703.clarification to changelogs/server_server/newsfragments/3703.clarification 2022-03-08 15:36:46 +00:00
Travis Ralston
e488a7fb6d v1.2 changelog 2022-02-02 10:05:30 -07:00
devonh
fc5ba959ca
Separate PDU terms from their definitions (#3527)
Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
2022-02-01 10:18:42 -05:00
Richard van der Hoff
4a9c236572 Changelogs for #3674 2022-01-26 11:00:30 +00:00
Patrick Cloke
fff5f87c3d
Fix the type of children in the /hierarchy S-S API. (#3660)
* Fix the type of children in the /hierarchy S-S API.

* Newsfragment
2022-01-19 13:30:09 -07:00
Travis Ralston
6c4aabd053
Room versions 8 and 9: Restricted rooms (#3387)
* Room versions 8 and 9: Restricted rooms

MSCs:
* https://github.com/matrix-org/matrix-doc/pull/3083
* https://github.com/matrix-org/matrix-doc/pull/3289
* https://github.com/matrix-org/matrix-doc/pull/3375

* Changelogs

* Capitalization

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

* Remove verbiage for spaces because they don't exist

* Iterations on text

* Another clarification

* Make error code descriptions consistent

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Incorporate from merge

* Misc language update per review

* Update accuracy before splitting auth rules

* fix wtf moment

* Fix up v8 and v9 to match "fully specify room versions"

* Scope auth events selection to room version

* Apply consistency

* Add changelogs

* Review part 1

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Split out redaction sections

* Clarify general case of join conditions

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2022-01-18 09:55:34 -07:00
Travis Ralston
9af83dfd41
Add Spaces to the spec (#3610)
* First iteration of specifying Spaces

MSCs:
* https://github.com/matrix-org/matrix-doc/pull/3288
* https://github.com/matrix-org/matrix-doc/pull/2946
* https://github.com/matrix-org/matrix-doc/pull/1772

Note that this makes modifications to the underlying MSCs as well. These are intended to be minor edits to aid clarity/accuracy of the MSCs, as per the proposal process. Functionally, clients and servers might need to change their behaviour slightly as is expected of implementing this stuff early. Synapse has these changes (alongside backwards compatibility) here: https://github.com/matrix-org/synapse/pull/11667

* add changelogs

* Accuracy per review

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* fully prefix new endpoints

* Fully prefix endpoint in 3616 too

* Fix ordering example

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2022-01-17 10:03:14 -07:00
Richard van der Hoff
355e06eaa6
Clarification for /event_auth (#3583)
The description on this endpoint implied it returned the auth chain for the
full state of the room, which is incorrect.
2022-01-04 16:45:10 +00:00
Travis Ralston
195b8a54c5 v1.1 changelog 2021-11-09 07:23:27 -07:00
Travis Ralston
8f2e8f03d0
Normalize changelog entries (#3476)
* Remove entries which don't affect the rendered spec (sorry people using the swagger schemas - we'll have to figure out a changelog for you). See https://github.com/matrix-org/matrix-doc/issues/3475
  * Note that a breaking change is removed by this commit: key backup was introduced in this release cycle, so is not breaking.
* Use uniform references to MSCs ("as per MSC0000").
* General rewording to be consistent with the overall voice of the changelog.
* Condensing of entries where needed to make them fit in the changelog.
* Rewording to collapse entries into fewer lines.
* Spell "deprecation" correctly in file extension.
2021-11-05 13:57:39 -06:00
Denis Kasak
ed08c1cb9e Tweak PDU diagram demonstrating prev_events. (#3340)
This tweaks the DAG to be simpler, with two linear event chains E4 -> E3
-> E2 -> E1 and E6 -> E5 -> E2 -> E1. The extremities of the DAG are now
the first and only point in the DAG where multiple event parents occur.
Since the point of the diagram is to demonstrate this very situation,
it's better didactically if there is only one such situation in the
diagram.
2021-08-31 16:51:06 +01:00
Niels Basjes
cf5b519963 Explain the reasons why <hostname> TLS certificate is needed rather than <delegated_hostname> for SRV delegation. (#3322)
Signed-off-by: Niels Basjes <niels@basjes.nl>
2021-08-27 19:17:17 +01:00
Neil Alexander
af0ebc7414 /_matrix/federation/v1/user/devices/{userId}: Rename self_signing_keys to self_signing_key (#3312)
Apparently, in response to a /_matrix/federation/v1/user/devices/{userId} request, Synapse actually returns a key called "self_signing_key" instead of "self_signing_keys".
2021-08-27 19:17:17 +01:00
Hubert Chathi
53fedb2c61 Add changelog 2021-08-27 19:17:14 +01:00
Travis Ralston
2d39ed69c3 Add changelogs 2021-08-27 19:17:12 +01:00
Travis Ralston
5e211480bf add changelog 2021-08-27 19:17:10 +01:00
Travis Ralston
456353c8b4 Add changelogs 2021-08-27 19:17:10 +01:00
Will
415199bd3d
Use Markdown in changelog descriptions 2021-02-02 20:43:14 -08:00
Hubert Chathi
f352de90c3
Merge pull request #2536 from uhoreg/cross-signing-spec
initial spec for cross-signing
2020-12-15 13:11:16 -05:00
Travis Ralston
e659572183 Add changelogs for 2888 2020-12-07 14:32:58 -07:00
Richard van der Hoff
1b74e96b7e fix RST in changelog 2020-07-16 15:21:50 +01:00
Richard van der Hoff
6da06383e8
Allow /make_join to return a 404 (#2688)
Specify that `GET /_matrix/federation/v1/make_join/{roomId}/{userId}` can
return a 404 if the room is unknown.
2020-07-16 15:17:40 +01:00
Hubert Chathi
c8e816d854 Add link to MSC in changelog entries. 2020-06-19 22:22:03 -04:00
Hubert Chathi
ec0b9badc7 Merge remote-tracking branch 'origin/master' into cross-signing-spec 2020-05-29 17:25:19 -04:00
Travis Ralston
09986af8fc Server-Server r0.1.4
Includes a link to r0.1.3 because we forgot
2020-05-27 07:21:59 -06:00
Travis Ralston
db72e7caea
Merge pull request #2575 from matrix-org/travis/clarification/send-join
Clarify the auth_chain and state requirements for /send_join
2020-05-26 14:32:48 -06:00