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

Document supported matrix versions, and introduce compatibility modes for older ones #404

Open
5 tasks
ShadowJonathan opened this issue Nov 10, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ShadowJonathan
Copy link
Contributor

ShadowJonathan commented Nov 10, 2021

Is your feature request related to a problem? Please describe.

Matrix now has a quarterly release cadence, starting with v1.1, it'd help if libraries and clients can start relying on these versions to introduce, work with, or otherwise stay compatible with versions and features per-version.

Describe the solution you'd like

A few action items;

  • Document the matrix versions supported ("Compatible with matrix vX" badges/shields#7245)
    • Make supported matrix versions programmaticallu queryable
  • Introduce compatibility probing (call /versions)
    • Bubble error when client cannot properly communicate to server.
      ("Cannot communicate with server, this library version supports versions v1.1 and v1.2, but the server only supports v1.0")
  • Introduce compatibility modes based off of the /versions response for older versions

Describe alternatives you've considered

Additional context

@jplatte jplatte added the enhancement New feature or request label Apr 8, 2022
@gnunicorn gnunicorn added the documentation Improvements or additions to documentation label Apr 20, 2022
@gnunicorn gnunicorn mentioned this issue Apr 21, 2022
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants