Skip to content

Add reportRoom API #4753

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

Merged
merged 6 commits into from
Mar 17, 2025
Merged

Add reportRoom API #4753

merged 6 commits into from
Mar 17, 2025

Conversation

Half-Shot
Copy link
Contributor

@Half-Shot Half-Shot commented Mar 17, 2025

This arrived in Matrix 1.13 https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidreport

Checklist

  • Tests written for new code (and old code if feasible).
  • New or updated public/exported symbols have accurate TSDoc documentation.
  • Linter and other CI checks pass.
  • Sign-off given on the changes (see CONTRIBUTING.md).

@t3chguy
Copy link
Member

t3chguy commented Mar 17, 2025

The SDK claims it doesn't support 1.13 yet: https://github.com/matrix-org/matrix-js-sdk/blob/develop/src/version-support.ts#L26

@Half-Shot
Copy link
Contributor Author

The SDK claims it doesn't support 1.13 yet: https://github.com/matrix-org/matrix-js-sdk/blob/develop/src/version-support.ts#L26

There are certainly elements of 1.10+ supported in this SDK, so what's the procedure for it? Should I put a docstring in warning that it's only partially supported?

@t3chguy
Copy link
Member

t3chguy commented Mar 17, 2025

Definitely worth mentioning the Matrix version requirement in the typedoc IMO, as the error from the server in such a case won't be helpful, likely a 404 M_UNRECOGNIZED

Copy link
Member

@dbkr dbkr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say this is fine: saying that we support an certain API version is saying we support all of it, we can still support bits of newer versions. We generally have not done any kind of version checking on news APIs like this since if it's not there, it will just fail anyway.

@Half-Shot Half-Shot enabled auto-merge March 17, 2025 14:59
@Half-Shot Half-Shot added this pull request to the merge queue Mar 17, 2025
Merged via the queue into develop with commit e62aabc Mar 17, 2025
30 checks passed
@Half-Shot Half-Shot deleted the hs/report-room branch March 17, 2025 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants