Custom operation filters

[romash1408]

Is your feature request related to a problem? Please describe.
We have little library for api versioning that generates custom RequestCondition depending on special annotation. So we can write controllers like this:

@RestController
public class Controller {
    @Versioner(till = 0)
    @GetMapping("/test")
    public String old() {
        return "old";
    }

    @Versioner(from = 1)
    @GetMapping("/test")
    public Integer other() {
        return 123;
    }
}

Then GET /v0/test returns "old" and GET /v1/test returns 123

Now we need openapi to produce 2 groups: group v0 with GET /test endpoint that produces String and group v1 with GET /test endpoint that produces Integer

Describe the solution you'd like
Something like addCustomFilter in GroupedOpenApi.Builder where I can use handlerMethod.getMethodAnnotation(Versioner.class) to determine, if this method should be displayed in this group

Describe alternatives you've considered

• I have tried to filter paths in OpenApiCustomiser, but when it is called, there is already only one endpoint because the others have been overwritten here due to identical operationPath (/test)

[bnasslahsen]

@romash1408,

You can combine GroupedOpenApi with OperationCustomizer where you have access to handlerMethod.
This is sample code.

[romash1408]

Hello, @bnasslahsen. thank you for you response.
Maybe my issue description is not very good, sorry. But I need to remove (what I called "to filter") some operations. And as I can see OperationCustomizer doesn't have methods to do that. Am I wrong?

[romash1408]

By the way, OperationCustomizer's javadoc says that it should @return customized operation, but returned value is ignored.
This behavior may confuse people who try

	OperationCustomizer operationCustomizer() {
		return (Operation operation, HandlerMethod handlerMethod) -> {
                        Operation newOperation = new Operation();
                        // ...
			return newOperation;
		};
	}

[bnasslahsen]

@romash1408,

OperationCustomizer is not for filtering operations.
For deciding whether to hide or not operation. You can simply use @Hidden annotation.

[romash1408]

@Hidden annotation don't let me filter operation only in certain groups. I need to select operations for group depending on my custom annotation.

[bnasslahsen]

@romash1408,

Frankly, i am not sure you need any additional feature.
I don't understand why you are not able to filter using OpenApiCustomiser as mentioned earlier.

[michaelkrog]

@romash1408 Did you find a solution for this?

I have been trying for 2 days now to make springdoc filter out the right controllers for the specific (version) groups but havent succeeded yet. It always seem to have merged methods from multiple versioned controllers into the same operations before I can get to them with OpenApiCustomizer because they have the same path and signature.

[bnasslahsen]

@michaelkrog,

What criteria are you using to identify a controller for the specific (version) ?

[michaelkrog]

I have a custom Annotation on the controllerlevel. A custom RequestMappingHandlerMapping & RequrstCondition ensures that all versions of the same controller can be registered with the otherwise same MVC signature. In my case only a header determines the required version of the controller to hit.

I tried a lot of the examples I could find and several of your suggestions for filtering out in groups, but I always ended up with mixed results, fx. multiple versions of the same schema being referenced in one group. It seems to me that the controller methods that have the same MVC signature (not including my custom conditions) are merged before I can customize them.

[bnasslahsen]

@michaelkrog,

If you are in case you using headers that determines the required version, you can use headersToMatch of GroupedOpenApi. Sample code is available here.

If this does not answer your custom filtering, make sure you provide a Minimal, Reproducible Example - with HelloController that reproduces your problem, and we will see how we can help.

[michaelkrog]

@bnasslahsen

Simply using Spring MVC's header matching won't suffice in my case. My need for selecting the controller to serve the request is more sophisticated.

I have created the smallest project reproducing the problem that I can think of here:
https://github.com/michaelkrog/springdoc-demo

The Readme of the project adds a bit more details to the versioning concept and problem I am seeing.

Do you want a whole new issue created or is it fine to reopen this one if you find it to be an issue?