Skip to content

Commit a539518

Browse files
zecakehbnjbvr
authored andcommitted
chore: Add changelog for Oidc renaming
Signed-off-by: Kévin Commaille <[email protected]>
1 parent f61cd60 commit a539518

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

crates/matrix-sdk/CHANGELOG.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ simpler methods:
9494
- `Oidc::fetch_authentication_issuer()` was removed. To check if the
9595
homeserver supports OAuth 2.0, use `Oidc::provider_metadata()`. To get the
9696
issuer, use `VerifiedProviderMetadata::issuer()`.
97-
- `Oidc::provider_metadata()` returns an `OauthDiscoveryError`. It has a
97+
- `Oidc::provider_metadata()` returns an `OAuthDiscoveryError`. It has a
9898
`NotSupported` variant and an `is_not_supported()` method to check if the
9999
error is due to the server not supporting OAuth 2.0.
100100
- `OidcError::MissingAuthenticationIssuer` was removed.
@@ -157,6 +157,19 @@ simpler methods:
157157
- [**breaking**] The `server_url` and `server_response` methods of
158158
`SsoLoginBuilder` are replaced by `server_builder()`, which allows more
159159
fine-grained settings for the server.
160+
- [**breaking**]: Rename the `Oidc` API to `OAuth`, since it's using almost
161+
exclusively OAuth 2.0 rather than OpenID Connect.
162+
([#4805](https://github.com/matrix-org/matrix-rust-sdk/pull/4805))
163+
- The `oidc` module was renamed to `oauth`.
164+
- `Client::oidc()` was renamed to `Client::oauth()` and the `AuthApi::Oidc`
165+
variant was renamed to `AuthApi::OAuth`.
166+
- `OidcSession` was renamed to `OAuthSession` and the `AuthSession::Oidc`
167+
variant was renamed to `AuthSession::OAuth`.
168+
- `OidcAuthCodeUrlBuilder` and `OidcAuthorizationData` were renamed to
169+
`OAuthAuthCodeUrlBuilder` and `OAuthAuthorizationData`.
170+
- `OidcError` was renamed to `OAuthError` and the `RefreshTokenError::Oidc`
171+
variant was renamed to `RefreshTokenError::OAuth`.
172+
- `Oidc::provider_metadata()` was renamed to `OAuth::server_metadata()`.
160173

161174
## [0.10.0] - 2025-02-04
162175

0 commit comments

Comments
 (0)