Package com.atlassian.oai.validator.report

Interface ValidationReport.MessageContext

Enclosing interface:

ValidationReport

public static interface ValidationReport.MessageContext

Contextual information about a validation message.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ValidationReport.MessageContext.Builder
static enum	ValidationReport.MessageContext.Location
static class	ValidationReport.MessageContext.Pointers	Pointers to the instance being validated and the schema being used for validation

Method Summary

Modifier and Type	Method	Description
static ValidationReport.MessageContext.Builder	create()
static ValidationReport.MessageContext	empty()
ValidationReport.MessageContext	enhanceWith(ValidationReport.MessageContext other)	Return a new MessageContext instance that contains all of the data in this context, plus data from the incoming context where that data does not already exist on this context.
static ValidationReport.MessageContext.Builder	from(ValidationReport.MessageContext other)
Optional<ApiOperation>	getApiOperation()
Optional<io.swagger.v3.oas.models.parameters.RequestBody>	getApiRequestBodyDefinition()
Optional<String>	getApiRequestContentType()
Optional<io.swagger.v3.oas.models.responses.ApiResponse>	getApiResponseDefinition()
Optional<NamedWhitelistRule>	getAppliedWhitelistRule()
Optional<ValidationReport.MessageContext.Location>	getLocation()
Optional<io.swagger.v3.oas.models.parameters.Parameter>	getParameter()
Optional<ValidationReport.MessageContext.Pointers>	getPointers()
Optional<Request.Method>	getRequestMethod()
Optional<String>	getRequestPath()
Optional<Integer>	getResponseStatus()
boolean	hasData()

Method Details

empty

static ValidationReport.MessageContext empty()

create

static ValidationReport.MessageContext.Builder create()

from

static ValidationReport.MessageContext.Builder from(ValidationReport.MessageContext other)

getRequestPath

Optional<String> getRequestPath()

getRequestMethod

Optional<Request.Method> getRequestMethod()

getApiOperation

Optional<ApiOperation> getApiOperation()

getApiRequestContentType

Optional<String> getApiRequestContentType()

getApiRequestBodyDefinition

Optional<io.swagger.v3.oas.models.parameters.RequestBody> getApiRequestBodyDefinition()

getParameter

Optional<io.swagger.v3.oas.models.parameters.Parameter> getParameter()

getResponseStatus

Optional<Integer> getResponseStatus()

getApiResponseDefinition

Optional<io.swagger.v3.oas.models.responses.ApiResponse> getApiResponseDefinition()

getLocation

Optional<ValidationReport.MessageContext.Location> getLocation()

Returns:

Which part of the request/response interaction triggered the failure

getAppliedWhitelistRule

Optional<NamedWhitelistRule> getAppliedWhitelistRule()

Returns:

The whitelist rule applied to the message, if applicable.

getPointers

Optional<ValidationReport.MessageContext.Pointers> getPointers()

Returns:

Pointers to the instance and schema that caused the validation failure, if the failure is from schema validation.

hasData

boolean hasData()

Returns:

true if at least one field on this context object has been set; false otherwise.

enhanceWith

ValidationReport.MessageContext enhanceWith(ValidationReport.MessageContext other)

Return a new MessageContext instance that contains all of the data in this context, plus data from the incoming context where that data does not already exist on this context.

This is used to build a context up as more information becomes available.