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

Fix m.call.negotiate schema and example #1546

Merged
merged 4 commits into from Oct 3, 2023

Conversation

zecakeh
Copy link
Contributor

@zecakeh zecakeh commented May 26, 2023

Introduced in #1511. The properties and example look like a copy-paste of m.call.invite, but don't match the description of the event, nor MSC2746.

cc @dbkr

Preview: https://pr1546--matrix-spec-previews.netlify.app

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
@zecakeh zecakeh requested a review from a team as a code owner May 26, 2023 08:29
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
@zecakeh
Copy link
Contributor Author

zecakeh commented May 26, 2023

Furthermore it looks like this paragraph in the description is out of place. It probably deserves to be in the text of the module, and/or on the corresponding events/fields description:

In the `m.call.invite` and `m.call.answer` events, the `offer` and `answer`
fields respectively are objects of type `RTCSessionDescriptionInit`. Hence
the `type` field, whilst redundant in these events, is included for ease of
working with the WebRTC API and is mandatory. Receiving clients should not
attempt to validate the `type` field, but simply pass the object into the
WebRTC API.

And given the text in it, I'm wondering if we should remove the enum property of the corresponding schemas, so clients don't try to validate them against the given values.

@richvdh richvdh requested a review from dbkr May 26, 2023 09:48
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
@richvdh richvdh requested a review from dbkr June 20, 2023 16:11
@dbkr dbkr merged commit 242b62e into matrix-org:main Oct 3, 2023
10 checks passed
@zecakeh zecakeh deleted the fix-call-negotiate branch October 4, 2023 07:14
@zecakeh zecakeh mentioned this pull request Nov 30, 2023
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants