Package io.smallrye.openapi.api

Interface OperationHandler

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface OperationHandler

Handler interface for a platform integration layer to inspect or modify an operation. The resource method and class from which the operation was constructed are also provided.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
static final OperationHandler	DEFAULT

Method Summary

Modifier and Type	Method	Description
void	handleOperation(org.eclipse.microprofile.openapi.models.Operation operation, org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo resourceMethod)	Callback to allow modification to an operation, together with the associated resource class and resource method associated with the operation.

Field Details

DEFAULT

static final OperationHandler DEFAULT

Method Details

handleOperation

void handleOperation(org.eclipse.microprofile.openapi.models.Operation operation,
 org.jboss.jandex.ClassInfo resourceClass,
 org.jboss.jandex.MethodInfo resourceMethod)

Callback to allow modification to an operation, together with the associated resource class and resource method associated with the operation.

Parameters:

operation - the OpenAPI operation model created from the resource class/method

resourceClass - the resource class that hosts REST endpoint methods

resourceMethod - resource method for a REST request. The method's declaring class may differ from the resource class. For example it may have been declared in an abstract class or interface.