Global @Parameter(hidden = true) Handling Inquiry

[hongseungjae]

Hi

Summary

I am trying to globally apply @Parameter(hidden = true) for @Login LoginInfo loginInfo without manually adding it to each controller method. However, the expected behavior is not achieved for @RequestBody parameters in POST/PUT requests.

---

Steps to Reproduce

1. Add SpringDoc Dependency

   implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'

2. Implement GlobalOperationCustomizer

   @Bean
   public GlobalOperationCustomizer customize() {
       return (operation, handlerMethod) -> {
           if (operation.getParameters() == null) {
               operation.setParameters(new ArrayList<>());
           }
   
           // Find parameters annotated with @Login
           List<String> loginParamNames = Arrays.stream(handlerMethod.getMethodParameters())
                   .filter(param -> param.hasParameterAnnotation(Login.class))
                   .map(param -> param.getParameter().getName())
                   .collect(Collectors.toList());
   
           // Remove @Login parameters from GET, DELETE requests
           operation.getParameters().removeIf(parameter -> loginParamNames.contains(parameter.getName()));
   
           // Remove @Login from @RequestBody in POST, PUT requests
           if (operation.getRequestBody() != null) {
               Content content = operation.getRequestBody().getContent();
               if (content != null) {
                   content.values().forEach(mediaType -> {
                       Schema<?> schema = mediaType.getSchema();
                       if (schema != null && schema.getProperties() != null) {
                           loginParamNames.forEach(schema.getProperties()::remove);
                       }
                   });
               }
           }
   
           return operation;
       };
   }

3. Define Controller Methods

   @PostMapping
   @Operation(summary = "Add Exclusion Keyword")
   public ResponseEntity<ApiResponse<Void>> addExclusionKeyword(
           @RequestBody ExclusionKeywordAddRequest exclusionKeywordAddRequest, 
           @Login LoginInfo loginInfo) {
       return ResponseEntity.ok(ApiResponseGenerator.success());
   }
   
   @PostMapping("/2")
   @Operation(summary = "Add Exclusion Keyword 2")
   public ResponseEntity<ApiResponse<Void>> addExclusionKeyword2(
           @RequestBody ExclusionKeywordAddRequest exclusionKeywordAddRequest, 
           @Parameter(hidden = true) @Login LoginInfo loginInfo) {
       return ResponseEntity.ok(ApiResponseGenerator.success());
   }

---

addExclusionKeyword Behavior

LoginInfo has been removed from the Swagger configuration, but the two result structures are different:

{
  "exclusionKeywordAddRequest": {
    "exclusionKeyword": "Test",
    "state": "Y"
  }
}

---

addExclusionKeyword2 Behavior

{
  "exclusionKeyword": "Test",
  "state": "Y"
}

The swagger structure is changed as in 1, but is there a way to get the same result as in 2?

---

Question

How can I modify the global configuration to ensure that @Login LoginInfo loginInfo is removed in the same way as manually adding @Parameter(hidden = true), so that the request body structure is flattened correctly in Swagger?

Could you please help me?

[hongseungjae]

Sorry, I found a really simple solution.

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Parameter(hidden = true)
public @interface Login {
}

Adding @parameter(hidden = true) to the Login annotation solved the issue.
I foolishly tried to apply it to the LoginInfo class instead.

Closing this issue now.