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

documentation about state key unclear or accidentally removed #1013

Closed
julianhille opened this issue Mar 22, 2022 · 1 comment · Fixed by #1100
Closed

documentation about state key unclear or accidentally removed #1013

julianhille opened this issue Mar 22, 2022 · 1 comment · Fixed by #1100
Assignees
Labels
release-blocker Blocks the next release from happening spec-bug Something which is in the spec, but is wrong

Comments

@julianhille
Copy link

julianhille commented Mar 22, 2022

Describe the bug
There was a documentation about the state key in the client server spec, which stated:

| Key          | Type         | Description                                                                                                  |
|--------------|--------------|--------------------------------------------------------------------------------------------------------------|
| state_key    | string       | **Required.** A unique key which defines the overwriting semantics for this piece of room state. This value is often a zero-length string. The presence of this key makes this event a State Event. State keys starting with an `@` are reserved for referencing user IDs, such as room members. With the exception of a few events, state events set with a given user's ID as the state key MUST only be set by that user.         |

The part about the user ID and the zero length is missing now and has been removed in this PR by @richvdh :
matrix-org/matrix-spec-proposals#3658 from this file https://github.com/matrix-org/matrix-spec-proposals/blob/5b44bc4bd71baa5ffbd71b4fae921035aa291bd1/content/client-server-api/_index.md

Too me this looks like an accidental remove and it is not clear to me if the code here in synapse: https://github.com/matrix-org/synapse/blob/develop/synapse/event_auth.py#L549

is outdated / wrong or if it is correct and the documentation is not specific enough anymore.

@richvdh
Copy link
Member

richvdh commented Mar 22, 2022

oops, matrix-org/matrix-spec-proposals#3658 was not intended to change the spec here.

@richvdh richvdh added spec-bug Something which is in the spec, but is wrong release-blocker Blocks the next release from happening labels Mar 22, 2022
@anoadragon453 anoadragon453 transferred this issue from matrix-org/matrix-spec-proposals Mar 30, 2022
@turt2live turt2live self-assigned this May 30, 2022
turt2live added a commit that referenced this issue May 31, 2022
* Re-add paragraph about how some state keys are reserved

Fixes #1013

* changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-blocker Blocks the next release from happening spec-bug Something which is in the spec, but is wrong
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants