Missing Request Body for Write Operation Actuator Endpoints #1565

Activity

1. bnasslahsen

   closed this as completedin 6ce3b5aon Mar 21, 2022
2. bnasslahsen commented on Mar 21, 2022

   

   bnasslahsen

   on Mar 21, 2022

   Collaborator

   More actions

   @mathieu-amblard,

   I have added a fix, to handle this case out of the box.
   Feel free to test with the latest SNAPSHOT and provide your feedback.
3. bnasslahsen

   added a commit that references this issue on Mar 21, 2022

   Changes report: Missing Request Body for Write Operation Actuator End…

   ...

   This issue will close once commit 495e88f is merged into the 'main' branch.

   495e88f
4. bnasslahsen

   added

   bugSomething isn't workingSomething isn't working

   on Mar 21, 2022
5. mathieu-amblard commented on Mar 23, 2022

   

   mathieu-amblard

   on Mar 23, 2022

   ContributorAuthor

   More actions

   I works well, thank you for the fix and for your reactivity 👍
6. bnasslahsen

   added a commit that references this issue on Mar 12, 2024

   Missing Request Body for Write Operation Actuator Endpoints. Fixes #1565

   ...

   This issue will close once commit 6ce3b5a is merged into the 'main' branch.

   6ce3b5a
7. mpleine

   added a commit that references this issue on May 17, 2025

   Changes report: Missing Request Body for Write Operation Actuator End…

   ...

   This issue will close once commit d061b3a is merged into the 'main' branch.

   d061b3a
8. ajs139 commented on Oct 22, 2025

   

   ajs139

   on Oct 22, 2025

   More actions

   The fix generates:

          "requestBody": {
             "content": {
               "application/json": {
                 "schema": {
                   "type": "string",
                   "enum": [
                     "TRACE",
                     "DEBUG",
                     "INFO",
                     "WARN",
                     "ERROR",
                     "FATAL",
                     "OFF"
                   ]
                 }
               }
             }
           },

   However, the request body should be an object type with a configuredLevel property.
9. jorgerod commented on Nov 26, 2025

   

   jorgerod

   on Nov 26, 2025

   Last edited by jorgerod

   More actions

   Hi @bnasslahsen @ajs139

   I'm experiencing the same issue described here, even though the issue was marked as closed.

   Context

   I'm using a custom actuator endpoint from the Resilience4j library (version 2.3.0), specifically the CircuitBreakerEndpoint class. This is a third-party library endpoint that we cannot modify - it comes from the io.github.resilience4j:resilience4j-spring-boot3 dependency.

   The Problem

   When using @Endpoint with @WriteOperation annotations (Spring Boot Actuator's standard approach), the enum parameter UpdateState is not rendered correctly in Swagger UI. The parameter appears but doesn't show the available enum values properly.

   Problematic code (from resilience4j library - we cannot modify this):

   /*
    * Copyright 2017 Robert Winkler
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *        http://www.apache.org/licenses/LICENSE-2.0
    */
   package io.github.resilience4j.circuitbreaker.monitoring.endpoint;
   
   import io.github.resilience4j.circuitbreaker.CircuitBreaker;
   import io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry;
   import io.github.resilience4j.common.circuitbreaker.monitoring.endpoint.CircuitBreakerUpdateStateResponse;
   import io.github.resilience4j.common.circuitbreaker.monitoring.endpoint.UpdateState;
   import io.swagger.v3.oas.annotations.Parameter;
   import io.swagger.v3.oas.annotations.enums.ParameterIn;
   import io.swagger.v3.oas.annotations.media.Schema;
   import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
   import org.springframework.boot.actuate.endpoint.annotation.Selector;
   import org.springframework.boot.actuate.endpoint.annotation.WriteOperation;
   
   import java.util.Arrays;
   
   @Endpoint(id = "circuitbreakers")
   public class CircuitBreakerEndpoint {
   
       private final CircuitBreakerRegistry circuitBreakerRegistry;
   
       public CircuitBreakerEndpoint(CircuitBreakerRegistry circuitBreakerRegistry) {
           this.circuitBreakerRegistry = circuitBreakerRegistry;
       }
   
       @WriteOperation
       public CircuitBreakerUpdateStateResponse updateCircuitBreakerState(
               @Selector String name,  UpdateState updateState) {
           final CircuitBreaker circuitBreaker = this.circuitBreakerRegistry.circuitBreaker(name);
           final String message = "%s state has been changed successfully";
           switch (updateState) {
               case CLOSE:
                   circuitBreaker.transitionToClosedState();
                   return this.createCircuitBreakerUpdateStateResponse(name, 
                       circuitBreaker.getState().toString(), String.format(message, name));
               case FORCE_OPEN:
                   circuitBreaker.transitionToForcedOpenState();
                   return this.createCircuitBreakerUpdateStateResponse(name, 
                       circuitBreaker.getState().toString(), String.format(message, name));
               case DISABLE:
                   circuitBreaker.transitionToDisabledState();
                   return this.createCircuitBreakerUpdateStateResponse(name, 
                       circuitBreaker.getState().toString(), String.format(message, name));
               default:
                   return this.createCircuitBreakerUpdateStateResponse(name, 
                       circuitBreaker.getState().toString(),
                       "State change value is not supported please use only " + 
                       Arrays.toString(UpdateState.values()));
           }
       }
   
       private CircuitBreakerUpdateStateResponse createCircuitBreakerUpdateStateResponse(
               String circuitBreakerName, String newState, String message) {
           final CircuitBreakerUpdateStateResponse response = new CircuitBreakerUpdateStateResponse();
           response.setCircuitBreakerName(circuitBreakerName);
           response.setCurrentState(newState);
           response.setMessage(message);
           return response;
       }
   }

   The UpdateState enum parameter doesn't display correctly in Swagger UI despite the @Parameter annotation with @Schema configuration.

   Why @RestControllerEndpoint is NOT a solution for us

   I've seen suggestions to use @RestControllerEndpoint instead of @Endpoint, and I can confirm that approach works. However, this is not a viable solution in our case because:

   1. We cannot modify the resilience4j library code - this endpoint comes from an external dependency
   2. We would need to create custom wrapper classes for every actuator endpoint from third-party libraries that has enum parameters
   3. This defeats the purpose of using the library's built-in endpoints and creates maintenance overhead

   For reference, here's what a @RestControllerEndpoint implementation looks like (which DOES work, but we cannot use it because we can't modify the library):

   @RestControllerEndpoint(id = "circuitbreakers")
   public class CircuitBreakerEndpoint {
       // ...
       @PostMapping("/updateState")
       public CircuitBreakerUpdateStateResponse updateCircuitBreakerState(
               @Selector String name, 
               UpdateState updateState) {
           // ... implementation
       }
   }

   Environment Details

   • Spring Boot: 3.5.8
   • springdoc-openapi-starter-webmvc-ui: 2.8.14
   • resilience4j-spring-boot3: 2.3.0
   • Java: 21

   Question

   Is there a way to make @Endpoint + @WriteOperation work correctly with enum parameters in Swagger UI without having to wrap or recreate third-party library endpoints?

   The current situation forces us to either:

   1. Accept broken Swagger UI documentation for these endpoints, or
   2. Create and maintain custom wrappers for all third-party actuator endpoints with enum parameters

   Neither option is ideal. Is there a configuration or workaround that would allow springdoc-openapi to properly introspect enum parameters in @Endpoint + @WriteOperation methods from third-party libraries?

   👀React with 👀1Reacted by Julio Gómez Díaz