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

MSC2301: server info endpoint #2301

Open
wants to merge 3 commits into
base: master
from

Conversation

@ara4n
Copy link
Member

commented Sep 23, 2019

We turn /versions into a more generic unauthed server /info endpoint, suitable for sharing branding information to clients before they login or register.

Open question on whether to use a server info room to store the bulk of the data or not.

Rendered

@ara4n ara4n added the proposal label Sep 23, 2019
to try to solve matrix-org/synapse#1199
@ara4n ara4n referenced this pull request Sep 23, 2019
@aaronraimist

This comment has been minimized.

Copy link
Contributor

commented Sep 23, 2019

So this is an alternate way to do #1929?

@grinapo

This comment has been minimized.

Copy link

commented Sep 23, 2019

Also #2063?

We have many different APIs for querying server capabilities and configuration:

* `/_matrix/client/versions` tells you what CS API versions your server supports (unauthed)
* `/_matrix/media/r0/config` tells you the capabilities of your media repository (unauthed)

This comment has been minimized.

Copy link
@turt2live

turt2live Sep 24, 2019

Member
Suggested change
* `/_matrix/media/r0/config` tells you the capabilities of your media repository (unauthed)
* `/_matrix/media/r0/config` tells you the capabilities of your media repository (authed)
* `/_matrix/client/r0/capabilities` tells you whether your server supports various optional capabilities (but is authed)
* `/_matrix/federation/v1/capabilities` (MSC2127) is a proposal to tell you when you can upgrade rooms or not (authed as server)
* MSC2233 as a rejected un-authed capabilities endpoint
* System Alerts (as a way of sharing server updates with users)

This comment has been minimized.

Copy link
@turt2live

turt2live Sep 24, 2019

Member

We call them server notices: https://matrix.org/docs/spec/client_server/r0.5.0#module-server-notices

Suggested change
* System Alerts (as a way of sharing server updates with users)
* Server Notices (as a way of sharing server updates with users)

```json
{
"m.brand.server_name": "Matthew's Server",

This comment has been minimized.

Copy link
@turt2live

turt2live Sep 24, 2019

Member

why are we not using objects for m.brand?

"m.brand.server_name": "Matthew's Server",
"m.brand.server_info": "Where all the cool kids hang out",
"m.motd": "This server will be upgraded on Oct 1st",
"m.server_admin": "@admin:example.com",

This comment has been minimized.

Copy link
@turt2live

turt2live Sep 24, 2019

Member

what if my admin is an email address? what if there's many?

}
```

## Alternatives

This comment has been minimized.

Copy link
@turt2live

turt2live Sep 24, 2019

Member

Needs comparison to #1929 and #2063 (per comments)

@@ -0,0 +1,75 @@
# Proposal for an /info endpoint on the CS API

## Problem
@bwindels

This comment has been minimized.

Copy link
Contributor

commented Sep 25, 2019

How would clients receive updates to the info data? Periodic polling of the endpoint?

@ara4n

This comment has been minimized.

Copy link
Member Author

commented Oct 23, 2019

ugh, i tried to enumerate all the existing prior art in the 7 bullet points at the beginning of this, but apparently missed #1929 and #2063. sorry. what a mess.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.