Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add server support discovery endpoint #1733

Merged
merged 8 commits into from
Mar 19, 2024
Merged

Conversation

zecakeh
Copy link
Contributor

@zecakeh zecakeh commented Feb 27, 2024

As per MSC1929.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
@zecakeh zecakeh requested a review from a team as a code owner February 27, 2024 19:09
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generally this looks good to me - I have a bunch of minor editorial comments.

Thank you!

data/api/client-server/support.yaml Outdated Show resolved Hide resolved
data/api/client-server/support.yaml Outdated Show resolved Hide resolved
data/api/client-server/support.yaml Outdated Show resolved Hide resolved
data/api/client-server/support.yaml Outdated Show resolved Hide resolved
contacts:
type: array
description: |-
Ways to contact the server administrator.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should define "administrator" somewhere here. I believe the MSC had some notion of what the admin's contact could be used for - can we incorporate that into the schema somewhere?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see anything on the MSC about why the admins would be contacted, other than the description of the role property.

data/api/client-server/support.yaml Outdated Show resolved Hide resolved
data/api/client-server/support.yaml Outdated Show resolved Hide resolved
data/api/client-server/support.yaml Outdated Show resolved Hide resolved
data/api/client-server/support.yaml Outdated Show resolved Hide resolved
data/api/client-server/support.yaml Outdated Show resolved Hide resolved
zecakeh and others added 5 commits March 4, 2024 09:55
Co-authored-by: Travis Ralston <travpc@gmail.com>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
@turt2live turt2live self-requested a review March 4, 2024 18:53
@turt2live turt2live mentioned this pull request Mar 12, 2024
23 tasks
@@ -363,6 +363,8 @@ specify parameter values. The flow for this method is as follows:

{{% http-api spec="client-server" api="versions" %}}

{{% http-api spec="client-server" api="support" %}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not convinced this belongs under "Server discovery". I'd be inclined to put it in a new "Module", but I'm open to other suggestions

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rationale behind the suggestion to put it here is you're discovering information about the server without necessarily needing to speak the rest of Matrix. Both authenticated and unauthenticated clients can use this, and it's "before" the homeserver APIs really start to do anything.

Arguably though, we should rename or introduce a section for .well-known stuff. I think this is best left to a future PR at this stage.

Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Apologies for this taking so long to review.

If we do want to move it to another section/module, that can be done with a follow-up PR imo.

@turt2live turt2live merged commit 44c1691 into matrix-org:main Mar 19, 2024
12 checks passed
@zecakeh zecakeh deleted the msc1929 branch March 19, 2024 21:34
@richvdh
Copy link
Member

richvdh commented Mar 19, 2024

It's a bit of an anomaly that https://spec.matrix.org/unstable/client-server-api/#well-known-uri now talks about "Servers hosting the .well-known JSON file", and now there are two .well-known JSON files. Generally I don't feel that section is particularly coherent now. But yes, we can improve this later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants