Skip to content

Commit

Permalink
docs: rewrite highlights heading to focus on the new structure
Browse files Browse the repository at this point in the history
  • Loading branch information
consideRatio committed Jul 4, 2023
1 parent 6c35161 commit f878707
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions docs/source/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit f878707

Please sign in to comment.