Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ACCEPT - Static variable in interface com.atlassian.oai.validator.model.Headers
- ADDITIONAL_PROPERTIES_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- ADDITIONAL_PROPERTIES_KEY - Static variable in class com.atlassian.oai.validator.schema.SchemaValidator
- AdditionalPropertiesInjectionTransformer - Class in com.atlassian.oai.validator.schema.transform
-
Transformer that injects `additionalProperties: false` into the nodes in the schema tree if additional properties validation is enabled.
- AdditionalPropertiesInjectionTransformer() - Constructor for class com.atlassian.oai.validator.schema.transform.AdditionalPropertiesInjectionTransformer
- addOpeningAndTrailingNewlines(String, boolean) - Static method in class com.atlassian.oai.validator.util.StringUtils
-
Adds "\r\n" to the beginning and to the end of the string if not there
- allOf(WhitelistRule...) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Creates a rule that matches if all given rules match.
- allOf(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- ALLOF_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- and(WhitelistRule) - Method in interface com.atlassian.oai.validator.whitelist.rule.WhitelistRule
-
Creates a new rule that matches only if this and that matches.
- anyOf(WhitelistRule...) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Creates a rule that matches if any of the given rules match.
- anyOf(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- ANYOF_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- ApiLoadException(String, SwaggerParseResult) - Constructor for exception com.atlassian.oai.validator.OpenApiInteractionValidator.ApiLoadException
- ApiLoadException(String, Throwable) - Constructor for exception com.atlassian.oai.validator.OpenApiInteractionValidator.ApiLoadException
- ApiOperation - Class in com.atlassian.oai.validator.model
-
A container representing a single API operation.
- ApiOperation(ApiPath, NormalisedPath, PathItem.HttpMethod, Operation) - Constructor for class com.atlassian.oai.validator.model.ApiOperation
- ApiOperationMatch - Class in com.atlassian.oai.validator.model
-
After trying to find the best matching
ApiOperationthis model contains the information if the path is defined, the operation is allowed and if so theApiOperationitself, too. - ApiOperationMatch(ApiOperation) - Constructor for class com.atlassian.oai.validator.model.ApiOperationMatch
-
If and only if a
ApiOperationwas found thisApiOperationMatchcontains it. - ApiOperationResolver - Class in com.atlassian.oai.validator.interaction
-
Component responsible for matching an incoming request path + method with an operation defined in the OAI spec.
- ApiOperationResolver(OpenAPI, String, boolean) - Constructor for class com.atlassian.oai.validator.interaction.ApiOperationResolver
-
A utility for finding the best fitting API path.
- ApiPath - Interface in com.atlassian.oai.validator.model
-
Representation of a path within an OpenAPI / Swagger specification.
- ApiPathImpl - Class in com.atlassian.oai.validator.model
- ApiPathImpl(String, String) - Constructor for class com.atlassian.oai.validator.model.ApiPathImpl
- ApiPathImpl(String, String, boolean) - Constructor for class com.atlassian.oai.validator.model.ApiPathImpl
- apply(ValidationReport) - Method in class com.atlassian.oai.validator.report.JsonValidationReportFormat
- apply(ValidationReport) - Method in class com.atlassian.oai.validator.report.SimpleValidationReportFormat
- apply(ValidationReport) - Method in interface com.atlassian.oai.validator.report.ValidationReportFormat
-
Format the given validation report as a
Stringsuitable for logging etc. - apply(ValidationReport.Message) - Method in class com.atlassian.oai.validator.report.JsonValidationReportFormat
- apply(JsonNode, SchemaTransformationContext) - Method in class com.atlassian.oai.validator.schema.transform.AdditionalPropertiesInjectionTransformer
- apply(JsonNode, SchemaTransformationContext) - Method in class com.atlassian.oai.validator.schema.transform.RequiredFieldTransformer
- apply(JsonNode, SchemaTransformationContext) - Method in class com.atlassian.oai.validator.schema.transform.SchemaDefinitionsInjectionTransformer
- apply(JsonNode, SchemaTransformationContext) - Method in class com.atlassian.oai.validator.schema.transform.SchemaRefInjectionTransformer
- apply(JsonNode, SchemaTransformationContext) - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
-
Apply the schema transformation to the given node.
- AUTHORIZATION - Static variable in interface com.atlassian.oai.validator.model.Headers
B
- badRequest() - Static method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
A convenience method for creating a
SimpleResponse.Builderwith the HTTP status code 400. - Base64Attribute - Class in com.atlassian.oai.validator.schema.format
- Body - Interface in com.atlassian.oai.validator.model
- build() - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Builds a
SimpleRequestout of this builder. - build() - Method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
Builds a
SimpleResponseout of this builder. - build() - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
Build a configured
OpenApiInteractionValidatorinstance with the values collected in this builder. - build() - Method in class com.atlassian.oai.validator.report.LevelResolver.Builder
-
Build and return a new
LevelResolverinstance created from the configuration collected in this builder. - build() - Method in class com.atlassian.oai.validator.report.ValidationReport.Message.Builder
- build() - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- build() - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext.Builder
- Builder() - Constructor for class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
- Builder() - Constructor for class com.atlassian.oai.validator.report.LevelResolver.Builder
- Builder(int) - Constructor for class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
Creates a
SimpleResponse.Builderwith the given HTTP status code. - Builder(Request.Method, String) - Constructor for class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Creates a
SimpleRequest.Builderwith the given HTTPRequest.Methodand path. - Builder(Request.Method, String, boolean) - Constructor for class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Creates a
SimpleRequest.Builderwith the given HTTPRequest.Methodand path including the specification if the query parameters are handled case sensitive or not. - Builder(String, String) - Constructor for class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Creates a
SimpleRequest.Builderwith the given HTTP method and path. - Builder(String, String, boolean) - Constructor for class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Creates a
SimpleRequest.Builderwith the given HTTP method and path including the specification if the query parameters are handled case sensitive or not. - ByteArrayBody - Class in com.atlassian.oai.validator.model
- ByteArrayBody(byte[]) - Constructor for class com.atlassian.oai.validator.model.ByteArrayBody
C
- ChainingLoader(LevelLoader...) - Constructor for class com.atlassian.oai.validator.report.LevelLoader.ChainingLoader
- checkValue(Collection<JsonPointer>, MessageBundle, ProcessingReport, SchemaTree) - Method in class com.atlassian.oai.validator.schema.keyword.DiscriminatorSyntaxChecker
- checkValue(Collection<JsonPointer>, MessageBundle, ProcessingReport, SchemaTree) - Method in class com.atlassian.oai.validator.schema.keyword.Nullable.NullableSyntaxChecker
- classpathLoader() - Static method in interface com.atlassian.oai.validator.report.LevelLoader
-
Loads levels from a properties file "/swagger-validator.properties" in the project's classpath.
- CLIENT_ERROR - Enum constant in enum com.atlassian.oai.validator.whitelist.StatusType
-
All client error (4xx) status codes
- com.atlassian.oai.validator - package com.atlassian.oai.validator
- com.atlassian.oai.validator.interaction - package com.atlassian.oai.validator.interaction
- com.atlassian.oai.validator.interaction.request - package com.atlassian.oai.validator.interaction.request
- com.atlassian.oai.validator.interaction.response - package com.atlassian.oai.validator.interaction.response
- com.atlassian.oai.validator.model - package com.atlassian.oai.validator.model
- com.atlassian.oai.validator.report - package com.atlassian.oai.validator.report
- com.atlassian.oai.validator.schema - package com.atlassian.oai.validator.schema
- com.atlassian.oai.validator.schema.format - package com.atlassian.oai.validator.schema.format
- com.atlassian.oai.validator.schema.keyword - package com.atlassian.oai.validator.schema.keyword
- com.atlassian.oai.validator.schema.transform - package com.atlassian.oai.validator.schema.transform
- com.atlassian.oai.validator.util - package com.atlassian.oai.validator.util
- com.atlassian.oai.validator.whitelist - package com.atlassian.oai.validator.whitelist
- com.atlassian.oai.validator.whitelist.rule - package com.atlassian.oai.validator.whitelist.rule
- COMPONENTS_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- containsGlobalAccept(Collection<String>) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Return whether the given content types includes a "global match" wildcard
- CONTENT_TYPE - Static variable in interface com.atlassian.oai.validator.model.Headers
- ContentTypeUtils - Class in com.atlassian.oai.validator.util
- create() - Static method in class com.atlassian.oai.validator.report.LevelResolver
-
Create a new
LevelResolverinstance using a builder to obtain configuration. - create() - Static method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- create() - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext
- create() - Static method in class com.atlassian.oai.validator.whitelist.ValidationErrorsWhitelist
-
Creates an empty validation whitelist.
- create(String, String) - Static method in interface com.atlassian.oai.validator.report.ValidationReport.Message
- create(String, String, String...) - Method in class com.atlassian.oai.validator.report.MessageResolver
-
Create a message with the given key and message.
- createFor(OpenAPI) - Static method in class com.atlassian.oai.validator.OpenApiInteractionValidator
-
Create a new instance using a parsed API specification.
- createFor(String) - Static method in class com.atlassian.oai.validator.OpenApiInteractionValidator
-
Create a new instance using the OpenAPI / Swagger specification at the given location OR an actual specification payload.
- createFor(String) - Static method in class com.atlassian.oai.validator.SwaggerRequestResponseValidator
-
Deprecated.
- createForInlineApiSpecification(String) - Static method in class com.atlassian.oai.validator.OpenApiInteractionValidator
-
Create a new instance using given the OpenAPI / Swagger specification.
- createForSpecificationUrl(String) - Static method in class com.atlassian.oai.validator.OpenApiInteractionValidator
-
Create a new instance using the OpenAPI / Swagger specification at the given location.
- currentDirectoryLoader() - Static method in interface com.atlassian.oai.validator.report.LevelLoader
-
Loads levels from a properties file ".swagger-validator" in the user's current directory.
- CustomDateTimeFormatter - Class in com.atlassian.oai.validator.schema
-
A custom
DateTimeFormatterfor date and time format defined in RFC3339. - CustomRequestValidator - Interface in com.atlassian.oai.validator.interaction.request
-
User-defined validation for a request.
- CustomResponseValidator - Interface in com.atlassian.oai.validator.interaction.response
-
User-defined validation for a response.
D
- defaultLevel() - Method in class com.atlassian.oai.validator.report.LevelLoader.ChainingLoader
- defaultLevel() - Method in interface com.atlassian.oai.validator.report.LevelLoader
-
Load the default level from this loader (if it has been defined).
- defaultLevel() - Method in class com.atlassian.oai.validator.report.LevelLoader.PropertiesLoader
- defaultLoaderChain() - Static method in interface com.atlassian.oai.validator.report.LevelLoader
-
The default loader chain used when no other loader is specified.
- defaultResolver() - Static method in class com.atlassian.oai.validator.report.LevelResolver
-
Create a new default
LevelResolver. - defaultsLoader() - Static method in interface com.atlassian.oai.validator.report.LevelLoader
-
Loads default level values from the "default-levels.properties" file in the library's classpath.
- delete(String) - Static method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
A convenience method for creating a
SimpleRequest.Builderwith HTTP method DELETE and the given path. - DELETE - Enum constant in enum com.atlassian.oai.validator.model.Request.Method
- digest(JsonNode) - Method in class com.atlassian.oai.validator.schema.keyword.Discriminator.DiscriminatorDigester
- digest(JsonNode) - Method in class com.atlassian.oai.validator.schema.keyword.Nullable.NullableDigester
- disableAdditionalProperties(ObjectNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- Discriminator - Class in com.atlassian.oai.validator.schema.keyword
- DISCRIMINATOR_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- Discriminator.DiscriminatorDigester - Class in com.atlassian.oai.validator.schema.keyword
-
Digester for the
discriminatorkeyword introduced by the OpenAPI / Swagger specification. - DiscriminatorKeywordValidator - Class in com.atlassian.oai.validator.schema.keyword
-
Keyword validator for the
discriminatorkeyword introduced by the OpenAPI / Swagger specification. - DiscriminatorKeywordValidator(JsonNode) - Constructor for class com.atlassian.oai.validator.schema.keyword.DiscriminatorKeywordValidator
- DiscriminatorSyntaxChecker - Class in com.atlassian.oai.validator.schema.keyword
-
Syntax checker for the
discriminatorkeyword introduced by the OpenAPI / Swagger specification. - DoubleAttribute - Class in com.atlassian.oai.validator.schema.format
- doValidate(Processor<FullData, FullData>, ProcessingReport, MessageBundle, FullData) - Method in class com.atlassian.oai.validator.schema.keyword.DiscriminatorKeywordValidator
E
- empty() - Static method in interface com.atlassian.oai.validator.report.ValidationReport
-
Return an empty report.
- empty() - Static method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- EmptyValidationReport - Class in com.atlassian.oai.validator.report
-
An empty
ValidationReportwhich contains noValidationReport.Message. - enhanceWith(ValidationReport.MessageContext) - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
-
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.
- entityIs(String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches if the given entity (identified by name) is sent in the request or returned in the response, as specified in the spec (actual json payload are not inspected).
- equals(Object) - Method in class com.atlassian.oai.validator.whitelist.NamedWhitelistRule
- equals(Object) - Method in class com.atlassian.oai.validator.whitelist.ValidationErrorsWhitelist
- ERROR - Enum constant in enum com.atlassian.oai.validator.report.ValidationReport.Level
- extractMultipartBoundary(String) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Extracts boundary from multipart/form-data content type
- extractMultipartBoundary(String) - Static method in class com.atlassian.oai.validator.util.HttpParsingUtils
-
Extracts boundary from multipart/form-data content type
F
- findApiOperation(String, Request.Method) - Method in class com.atlassian.oai.validator.interaction.ApiOperationResolver
-
Tries to find the best fitting API path matching the given path and request method.
- findMostSpecificMatch(Request, Set<String>) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Find the content-type that most specifically matches the content-type defined on the given request.
- findMostSpecificMatch(Response, Set<String>) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Find the content-type that most specifically matches the content-type defined on the given response.
- findMostSpecificMatch(String, Set<String>) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Find the content-type that most specifically matches the given candidate content type.
- FloatAttribute - Class in com.atlassian.oai.validator.schema.format
- forRequest(boolean) - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext.Builder
- forResponse(boolean) - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext.Builder
- from(ValidationReport.Message...) - Static method in interface com.atlassian.oai.validator.report.ValidationReport
-
Return an unmodifiable report containing all the provided messages
- from(ValidationReport.MessageContext) - Static method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- from(Collection<ValidationReport.Message>) - Static method in interface com.atlassian.oai.validator.report.ValidationReport
-
Return an unmodifiable report containing all the provided messages
G
- get() - Method in interface com.atlassian.oai.validator.schema.SchemaValidator.JsonNodeSupplier
- get() - Static method in class com.atlassian.oai.validator.schema.SwaggerV20Library
- get(String) - Static method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
A convenience method for creating a
SimpleRequest.Builderwith HTTP method GET and the given path. - get(String, Object...) - Method in class com.atlassian.oai.validator.report.MessageResolver
-
Get the message with the given key.
- GET - Enum constant in enum com.atlassian.oai.validator.model.Request.Method
- getAdditionalInfo() - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
- getApiOperation() - Method in class com.atlassian.oai.validator.model.ApiOperationMatch
- getApiOperation() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getApiPath() - Method in class com.atlassian.oai.validator.model.ApiOperation
- getApiRequestBodyDefinition() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getApiRequestContentType() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getApiResponseDefinition() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getAppliedWhitelistRule() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getBody() - Method in interface com.atlassian.oai.validator.model.Request
-
Deprecated.
- getBody() - Method in interface com.atlassian.oai.validator.model.Response
-
Deprecated.use
Response.getResponseBody(). This method will be removed in a future release. - getBody() - Method in class com.atlassian.oai.validator.model.SimpleRequest
- getBody() - Method in class com.atlassian.oai.validator.model.SimpleResponse
- getBundle() - Method in class com.atlassian.oai.validator.schema.SwaggerV20Library.SyntaxBundle
- getBundle() - Method in class com.atlassian.oai.validator.schema.SwaggerV20Library.ValidationBundle
- getCharsetFromContentType(Multimap<String, String>) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Resolves the content-type of the given headers, if it is defined.
- getCharsetFromContentType(String) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Extract and return the charset from the given content-type, if it is defined.
- getContentType() - Method in interface com.atlassian.oai.validator.model.Request
-
Get the content-type header of this request, if it has been set.
- getContentType() - Method in interface com.atlassian.oai.validator.model.Response
-
Get the content-type header of this response, if it has been set.
- getContext() - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
-
Returns contextual information about this message, if it is available.
- getHeaders() - Method in interface com.atlassian.oai.validator.model.Request
-
Get the collection of headers on this request.
- getHeaders() - Method in class com.atlassian.oai.validator.model.SimpleRequest
- getHeaderValue(String) - Method in interface com.atlassian.oai.validator.model.Request
-
Get the first of header value for the header param with the given name (if any exist).
- getHeaderValue(String) - Method in interface com.atlassian.oai.validator.model.Response
-
Get the first of header value for the header param with the given name (if any exist).
- getHeaderValues(String) - Method in interface com.atlassian.oai.validator.model.Request
-
Get the collection of header values for the header param with the given name.
- getHeaderValues(String) - Method in interface com.atlassian.oai.validator.model.Response
-
Get the collection of header values for the header param with the given name.
- getHeaderValues(String) - Method in class com.atlassian.oai.validator.model.SimpleRequest
- getHeaderValues(String) - Method in class com.atlassian.oai.validator.model.SimpleResponse
- getInstance() - Static method in class com.atlassian.oai.validator.report.JsonValidationReportFormat
- getInstance() - Static method in class com.atlassian.oai.validator.report.SimpleValidationReportFormat
- getInstance() - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Pointers
- getInstance() - Static method in class com.atlassian.oai.validator.schema.format.Base64Attribute
- getInstance() - Static method in class com.atlassian.oai.validator.schema.format.DoubleAttribute
- getInstance() - Static method in class com.atlassian.oai.validator.schema.format.FloatAttribute
- getInstance() - Static method in class com.atlassian.oai.validator.schema.format.Int32Attribute
- getInstance() - Static method in class com.atlassian.oai.validator.schema.format.Int64Attribute
- getInstance() - Static method in class com.atlassian.oai.validator.schema.keyword.Discriminator.DiscriminatorDigester
- getInstance() - Static method in class com.atlassian.oai.validator.schema.keyword.Discriminator
- getInstance() - Static method in class com.atlassian.oai.validator.schema.keyword.Nullable
- getInstance() - Static method in class com.atlassian.oai.validator.schema.keyword.Nullable.NullableDigester
- getInstance() - Static method in class com.atlassian.oai.validator.schema.transform.AdditionalPropertiesInjectionTransformer
- getInstance() - Static method in class com.atlassian.oai.validator.schema.transform.RequiredFieldTransformer
- getInstance() - Static method in class com.atlassian.oai.validator.schema.transform.SchemaDefinitionsInjectionTransformer
- getInstance() - Static method in class com.atlassian.oai.validator.schema.transform.SchemaRefInjectionTransformer
- getKey() - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
- getLevel() - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
- getLevel(String) - Method in class com.atlassian.oai.validator.report.LevelResolver
-
Gets the
ValidationReport.Levelfor the given message key. - getLevel(String) - Method in class com.atlassian.oai.validator.report.MessageResolver
-
Get the level that the given message key would be resolved at when using the
MessageResolver.get(java.lang.String, java.lang.Object...)orMessageResolver.create(java.lang.String, java.lang.String, java.lang.String...)methods. - getLocation() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getMaxCacheSize() - Method in class com.atlassian.oai.validator.schema.ValidationConfiguration
-
Specifies the maximum number of JsonSchema entries the cache in
SchemaValidatormay contain. - getMessage() - Method in exception com.atlassian.oai.validator.OpenApiInteractionValidator.ApiLoadException
- getMessage() - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
- getMessages() - Method in class com.atlassian.oai.validator.report.EmptyValidationReport
- getMessages() - Method in class com.atlassian.oai.validator.report.ImmutableValidationReport
- getMessages() - Method in class com.atlassian.oai.validator.report.MergedValidationReport
- getMessages() - Method in interface com.atlassian.oai.validator.report.ValidationReport
-
Get the validation messages on this report.
- getMethod() - Method in class com.atlassian.oai.validator.model.ApiOperation
- getMethod() - Method in interface com.atlassian.oai.validator.model.Request
- getMethod() - Method in class com.atlassian.oai.validator.model.SimpleRequest
- getName() - Method in class com.atlassian.oai.validator.whitelist.NamedWhitelistRule
- getNestedMessages() - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
- getOperation() - Method in class com.atlassian.oai.validator.model.ApiOperation
- getParameter() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getParseMessages() - Method in exception com.atlassian.oai.validator.OpenApiInteractionValidator.ApiLoadException
- getPath() - Method in interface com.atlassian.oai.validator.model.Request
- getPath() - Method in class com.atlassian.oai.validator.model.SimpleRequest
- getPointers() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getQueryParameters() - Method in interface com.atlassian.oai.validator.model.Request
- getQueryParameters() - Method in class com.atlassian.oai.validator.model.SimpleRequest
- getQueryParameterValues(String) - Method in interface com.atlassian.oai.validator.model.Request
-
Get the collection of query parameter values for the query param with the given name.
- getQueryParameterValues(String) - Method in class com.atlassian.oai.validator.model.SimpleRequest
- getRequestBody() - Method in interface com.atlassian.oai.validator.model.Request
- getRequestBody() - Method in class com.atlassian.oai.validator.model.SimpleRequest
- getRequestMethod() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getRequestPath() - Method in class com.atlassian.oai.validator.model.ApiOperation
- getRequestPath() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getRequiredFieldNames(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- getResponseBody() - Method in interface com.atlassian.oai.validator.model.Response
- getResponseBody() - Method in class com.atlassian.oai.validator.model.SimpleResponse
- getResponseStatus() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- getRFC3339Formatter() - Static method in class com.atlassian.oai.validator.schema.CustomDateTimeFormatter
- getRule() - Method in class com.atlassian.oai.validator.whitelist.NamedWhitelistRule
- getSchema() - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Pointers
- getSchemaDefinitions() - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext
- getSpecUrlOrPayload() - Method in exception com.atlassian.oai.validator.OpenApiInteractionValidator.ApiLoadException
- getStatus() - Method in interface com.atlassian.oai.validator.model.Response
- getStatus() - Method in class com.atlassian.oai.validator.model.SimpleResponse
- getValidator() - Method in class com.atlassian.oai.validator.SwaggerRequestResponseValidator
-
Deprecated.
- getValue() - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.SpecSource
H
- hasAdditionalFieldSet(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- hasAllOfField(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- hasBody() - Method in interface com.atlassian.oai.validator.model.Body
- hasBody() - Method in class com.atlassian.oai.validator.model.ByteArrayBody
- hasBody() - Method in class com.atlassian.oai.validator.model.InputStreamBody
- hasBody() - Method in class com.atlassian.oai.validator.model.StringBody
- hasContentType(Request) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Determine whether a given request has a content-type header.
- hasContentType(Response) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Determine whether a given request has a content-type header.
- hasData() - Method in interface com.atlassian.oai.validator.report.ValidationReport.MessageContext
- hasDiscriminatorField(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- hasErrors() - Method in class com.atlassian.oai.validator.report.EmptyValidationReport
- hasErrors() - Method in class com.atlassian.oai.validator.report.MergedValidationReport
- hasErrors() - Method in interface com.atlassian.oai.validator.report.ValidationReport
-
Return if this validation report contains errors.
- hashCode() - Method in class com.atlassian.oai.validator.whitelist.NamedWhitelistRule
- hashCode() - Method in class com.atlassian.oai.validator.whitelist.ValidationErrorsWhitelist
- hasParams(int) - Method in interface com.atlassian.oai.validator.model.ApiPath
- hasParams(int) - Method in class com.atlassian.oai.validator.model.ApiPathImpl
- hasPropertiesField(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- hasRequiredFields(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- head(String) - Static method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
A convenience method for creating a
SimpleRequest.Builderwith HTTP method HEAD and the given path. - HEAD - Enum constant in enum com.atlassian.oai.validator.model.Request.Method
- headerContains(String, String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Deprecated.
- headerContainsRegexp(String, String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches requests or responses where the given regex matches a subsequence within at least one of the given header's values.
- headerContainsSubstring(String, String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches requests or responses where at least one of the given header's values contains the given substring.
- Headers - Interface in com.atlassian.oai.validator.model
- HttpAcceptUtils - Class in com.atlassian.oai.validator.util
-
Utils for parsing a HTTP Accept header into a list of media types
- HttpParsingUtils - Class in com.atlassian.oai.validator.util
I
- IGNORE - Enum constant in enum com.atlassian.oai.validator.report.ValidationReport.Level
- ImmutableValidationReport - Class in com.atlassian.oai.validator.report
-
A
ValidationReportcontaining a singleValidationReport.Message. - in(ValidationReport.MessageContext.Location) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- indentString(String, String) - Static method in class com.atlassian.oai.validator.util.StringUtils
-
Inserts indentStr before every line
- INFO - Enum constant in enum com.atlassian.oai.validator.report.ValidationReport.Level
- inline(String) - Static method in class com.atlassian.oai.validator.OpenApiInteractionValidator.SpecSource
- InputStreamBody - Class in com.atlassian.oai.validator.model
- InputStreamBody(InputStream) - Constructor for class com.atlassian.oai.validator.model.InputStreamBody
- Int32Attribute - Class in com.atlassian.oai.validator.schema.format
- Int64Attribute - Class in com.atlassian.oai.validator.schema.format
- INVALID_JSON_KEY - Static variable in class com.atlassian.oai.validator.schema.SchemaValidator
- isAdditionalPropertiesValidationEnabled() - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext
- isArrayDefinition(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- isCacheEnabled() - Method in class com.atlassian.oai.validator.schema.ValidationConfiguration
-
If the maxCacheSize is less than or equal to 0, then disable jsonSchemaCache in
SchemaValidator. - isFormDataContentType(Request) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Determine whether a given request has a formdata content-type.
- isFormDataContentType(Response) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Determine whether a given response has a formdata content-type.
- isFormDataContentType(String) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
- isIgnored(String) - Method in class com.atlassian.oai.validator.report.MessageResolver
-
Determine if the message with the given key would be resolved with a level of
ValidationReport.Level.IGNORE. - isInlineSpecification() - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.SpecSource
- isJsonContentType(Request) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Determine whether a given request has a JSON content-type.
- isJsonContentType(Response) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
- isJsonContentType(String) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
- isMultipartContentTypeAcceptedByConsumer(String, String) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Checks if the content type of a multipart/form-data request matches the consumer's content type.
- isMultipartContentTypeAcceptedByConsumer(String, String) - Static method in class com.atlassian.oai.validator.util.HttpParsingUtils
-
Checks if the content type of a multipart/form-data request matches the consumer's content type.
- isMultipartFormDataContentType(String) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
- isObjectDefinition(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- isOperationAllowed() - Method in class com.atlassian.oai.validator.model.ApiOperationMatch
- isPathFound() - Method in class com.atlassian.oai.validator.model.ApiOperationMatch
- isReadOnly(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- isRequest() - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext
- isRequest() - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches all request errors.
- isResponse() - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext
- isResponse() - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches all response errors.
- isSpecUrl() - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.SpecSource
- isWriteOnly(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- itemsDefinition(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
J
- JsonValidationReportFormat - Class in com.atlassian.oai.validator.report
-
Formats a
ValidationReportas a JSON string for use in tooling etc.
K
- KEYWORD - Static variable in class com.atlassian.oai.validator.schema.keyword.Discriminator
- KEYWORD - Static variable in class com.atlassian.oai.validator.schema.keyword.Nullable
L
- LevelLoader - Interface in com.atlassian.oai.validator.report
- LevelLoader.ChainingLoader - Class in com.atlassian.oai.validator.report
-
A loader that chains multiple loaders together.
- LevelLoader.PropertiesLoader - Class in com.atlassian.oai.validator.report
-
Loads levels from properties of the form
{prefix}{key}={LEVEL}. - LevelResolver - Class in com.atlassian.oai.validator.report
-
Resolves the
ValidationReport.Levelfor a given message key. - LevelResolver.Builder - Class in com.atlassian.oai.validator.report
-
A builder for creating
LevelResolverinstances. - LevelResolverFactory - Class in com.atlassian.oai.validator.report
- loadApi(OpenApiInteractionValidator.SpecSource, List<AuthorizationValue>, ParseOptions) - Method in class com.atlassian.oai.validator.util.OpenApiLoader
-
Loads the
OpenAPIfrom the specified source and prepares it for usage. - loadLevels() - Method in class com.atlassian.oai.validator.report.LevelLoader.ChainingLoader
- loadLevels() - Method in interface com.atlassian.oai.validator.report.LevelLoader
-
Load message levels from this loader.
- loadLevels() - Method in class com.atlassian.oai.validator.report.LevelLoader.PropertiesLoader
M
- matches(int) - Method in enum com.atlassian.oai.validator.whitelist.StatusType
- matches(NormalisedPath) - Method in interface com.atlassian.oai.validator.model.ApiPath
-
Determine if the given request path matches this API path, taking into consideration path params.
- matches(NormalisedPath) - Method in class com.atlassian.oai.validator.model.ApiPathImpl
- matches(ValidationReport.Message, ApiOperation, Request, Response) - Method in interface com.atlassian.oai.validator.whitelist.rule.WhitelistRule
- matches(String, MediaType) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
- matchesAny(MediaType, Collection<String>) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Returns whether the candidate media type matches any of the applied API content type expressions.
- matchesAny(String, Collection<String>) - Static method in class com.atlassian.oai.validator.util.ContentTypeUtils
-
Returns whether the candidate media type matches any of the applied API content type expressions.
- merge(ValidationReport) - Method in interface com.atlassian.oai.validator.report.ValidationReport
-
Merges the given validation report with this one, and return a new, unmodifiable report containing the messages from both reports.
- MergedValidationReport - Class in com.atlassian.oai.validator.report
-
A
ValidationReportserving as container for multipleValidationReports. - messageContains(String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Deprecated.
- messageContainsRegexp(String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches validation messages that contain a substring that matches the given regular expression.
- messageContainsSubstring(String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches validation messages that contain a substring that matches the given regular expression.
- messageHasKey(String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches all error messages with the given key.
- MessageResolver - Class in com.atlassian.oai.validator.report
-
Resolves a message key to a
ValidationReport.Messageobject. - MessageResolver() - Constructor for class com.atlassian.oai.validator.report.MessageResolver
-
Create a new instance with the default
LevelResolver(all messages will be emitted at the ERROR level). - MessageResolver(LevelResolver) - Constructor for class com.atlassian.oai.validator.report.MessageResolver
-
Create a new instance with the provided {
LevelResolver}. - methodIs(PathItem.HttpMethod) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches all operations with the given method.
- MISSING_PATH - Static variable in class com.atlassian.oai.validator.model.ApiOperationMatch
-
The searched path is not defined in the API definition.
N
- NamedWhitelistRule - Class in com.atlassian.oai.validator.whitelist
- noContent() - Static method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
A convenience method for creating a
SimpleResponse.Builderwith the HTTP status code 204. - normalised() - Method in interface com.atlassian.oai.validator.model.NormalisedPath
- normalised() - Method in class com.atlassian.oai.validator.model.NormalisedPathImpl
- NormalisedPath - Interface in com.atlassian.oai.validator.model
-
A normalised representation of an API path.
- NormalisedPathImpl - Class in com.atlassian.oai.validator.model
- NormalisedPathImpl(String, String) - Constructor for class com.atlassian.oai.validator.model.NormalisedPathImpl
- not() - Method in interface com.atlassian.oai.validator.whitelist.rule.WhitelistRule
-
Negates the result of this rule.
- NOT_ALLOWED_OPERATION - Static variable in class com.atlassian.oai.validator.model.ApiOperationMatch
-
The searched path is defined in the API definition, but the HTTP method is not allowed.
- notFound() - Static method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
A convenience method for creating a
SimpleResponse.Builderwith the HTTP status code 404. - Nullable - Class in com.atlassian.oai.validator.schema.keyword
-
Support for the
nullablekeyword introduced in OpenAPI v3 - Nullable.NullableDigester - Class in com.atlassian.oai.validator.schema.keyword
- Nullable.NullableKeywordValidator - Class in com.atlassian.oai.validator.schema.keyword
- Nullable.NullableSyntaxChecker - Class in com.atlassian.oai.validator.schema.keyword
- NullableKeywordValidator(JsonNode) - Constructor for class com.atlassian.oai.validator.schema.keyword.Nullable.NullableKeywordValidator
- numberOfParts() - Method in interface com.atlassian.oai.validator.model.NormalisedPath
- numberOfParts() - Method in class com.atlassian.oai.validator.model.NormalisedPathImpl
O
- OAI_V2_METASCHEMA_URI - Static variable in class com.atlassian.oai.validator.schema.SwaggerV20Library
- ok() - Static method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
A convenience method for creating a
SimpleResponse.Builderwith the HTTP status code 200. - oneOf(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- ONEOF_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- OpenApiInteractionValidator - Class in com.atlassian.oai.validator
-
Validates a HTTP interaction (request/response pair) with a Swagger v2 / OpenAPI v3 specification.
- OpenApiInteractionValidator.ApiLoadException - Exception in com.atlassian.oai.validator
-
An exception thrown when the
OpenApiInteractionValidatoris unable to load a given API spec - OpenApiInteractionValidator.Builder - Class in com.atlassian.oai.validator
-
A builder used to createFor configured instances of the
OpenApiInteractionValidator. - OpenApiInteractionValidator.SpecSource - Class in com.atlassian.oai.validator
-
Holds the source location for an API specification.
- OpenApiLoader - Class in com.atlassian.oai.validator.util
- OpenApiLoader() - Constructor for class com.atlassian.oai.validator.util.OpenApiLoader
- options(String) - Static method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
A convenience method for creating a
SimpleRequest.Builderwith HTTP method OPTIONS and the given path. - OPTIONS - Enum constant in enum com.atlassian.oai.validator.model.Request.Method
- or(WhitelistRule) - Method in interface com.atlassian.oai.validator.whitelist.rule.WhitelistRule
-
Creates a new rule that matches if this or that matches.
- original() - Method in interface com.atlassian.oai.validator.model.NormalisedPath
- original() - Method in class com.atlassian.oai.validator.model.NormalisedPathImpl
P
- paramNames(int) - Method in interface com.atlassian.oai.validator.model.ApiPath
- paramNames(int) - Method in class com.atlassian.oai.validator.model.ApiPathImpl
- paramValues(int, String) - Method in interface com.atlassian.oai.validator.model.ApiPath
-
Extract the param values for each param in the indexed path part, extracted from the given request path part.
- paramValues(int, String) - Method in class com.atlassian.oai.validator.model.ApiPathImpl
- parseMultipartFormDataBody(String, String) - Static method in class com.atlassian.oai.validator.util.HttpParsingUtils
-
Parses the body of an HTTP request that was submitted as a multipart document (multipart/mixed)
- parseUrlEncodedFormDataBody(String) - Static method in class com.atlassian.oai.validator.util.HttpParsingUtils
-
Parses the body of an HTTP request that was submitted as a form (application/x-www-form-urlencoded)
- parseUrlEncodedFormDataBodyAsJson(String) - Static method in class com.atlassian.oai.validator.util.HttpParsingUtils
-
Deprecated.
- parseUrlEncodedFormDataBodyAsJsonNode(String) - Static method in class com.atlassian.oai.validator.util.HttpParsingUtils
-
Parses the body of an HTTP request that was submitted as a form (application/x-www-form-urlencoded) and transform it into a JSON representation that can be validated with the schema validator.
- part(int) - Method in interface com.atlassian.oai.validator.model.NormalisedPath
- part(int) - Method in class com.atlassian.oai.validator.model.NormalisedPathImpl
- partMatches(int, String) - Method in interface com.atlassian.oai.validator.model.ApiPath
-
Determine if the given request path part matches against the corresponding path part in this API path, taking into consideration path params.
- partMatches(int, String) - Method in class com.atlassian.oai.validator.model.ApiPathImpl
- patch(String) - Static method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
A convenience method for creating a
SimpleRequest.Builderwith HTTP method PATCH and the given path. - PATCH - Enum constant in enum com.atlassian.oai.validator.model.Request.Method
- pathContains(String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Deprecated.
- pathContainsRegexp(String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches operations whose API path contains a substring that matches the given regular expression.
- pathContainsSubstring(String) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches operations whose API path contains a the given substring.
- Pointers(String, String) - Constructor for class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Pointers
- post(String) - Static method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
A convenience method for creating a
SimpleRequest.Builderwith HTTP method POST and the given path. - POST - Enum constant in enum com.atlassian.oai.validator.model.Request.Method
- properties(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- PROPERTIES_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- PropertiesLoader(File, String) - Constructor for class com.atlassian.oai.validator.report.LevelLoader.PropertiesLoader
- PropertiesLoader(String, String) - Constructor for class com.atlassian.oai.validator.report.LevelLoader.PropertiesLoader
- PropertiesLoader(URL, String) - Constructor for class com.atlassian.oai.validator.report.LevelLoader.PropertiesLoader
- PropertiesLoader(Properties, String) - Constructor for class com.atlassian.oai.validator.report.LevelLoader.PropertiesLoader
- property(JsonNode, String) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- put(String) - Static method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
A convenience method for creating a
SimpleRequest.Builderwith HTTP method PUT and the given path. - PUT - Enum constant in enum com.atlassian.oai.validator.model.Request.Method
R
- READONLY_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- REDIRECTION - Enum constant in enum com.atlassian.oai.validator.whitelist.StatusType
-
All redirect (3xx) status codes
- replaceReportOutput(JsonNode, String, String) - Static method in class com.atlassian.oai.validator.util.ValidationReportUtils
-
Walk a JSON object representing a report and replace all instances of the search string in schema pointers or report paths with the given replacement value.
- Request - Interface in com.atlassian.oai.validator.model
-
Implementation-agnostic representation of a HTTP request
- REQUEST - Enum constant in enum com.atlassian.oai.validator.report.ValidationReport.MessageContext.Location
- Request.Method - Enum in com.atlassian.oai.validator.model
-
Supported HTTP request methods
- RequestValidator - Class in com.atlassian.oai.validator.interaction.request
-
Validate a request against a given API operation.
- RequestValidator(SchemaValidator, MessageResolver, OpenAPI, List<CustomRequestValidator>) - Constructor for class com.atlassian.oai.validator.interaction.request.RequestValidator
-
Construct a new request validator with the given schema validator.
- REQUIRED_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- RequiredFieldTransformer - Class in com.atlassian.oai.validator.schema.transform
-
Transformer that adjusts the "required" fields list for nodes to remove fields marked as `readOnly` or `writeOnly` for request / response validation as appropriate.
- RequiredFieldTransformer() - Constructor for class com.atlassian.oai.validator.schema.transform.RequiredFieldTransformer
- requireNonEmpty(String, String) - Static method in class com.atlassian.oai.validator.util.StringUtils
-
Require that the given value is non-empty.
- Response - Interface in com.atlassian.oai.validator.model
-
Implementation-agnostic representation of a HTTP response
- RESPONSE - Enum constant in enum com.atlassian.oai.validator.report.ValidationReport.MessageContext.Location
- responseStatusIs(int) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches all responses with the given status.
- responseStatusTypeIs(StatusType) - Static method in class com.atlassian.oai.validator.whitelist.rule.WhitelistRules
-
Matches all responses with the given status type.
- ResponseValidator - Class in com.atlassian.oai.validator.interaction.response
-
Validate a response against an API operation
- ResponseValidator(SchemaValidator, MessageResolver, OpenAPI, List<CustomResponseValidator>) - Constructor for class com.atlassian.oai.validator.interaction.response.ResponseValidator
-
Construct a new response validator with the given schema validator.
S
- SCHEMA_REF_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- schemaComponents(JsonNode) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- SchemaDefinitionsInjectionTransformer - Class in com.atlassian.oai.validator.schema.transform
-
Simple transformer than injects schema definitions into the `#/components/schemas` path so that references resolve correctly.
- SchemaDefinitionsInjectionTransformer() - Constructor for class com.atlassian.oai.validator.schema.transform.SchemaDefinitionsInjectionTransformer
- schemaFactory() - Static method in class com.atlassian.oai.validator.schema.SwaggerV20Library
- schemaFactory(LogLevel, LogLevel) - Static method in class com.atlassian.oai.validator.schema.SwaggerV20Library
- SchemaRefInjectionTransformer - Class in com.atlassian.oai.validator.schema.transform
-
Simple transformer that injects our custom metaschema URI into the `$schema` field to enable use of the custom validation library.
- SchemaRefInjectionTransformer() - Constructor for class com.atlassian.oai.validator.schema.transform.SchemaRefInjectionTransformer
- SCHEMAS_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- SchemaTransformationContext - Class in com.atlassian.oai.validator.schema.transform
- SchemaTransformationContext.Builder - Class in com.atlassian.oai.validator.schema.transform
- SchemaTransformer - Class in com.atlassian.oai.validator.schema.transform
-
A base class for transformers that mutate the state of a parsed Swagger/OpenAPI schema object.
- SchemaTransformer() - Constructor for class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- SchemaValidator - Class in com.atlassian.oai.validator.schema
-
Validate a value against the schema defined in an OpenAPI / Swagger specification.
- SchemaValidator(OpenAPI, MessageResolver) - Constructor for class com.atlassian.oai.validator.schema.SchemaValidator
-
Build a new validator for the given API specification.
- SchemaValidator(OpenAPI, MessageResolver, Supplier<JsonSchemaFactory>) - Constructor for class com.atlassian.oai.validator.schema.SchemaValidator
-
Build a new validator for the given API specification.
- SchemaValidator(OpenAPI, MessageResolver, Supplier<JsonSchemaFactory>, ValidationConfiguration) - Constructor for class com.atlassian.oai.validator.schema.SchemaValidator
-
Build a new validator for the given API specification.
- SchemaValidator.JsonNodeSupplier - Interface in com.atlassian.oai.validator.schema
- SERVER_ERROR - Enum constant in enum com.atlassian.oai.validator.whitelist.StatusType
-
All server error (5xx) status codes
- serverError() - Static method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
A convenience method for creating a
SimpleResponse.Builderwith the HTTP status code 500. - setMaxCacheSize(int) - Method in class com.atlassian.oai.validator.schema.ValidationConfiguration
- setRequiredFieldNames(JsonNode, List<String>) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- setSchemaRef(JsonNode, String) - Static method in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
- SimpleRequest - Class in com.atlassian.oai.validator.model
-
Simple immutable
Requestimplementation. - SimpleRequest.Builder - Class in com.atlassian.oai.validator.model
-
A builder for constructing new
SimpleRequestinstances. - SimpleResponse - Class in com.atlassian.oai.validator.model
-
Simple immutable
Responseimplementation - SimpleResponse.Builder - Class in com.atlassian.oai.validator.model
-
A builder for constructing new
SimpleResponseinstances. - SimpleValidationReportFormat - Class in com.atlassian.oai.validator.report
-
Format a
ValidationReportinstance into human-readable String representation for use in e.g. - singleton(ValidationReport.Message) - Static method in interface com.atlassian.oai.validator.report.ValidationReport
-
Return an unmodifiable report that contains a single message.
- sortedValidationLevels() - Method in interface com.atlassian.oai.validator.report.ValidationReport
-
Return sorted set of levels found during validation
- specUrl(String) - Static method in class com.atlassian.oai.validator.OpenApiInteractionValidator.SpecSource
- splitAcceptHeader(String) - Static method in class com.atlassian.oai.validator.util.HttpAcceptUtils
-
Split the given header value into individual media types that can then be parsed as necessary.
- status(int) - Static method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
Creates a
SimpleResponse.Builderwith the given HTTP status code. - StatusType - Enum in com.atlassian.oai.validator.whitelist
- StringBody - Class in com.atlassian.oai.validator.model
- StringBody(String, Charset) - Constructor for class com.atlassian.oai.validator.model.StringBody
- StringUtils - Class in com.atlassian.oai.validator.util
- SUCCESS - Enum constant in enum com.atlassian.oai.validator.whitelist.StatusType
-
All success (2xx) status codes
- SwaggerRequestResponseValidator - Class in com.atlassian.oai.validator
-
Deprecated.Replaced with
OpenApiInteractionValidator. This class will be removed in a future release. - SwaggerRequestResponseValidator() - Constructor for class com.atlassian.oai.validator.SwaggerRequestResponseValidator
-
Deprecated.
- SwaggerV20Library - Class in com.atlassian.oai.validator.schema
-
Library that extends the JSON Schema v4 and adds the additional keywords introduced by the OpenAPI / Swagger v2.0 specification.
- SwaggerV20Library.SyntaxBundle - Class in com.atlassian.oai.validator.schema
-
Message bundle loader that appends messages for the Swagger V20 extensions to the standard JSON Schema syntax bundle.
- SwaggerV20Library.ValidationBundle - Class in com.atlassian.oai.validator.schema
-
Message bundle loader that appends messages for the Swagger V20 extensions to the standard JSON Schema validation message bundle.
- SyntaxBundle() - Constructor for class com.atlassian.oai.validator.schema.SwaggerV20Library.SyntaxBundle
- systemPropertyLoader() - Static method in interface com.atlassian.oai.validator.report.LevelLoader
-
Loads levels from system properties of the form
swagger.{key}={LEVEL}.
T
- toJsonNode() - Method in interface com.atlassian.oai.validator.model.Body
- toJsonNode() - Method in class com.atlassian.oai.validator.model.ByteArrayBody
- toJsonNode() - Method in class com.atlassian.oai.validator.model.InputStreamBody
- toJsonNode() - Method in class com.atlassian.oai.validator.model.StringBody
- toString() - Method in class com.atlassian.oai.validator.report.ImmutableValidationReport
- toString() - Method in class com.atlassian.oai.validator.schema.keyword.DiscriminatorKeywordValidator
- toString() - Method in class com.atlassian.oai.validator.schema.keyword.Nullable.NullableKeywordValidator
- toString() - Method in class com.atlassian.oai.validator.whitelist.NamedWhitelistRule
- toString() - Method in enum com.atlassian.oai.validator.whitelist.StatusType
- toString() - Method in class com.atlassian.oai.validator.whitelist.ValidationErrorsWhitelist
- toString(Charset) - Method in interface com.atlassian.oai.validator.model.Body
- toString(Charset) - Method in class com.atlassian.oai.validator.model.ByteArrayBody
- toString(Charset) - Method in class com.atlassian.oai.validator.model.InputStreamBody
- toString(Charset) - Method in class com.atlassian.oai.validator.model.StringBody
- trace(String) - Static method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
A convenience method for creating a
SimpleRequest.Builderwith HTTP method TRACE and the given path. - TRACE - Enum constant in enum com.atlassian.oai.validator.model.Request.Method
- TYPE_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
U
- unauthorized() - Static method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
A convenience method for creating a
SimpleResponse.Builderwith the HTTP status code 401. - unknown(String) - Static method in class com.atlassian.oai.validator.OpenApiInteractionValidator.SpecSource
- UNKNOWN_ERROR_KEY - Static variable in class com.atlassian.oai.validator.schema.SchemaValidator
V
- validate(Request, ApiOperation) - Method in interface com.atlassian.oai.validator.interaction.request.CustomRequestValidator
-
Validates a request against a given api operation.
- validate(Request, Response) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator
-
Validate the given request/response against the API.
- validate(Request, Response) - Method in class com.atlassian.oai.validator.SwaggerRequestResponseValidator
-
Deprecated.
- validate(Response, ApiOperation) - Method in interface com.atlassian.oai.validator.interaction.response.CustomResponseValidator
-
Validates a response against a given api operation.
- validate(SchemaValidator.JsonNodeSupplier, Schema, String) - Method in class com.atlassian.oai.validator.schema.SchemaValidator
-
Validate the given value against the given property schema.
- validate(Processor<FullData, FullData>, ProcessingReport, MessageBundle, FullData) - Method in class com.atlassian.oai.validator.schema.keyword.DiscriminatorKeywordValidator
- validate(Processor<FullData, FullData>, ProcessingReport, MessageBundle, FullData) - Method in class com.atlassian.oai.validator.schema.keyword.Nullable.NullableKeywordValidator
- validate(ProcessingReport, MessageBundle, FullData) - Method in class com.atlassian.oai.validator.schema.format.Base64Attribute
- validate(ProcessingReport, MessageBundle, FullData) - Method in class com.atlassian.oai.validator.schema.format.DoubleAttribute
- validate(ProcessingReport, MessageBundle, FullData) - Method in class com.atlassian.oai.validator.schema.format.FloatAttribute
- validate(ProcessingReport, MessageBundle, FullData) - Method in class com.atlassian.oai.validator.schema.format.Int32Attribute
- validate(ProcessingReport, MessageBundle, FullData) - Method in class com.atlassian.oai.validator.schema.format.Int64Attribute
- validate(String, Schema, String) - Method in class com.atlassian.oai.validator.schema.SchemaValidator
-
Validate the given value against the given property schema.
- validateRequest(Request) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator
-
Validate the given request against the API.
- validateRequest(Request) - Method in class com.atlassian.oai.validator.SwaggerRequestResponseValidator
-
Deprecated.
- validateRequest(Request, ApiOperation) - Method in class com.atlassian.oai.validator.interaction.request.RequestValidator
-
Validate the request against the given API operation
- validateResponse(Response, ApiOperation) - Method in class com.atlassian.oai.validator.interaction.response.ResponseValidator
-
Validate the given response against the API operation.
- validateResponse(String, Request.Method, Response) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator
-
Validate the given response against the API.
- validateResponse(String, Request.Method, Response) - Method in class com.atlassian.oai.validator.SwaggerRequestResponseValidator
-
Deprecated.
- ValidationBundle() - Constructor for class com.atlassian.oai.validator.schema.SwaggerV20Library.ValidationBundle
- ValidationConfiguration - Class in com.atlassian.oai.validator.schema
-
Validation configuration for Open API validation.
- ValidationConfiguration() - Constructor for class com.atlassian.oai.validator.schema.ValidationConfiguration
- ValidationErrorsWhitelist - Class in com.atlassian.oai.validator.whitelist
- ValidationReport - Interface in com.atlassian.oai.validator.report
-
A report of validation errors that occurred during validation.
- ValidationReport.Level - Enum in com.atlassian.oai.validator.report
-
The validation level
- ValidationReport.Message - Interface in com.atlassian.oai.validator.report
-
A single message in the validation report
- ValidationReport.Message.Builder - Class in com.atlassian.oai.validator.report
- ValidationReport.MessageContext - Interface in com.atlassian.oai.validator.report
-
Contextual information about a validation message.
- ValidationReport.MessageContext.Builder - Class in com.atlassian.oai.validator.report
- ValidationReport.MessageContext.Location - Enum in com.atlassian.oai.validator.report
- ValidationReport.MessageContext.Pointers - Class in com.atlassian.oai.validator.report
-
Pointers to the instance being validated and the schema being used for validation
- ValidationReportFormat - Interface in com.atlassian.oai.validator.report
- ValidationReportUtils - Class in com.atlassian.oai.validator.util
- valueOf(String) - Static method in enum com.atlassian.oai.validator.model.Request.Method
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.atlassian.oai.validator.report.ValidationReport.Level
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.atlassian.oai.validator.report.ValidationReport.MessageContext.Location
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.atlassian.oai.validator.whitelist.StatusType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.atlassian.oai.validator.model.Request.Method
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.atlassian.oai.validator.report.ValidationReport.Level
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.atlassian.oai.validator.report.ValidationReport.MessageContext.Location
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.atlassian.oai.validator.whitelist.StatusType
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WARN - Enum constant in enum com.atlassian.oai.validator.report.ValidationReport.Level
- whitelistedBy(ValidationReport.Message, ApiOperation, Request, Response) - Method in class com.atlassian.oai.validator.whitelist.ValidationErrorsWhitelist
-
Returns a whitelist rule that is applicable for the given parameters.
- WhitelistRule - Interface in com.atlassian.oai.validator.whitelist.rule
-
A rule for matching validation messages.
- WhitelistRules - Class in com.atlassian.oai.validator.whitelist.rule
-
Static factory methods for creating
WhitelistRuleinstances. - withAccept(String...) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Sets the accept header on this builder.
- withAdditionalContext(ValidationReport.MessageContext) - Method in class com.atlassian.oai.validator.report.EmptyValidationReport
- withAdditionalContext(ValidationReport.MessageContext) - Method in class com.atlassian.oai.validator.report.ImmutableValidationReport
- withAdditionalContext(ValidationReport.MessageContext) - Method in class com.atlassian.oai.validator.report.MergedValidationReport
- withAdditionalContext(ValidationReport.MessageContext) - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
-
Returns a new instance, the same as this message, but additional context attached.
- withAdditionalContext(ValidationReport.MessageContext) - Method in interface com.atlassian.oai.validator.report.ValidationReport
-
Apply the given additional message context to each message in this validation report, returning a new unmodifiable report.
- withAdditionalDataFrom(ValidationReport.MessageContext) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withAdditionalInfo(String) - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
-
Returns a new instance, the same as this message, but with additional info attached.
- withAdditionalInfo(String...) - Method in class com.atlassian.oai.validator.report.ValidationReport.Message.Builder
- withAdditionalInfo(List<String>) - Method in class com.atlassian.oai.validator.report.ValidationReport.Message.Builder
- withAdditionalPropertiesIgnored() - Static method in class com.atlassian.oai.validator.report.LevelResolverFactory
-
Construct a new
LevelResolverthat disables the additional properties validation. - withAdditionalPropertiesValidation(boolean) - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext.Builder
- withApi(OpenAPI) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
- withApiOperation(ApiOperation) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withApiRequestBodyDefinition(RequestBody) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withApiResponseDefinition(ApiResponse) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withApiSpecification(String) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
- withApiSpecificationUrl(String) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
The location of the OpenAPI / Swagger specification to use in the validator.
- withAppliedWhitelistRule(NamedWhitelistRule) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withAuthHeaderData(String, String) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
An optional key value header to add to the OpenAPI / Swagger spec retrieval request.
- withAuthorization(String) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Sets the authorization header on this builder.
- withBasePathOverride(String) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
An optional basepath override to override the one defined in the OpenAPI / Swagger spec.
- withBody(byte[]) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Adds a request body as byte array to this builder.
- withBody(byte[]) - Method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
Adds a response body as byte array to this builder.
- withBody(Body) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Adds a request
Bodyto this builder. - withBody(InputStream) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Adds a request body as
InputStreamto this builder. - withBody(InputStream) - Method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
Adds a response body as
InputStreamto this builder. - withBody(String) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Adds a request body as
Stringto this builder. - withBody(String) - Method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
Adds a response body to this builder.
- withBody(String, Charset) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
- withBody(String, Charset) - Method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
- withContentType(String) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Sets the content type header on this builder.
- withContentType(String) - Method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
Sets the content type header on this builder.
- withContext(ValidationReport.MessageContext) - Method in class com.atlassian.oai.validator.report.ValidationReport.Message.Builder
- withCustomRequestValidation(CustomRequestValidator) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
An optional custom request validation step.
- withCustomResponseValidation(CustomResponseValidator) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
An optional custom response validation step.
- withDefaultLevel(ValidationReport.Level) - Method in class com.atlassian.oai.validator.report.LevelResolver.Builder
-
Set the default level to use for any message which does not have an explicit mapping defined.
- withDefinitions(JsonNode) - Method in class com.atlassian.oai.validator.schema.transform.SchemaTransformationContext.Builder
- withHeader(String, String...) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Adds a request header to this builder.
- withHeader(String, String...) - Method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
Adds a response header to this builder.
- withHeader(String, List<String>) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Adds a request header to this builder.
- withHeader(String, List<String>) - Method in class com.atlassian.oai.validator.model.SimpleResponse.Builder
-
Adds a response header to this builder.
- withInlineApiSpecification(String) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
The inline API specification to use.
- withLevel(ValidationReport.Level) - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
-
Returns a new instance, the same as this message, but, with level changed.
- withLevel(String, ValidationReport.Level) - Method in class com.atlassian.oai.validator.report.LevelResolver.Builder
-
Add a mapping of message key -> level to use in the
LevelResolver. - withLevelResolver(LevelResolver) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
The resolver to use for resolving the level of validation messages (ERROR, WARN, IGNORE etc.).
- withLevels(Map<String, ValidationReport.Level>) - Method in class com.atlassian.oai.validator.report.LevelResolver.Builder
-
Set mappings of message key -> level to use in the
LevelResolver. - withLoader(LevelLoader) - Method in class com.atlassian.oai.validator.report.LevelResolver.Builder
-
Set or override the
LevelLoaderstrategy used to load message levels. - withMatchedApiContentType(String) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withNestedMessages(Collection<ValidationReport.Message>) - Method in interface com.atlassian.oai.validator.report.ValidationReport.Message
-
Returns a new instance, the same as this message, but with nested messages attached.
- withParameter(Parameter) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withParseOptions(ParseOptions) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
Optionally supply parse options to control the behavior of the underlying
OpenAPIParserparser. - withPointers(String, String) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withQueryParam(String, String...) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Adds a query parameter to this request builder.
- withQueryParam(String, List<String>) - Method in class com.atlassian.oai.validator.model.SimpleRequest.Builder
-
Adds a query parameter to this request builder.
- withRequestMethod(Request.Method) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withRequestPath(String) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withResolveCombinators(boolean) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
Sets the
resolveCombinatorsflag on theParseOptionssupplied to the underlyingOpenAPIParser. - withResolveRefs(boolean) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
Sets the
resolveandresolveFullyflags on theParseOptionssupplied to the underlyingOpenAPIParser. - withResponseStatus(Integer) - Method in class com.atlassian.oai.validator.report.ValidationReport.MessageContext.Builder
- withRule(String, WhitelistRule) - Method in class com.atlassian.oai.validator.whitelist.ValidationErrorsWhitelist
-
Creates a new whitelist with all rules of this and with a new rule.
- withSchemaFactorySupplier(Supplier<JsonSchemaFactory>) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
Optionally supply a function that returns a
JsonSchemaFactoryto use. - withSchemaValidationConfiguration(ValidationConfiguration) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
Optionally supply a configuration to configure the following aspects of validation: The cache size of
JsonSchemainSchemaValidator - withStrictOperationPathMatching() - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
Optionally enable strict operation path matching.
- withSwaggerJsonUrl(String) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
Deprecated.use
OpenApiInteractionValidator.Builder.withApiSpecification(String). This method will be removed in a future release. - withWhitelist(ValidationErrorsWhitelist) - Method in class com.atlassian.oai.validator.OpenApiInteractionValidator.Builder
-
A whitelist for error messages.
- WRITEONLY_FIELD - Static variable in class com.atlassian.oai.validator.schema.transform.SchemaTransformer
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Request.getRequestBody(). This method will be removed in a future release.