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

Typing CS documentation contains mistake about the room_id #578

Closed
bmarty opened this issue Jan 13, 2020 · 2 comments · Fixed by #1265
Closed

Typing CS documentation contains mistake about the room_id #578

bmarty opened this issue Jan 13, 2020 · 2 comments · Fixed by #1265
Labels
A-Client-Server Issues affecting the CS API clarification An area where the expected behaviour is understood, but the spec could do with being more explicit

Comments

@bmarty
Copy link

bmarty commented Jan 13, 2020

In https://matrix.org/docs/spec/client_server/latest#id49, the part:

but still have a room_id key

is not correct.

Also in the sample of https://matrix.org/docs/spec/client_server/latest#m-typing:

{
    "content": {
        "user_ids": [
            "@alice:matrix.org",
            "@bob:example.com"
        ]
    },
    "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
    "type": "m.typing"
}

contains room_id field, which is actually not the case.

The typing event is already in the rooms.join.{room_id}.ephemeral.events list of the sync response, so room_id is not necessary in the event content. And it's actually not there. The issue is just in the documentation.

@bmarty bmarty added enhancement A suggestion for a relatively simple improvement to the protocol p3 labels Jan 13, 2020
@turt2live
Copy link
Member

This probably needs clarifying in the /sync section rather than in the typing module

@turt2live turt2live added clarification An area where the expected behaviour is understood, but the spec could do with being more explicit A-Client-Server Issues affecting the CS API and removed enhancement A suggestion for a relatively simple improvement to the protocol p3 labels Jan 13, 2020
@richvdh richvdh transferred this issue from matrix-org/matrix-spec-proposals Mar 1, 2022
@richvdh
Copy link
Member

richvdh commented Sep 22, 2022

in https://spec.matrix.org/v1.3/client-server-api/#typing-notifications, looks like the example has been updated but not the text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Client-Server Issues affecting the CS API clarification An area where the expected behaviour is understood, but the spec could do with being more explicit
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants