Skip to content

Conversation

@hyderraza18
Copy link
Contributor

This PR updates the matrix-auth plugin JCasC documentation to reflect the syntax changes introduced in matrix-auth 3.2+.
The previous examples used the deprecated pre-3.2 format.
I added an updated example using the new entries: structure and noted that the old format is deprecated but still works when deprecated: warn is enabled.

  • [ x] Make sure you are requesting to pull a topic/feature/bugfix branch (right side) and not your master branch!
  • [ x] Ensure that the pull request title represents the desired changelog entry
  • [ x] Please describe what you did
  • [ x] Link to relevant issues in GitHub or in Jenkins JIRA
  • [ x] Link to relevant pull requests, esp. upstream and downstream changes
  • Did you provide a test-case? That demonstrates feature works or fixes the issue.

@hyderraza18 hyderraza18 requested a review from a team as a code owner November 24, 2025 12:11
Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

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

The documentation does use the 3.2+ format already???

@hyderraza18
Copy link
Contributor Author

The documentation does use the 3.2+ format already???

The docs mention 3.2+, but the example shown is still using the older pre-3.2 syntax.
My change updates the example to the actual 3.2+ entries: format used by matrix-auth now, so the documentation matches the current schema.

@timja
Copy link
Member

timja commented Nov 24, 2025

The documentation does use the 3.2+ format already???

The docs mention 3.2+, but the example shown is still using the older pre-3.2 syntax. My change updates the example to the actual 3.2+ entries: format used by matrix-auth now, so the documentation matches the current schema.

Your change only adds:

Note: Starting from matrix-auth 3.2, the older
grantedPermissions: JCasC syntax is deprecated.
The examples below already use the new entries: format, which should be used going forward.

You have a conflict with master probably got an old version locally?

@hyderraza18
Copy link
Contributor Author

@timja Yes , i did not notice that. I will make the necessary changes

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.

2 participants