Index (Vert.x OpenAPI 4.5.0 API)

A B C D E F G I L M O P R S T V

A

APPLICATION_JSON - Static variable in interface io.vertx.openapi.contract.MediaType
APPLICATION_JSON_UTF8 - Static variable in interface io.vertx.openapi.contract.MediaType
ApplicationJsonTransformer - Class in io.vertx.openapi.validation.transformer
ApplicationJsonTransformer() - Constructor for class io.vertx.openapi.validation.transformer.ApplicationJsonTransformer

B

BodyTransformer - Interface in io.vertx.openapi.validation.transformer

C

ContractErrorType - Enum in io.vertx.openapi.contract
create(Vertx, OpenAPIContract) - Static method in interface io.vertx.openapi.validation.RequestValidator: Create a new RequestValidator.
create(Vertx, OpenAPIContract) - Static method in interface io.vertx.openapi.validation.ResponseValidator: Create a new ResponseValidator.
create(int) - Static method in interface io.vertx.openapi.validation.ValidatableResponse: Creates a new ValidatableResponse object based on the passed parameters.
create(int, Map<String, String>) - Static method in interface io.vertx.openapi.validation.ValidatableResponse: Creates a new ValidatableResponse object based on the passed parameters.
create(int, Buffer, String) - Static method in interface io.vertx.openapi.validation.ValidatableResponse: Creates a new ValidatableResponse object based on the passed parameters.
create(int, Map<String, String>, Buffer, String) - Static method in interface io.vertx.openapi.validation.ValidatableResponse: Creates a new ValidatableResponse object based on the passed parameters.
createCantDecodeValue(Parameter) - Static method in exception io.vertx.openapi.validation.ValidatorException
createInvalidContract(String) - Static method in exception io.vertx.openapi.contract.OpenAPIContractException
createInvalidContract(String, Throwable) - Static method in exception io.vertx.openapi.contract.OpenAPIContractException
createInvalidStyle(Location, String) - Static method in exception io.vertx.openapi.contract.OpenAPIContractException
createInvalidValue(Parameter, JsonSchemaValidationException) - Static method in exception io.vertx.openapi.validation.ValidatorException
createInvalidValueBody(JsonSchemaValidationException) - Static method in exception io.vertx.openapi.validation.ValidatorException
createInvalidValueFormat(Parameter) - Static method in exception io.vertx.openapi.validation.ValidatorException
createMissingRequiredParameter(Parameter) - Static method in exception io.vertx.openapi.validation.ValidatorException
createOperationIdInvalid(String) - Static method in exception io.vertx.openapi.validation.ValidatorException
createOperationNotFound(HttpMethod, String) - Static method in exception io.vertx.openapi.validation.ValidatorException
createResponseNotFound(int, String) - Static method in exception io.vertx.openapi.validation.ValidatorException
createUnsupportedFeature(String) - Static method in exception io.vertx.openapi.contract.OpenAPIContractException
createUnsupportedValueFormat(Parameter) - Static method in exception io.vertx.openapi.validation.ValidatorException
createUnsupportedVersion(String) - Static method in exception io.vertx.openapi.contract.OpenAPIContractException

D

defaultByLocation(Location) - Static method in enum io.vertx.openapi.contract.Style
determineContentType(String) - Method in interface io.vertx.openapi.contract.RequestBody: This method tries to determine the best fitting MediaType based on the passed content type.

E

extract(HttpServerRequest, Operation) - Static method in class io.vertx.openapi.validation.RequestUtils: Extracts and transforms the parameters and the body of an incoming request into a format that can be validated by the RequestValidator.
extract(HttpServerRequest, Operation, Supplier<Future<Buffer>>) - Static method in class io.vertx.openapi.validation.RequestUtils: Like RequestUtils.extract(HttpServerRequest, Operation), but offers to pass a supplier fpr the body.

F

findOperation(String, HttpMethod) - Method in interface io.vertx.openapi.contract.OpenAPIContract: Finds the related Operation object based on the passed url path and method.
findPath(String) - Method in interface io.vertx.openapi.contract.OpenAPIContract: Finds the related Path object based on the passed url path.
FormTransformer - Class in io.vertx.openapi.validation.transformer: +--------+---------+--------+------------+------------------------------------+-------------------------+ | style | explode | empty | string | array | object | +--------+---------+--------+------------+------------------------------------+-------------------------+ | form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +--------+---------+--------+------------+------------------------------------+-------------------------+ | form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | +--------+---------+--------+------------+------------------------------------+-------------------------+
FormTransformer() - Constructor for class io.vertx.openapi.validation.transformer.FormTransformer
from(Vertx, String) - Static method in interface io.vertx.openapi.contract.OpenAPIContract: Resolves / dereferences the passed contract and creates an OpenAPIContract instance.
from(Vertx, JsonObject) - Static method in interface io.vertx.openapi.contract.OpenAPIContract: Resolves / dereferences the passed contract and creates an OpenAPIContract instance.
from(Vertx, String, Map<String, String>) - Static method in interface io.vertx.openapi.contract.OpenAPIContract: Resolves / dereferences the passed contract and creates an OpenAPIContract instance.
from(Vertx, JsonObject, Map<String, JsonObject>) - Static method in interface io.vertx.openapi.contract.OpenAPIContract: Resolves / dereferences the passed contract and creates an OpenAPIContract instance.
fromContract(JsonObject) - Static method in enum io.vertx.openapi.contract.OpenAPIVersion

G

getAbsoluteOpenAPIPath() - Method in interface io.vertx.openapi.contract.Operation
getArrayValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.FormTransformer
getArrayValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.LabelTransformer
getArrayValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.MatrixTransformer
getArrayValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.ParameterTransformer
getArrayValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.SimpleTransformer
getAuthorizationCode() - Method in interface io.vertx.openapi.contract.OAuthFlows: Configuration for the OAuth Authorization Code flow.
getAuthorizationUrl() - Method in interface io.vertx.openapi.contract.OAuthFlow: The authorization URL to be used for this flow.
getBasePath() - Method in interface io.vertx.openapi.contract.Server: The base path is used to indicate that the location where the OpenAPI contract is served is different from the path specified in the OpenAPI contract.
getBearerFormat() - Method in interface io.vertx.openapi.contract.SecurityScheme: A hint to the client to identify how the bearer token is formatted.
getBody() - Method in interface io.vertx.openapi.validation.ValidatableResponse
getBody() - Method in interface io.vertx.openapi.validation.ValidatedRequest
getBody() - Method in interface io.vertx.openapi.validation.ValidatedResponse
getClientCredentials() - Method in interface io.vertx.openapi.contract.OAuthFlows: Configuration for the OAuth Client Credentials flow.
getContent() - Method in interface io.vertx.openapi.contract.RequestBody
getContent() - Method in interface io.vertx.openapi.contract.Response
getContentType() - Method in interface io.vertx.openapi.validation.ValidatableRequest
getContentType() - Method in interface io.vertx.openapi.validation.ValidatableResponse
getCookies() - Method in interface io.vertx.openapi.validation.ValidatedRequest
getDefaultResponse() - Method in interface io.vertx.openapi.contract.Operation
getFlows() - Method in interface io.vertx.openapi.contract.SecurityScheme: An object containing configuration information for the flow types supported.
getHeaders() - Method in interface io.vertx.openapi.contract.Response
getHeaders() - Method in interface io.vertx.openapi.validation.ValidatableResponse
getHeaders() - Method in interface io.vertx.openapi.validation.ValidatedRequest
getHeaders() - Method in interface io.vertx.openapi.validation.ValidatedResponse
getHttpMethod() - Method in interface io.vertx.openapi.contract.Operation
getIdentifier() - Method in interface io.vertx.openapi.contract.MediaType
getImplicit() - Method in interface io.vertx.openapi.contract.OAuthFlows: Configuration for the OAuth Implicit flow.
getIn() - Method in interface io.vertx.openapi.contract.Parameter
getIn() - Method in interface io.vertx.openapi.contract.SecurityScheme: The location of the API key.
getName() - Method in interface io.vertx.openapi.contract.Parameter
getName() - Method in interface io.vertx.openapi.contract.Path
getName() - Method in interface io.vertx.openapi.contract.SecurityScheme: The name of the header, query or cookie parameter to be used.
getNames() - Method in interface io.vertx.openapi.contract.SecurityRequirement: Return the name at a given index
getObjectKeysAndValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.FormTransformer
getObjectKeysAndValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.LabelTransformer
getObjectKeysAndValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.MatrixTransformer
getObjectKeysAndValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.ParameterTransformer
getObjectKeysAndValues(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.SimpleTransformer
getOpenAPIModel() - Method in interface io.vertx.openapi.contract.OpenAPIObject: Returns the part of the related OpenAPI specification which is represented by the OpenAPI object that is implementing this interface.
getOpenAPIPath() - Method in interface io.vertx.openapi.contract.Operation
getOpenIdConnectUrl() - Method in interface io.vertx.openapi.contract.SecurityScheme: OpenId Connect URL to discover OAuth2 configuration values.
getOperationId() - Method in interface io.vertx.openapi.contract.Operation
getOperations() - Method in interface io.vertx.openapi.contract.Path
getParameters() - Method in interface io.vertx.openapi.contract.Operation
getParameters() - Method in interface io.vertx.openapi.contract.Path
getPassword() - Method in interface io.vertx.openapi.contract.OAuthFlows: Configuration for the OAuth Resource Owner Password flow
getPathParameters() - Method in interface io.vertx.openapi.validation.ValidatedRequest
getPaths() - Method in interface io.vertx.openapi.contract.OpenAPIContract
getQuery() - Method in interface io.vertx.openapi.validation.ValidatedRequest
getRawContract() - Method in interface io.vertx.openapi.contract.OpenAPIContract
getRefreshUrl() - Method in interface io.vertx.openapi.contract.OAuthFlow: The URL to be used for obtaining refresh tokens.
getRepository(Vertx, String) - Method in enum io.vertx.openapi.contract.OpenAPIVersion
getRequestBody() - Method in interface io.vertx.openapi.contract.Operation
getResponse(int) - Method in interface io.vertx.openapi.contract.Operation: Returns the response to the passed response code or null.
getSchema() - Method in interface io.vertx.openapi.contract.MediaType
getSchema() - Method in interface io.vertx.openapi.contract.Parameter
getSchemaRepository() - Method in interface io.vertx.openapi.contract.OpenAPIContract
getSchemaType() - Method in interface io.vertx.openapi.contract.Parameter
getScheme() - Method in interface io.vertx.openapi.contract.SecurityScheme: The name of the HTTP Authorization scheme to be used in the Authorization header as defined in [RFC7235].
getScopes() - Method in interface io.vertx.openapi.contract.OAuthFlow: The available scopes for the OAuth2 security scheme.
getScopes(String) - Method in interface io.vertx.openapi.contract.SecurityRequirement: Return the scopes for a given name
getSecurityRequirements() - Method in interface io.vertx.openapi.contract.OpenAPIContract: Returns the applicable list of global security requirements (scopes) or empty list.
getSecurityRequirements() - Method in interface io.vertx.openapi.contract.Operation: Returns the applicable list of security requirements (scopes) or empty list.
getServers() - Method in interface io.vertx.openapi.contract.OpenAPIContract
getStatusCode() - Method in interface io.vertx.openapi.validation.ValidatableResponse
getStyle() - Method in interface io.vertx.openapi.contract.Parameter
getTags() - Method in interface io.vertx.openapi.contract.Operation
getTokenUrl() - Method in interface io.vertx.openapi.contract.OAuthFlow: The token URL to be used for this flow.
getType() - Method in interface io.vertx.openapi.contract.SecurityScheme: The type of the security scheme.
getURL() - Method in interface io.vertx.openapi.contract.Server
getVersion() - Method in interface io.vertx.openapi.contract.OpenAPIContract

I

io.vertx.openapi.contract - package io.vertx.openapi.contract
io.vertx.openapi.validation - package io.vertx.openapi.validation
io.vertx.openapi.validation.transformer - package io.vertx.openapi.validation.transformer
isEmpty() - Method in interface io.vertx.openapi.contract.SecurityRequirement
isExplode() - Method in interface io.vertx.openapi.contract.Parameter
isMediaTypeSupported(String) - Static method in interface io.vertx.openapi.contract.MediaType
isRequired() - Method in interface io.vertx.openapi.contract.Parameter
isRequired() - Method in interface io.vertx.openapi.contract.RequestBody

L

LabelTransformer - Class in io.vertx.openapi.validation.transformer: +--------+---------+--------+-------------+------------------------------+-------------------------------+ | style | explode | empty | string | array | object | +--------+---------+--------+-------------+------------------------------+-------------------------------+ | label | false | .
LabelTransformer() - Constructor for class io.vertx.openapi.validation.transformer.LabelTransformer
Location - Enum in io.vertx.openapi.contract

M

MatrixTransformer - Class in io.vertx.openapi.validation.transformer: +--------+---------+--------+-------------+-------------------------------------+--------------------------+ | style | explode | empty | string | array | object | +--------+---------+--------+-------------+-------------------------------------+--------------------------+ | matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +--------+---------+--------+-------------+-------------------------------------+--------------------------+ | matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +--------+---------+--------+-------------+-------------------------------------+--------------------------+
MatrixTransformer() - Constructor for class io.vertx.openapi.validation.transformer.MatrixTransformer
MediaType - Interface in io.vertx.openapi.contract: This interface represents the most important attributes of an OpenAPI Operation.

O

OAuthFlow - Interface in io.vertx.openapi.contract: Represents an OAuth Flow Object (the configuration).
OAuthFlows - Interface in io.vertx.openapi.contract: Represents an OAuth Flows Object.
of(HttpServerRequest, Operation) - Static method in interface io.vertx.openapi.validation.ValidatableRequest: Creates a new ValidatableRequest object based on the passed request and operation.
OpenAPIContract - Interface in io.vertx.openapi.contract
OpenAPIContractException - Exception in io.vertx.openapi.contract
OpenAPIContractException(String, ContractErrorType, Throwable) - Constructor for exception io.vertx.openapi.contract.OpenAPIContractException
OpenAPIObject - Interface in io.vertx.openapi.contract
OpenAPIVersion - Enum in io.vertx.openapi.contract
operation(String) - Method in interface io.vertx.openapi.contract.OpenAPIContract: Access to an operation defined in the contract with operationId.
Operation - Interface in io.vertx.openapi.contract: This interface represents the most important attributes of an OpenAPI Operation.
operations() - Method in interface io.vertx.openapi.contract.OpenAPIContract

P

Parameter - Interface in io.vertx.openapi.contract: This interface represents the most important attributes of an OpenAPI Parameter.
ParameterTransformer - Class in io.vertx.openapi.validation.transformer
ParameterTransformer() - Constructor for class io.vertx.openapi.validation.transformer.ParameterTransformer
parse(String) - Static method in enum io.vertx.openapi.contract.Location
parse(String) - Static method in enum io.vertx.openapi.contract.Style
Path - Interface in io.vertx.openapi.contract: This interface represents the most important attributes of an OpenAPI Parameter.

R

RequestBody - Interface in io.vertx.openapi.contract: This interface represents the most important attributes of an OpenAPI Operation.
RequestParameter - Interface in io.vertx.openapi.validation
RequestUtils - Class in io.vertx.openapi.validation
RequestValidator - Interface in io.vertx.openapi.validation: The RequestValidator requires the parameters in a specific format to be able to parse and validate them.
resolve(Vertx, SchemaRepository, JsonObject) - Method in enum io.vertx.openapi.contract.OpenAPIVersion
Response - Interface in io.vertx.openapi.contract
ResponseParameter - Interface in io.vertx.openapi.validation
ResponseValidator - Interface in io.vertx.openapi.validation: The ResponseValidator requires the parameters in a specific format to be able to parse and validate them.

S

SecurityRequirement - Interface in io.vertx.openapi.contract: A Security requirement is an object that contains the names of the security schemes that apply to the operation.
securityScheme(String) - Method in interface io.vertx.openapi.contract.OpenAPIContract: Gets the related SecurityScheme object based on the passed name.
SecurityScheme - Interface in io.vertx.openapi.contract: Represents a Security Scheme Object.
send(HttpServerResponse) - Method in interface io.vertx.openapi.validation.ValidatedResponse: Add all parameters from the validated response to the passed HttpServerResponse and send it.
Server - Interface in io.vertx.openapi.contract: This interface represents the most important attributes of an OpenAPI Server.
SimpleTransformer - Class in io.vertx.openapi.validation.transformer: +--------+---------+--------+-------------+-------------------------------------+--------------------------+ | style | explode | empty | string | array | object | +--------+---------+--------+-------------+-------------------------------------+--------------------------+ | simple | false | | blue | blue,black,brown | R,100,G,200,B,150 | +--------+---------+--------+-------------+-------------------------------------+--------------------------+ | simple | true | | blue | blue,black,brown | R=100,G=200,B=150 | +--------+---------+--------+-------------+-------------------------------------+--------------------------+
SimpleTransformer() - Constructor for class io.vertx.openapi.validation.transformer.SimpleTransformer
size() - Method in interface io.vertx.openapi.contract.SecurityRequirement: How many requirements are present
Style - Enum in io.vertx.openapi.contract
SUPPORTED_MEDIA_TYPES - Static variable in interface io.vertx.openapi.contract.MediaType

T

toString() - Method in enum io.vertx.openapi.contract.Location
toString() - Method in enum io.vertx.openapi.contract.Style
transform(MediaType, Buffer) - Method in class io.vertx.openapi.validation.transformer.ApplicationJsonTransformer
transform(MediaType, Buffer) - Method in interface io.vertx.openapi.validation.transformer.BodyTransformer
transform(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.LabelTransformer
transform(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.MatrixTransformer
transform(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.ParameterTransformer: Transforms the raw value from its String representation into JSON.
transformArray(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.ParameterTransformer: Like ParameterTransformer.transform(Parameter, String), but only for values considered to be an array.
transformObject(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.ParameterTransformer: Like ParameterTransformer.transform(Parameter, String), but only for values considered to be an object.
transformPrimitive(Parameter, String) - Method in class io.vertx.openapi.validation.transformer.ParameterTransformer: Like ParameterTransformer.transform(Parameter, String), but only for values considered to be primitive.
type() - Method in exception io.vertx.openapi.contract.OpenAPIContractException
type() - Method in exception io.vertx.openapi.validation.ValidatorException

V

ValidatableRequest - Interface in io.vertx.openapi.validation
ValidatableResponse - Interface in io.vertx.openapi.validation
validate(Vertx, SchemaRepository, JsonObject) - Method in enum io.vertx.openapi.contract.OpenAPIVersion
validate(HttpServerRequest) - Method in interface io.vertx.openapi.validation.RequestValidator: Like RequestValidator.validate(ValidatableRequest, String), but the operationId and ValidatableRequest are determined from the passed request.
validate(HttpServerRequest, String) - Method in interface io.vertx.openapi.validation.RequestValidator: Like RequestValidator.validate(ValidatableRequest, String), but ValidatableRequest are directly extracted from the passed request.
validate(ValidatableRequest, String) - Method in interface io.vertx.openapi.validation.RequestValidator: Validates the passed request parameters against the operation defined in the related OpenAPI contract.
validate(ValidatableResponse, String) - Method in interface io.vertx.openapi.validation.ResponseValidator: Validates the passed response parameters against the operation defined in the related OpenAPI contract.
ValidatedRequest - Interface in io.vertx.openapi.validation
ValidatedResponse - Interface in io.vertx.openapi.validation
ValidatorErrorType - Enum in io.vertx.openapi.validation
ValidatorException - Exception in io.vertx.openapi.validation
ValidatorException(String, ValidatorErrorType) - Constructor for exception io.vertx.openapi.validation.ValidatorException
ValidatorException(String, ValidatorErrorType, Throwable) - Constructor for exception io.vertx.openapi.validation.ValidatorException
valueOf(String) - Static method in enum io.vertx.openapi.contract.ContractErrorType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.openapi.contract.Location: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.openapi.contract.OpenAPIVersion: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.openapi.contract.Style: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.openapi.validation.ValidatorErrorType: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.vertx.openapi.contract.ContractErrorType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.openapi.contract.Location: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.openapi.contract.OpenAPIVersion: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.openapi.contract.Style: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.openapi.validation.ValidatorErrorType: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G I L M O P R S T V