From f8787071c38515c4af546f81e8e9b25dcc55dd81 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 4 Jul 2023 14:40:50 +0200 Subject: [PATCH] docs: rewrite highlights heading to focus on the new structure --- docs/source/reference/changelog.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/source/reference/changelog.md b/docs/source/reference/changelog.md index 8ff5212c..c44aeb7a 100644 --- a/docs/source/reference/changelog.md +++ b/docs/source/reference/changelog.md @@ -55,16 +55,19 @@ changes_ and _deprecations_ you should read through before upgrading. - [OpenShift] {attr}`.OpenShiftOAuthenticator.validate_cert` is deprecated and is being replaced by {attr}`.OAuthenticator.validate_server_cert`. -#### Highlights - -- [All] Low level configurations in `GenericOAuthenticator` has been moved to - the common base class `OAuthenticator` and is therefore available to all - authenticators. - - - {attr}`.OAuthenticator.basic_auth` - - {attr}`.OAuthenticator.token_params` - - {attr}`.OAuthenticator.userdata_params` - - {attr}`.OAuthenticator.userdata_token_method` +#### A new structure + +The authenticators are no longer overriding the `authenticate` method, but +instead relying on the OAuthenticator base class `authenticate` method which +calls a few lower level methods that can be overridden if needed. Like this, a +lot of code has been absorbed into the OAuthenticator base class that was +previously duplicated across authenticators. + +To learn more about this new structure the provider specific authenticator +classes rely on, please for now inspect the source code for the +`OAuthenticator.authenticate` method and `OAuthenticator.check_allowed` method. +Plans on writing more thorough documentation about this new structure is tracked +in issue [#634](https://github.com/jupyterhub/oauthenticator/issues/634). #### New features added