Commit Graph

6175 Commits (7e92964dc5ed070d2adf0dac0a0d0ac9d4888129)
 

Author SHA1 Message Date
Alexandre Franke 7e92964dc5
🚚 Rename OpenAPI artifact (#3621)
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Travis Ralston 56532dd688
Describe and hoist stripped state to a first-class citizen (#3606)
* Describe and hoist stripped state to a first-class citizen

Fixes https://github.com/matrix-org/matrix-doc/issues/3413
MSC: https://github.com/matrix-org/matrix-doc/pull/3173

* Add changelog

* may->can for clarity

* Update text per review
3 years ago
Travis Ralston 224773dc6a
Specify fallback keys (#3615)
* Specify fallback keys

MSC: https://github.com/matrix-org/matrix-doc/pull/2732

* changelog

* Appease spell check

* Fine, let's appease the spellcheck this way

* Apply suggestions from code review

Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>

* Fix intro

* word wrap

Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
3 years ago
Travis Ralston 26e0765159
Add guest changes to spec: MSC3069 and MSC3419 (#3605)
* Add MSC3069 support

https://github.com/matrix-org/matrix-doc/pull/3069

* Add MSC3419 support

https://github.com/matrix-org/matrix-doc/pull/3419

* Normalize and fix guest access endpoints list

* Changelogs
3 years ago
Travis Ralston 00169abcdb
Specify module order manually to work around hugo issues (#3612) 3 years ago
Travis Ralston 0ee58100c4
Add capabilities described by MSC3283 (#3614)
* Add capabilities described by MSC3283

MSC: https://github.com/matrix-org/matrix-doc/pull/3283

* changelog
3 years ago
Travis Ralston e4057072bd
Add registration token UIA type (#3616)
* Add registration token UIA type

MSC: https://github.com/matrix-org/matrix-doc/pull/3231

**Note**: This introduces the endpoint as v1 rather than r0 given the global versioning changes landed between the acceptance of the MSC and now.

* Fix swagger

* Changelogs

* Update data/api/client-server/registration_tokens.yaml

Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>

Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
3 years ago
Travis Ralston 20bd445602
Add a changelog for the appendices (#3609)
As a document which is versioned, we should have a changelog for it. It might be empty most of the time but oh well.
3 years ago
Lukas Lihotzki 4415e36a74 dump-swagger.py: include untagged operations (#3326) 3 years ago
Richard van der Hoff 3be746c9d3
Fix rendering of response examples (#3584)
* Fix rendering of response examples

Fixes the autogeneration of JSON examples for array objects. This fixes a
number of "Specification error: Example invalid or not present" errors in the
rendered spec.

* Unbreak examples for non-objects/arrays

The previous change had broken auto-generated examples for everything that
wasn't an object or array; fix it up again.

* Remove conditions on $example

Everything should now have a generated example, so the condition is
redundant. Furthermore it was suppressing examples for APIs where the example
was an empty dict.
3 years ago
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.
3 years ago
Travis Ralston 592cbd537c
Describe `matrix:` URI scheme (#3608)
* Copy spec PR near-verbatim from past PR

With light review being addressed.

https://github.com/matrix-org/matrix-doc/pull/3168

* Alter for modern day

* Add changelog

* specify that we're using the grammar
3 years ago
Travis Ralston 1e9dd4d22e
Avoid use of the word "clobber" (#3611)
* Avoid use of the word "clobber"

Fixes https://github.com/matrix-org/matrix-doc/issues/1328

* changelog
3 years ago
Travis Ralston 4734f40098 Add hugo build lock to gitignore 3 years ago
Travis Ralston afc5298f11
Replace s2s join sequence diagram for legibility (#3603)
Without the vertical lines it's a bit difficult to parse. A different tool was used to generate the graph this time.
3 years ago
Dan Callahan 48d8f7202d
Add HTTP 403 to possible profile responses (#3530)
* Add HTTP 403 to possible profile responses

Some servers may not allow profile lookup over federation, and thus
respond to GET /_matrix/client/v3/profile/{userId} with an HTTP 403.

For example, Synapse can be configured to behave in this way by setting:

    allow_profile_lookup_over_federation=false

Thus, this behavior already exists in the wild, and may cause issues for
clients such as https://github.com/vector-im/element-web/issues/17269.

Synapse could alter its behavior and return an HTTP 404 in these cases,
but amending the Spec seems preferable to align with extant behavior.
Further, allowing HTTP 403 gives clients more specific information as to
why a request has failed, enabling more precise error handling.

Signed-off-by: Dan Callahan <danc@element.io>

* Update changelogs/client_server/newsfragments/3530.clarification

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

* Annotate misc data about error

Co-authored-by: Travis Ralston <travpc@gmail.com>
Co-authored-by: Travis Ralston <travisr@matrix.org>
3 years ago
Travis Ralston dfec7d687e Remove extraneous slash 3 years ago
Alexandre Franke 6972342611
🐛 Fix base URL for OpenAPI definition (#3602)
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Travis Ralston afb6867232 Decorate the rest of the appservice login stuff too 3 years ago
Travis Ralston 76aaf39811 Decorate Matrix version on appservice login 3 years ago
Will Hunt a05706780d Add m.login.appservice to the spec (#3324)
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
Co-authored-by: Travis Ralston <travisr@matrix.org>
3 years ago
Travis Ralston 3ebe4e801b Fix historical spec build 3 years ago
Alexandre Franke b55cc15772
Fix links in OpenAPI description nodes (#3598)
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Travis Ralston 00ee4d7010 Add changelog 3 years ago
Aaron Raimist 01cd41de68
Add GitHub Action to check spelling (#3591)
Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
Travis Ralston d2fd90579b Add changelog 3 years ago
homersimpsons 9efe1887a4
instant_messaging: fix intra docs anchors (#3601)
Signed-off-by: homersimpsons <guillaume.alabre@gmail.com>
3 years ago
Shay 3ce9c1d288
MSC3550: Allow HTTP 403 as a response to profile lookups (#3550)
* add 403 proposal

* add msc number to file and filename

* correctly use markdown

* requested changes

* add links

* specify error code

* Update proposals/3550-allow-403-response-profile-lookup.md

Co-authored-by: Travis Ralston <travisr@matrix.org>

* fix formatting typo

Co-authored-by: Travis Ralston <travisr@matrix.org>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
3 years ago
Shay 87fcb7c8b0
Clarify that `base_url` in client `well_known` may or may not include trailing slash (#3562)
Fixes #3465. The change adds a line explicitly warning developers that the base_url of client well_known may or may not include a trailing slash and to be prepared to handle both cases.
3 years ago
Alexandre Franke 71ff06fd7a
⚰️ Remove leftover CircleCI config (#3579)
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Travis Ralston 336194aee4
Patch the release process docs (#3568)
* Add a release branch to avoid orphaned commits.
* Specify a patch process.
* Match reality and reference the internal deployment process.

This is largely what we do in practice now, including a created `release/v1.1` branch.
3 years ago
Hubert Chathi 71988263f3
clarify which signature to check (#3573) 3 years ago
Travis Ralston 0fbc6bdab6
Definition of "Standard Identifier Format" (#3171)
Spec for https://github.com/matrix-org/matrix-doc/pull/2758
3 years ago
Richard van der Hoff 4b866adac1
Bump `validator` dependency to 13.7.0 (#3566)
`validator` 13.6 has a security advisory:
https://github.com/advisories/GHSA-qgmg-gppg-76g5

I don't think it really affects us but it's making annoying noise in the repo.
3 years ago
Alexandre Franke d25fa13e6d
💚 Update PR description editing action (#3558)
Switch to upstream and use a more recent version.
Fixes failure to edit on empty descriptions.

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Alexandre Franke 806ae22da7
🚀 Make OpenAPI definition available (#3542)
* 🚀 Make OpenAPI definition available

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 💚 Fix artifact name

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 💚 Introduce dependency between jobs

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 🚀 Make historical definitions available

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Matthew Hodgson 87822fa105
MSC3419: Allow guests to send more event types (#3419)
* MSC3419 - Guest state events

Let guests send state events. Needed for guests to work with native
group voip in #3401

* typo

* Update 3419-guest-state-events.md

incorporate @clokep clarification

* also let guests send non-m.room.message events in general.

* Update proposals/3419-guest-state-events.md

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

* Update proposals/3419-guest-state-events.md

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

* wordwrap

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
3 years ago
Richard van der Hoff 86fb65a4bd
GHA: url-encode branch name in pull-request search (#3541) 3 years ago
Richard van der Hoff 83b24dd54d
Remove definition of Event for `/notifications` (#3525)
The documentation for the `/notifications` API had its own special definition
of what an Event was, which was used nowhere else.

The common definition isn't perfect, but it *is* common, so it gives us a
better starting place for improvement.
3 years ago
Richard van der Hoff 7f200c53e8
Move `prev_content` to unsigned (#3524) 3 years ago
David Robertson 1e12b45f97
Clarifications to /sync description (#3534)
* Clarify that E0 and E1 are not returned

* Clarify that ASCII art diagram 2 refers to diagram 1

* Correct third ASCII art diagram

To match the spacing in. Borked in the move to new docs format.

55aed1d296/specification/client_server_api.rst (L1610-L1615)

* Make ASCII art 3 follow from ASCII art 2

* Explain how to fill the gap

* Create 3543.clarification

* Update content/client-server-api/_index.md

Co-authored-by: Travis Ralston <travisr@matrix.org>
3 years ago
Alexandre Franke a26f2f8ca9
Fix typo (#3535)
* Fix typo

* Add changelog

Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Richard van der Hoff dce06f6dc2
Remove C-S `unsigned` data from PDU definitions (#3522)
Remove a bunch of fields from the `unsigned` property of PDUs. These things
shouldn't be passed over the Federation API, and they *really* shouldn't be
trusted if they are sent by another server.

 * `replaces_state` *is* returned by Synapse, but probably shouldn't
   be.
 * `redacted_because`, `prev_sender` and `prev_content` are not sent by Synapse.
3 years ago
Hubert Chathi 9654bf19b3 MSC2674: Event Relationships (#2674)
* initial version of event relationship MSC

* fix MSC numbers

* clarifications

* mention multiple relations per event might be useful, but postpone for a future MSC

* mention MSC 3051 for proposed multiple relations

* remove send_relation endpoint

* move e2ee section under sending relations

* mention limitation of leaving server-side aggregations out for now

* remove mentions of m.reference, we'll sort that out in another MSC

* whitespace

* argument why m.relates_to should be preserved by redactions more general

but still give example of redacted edits

* deal with this in the comments

* clarify the conditions to meet for a relation

* mention specifically that this does not replace replies (yet)

* clarify how general rel_types should be

* clarify that gaps may cause clients to be unaware of some relations

* Update proposals/2674-event-relationships.md

Co-authored-by: DeepBlueV7.X <nicolas.werner@hotmail.de>

* Update proposals/2674-event-relationships.md

Co-authored-by: DeepBlueV7.X <nicolas.werner@hotmail.de>

* make wording clearer and move to bottom of section

* remove this as references are not defined here anymore

* clearer wording

* move edge cases to other relevant mscs

* clarify that a goal of sticking to this format is backwards compat.

* mention MSC 3267, to which m.reference has been extracted

* Update proposals/2674-event-relationships.md

Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>

* Update proposals/2674-event-relationships.md

Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>

* Update proposals/2674-event-relationships.md

Co-authored-by: Matthew Hodgson <matthew@arasphere.net>

* Update proposals/2674-event-relationships.md

Co-authored-by: Matthew Hodgson <matthew@arasphere.net>

* Update proposals/2674-event-relationships.md

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

* wrap lines

* better wording

* this is singular, really

* add example of event shape

* specify how invalid relations should be treated by the redaction algorithm

* fix typo

* split up redactions changes in separate MSC

* also add new msc to introduction

* reword why not adopt m.in_reply_to

* remove guidelines how to pick rel_type

* mention that the target event must exist in the same room

* spell out the conscious (subject, object, verb) triple idea.

* Spelling

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

* remove paragraph saying what server should accept

* Revert "remove paragraph saying what server should accept"

This reverts commit e0271331b2.

* further specify that a server should reject invalid relations through the cs api

* linebreak

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

Co-authored-by: Bruno Windels <bruno@windels.cloud>
Co-authored-by: DeepBlueV7.X <nicolas.werner@hotmail.de>
Co-authored-by: Matthew Hodgson <matthew@arasphere.net>
Co-authored-by: Travis Ralston <travpc@gmail.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
3 years ago
Ankur ac98c8c08c
OpenAPI: Add missing `required` flag in `getRoomKeys` (#3509) 3 years ago
Matthew Hodgson 8d9a67d9f6
add an explicit dependencies block. 3 years ago
Richard van der Hoff f4a0c1aac5
Clarify event format text in room version specs (#3501)
Split the text about event IDs and event formats into separate sections. This
is largely to make it easier to link to, but I think the resulting text makes
more sense too.
3 years ago
Richard van der Hoff 92b29cf8e6
Add a changelog directory for room versions (#3504) 3 years ago
Richard van der Hoff d74a43f7cf
update docker instructions in README (#3502)
you need the fancy hugos.
3 years ago
Richard van der Hoff 0d8f466f39
Replace remaining CircleCI jobs with GHA (#3505)
Apparently the `build-docs` step is already happening, so we just need to port
the schema and example validation jobs.
3 years ago