Skip to content

Commit

Permalink
Fix references to ManagementRouteProvider (#1183)
Browse files Browse the repository at this point in the history
- replace misspelled `ManagementRoutesProvider` references with the actual class name `ManagementRouteProvider` in docs & reference.conf
  • Loading branch information
reardonj authored Aug 21, 2023
1 parent 9bb6e4b commit c1d5930
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/src/main/paradox/akka-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ and even trigger joining/leaving/downing decisions via HTTP calls to these route
logic for these are implemented inside the `akka-management-cluster-http`.

Management route providers should be regular extensions that additionally extend the
`akka.management.scaladsl.ManagementRoutesProvider` or `akka.management.javadsl.ManagementRoutesProvider`
`akka.management.scaladsl.ManagementRouteProvider` or `akka.management.javadsl.ManagementRouteProvider`
interface.

Libraries may register routes into the management routes by defining entries to this setting
Expand All @@ -205,7 +205,7 @@ akka.management.http.routes {
Where the `name` of the entry should be unique to allow different route providers to be registered
by different libraries and applications.

The FQCN is the fully qualified class name of the `ManagementRoutesProvider`.
The FQCN is the fully qualified class name of the `ManagementRouteProvider`.

Route providers included by a library (from reference.conf) can be excluded by an application
by using `""` or `null` as the FQCN of the named entry, for example:
Expand Down
6 changes: 3 additions & 3 deletions management/src/main/resources/reference.conf
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ akka.management {

# Definition of management route providers which shall contribute routes to the management HTTP endpoint.
# Management route providers should be regular extensions that aditionally extend the
# `akka.management.scaladsl.ManagementRoutesProvider` or
# `akka.management.javadsl.ManagementRoutesProvider` interface.
# `akka.management.scaladsl.ManagementRouteProvider` or
# `akka.management.javadsl.ManagementRouteProvider` interface.
#
# Libraries may register routes into the management routes by defining entries to this setting
# the library `reference.conf`:
Expand All @@ -50,7 +50,7 @@ akka.management {
# Where the `name` of the entry should be unique to allow different route providers to be registered
# by different libraries and applications.
#
# The FQCN is the fully qualified class name of the `ManagementRoutesProvider`.
# The FQCN is the fully qualified class name of the `ManagementRouteProvider`.
#
# By default the `akka.management.HealthCheckRoutes` is enabled, see `health-checks` section of how
# configure specific readiness and liveness checks.
Expand Down

0 comments on commit c1d5930

Please sign in to comment.