From c1d5930226afbc0072fb5b6f67880637534d35b6 Mon Sep 17 00:00:00 2001 From: Justin Reardon Date: Mon, 21 Aug 2023 04:15:39 -0400 Subject: [PATCH] Fix references to ManagementRouteProvider (#1183) - replace misspelled `ManagementRoutesProvider` references with the actual class name `ManagementRouteProvider` in docs & reference.conf --- docs/src/main/paradox/akka-management.md | 4 ++-- management/src/main/resources/reference.conf | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/src/main/paradox/akka-management.md b/docs/src/main/paradox/akka-management.md index e85b3abd6..0ac7aa518 100644 --- a/docs/src/main/paradox/akka-management.md +++ b/docs/src/main/paradox/akka-management.md @@ -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 @@ -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: diff --git a/management/src/main/resources/reference.conf b/management/src/main/resources/reference.conf index 4f79104c5..71876a4e4 100644 --- a/management/src/main/resources/reference.conf +++ b/management/src/main/resources/reference.conf @@ -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`: @@ -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.