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

Link to mxid grammar in register endpoint docs #1793

Closed
dbkr opened this issue Jan 10, 2019 · 1 comment · Fixed by #2091
Closed

Link to mxid grammar in register endpoint docs #1793

dbkr opened this issue Jan 10, 2019 · 1 comment · Fixed by #2091
Assignees
Labels
clarification An area where the spec could do with being more explicit client-server Client-Server API

Comments

@dbkr
Copy link
Member

dbkr commented Jan 10, 2019

The docs for POST /_matrix/client/r0/register go into some detail on how the grammar for mxids is restricted but only link to the actual grammar in the docs for the user_id response field. This feels like it belongs somewhere more prominent, eg. when it first talk about the grammar.

(Also we really need to split out a common spec section for this kind of thing: it being relegated to an appendix doesn't seem right).

@turt2live turt2live added the clarification An area where the spec could do with being more explicit label Jan 10, 2019
@turt2live turt2live added the client-server Client-Server API label Feb 6, 2019
@turt2live turt2live added this to Nice to have clarifications in Matrix 1.0 workflow May 25, 2019
@turt2live turt2live moved this from Clarifications TODO to To add to spec in Matrix 1.0 workflow Jun 3, 2019
@turt2live turt2live moved this from To add to spec to In progress in Matrix 1.0 workflow Jun 6, 2019
@turt2live turt2live self-assigned this Jun 6, 2019
@turt2live
Copy link
Member

Also we really need to split out a common spec section for this kind of thing: it being relegated to an appendix doesn't seem right

This is a general theme across the spec. We arguably also need to version the appendices, and possibly the index. We also need to clarify the relationship of spec versions (CS API advancing faster than the s2s spec, where both are slower than room versions...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification An area where the spec could do with being more explicit client-server Client-Server API
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants