io.syndesis.server.api.generator.openapi

Class OpenApiValidationRules<T extends io.apicurio.datamodels.openapi.models.OasResponse,S extends io.apicurio.datamodels.core.models.common.SecurityScheme,D extends io.apicurio.datamodels.openapi.models.OasSchema>

java.lang.Object

io.syndesis.server.api.generator.openapi.OpenApiValidationRules<T,S,D>

All Implemented Interfaces:

Function<OpenApiModelInfo,OpenApiModelInfo>

Direct Known Subclasses:

Oas20ValidationRules, Oas30ValidationRules

public abstract class OpenApiValidationRules<T extends io.apicurio.datamodels.openapi.models.OasResponse,S extends io.apicurio.datamodels.core.models.common.SecurityScheme,D extends io.apicurio.datamodels.openapi.models.OasSchema>
extends Object
implements Function<OpenApiModelInfo,OpenApiModelInfo>

This class contains Syndesis custom validation rules for Open API specifications.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenApiValidationRules(APIValidationContext context, List<Function<OpenApiModelInfo,OpenApiModelInfo>> consumerRules, List<Function<OpenApiModelInfo,OpenApiModelInfo>> providerRules) Constructor initializes rules based on given validation context and specific rules for consumer and producer APIs.

Method Summary

Modifier and Type	Method and Description
OpenApiModelInfo	apply(OpenApiModelInfo modelInfo)
protected abstract List<T>	getResponses(io.apicurio.datamodels.openapi.models.OasOperation operation)
protected abstract Map<String,D>	getSchemaDefinitions(OpenApiModelInfo info)
protected abstract List<String>	getSchemes(OpenApiModelInfo info)
protected abstract Collection<S>	getSecuritySchemes(OpenApiModelInfo info)
protected abstract boolean	hasResponseSchema(T responseEntry)
OpenApiModelInfo	validateConsumedAuthTypes(OpenApiModelInfo modelInfo) Check if all operations contains valid authentication types for consumed APIs.
OpenApiModelInfo	validateCyclicReferences(OpenApiModelInfo info)
OpenApiModelInfo	validateOperationsGiven(OpenApiModelInfo modelInfo)
OpenApiModelInfo	validateProvidedAuthTypes(OpenApiModelInfo modelInfo) Check if all operations contains valid authentication types for provided APIs.
OpenApiModelInfo	validateRequestResponseBodySchemas(OpenApiModelInfo modelInfo) Check if a request/response JSON schema is present
protected abstract Optional<Violation>	validateRequestSchema(String operationId, String path, io.apicurio.datamodels.openapi.models.OasOperation operation)
OpenApiModelInfo	validateUniqueOperationIds(OpenApiModelInfo info)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

OpenApiValidationRules

protected OpenApiValidationRules(APIValidationContext context,
                                 List<Function<OpenApiModelInfo,OpenApiModelInfo>> consumerRules,
                                 List<Function<OpenApiModelInfo,OpenApiModelInfo>> providerRules)

Constructor initializes rules based on given validation context and specific rules for consumer and producer APIs. Subclasses may provide special rules in addition to generic rules added in this base class.

Parameters:

context - the validation context specifying the consumer or provider API

consumerRules - specific rules to add for consumed APIs

providerRules - specific rules to add for provided APIs

Method Detail

apply

public OpenApiModelInfo apply(OpenApiModelInfo modelInfo)

Specified by:

apply in interface Function<OpenApiModelInfo,OpenApiModelInfo>

getResponses

protected abstract List<T> getResponses(io.apicurio.datamodels.openapi.models.OasOperation operation)

hasResponseSchema

protected abstract boolean hasResponseSchema(T responseEntry)

validateRequestSchema

protected abstract Optional<Violation> validateRequestSchema(String operationId,
                                                             String path,
                                                             io.apicurio.datamodels.openapi.models.OasOperation operation)

getSchemaDefinitions

protected abstract Map<String,D> getSchemaDefinitions(OpenApiModelInfo info)

getSchemes

protected abstract List<String> getSchemes(OpenApiModelInfo info)

getSecuritySchemes

protected abstract Collection<S> getSecuritySchemes(OpenApiModelInfo info)

validateConsumedAuthTypes

public OpenApiModelInfo validateConsumedAuthTypes(OpenApiModelInfo modelInfo)

Check if all operations contains valid authentication types for consumed APIs.

validateCyclicReferences

public OpenApiModelInfo validateCyclicReferences(OpenApiModelInfo info)

validateOperationsGiven

public OpenApiModelInfo validateOperationsGiven(OpenApiModelInfo modelInfo)

validateProvidedAuthTypes

public OpenApiModelInfo validateProvidedAuthTypes(OpenApiModelInfo modelInfo)

Check if all operations contains valid authentication types for provided APIs.

validateRequestResponseBodySchemas

public OpenApiModelInfo validateRequestResponseBodySchemas(OpenApiModelInfo modelInfo)

Check if a request/response JSON schema is present

validateUniqueOperationIds

public OpenApiModelInfo validateUniqueOperationIds(OpenApiModelInfo info)