From f782783f3c4e5555973509249fe08a5c590f3093 Mon Sep 17 00:00:00 2001 From: Marta Medio Date: Thu, 23 Nov 2023 13:12:02 +0100 Subject: [PATCH] Add docs with output of gateway actuator endpoint --- .../main/asciidoc/spring-cloud-gateway.adoc | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/src/main/asciidoc/spring-cloud-gateway.adoc b/docs/src/main/asciidoc/spring-cloud-gateway.adoc index f7ce13cc..d0ef4e5d 100644 --- a/docs/src/main/asciidoc/spring-cloud-gateway.adoc +++ b/docs/src/main/asciidoc/spring-cloud-gateway.adoc @@ -2787,6 +2787,50 @@ management.endpoints.web.exposure.include=gateway ---- ==== +This endpoint provides an overview of what is available on the child actuator endpoint and the available methods for each reference. The resulting response is similar to the following: + +[source,json] +---- +[ + { + "href":"/actuator/gateway/", + "methods":[ "GET" ] + }, + { + "href":"/actuator/gateway/routedefinitions", + "methods":[ "GET" ] + }, + { + "href":"/actuator/gateway/globalfilters", + "methods":[ "GET" ] + }, + { + "href":"/actuator/gateway/routefilters", + "methods":[ "GET" ] + }, + { + "href":"/actuator/gateway/routes", + "methods":[ "POST", "GET" ] + }, + { + "href":"/actuator/gateway/routepredicates", + "methods":[ "GET" ] + }, + { + "href":"/actuator/gateway/refresh", + "methods":[ "POST" ] + }, + { + "href":"/actuator/gateway/routes/route-id-1/combinedfilters", + "methods":[ "GET" ] + }, + { + "href":"/actuator/gateway/routes/route-id-1", + "methods":[ "POST", "DELETE", "GET" ] + } +] +---- + === Verbose Actuator Format A new, more verbose format has been added to Spring Cloud Gateway.