Package org.zalando.problem.spring.web.advice.validation

Interface OpenApiValidationAdviceTrait

All Superinterfaces:

AdviceTrait, AdviceTrait

@API(status=EXPERIMENTAL)
public interface OpenApiValidationAdviceTrait

Method Summary

Modifier and Type	Method	Description
default Violation	createViolation(com.atlassian.oai.validator.report.ValidationReport.Message message)
default org.zalando.problem.StatusType	defaultConstraintViolationStatus()
default URI	defaultConstraintViolationType()
default String	formatFieldName(String fieldName)	Format the name of a violating field (e.g.
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	handleInvalidRequest(com.atlassian.oai.validator.springmvc.InvalidRequestException exception, org.springframework.web.context.request.NativeWebRequest request)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	handleInvalidResponse(com.atlassian.oai.validator.springmvc.InvalidResponseException exception, org.springframework.web.context.request.NativeWebRequest request)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	newConstraintViolationProblem(Exception exception, org.springframework.web.context.request.NativeWebRequest request, com.atlassian.oai.validator.report.ValidationReport report)
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	newConstraintViolationProblem(Throwable throwable, Collection<Violation> stream, org.springframework.web.context.request.NativeWebRequest request)

Methods inherited from interface org.zalando.problem.spring.common.AdviceTrait

createStackTrace, isCausalChainsEnabled, prepare, process, resolveResponseStatus, toProblem, toProblem, toProblem

Methods inherited from interface org.zalando.problem.spring.web.advice.AdviceTrait

create, create, create, create, create, create, create, create, create, fallback, log, negotiate, process

Method Detail

handleInvalidRequest

@API(status=INTERNAL)
@ExceptionHandler
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> handleInvalidRequest(com.atlassian.oai.validator.springmvc.InvalidRequestException exception,
                                                                                                  org.springframework.web.context.request.NativeWebRequest request)

handleInvalidResponse

@API(status=INTERNAL)
@ExceptionHandler
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> handleInvalidResponse(com.atlassian.oai.validator.springmvc.InvalidResponseException exception,
                                                                                                   org.springframework.web.context.request.NativeWebRequest request)

newConstraintViolationProblem

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> newConstraintViolationProblem(Exception exception,
                                                                                                           org.springframework.web.context.request.NativeWebRequest request,
                                                                                                           com.atlassian.oai.validator.report.ValidationReport report)

createViolation

default Violation createViolation(com.atlassian.oai.validator.report.ValidationReport.Message message)

defaultConstraintViolationType

default URI defaultConstraintViolationType()

defaultConstraintViolationStatus

default org.zalando.problem.StatusType defaultConstraintViolationStatus()

formatFieldName

default String formatFieldName(String fieldName)

Format the name of a violating field (e.g. lower camel to snake case)

Parameters:

fieldName - the field name to format

Returns:

the formatted field name, defaults to the parameter, i.e. doesn't apply any transformation

newConstraintViolationProblem

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> newConstraintViolationProblem(Throwable throwable,
                                                                                                           Collection<Violation> stream,
                                                                                                           org.springframework.web.context.request.NativeWebRequest request)