Skip navigation links
A B C D E F G H I J L M N O P R S T U V W X 

A

addAllOf(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
addAnyOf(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
addAPIResponse(String, APIResponse) - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
addCallback(String, Callback) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
addCallback(String, Callback) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
addEncoding(String, Encoding) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
addEnumeration(Object) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
addEnumeration(String) - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
addExample(String, Example) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
addExample(String, Example) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
addExample(String, Example) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
addExample(String, Example) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
addExtension(String, Object) - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
addExtension(String, Object) - Method in class io.smallrye.openapi.api.models.ExtensibleImpl
 
addExtension(String, Object) - Method in class io.smallrye.openapi.api.models.PathsImpl
 
addExtension(String, Object) - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
addExtension(String, Object) - Method in class io.smallrye.openapi.api.models.security.ScopesImpl
 
addExtension(String, Object) - Method in class io.smallrye.openapi.api.models.servers.ServerVariablesImpl
 
addHeader(String, Header) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
addHeader(String, Header) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
addHeader(String, Header) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
additionalPropertiesBoolean(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
additionalPropertiesSchema(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
addLink(String, Link) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
addLink(String, Link) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
addMapping(String, String) - Method in class io.smallrye.openapi.api.models.media.DiscriminatorImpl
 
addMediaType(String, MediaType) - Method in class io.smallrye.openapi.api.models.media.ContentImpl
 
addOneOf(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
addParameter(String, Parameter) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
addParameter(String, Object) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
addParameter(Parameter) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
addParameter(Parameter) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
addPathItem(String, PathItem) - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
addPathItem(String, PathItem) - Method in class io.smallrye.openapi.api.models.PathsImpl
 
addProperty(String, Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
addRequestBody(String, RequestBody) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
addRequired(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
addResponse(String, APIResponse) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
addSchema(String, Schema) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
addScheme(String, String) - Method in class io.smallrye.openapi.api.models.security.SecurityRequirementImpl
 
addScheme(String, List<String>) - Method in class io.smallrye.openapi.api.models.security.SecurityRequirementImpl
 
addScheme(String) - Method in class io.smallrye.openapi.api.models.security.SecurityRequirementImpl
 
addScope(String, String) - Method in class io.smallrye.openapi.api.models.security.ScopesImpl
 
addSecurityRequirement(SecurityRequirement) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
addSecurityRequirement(SecurityRequirement) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
addSecurityScheme(String, SecurityScheme) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
addServer(Server) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
addServer(Server) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
addServer(Server) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
addServerVariable(String, ServerVariable) - Method in class io.smallrye.openapi.api.models.servers.ServerVariablesImpl
 
addTag(Tag) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
addTag(String) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
addTag(OpenAPI, Tag) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Adds a Tag to the OpenAPI model.
allOf(List<Schema>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
allowEmptyValue(Boolean) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
allowEmptyValue(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
allowRegistration(IndexView, Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Determines if a type is eligible for registration.
allowReserved(Boolean) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
allowReserved(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
AnnotationScannerExtension - Interface in io.smallrye.openapi.runtime.scanner
Extension point for supporting extensions to JAX-RS.
AnnotationTargetProcessor - Class in io.smallrye.openapi.runtime.scanner.dataobject
Process annotation targets such as FieldInfo.
AnnotationTargetProcessor(AugmentedIndexView, DataObjectDeque, DataObjectDeque.PathEntry, TypeResolver, AnnotationTarget, Type) - Constructor for class io.smallrye.openapi.runtime.scanner.dataobject.AnnotationTargetProcessor
 
anyOf(List<Schema>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
APIResponseImpl - Class in io.smallrye.openapi.api.models.responses
An implementation of the APIResponse OpenAPI model interface.
APIResponseImpl() - Constructor for class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
APIResponsesImpl - Class in io.smallrye.openapi.api.models.responses
An implementation of the APIResponses OpenAPI model interface.
APIResponsesImpl() - Constructor for class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
applyConstraints(AnnotationTarget, Schema, String, BeanValidationScanner.RequirementHandler) - Static method in class io.smallrye.openapi.runtime.scanner.dataobject.BeanValidationScanner
Determine if any Java Bean Validation constraint annotations are present on the AnnotationTarget that are applicable to the schema.
applyFilter(OASFilter, OpenAPI) - Static method in class io.smallrye.openapi.api.util.FilterUtil
Apply the given filter to the given model.
applyTypeAttributes(Type, Schema) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Sets the default schema attributes for the given type on the provided schema instance.
archiveName(String) - Method in class io.smallrye.openapi.api.OpenApiDocument
 
archiveToConfig(Archive<?>) - Static method in class io.smallrye.openapi.api.util.ArchiveUtil
Creates an OpenApiConfig instance from the given ShrinkWrap archive.
archiveToIndex(OpenApiConfig, Archive<?>) - Static method in class io.smallrye.openapi.api.util.ArchiveUtil
Index the ShrinkWrap archive to produce a jandex index.
archiveToStaticFile(Archive<?>) - Static method in class io.smallrye.openapi.api.util.ArchiveUtil
Finds the static OpenAPI file located in the deployment and, if it exists, returns it as an OpenApiStaticFile.
ArchiveUtil - Class in io.smallrye.openapi.api.util
Some useful methods for creating stuff from ShrinkWrap Archives.
ARRAY_TYPE_OBJECT - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
arrayFormat() - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
arrayNode() - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
 
attribute(Boolean) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
AugmentedIndexView - Class in io.smallrye.openapi.runtime.scanner.dataobject
IndexView augmented with additional methods for common operations used throughout the data object scanning code.
AugmentedIndexView(IndexView) - Constructor for class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
authorizationCode(OAuthFlow) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
authorizationUrl(String) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 

B

BeanValidationScanner - Class in io.smallrye.openapi.runtime.scanner.dataobject
 
BeanValidationScanner() - Constructor for class io.smallrye.openapi.runtime.scanner.dataobject.BeanValidationScanner
 
BeanValidationScanner.RequirementHandler - Interface in io.smallrye.openapi.runtime.scanner.dataobject
 
bearerFormat(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
bigDecimalProperty(JsonNode, String) - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
Extract a BigDecimal property from the given json tree.
bigDecimalProperty(ObjectNode, String, BigDecimal) - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
Sets the value of a property for a given json node.
bigDecimalValue(AnnotationInstance, String) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Reads a Double property value from the given annotation instance.
booleanProperty(JsonNode, String) - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
Extract a boolean property from the given json tree.
booleanProperty(ObjectNode, String, Boolean) - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
Sets the value of a property for a given json node.
booleanValue(AnnotationInstance, String) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Reads a Boolean property value from the given annotation instance.
booleanValueWithDefault(AnnotationInstance, String) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Reads a Boolean property from the given annotation instance.

C

CallbackImpl - Class in io.smallrye.openapi.api.models.callbacks
An implementation of the Callback OpenAPI model interface.
CallbackImpl() - Constructor for class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
callbacks(Map<String, Callback>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
callbacks(Map<String, Callback>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
checkRegistration(Type, TypeResolver, Schema) - Static method in class io.smallrye.openapi.runtime.scanner.SchemaRegistry
Check if the entityType is eligible for registration using the typeResolver.
CLASS_SUFFIX - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
clearMatchingDefaultAttributes(Schema, Schema) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Removes the known default schema attributes from the fieldSchema if they are also present and have the same value in the typeSchema.
clientCredentials(OAuthFlow) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
close() - Method in class io.smallrye.openapi.runtime.OpenApiStaticFile
 
COLLECTION_INTERFACE_NAME - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
COLLECTION_TYPE - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
CollectionStandin<E> - Class in io.smallrye.openapi.runtime.scanner
 
CollectionStandin() - Constructor for class io.smallrye.openapi.runtime.scanner.CollectionStandin
 
COMPLETION_STAGE_NAME - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
components(Components) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
components(OpenAPI) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Gets the Components from the OAI model.
ComponentsImpl - Class in io.smallrye.openapi.api.models
An implementation of the Components OpenAPI model interface.
ComponentsImpl() - Constructor for class io.smallrye.openapi.api.models.ComponentsImpl
 
config(OpenApiConfig) - Method in class io.smallrye.openapi.api.OpenApiDocument
 
configureServers(OpenApiConfig, OpenAPI) - Static method in class io.smallrye.openapi.api.util.ServersUtil
 
configureServers(OpenApiConfig, String, PathItem) - Static method in class io.smallrye.openapi.api.util.ServersUtil
Configures the servers for a PathItem.
configureServers(OpenApiConfig, Operation) - Static method in class io.smallrye.openapi.api.util.ServersUtil
Configures the servers for an Operation.
contact(Contact) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
ContactImpl - Class in io.smallrye.openapi.api.models.info
An implementation of the Contact OpenAPI model interface.
ContactImpl() - Constructor for class io.smallrye.openapi.api.models.info.ContactImpl
 
containsClass(Type) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
content(Content) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
content(Content) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
content(Content) - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
content(Content) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
ContentImpl - Class in io.smallrye.openapi.api.models.media
An implementation of the Content OpenAPI model interface.
ContentImpl() - Constructor for class io.smallrye.openapi.api.models.media.ContentImpl
 
contentType(String) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
createObject(Class<T>) - Method in class io.smallrye.openapi.spi.OASFactoryResolverImpl
 
currentInstance() - Static method in class io.smallrye.openapi.runtime.scanner.SchemaRegistry
Retrieve the SchemaRegistry previously created by newInstance for the current thread, or null if none has yet been created.
CUSTOM_SCHEMA_REGISTRY_CLASS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
CustomSchemaRegistry - Interface in io.smallrye.openapi.runtime.scanner
A simple registry that allows users to provide a custom schema for some types.
customSchemaRegistryClass() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
customSchemaRegistryClass() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 

D

DataObjectDeque - Class in io.smallrye.openapi.runtime.scanner.dataobject
Deque for exploring object graph.
DataObjectDeque(AugmentedIndexView) - Constructor for class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque
 
DataObjectDeque.PathEntry - Class in io.smallrye.openapi.runtime.scanner.dataobject
An entry on the object stack.
DEFAULT_MEDIA_TYPES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DefaultAnnotationScannerExtension - Class in io.smallrye.openapi.runtime.scanner
Deprecated.
implement AnnotationScannerExtension directly instead
DefaultAnnotationScannerExtension() - Constructor for class io.smallrye.openapi.runtime.scanner.DefaultAnnotationScannerExtension
Deprecated.
 
defaultValue(Object) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
defaultValue(APIResponse) - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
defaultValue(String) - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
DELETE(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
deprecated(Boolean) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
deprecated(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
deprecated(Boolean) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
deprecated(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.ExternalDocumentationImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
description(String) - Method in class io.smallrye.openapi.api.models.tags.TagImpl
 
discriminator(Discriminator) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
DiscriminatorImpl - Class in io.smallrye.openapi.api.models.media
An implementation of the Discriminator OpenAPI model interface.
DiscriminatorImpl() - Constructor for class io.smallrye.openapi.api.models.media.DiscriminatorImpl
 
DOTNAME_API_RESPONSE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_API_RESPONSES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_APPLICATION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_APPLICATION_PATH - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_ASYNC_RESPONSE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_BEAN_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_CALLBACK - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_CALLBACKS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_CONSUMES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_COOKIE_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_DECLARE_ROLES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_DEFAULT_VALUE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_DELETE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_DENY_ALL - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_DEPRECATED - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_EXTENSION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_EXTENSIONS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_FORM_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_GET - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_HEAD - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_HEADER_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JACKSON_IGNORE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JACKSON_IGNORE_PROPERTIES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JACKSON_IGNORE_TYPE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JACKSON_PROPERTY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JACKSON_PROPERTY_ORDER - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JAXB_XML_ATTRIBUTE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JAXB_XML_ELEMENT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JAXB_XML_TYPE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JAXRS_HTTP_METHODS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JSONB_PROPERTY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JSONB_PROPERTY_ORDER - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_JSONB_TRANSIENT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_MATRIX_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_OPEN_API_DEFINITION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_OPERATION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_OPTIONAL - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_OPTIONAL_DOUBLE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_OPTIONAL_INT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_OPTIONAL_LONG - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_OPTIONALS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_OPTIONS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_PARAMETER - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_PARAMETERS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_PATCH - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_PATH - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_PATH_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_PERMIT_ALL - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_POST - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_PRODUCES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_PROPERTY_ANNOTATIONS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_PUT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_QUERY_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_REQUEST_BODY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESPONSE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_COOKIE_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_FORM_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_HEADER_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MATRIX_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MULTIPART_FORM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MULTIPART_FORM_DATA_INPUT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MULTIPART_FORM_DATA_OUTPUT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MULTIPART_INPUT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MULTIPART_INPUTS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MULTIPART_OUTPUT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MULTIPART_OUTPUTS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MULTIPART_RELATED_INPUT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_MULTIPART_RELATED_OUTPUT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_PART_TYPE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_PATH_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_RESTEASY_QUERY_PARAM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_ROLES_ALLOWED - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_SCHEMA - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_SECURITY_REQUIREMENT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_SECURITY_REQUIREMENTS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_SECURITY_SCHEME - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_SECURITY_SCHEMES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_SERVER - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_SERVERS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_TAG - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
DOTNAME_TAGS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 

E

email(String) - Method in class io.smallrye.openapi.api.models.info.ContactImpl
 
encoding(Map<String, Encoding>) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
EncodingImpl - Class in io.smallrye.openapi.api.models.media
An implementation of the Encoding OpenAPI model interface.
EncodingImpl() - Constructor for class io.smallrye.openapi.api.models.media.EncodingImpl
 
ENUM_INTERFACE_NAME - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
ENUM_TYPE - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
enumeration(List<Object>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
enumeration(List<String>) - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
enumProperty(ObjectNode, String, E) - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
Sets the value of a property for a given json node.
enumToSchema(IndexView, Type) - Static method in class io.smallrye.openapi.runtime.util.SchemaFactory
Convert a Jandex enum class type to a Schema model.
enumValue(AnnotationInstance, String, Class<T>) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Reads a String property value from the given annotation instance.
enumValue(String, Class<T>) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Converts a string value to the given enum type.
equals(Object) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
equalTypes(Type, Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
equalWrappedTypes(Type, Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
example(Object) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
example(Object) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
example(Object) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
example(Object) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
ExampleImpl - Class in io.smallrye.openapi.api.models.examples
An implementation of the Example OpenAPI model interface.
ExampleImpl() - Constructor for class io.smallrye.openapi.api.models.examples.ExampleImpl
 
examples(Map<String, Example>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
examples(Map<String, Example>) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
examples(Map<String, Example>) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
examples(Map<String, Example>) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
exclusiveMaximum(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
exclusiveMinimum(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
explode(Boolean) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
explode(Boolean) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
explode(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
ExtensibleImpl<T extends org.eclipse.microprofile.openapi.models.Extensible<T>> - Class in io.smallrye.openapi.api.models
Implementation of the Extensible OpenAPI model interface.
ExtensibleImpl() - Constructor for class io.smallrye.openapi.api.models.ExtensibleImpl
 
EXTENSION_PROPERTY_PREFIX - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
externalDocs(ExternalDocumentation) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
externalDocs(ExternalDocumentation) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
externalDocs(ExternalDocumentation) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
externalDocs(ExternalDocumentation) - Method in class io.smallrye.openapi.api.models.tags.TagImpl
 
ExternalDocumentationImpl - Class in io.smallrye.openapi.api.models
An implementation of the ExternalDocumentation OpenAPI model interface.
ExternalDocumentationImpl() - Constructor for class io.smallrye.openapi.api.models.ExternalDocumentationImpl
 
externalValue(String) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 

F

filter() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
filter() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
filter(OASFilter) - Method in class io.smallrye.openapi.api.OpenApiDocument
 
FilteredIndexView - Class in io.smallrye.openapi.runtime.scanner
Wraps an IndexView instance and filters the contents based on the settings provided via OpenApiConfig.
FilteredIndexView(IndexView, OpenApiConfig) - Constructor for class io.smallrye.openapi.runtime.scanner.FilteredIndexView
Constructor.
FilterUtil - Class in io.smallrye.openapi.api.util
 
flows(OAuthFlows) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
format(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 

G

GET(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
get() - Method in class io.smallrye.openapi.api.OpenApiDocument
 
getAdditionalProperties() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getAdditionalPropertiesBoolean() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getAdditionalPropertiesSchema() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getAllFields(AugmentedIndexView, Type, ClassInfo) - Static method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
 
getAllKnownImplementors(DotName) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
getAllKnownImplementors(DotName) - Method in class io.smallrye.openapi.runtime.scanner.FilteredIndexView
 
getAllKnownSubclasses(DotName) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
getAllKnownSubclasses(DotName) - Method in class io.smallrye.openapi.runtime.scanner.FilteredIndexView
 
getAllOf() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getAllowEmptyValue() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getAllowEmptyValue() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getAllowReserved() - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
getAllowReserved() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getAnnotation(AnnotationTarget, DotName) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getAnnotation(Type, DotName) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getAnnotation(ClassInfo, DotName) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getAnnotation(FieldInfo, DotName) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getAnnotations(DotName) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
getAnnotations(DotName) - Method in class io.smallrye.openapi.runtime.scanner.FilteredIndexView
 
getAnnotations(AnnotationTarget) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getAnnotationTarget() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
getAnnotationTarget() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
Get the annotation target that represents this instance's schema property.
getAnnotationValue(AnnotationTarget, DotName) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Convenience method to retrieve the "value" parameter from an annotation bound to the target.
getAnnotationValue(AnnotationTarget, DotName, String) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Convenience method to retrieve the named parameter from an annotation bound to the target.
getAnnotationValue(AnnotationTarget, DotName, String, T) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Convenience method to retrieve the named parameter from an annotation bound to the target.
getAnyOf() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getAPIResponses() - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
getAttribute() - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
getAuthorizationCode() - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
getAuthorizationUrl() - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
getBearerFormat() - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
getBound(WildcardType) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getCallbacks() - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
getCallbacks() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getClass(Type) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
getClass(Class<?>) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
getClassAnnotation(ClassInfo, DotName) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Gets a single class annotation from the given class.
getClassByName(DotName) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
getClassByName(DotName) - Method in class io.smallrye.openapi.runtime.scanner.FilteredIndexView
 
getClazz() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
getClazzType() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
getClientCredentials() - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
getComponents() - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
getConfig() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
getContact() - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
getContent() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getContent() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getContent() - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
getContent() - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
getContent() - Method in class io.smallrye.openapi.runtime.OpenApiStaticFile
 
getContentType() - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
getDeclaringClass() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
Get the declaring class of the annotation target.
getDeclaringClass(AnnotationTarget) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getDefaultValue() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getDefaultValue() - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
getDefaultValue() - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
getDELETE() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getDeprecated() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getDeprecated() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getDeprecated() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getDeprecated() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.ExternalDocumentationImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
getDescription() - Method in class io.smallrye.openapi.api.models.tags.TagImpl
 
getDiscriminator() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getEmail() - Method in class io.smallrye.openapi.api.models.info.ContactImpl
 
getEnclosing() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
getEncoding() - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
getEnumeration() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getEnumeration() - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
getExample() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getExample() - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
getExample() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getExample() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getExamples() - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
getExamples() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getExamples() - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
getExamples() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getExclusiveMaximum() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getExclusiveMinimum() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getExplode() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getExplode() - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
getExplode() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getExtensions() - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
getExtensions() - Method in class io.smallrye.openapi.api.models.ExtensibleImpl
 
getExtensions() - Method in class io.smallrye.openapi.api.models.PathsImpl
 
getExtensions() - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
getExtensions() - Method in class io.smallrye.openapi.api.models.security.ScopesImpl
 
getExtensions() - Method in class io.smallrye.openapi.api.models.servers.ServerVariablesImpl
 
getExternalDocs() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getExternalDocs() - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
getExternalDocs() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getExternalDocs() - Method in class io.smallrye.openapi.api.models.tags.TagImpl
 
getExternalValue() - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
getField() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
Retrieves the field associated with this property.
getFilter(OpenApiConfig, ClassLoader) - Static method in class io.smallrye.openapi.runtime.OpenApiProcessor
Instantiate the OASFilter configured by the app.
getFlows() - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
getFormat() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getFormat() - Method in class io.smallrye.openapi.runtime.OpenApiStaticFile
 
getFormBodyContent() - Method in class io.smallrye.openapi.runtime.scanner.ParameterProcessor.ResourceParameters
 
getFormBodySchema() - Method in class io.smallrye.openapi.runtime.scanner.ParameterProcessor.ResourceParameters
 
getFullOperationPath() - Method in class io.smallrye.openapi.runtime.scanner.ParameterProcessor.ResourceParameters
 
getGET() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getHEAD() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getHeaders() - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
getHeaders() - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
getHeaders() - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
getImplicit() - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
getIn() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getIn() - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
getInfo() - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
getItems() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getJaxRsResourceClasses(IndexView) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Use the Jandex index to find all jax-rs resource classes.
getKnownClasses() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
getKnownClasses() - Method in class io.smallrye.openapi.runtime.scanner.FilteredIndexView
 
getKnownDirectImplementors(DotName) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
getKnownDirectImplementors(DotName) - Method in class io.smallrye.openapi.runtime.scanner.FilteredIndexView
 
getKnownDirectSubclasses(DotName) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AugmentedIndexView
 
getKnownDirectSubclasses(DotName) - Method in class io.smallrye.openapi.runtime.scanner.FilteredIndexView
 
getLicense() - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
getLinks() - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
getLinks() - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
getMapping() - Method in class io.smallrye.openapi.api.models.media.DiscriminatorImpl
 
getMaximum() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getMaxItems() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getMaxLength() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getMaxProperties() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getMediaTypes() - Method in class io.smallrye.openapi.api.models.media.ContentImpl
 
getMethodParameterAnnotation(MethodInfo, int, DotName) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Finds an annotation (if present) with the given name, on a particular parameter of a method.
getMethodParameterType(MethodInfo, short) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Returns the class type of the method parameter at the given position.
getMethodParameterType(MethodParameterInfo) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Returns the class type of the method parameter.
getMimeType() - Method in enum io.smallrye.openapi.runtime.io.OpenApiSerializer.Format
 
getMinimum() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getMinItems() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getMinLength() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getMinProperties() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getMultipleOf() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getName() - Method in class io.smallrye.openapi.api.models.info.ContactImpl
 
getName() - Method in class io.smallrye.openapi.api.models.info.LicenseImpl
 
getName() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getName() - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
getName() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getName() - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
getName() - Method in class io.smallrye.openapi.api.models.tags.TagImpl
 
getName(Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getNamespace() - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
getNot() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getNullable() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getOneOf() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getOpenapi() - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
getOpenIdConnectUrl() - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
getOperationId() - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
getOperationId() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getOperationParameters() - Method in class io.smallrye.openapi.runtime.scanner.ParameterProcessor.ResourceParameters
 
getOperationPath() - Method in class io.smallrye.openapi.runtime.scanner.ParameterProcessor.ResourceParameters
 
getOperationRef() - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
getOperations() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getOptionalType(Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Unwraps the type parameter (generic or primitive) from the given optional type.
getOPTIONS() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getParameterAnnotations(MethodInfo, short) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Returns all annotations configured for a single parameter of a method.
getParameters() - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
getParameters() - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
getParameters() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getParameters() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getParameterSchemas(Parameter) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Returns the list of Schemas defined for the given Parameter.
getPassword() - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
getPATCH() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getPathItemParameters() - Method in class io.smallrye.openapi.runtime.scanner.ParameterProcessor.ResourceParameters
 
getPathItems() - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
getPathItems() - Method in class io.smallrye.openapi.api.models.PathsImpl
 
getPaths() - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
getPattern() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getPOST() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getPrefix() - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
getProperties() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getPropertyName() - Method in class io.smallrye.openapi.api.models.media.DiscriminatorImpl
 
getPropertyName() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
Determine the name of the instance's property.
getPUT() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getReadMethod() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
Retrieves the read method (getter) associated with this property.
getReadOnly() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
getRef() - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
getRefreshUrl() - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
getRepeatableAnnotation(AnnotationTarget, DotName, DotName) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Many OAI annotations can either be found singly or as a wrapped array.
getRequestBodies() - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
getRequestBody() - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
getRequestBody() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getRequestBodyParameterClassType(MethodInfo, List<AnnotationScannerExtension>) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Go through the method parameters looking for one that is not annotated with a jax-rs annotation.
getRequired() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getRequired() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getRequired() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getRequired() - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
getResolvedType(Type) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
Resolve a type against this TypeResolver's resolution stack
getResponses() - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
getResponses() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getSchema() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getSchema() - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
getSchema() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getSchema() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
getSchema() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeProcessor
 
getSchemaAnnotation(AnnotationTarget) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getSchemaAnnotation(ClassInfo) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getSchemaAnnotation(FieldInfo) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getSchemaAnnotation(Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
getSchemas() - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
getScheme() - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
getSchemes() - Method in class io.smallrye.openapi.api.models.security.SecurityRequirementImpl
 
getScopes() - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
getScopes() - Method in class io.smallrye.openapi.api.models.security.ScopesImpl
 
getSecurity() - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
getSecurity() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getSecuritySchemes() - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
getServer() - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
getServers() - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
getServers() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getServers() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getServerVariables() - Method in class io.smallrye.openapi.api.models.servers.ServerVariablesImpl
 
getStyle() - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
getStyle() - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
getStyle() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
getSummary() - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
getSummary() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getSummary() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getTags() - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
getTags() - Method in class io.smallrye.openapi.api.models.OperationImpl
 
getTermsOfService() - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
getTitle() - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
getTitle() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getTokenUrl() - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
getTRACE() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
getType() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getType() - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
getTypeAttributes(Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Retrieves the read-only Map of schema attributes for the given type.
getUniqueItems() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getUnresolvedType() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
 
getUrl() - Method in class io.smallrye.openapi.api.models.ExternalDocumentationImpl
 
getUrl() - Method in class io.smallrye.openapi.api.models.info.ContactImpl
 
getUrl() - Method in class io.smallrye.openapi.api.models.info.LicenseImpl
 
getUrl() - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 
getValue() - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
getVariables() - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 
getVersion() - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
getWrapped() - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
getWriteMethod() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
Retrieves the write method (setter) associated with this property.
getWriteOnly() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
getXml() - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 

H

has(Type) - Method in class io.smallrye.openapi.runtime.scanner.SchemaRegistry
 
hasAnnotation(AnnotationTarget, DotName) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
hashCode() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
hasImplementation(AnnotationInstance) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Returns true if the given @Schema annotation has defined an "implementation" field.
hasParent(DataObjectDeque.PathEntry) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
HEAD(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
HeaderImpl - Class in io.smallrye.openapi.api.models.headers
An implementation of the Header OpenAPI model interface.
HeaderImpl() - Constructor for class io.smallrye.openapi.api.models.headers.HeaderImpl
 
headers(Map<String, Header>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
headers(Map<String, Header>) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
headers(Map<String, Header>) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 

I

IgnoreResolver - Class in io.smallrye.openapi.runtime.scanner.dataobject
 
IgnoreResolver(AugmentedIndexView) - Constructor for class io.smallrye.openapi.runtime.scanner.dataobject.IgnoreResolver
 
implicit(OAuthFlow) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
in(Parameter.In) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
in(SecurityScheme.In) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
info(Info) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
InfoImpl - Class in io.smallrye.openapi.api.models.info
An implementation of the Info OpenAPI model interface.
InfoImpl() - Constructor for class io.smallrye.openapi.api.models.info.InfoImpl
 
inheritanceChain(IndexView, ClassInfo, Type) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Builds an insertion-order map of a class's inheritance chain, starting with the klazz argument.
initialize() - Method in class io.smallrye.openapi.api.OpenApiDocument
 
INSTANCE - Static variable in class io.smallrye.openapi.api.OpenApiDocument
 
intProperty(JsonNode, String) - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
Extract a integer property from the given json tree.
intProperty(ObjectNode, String, Integer) - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
Sets the value of a property for a given json node.
intValue(AnnotationInstance, String) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Reads a Integer property value from the given annotation instance.
io.smallrye.openapi.api - package io.smallrye.openapi.api
 
io.smallrye.openapi.api.models - package io.smallrye.openapi.api.models
 
io.smallrye.openapi.api.models.callbacks - package io.smallrye.openapi.api.models.callbacks
 
io.smallrye.openapi.api.models.examples - package io.smallrye.openapi.api.models.examples
 
io.smallrye.openapi.api.models.headers - package io.smallrye.openapi.api.models.headers
 
io.smallrye.openapi.api.models.info - package io.smallrye.openapi.api.models.info
 
io.smallrye.openapi.api.models.links - package io.smallrye.openapi.api.models.links
 
io.smallrye.openapi.api.models.media - package io.smallrye.openapi.api.models.media
 
io.smallrye.openapi.api.models.parameters - package io.smallrye.openapi.api.models.parameters
 
io.smallrye.openapi.api.models.responses - package io.smallrye.openapi.api.models.responses
 
io.smallrye.openapi.api.models.security - package io.smallrye.openapi.api.models.security
 
io.smallrye.openapi.api.models.servers - package io.smallrye.openapi.api.models.servers
 
io.smallrye.openapi.api.models.tags - package io.smallrye.openapi.api.models.tags
 
io.smallrye.openapi.api.util - package io.smallrye.openapi.api.util
 
io.smallrye.openapi.runtime - package io.smallrye.openapi.runtime
 
io.smallrye.openapi.runtime.io - package io.smallrye.openapi.runtime.io
 
io.smallrye.openapi.runtime.scanner - package io.smallrye.openapi.runtime.scanner
 
io.smallrye.openapi.runtime.scanner.dataobject - package io.smallrye.openapi.runtime.scanner.dataobject
 
io.smallrye.openapi.runtime.util - package io.smallrye.openapi.runtime.util
 
io.smallrye.openapi.spi - package io.smallrye.openapi.spi
 
isA(IndexView, Type, Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Test whether testSubject is an instanceof type test.
isArraySchema(AnnotationInstance) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Returns true if the given @Schema annotation is an array schema.
isEmpty() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque
 
isEmpty(AnnotationInstance) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Returns true if the given annotation is void of any values (and thus is "empty").
isHidden() - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
isIgnore(AnnotationTarget, DataObjectDeque.PathEntry) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.IgnoreResolver
 
isJaxRsAnnotationExtension(AnnotationInstance) - Method in interface io.smallrye.openapi.runtime.scanner.AnnotationScannerExtension
Returns true if the given annotation is a jax-rs annotation extension, such as would be in the javax.ws.rs package.
isOptional(Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
Determine if a given type is one of the following types: java.util.Optional java.util.OptionalDouble java.util.OptionalInt java.util.OptionalLong
isParameter(DotName) - Static method in enum io.smallrye.openapi.runtime.scanner.ParameterProcessor.JaxRsParameter
 
isPrimitiveWrapper(PrimitiveType, Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
isRef(AnnotationInstance) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Returns true if the given annotation instance is a "ref".
isSet() - Method in class io.smallrye.openapi.api.OpenApiDocument
 
isSimpleArraySchema(AnnotationInstance) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Returns true if the given @Schema annotation is a simple array schema.
isSimpleClassSchema(AnnotationInstance) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Returns true if the given @Schema annotation is a simple class schema.
isTerminalType(Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
items(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 

J

JandexUtil - Class in io.smallrye.openapi.runtime.util
Some utility methods for working with Jandex objects.
JandexUtil.RefType - Enum in io.smallrye.openapi.runtime.util
Simple enum to indicate the type of a $ref being read/written.
JAR_SUFFIX - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
JsonUtil - Class in io.smallrye.openapi.runtime.io
Utilities methods for reading information from a Json Tree.

L

leafNode(DataObjectDeque.PathEntry, AnnotationTarget, Type, Schema) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque
Create a leaf node (i.e.
license(License) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
LicenseImpl - Class in io.smallrye.openapi.api.models.info
An implementation of the License OpenAPI model interface.
LicenseImpl() - Constructor for class io.smallrye.openapi.api.models.info.LicenseImpl
 
LinkImpl - Class in io.smallrye.openapi.api.models.links
An implementation of the Link OpenAPI model interface.
LinkImpl() - Constructor for class io.smallrye.openapi.api.models.links.LinkImpl
 
links(Map<String, Link>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
links(Map<String, Link>) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
lookupRef(Type) - Method in class io.smallrye.openapi.runtime.scanner.SchemaRegistry
 

M

makePath(String...) - Static method in class io.smallrye.openapi.runtime.scanner.OpenApiAnnotationScanner
Make a path out of a number of path segments.
MAP_INTERFACE_NAME - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
MAP_TYPE - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
mapping(Map<String, String>) - Method in class io.smallrye.openapi.api.models.media.DiscriminatorImpl
 
MapStandin<K,V> - Class in io.smallrye.openapi.runtime.scanner
 
MapStandin() - Constructor for class io.smallrye.openapi.runtime.scanner.MapStandin
 
maximum(BigDecimal) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
maxItems(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
maxLength(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
maxProperties(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
MediaTypeImpl - Class in io.smallrye.openapi.api.models.media
An implementation of the Discriminator MediaType model interface.
MediaTypeImpl() - Constructor for class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
merge(OpenAPIImpl, OpenAPIImpl) - Static method in class io.smallrye.openapi.api.util.MergeUtil
Merges two documents and returns the result.
mergeMaps(Map, Map) - Static method in class io.smallrye.openapi.api.util.MergeUtil
Merges two Maps.
mergeObjects(T, T) - Static method in class io.smallrye.openapi.api.util.MergeUtil
Generic merge of two objects of the same type.
MergeUtil - Class in io.smallrye.openapi.api.util
Used to merge two OAI data models into a single one.
minimum(BigDecimal) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
minItems(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
minLength(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
minProperties(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
modelFromAnnotations(OpenAPI) - Method in class io.smallrye.openapi.api.OpenApiDocument
 
modelFromAnnotations(OpenApiConfig, IndexView) - Static method in class io.smallrye.openapi.runtime.OpenApiProcessor
Create an OpenAPI model by scanning the deployment for relevant JAX-RS and OpenAPI annotations.
modelFromReader(OpenAPI) - Method in class io.smallrye.openapi.api.OpenApiDocument
 
modelFromReader(OpenApiConfig, ClassLoader) - Static method in class io.smallrye.openapi.runtime.OpenApiProcessor
Instantiate the configured OASModelReader and invoke it.
modelFromStaticFile(OpenAPI) - Method in class io.smallrye.openapi.api.OpenApiDocument
 
modelFromStaticFile(OpenApiStaticFile) - Static method in class io.smallrye.openapi.runtime.OpenApiProcessor
Parse the static file content and return the resulting model.
ModelImpl - Interface in io.smallrye.openapi.api.models
Marker interface - all data model implementations implement this interface.
modelReader() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
modelReader() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
ModelUtil - Class in io.smallrye.openapi.runtime.util
Class with some convenience methods useful for working with the OAI data model.
multipleOf(BigDecimal) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 

N

name(String) - Method in class io.smallrye.openapi.api.models.info.ContactImpl
 
name(String) - Method in class io.smallrye.openapi.api.models.info.LicenseImpl
 
name(String) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
name(String) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
name(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
name(String) - Method in class io.smallrye.openapi.api.models.tags.TagImpl
 
nameFromRef(AnnotationInstance) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Gets the name of an item from its ref.
nameFromRef(String) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Returns the name component of the ref.
namespace(String) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
NEVER_SCAN_CLASSES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
Set of classes which should never be scanned, regardless of user configuration.
NEVER_SCAN_PACKAGES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
Set of packages which should never be scanned, regardless of user configuration.
newInstance(OpenApiConfig, OpenAPI, IndexView) - Static method in class io.smallrye.openapi.runtime.scanner.SchemaRegistry
Create a new instance of a SchemaRegistry on this thread.
not(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
nullable(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 

O

OASFactoryResolverImpl - Class in io.smallrye.openapi.spi
An implementation of the OpenAPI 1.0 spec's OASFactoryResolver.
OASFactoryResolverImpl() - Constructor for class io.smallrye.openapi.spi.OASFactoryResolverImpl
 
OAuthFlowImpl - Class in io.smallrye.openapi.api.models.security
An implementation of the OAuthFlow OpenAPI model interface.
OAuthFlowImpl() - Constructor for class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
OAuthFlowsImpl - Class in io.smallrye.openapi.api.models.security
An implementation of the OAuthFlows OpenAPI model interface.
OAuthFlowsImpl() - Constructor for class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
OBJECT_TYPE - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
objectFormat() - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
objectNode() - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
 
oneOf(List<Schema>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
OPEN_API_VERSION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
openapi(String) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
OpenApiAnnotationScanner - Class in io.smallrye.openapi.runtime.scanner
Scans a deployment (using the archive and jandex annotation index) for JAX-RS and OpenAPI annotations.
OpenApiAnnotationScanner(OpenApiConfig, IndexView) - Constructor for class io.smallrye.openapi.runtime.scanner.OpenApiAnnotationScanner
Constructor.
OpenApiAnnotationScanner(OpenApiConfig, IndexView, List<AnnotationScannerExtension>) - Constructor for class io.smallrye.openapi.runtime.scanner.OpenApiAnnotationScanner
Constructor.
OpenApiConfig - Interface in io.smallrye.openapi.api
Accessor to OpenAPI configuration options.
OpenApiConfigImpl - Class in io.smallrye.openapi.api
Implementation of the OpenApiConfig interface that gets config information from a standard MP Config object.
OpenApiConfigImpl(Config) - Constructor for class io.smallrye.openapi.api.OpenApiConfigImpl
Constructor.
OpenApiConstants - Class in io.smallrye.openapi.api
 
OpenApiDataObjectScanner - Class in io.smallrye.openapi.runtime.scanner
Explores the class graph from the provided root, creating an OpenAPI Schema from the entities encountered.
OpenApiDataObjectScanner(IndexView, Type) - Constructor for class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
Constructor for data object scanner.
OpenApiDocument - Class in io.smallrye.openapi.api
Holds the final OpenAPI document produced during the startup of the app.
OpenAPIImpl - Class in io.smallrye.openapi.api.models
An implementation of the OpenAPI OpenAPI model interface.
OpenAPIImpl() - Constructor for class io.smallrye.openapi.api.models.OpenAPIImpl
 
OpenApiParser - Class in io.smallrye.openapi.runtime.io
A class used to parse an OpenAPI document (either YAML or JSON) into a Microprofile OpenAPI model tree.
OpenApiParser(JsonNode) - Constructor for class io.smallrye.openapi.runtime.io.OpenApiParser
Constructor.
OpenApiProcessor - Class in io.smallrye.openapi.runtime
Provides some core archive processing functionality.
OpenApiProcessor() - Constructor for class io.smallrye.openapi.runtime.OpenApiProcessor
 
OpenApiSerializer - Class in io.smallrye.openapi.runtime.io
Class used to serialize an OpenAPI
OpenApiSerializer(OpenAPI) - Constructor for class io.smallrye.openapi.runtime.io.OpenApiSerializer
Constructor.
OpenApiSerializer.Format - Enum in io.smallrye.openapi.runtime.io
 
OpenApiStaticFile - Class in io.smallrye.openapi.runtime
 
OpenApiStaticFile() - Constructor for class io.smallrye.openapi.runtime.OpenApiStaticFile
Constructor.
OpenApiStaticFile(InputStream, OpenApiSerializer.Format) - Constructor for class io.smallrye.openapi.runtime.OpenApiStaticFile
 
openIdConnectUrl(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
operationHasParameter(Operation, String) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Returns true if the given operation has a parameter with the given name.
operationId(String) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
operationId(String) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
OperationImpl - Class in io.smallrye.openapi.api.models
An implementation of the ExternalDocumentation OpenAPI model interface.
OperationImpl() - Constructor for class io.smallrye.openapi.api.models.OperationImpl
 
operationRef(String) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
operationServers(String) - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
operationServers(String) - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
OPTIONS(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 

P

parameterHasSchema(Parameter) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Returns true only if the given Parameter has a schema defined for it.
ParameterImpl - Class in io.smallrye.openapi.api.models.parameters
An implementation of the Parameter OpenAPI model interface.
ParameterImpl() - Constructor for class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
ParameterProcessor - Class in io.smallrye.openapi.runtime.scanner
Note, PathParam targets of PathSegment are not currently supported.
ParameterProcessor.JaxRsParameter - Enum in io.smallrye.openapi.runtime.scanner
Meta information for the JAX-RS *Param annotations relating them to the Parameter.In and Parameter.Style attributes of Parameters.
ParameterProcessor.ResourceParameters - Class in io.smallrye.openapi.runtime.scanner
Result object returned to the annotation scanner.
parameters(Map<String, Parameter>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
parameters(Map<String, Object>) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
parameters(List<Parameter>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
parameters(List<Parameter>) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
parse(URL) - Static method in class io.smallrye.openapi.runtime.io.OpenApiParser
Parses the resource found at the given URL.
parse(InputStream, OpenApiSerializer.Format) - Static method in class io.smallrye.openapi.runtime.io.OpenApiParser
Parses the resource found at the given stream.
password(OAuthFlow) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
PATCH(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
path(String, PathItem) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
PathItemImpl - Class in io.smallrye.openapi.api.models
An implementation of the PathItem OpenAPI model interface.
PathItemImpl() - Constructor for class io.smallrye.openapi.api.models.PathItemImpl
 
paths(Paths) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
paths(OpenAPIImpl) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Gets the Paths from the OAI model.
pathServers(String) - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
pathServers(String) - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
PathsImpl - Class in io.smallrye.openapi.api.models
An implementation of the Paths OpenAPI model interface.
PathsImpl() - Constructor for class io.smallrye.openapi.api.models.PathsImpl
 
pattern(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
peek() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque
Look at top of stack, but don't remove.
pop() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque
Remove and return top element from stack.
POST(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
prefix(String) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
process(AugmentedIndexView, DataObjectDeque, TypeResolver, DataObjectDeque.PathEntry) - Static method in class io.smallrye.openapi.runtime.scanner.dataobject.AnnotationTargetProcessor
 
process(AugmentedIndexView, DataObjectDeque, TypeResolver, DataObjectDeque.PathEntry, Type) - Static method in class io.smallrye.openapi.runtime.scanner.dataobject.AnnotationTargetProcessor
 
process(IndexView, Type) - Static method in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
Build a Schema with ClassType as root.
process(PrimitiveType) - Static method in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
Build a Schema with PrimitiveType as root.
process(IndexView, ClassInfo, MethodInfo, Function<AnnotationInstance, ParameterImpl>, List<AnnotationScannerExtension>) - Static method in class io.smallrye.openapi.runtime.scanner.ParameterProcessor
Process parameter annotations for the given class and method.
processDefinition(OpenAPIImpl, AnnotationInstance) - Method in class io.smallrye.openapi.runtime.scanner.OpenApiAnnotationScanner
Reads a OpenAPIDefinition annotation.
processJaxRsApplications(OpenApiAnnotationScanner, Collection<ClassInfo>) - Method in interface io.smallrye.openapi.runtime.scanner.AnnotationScannerExtension
Gives a chance to extensions to process the set of jax-rs application classes.
processType() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeProcessor
 
PROP_$REF - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ADDITIONAL_PROPERTIES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ALL_OF - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ALLOW_EMPTY_VALUE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ALLOW_RESERVED - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ANY_OF - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_API_KEY_NAME - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ATTRIBUTE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_AUTHORIZATION_CODE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_AUTHORIZATION_URL - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_BEARER_FORMAT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_CALLBACK_URL_EXPRESSION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_CALLBACKS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_CLIENT_CREDENTIALS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_COMPONENTS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_CONTACT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_CONTENT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_CONTENT_TYPE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_DEFAULT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_DEFAULT_VALUE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_DELETE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_DEPRECATED - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_DESCRIPTION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_DISCRIMINATOR - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_DISCRIMINATOR_MAPPING - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_DISCRIMINATOR_PROPERTY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EMAIL - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ENCODING - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ENUM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ENUMERATION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EXAMPLE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EXAMPLES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EXCLUSIVE_MAXIMUM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EXCLUSIVE_MINIMUM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EXPLODE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EXPRESSION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EXTENSIONS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EXTERNAL_DOCS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_EXTERNAL_VALUE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_FLOWS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_FORMAT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_GET - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_HEAD - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_HEADERS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_HIDDEN - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_IMPLEMENTATION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_IMPLICIT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_IN - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_INFO - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ITEMS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_LICENSE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_LINKS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MAPPING - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MAX_ITEMS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MAX_LENGTH - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MAX_PROPERTIES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MAXIMUM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MEDIA_TYPE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_METHOD - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MIN_ITEMS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MIN_LENGTH - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MIN_PROPERTIES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MINIMUM - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_MULTIPLE_OF - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_NAME - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_NAMESPACE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_NOT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_NULLABLE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_ONE_OF - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_OPEN_ID_CONNECT_URL - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_OPENAPI - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_OPERATION_ID - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_OPERATION_REF - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_OPERATIONS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_OPTIONS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PARAMETERS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PARSE_VALUE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PASSWORD - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PATCH - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PATHS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PATTERN - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_POST - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PREFIX - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PROPERTIES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PROPERTY_NAME - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_PUT - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_READ_ONLY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_REF - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_REFRESH_URL - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_REFS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_REQUEST_BODIES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_REQUEST_BODY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_REQUIRED - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_REQUIRED_PROPERTIES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_RESPONSE_CODE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_RESPONSES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SCHEMA - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SCHEMAS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SCHEME - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SCOPES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SECURITY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SECURITY_SCHEME_NAME - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SECURITY_SCHEMES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SERVER - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SERVERS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_STYLE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_SUMMARY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_TAGS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_TERMS_OF_SERVICE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_TITLE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_TOKEN_URL - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_TRACE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_TYPE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_UNIQUE_ITEMS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_URL - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_VALUE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_VARIABLES - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_VERSION - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_WRAPPED - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_WRITE_ONLY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
PROP_XML - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
properties(Map<String, Schema>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
propertyName(String) - Method in class io.smallrye.openapi.api.models.media.DiscriminatorImpl
 
push(DataObjectDeque.PathEntry) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque
Push entry to stack.
push(AnnotationTarget, DataObjectDeque.PathEntry, Type, Schema) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque
Create new entry and push to stack.
PUT(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 

R

readOnly(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
readOperations() - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
readSchema(IndexView, AnnotationValue) - Static method in class io.smallrye.openapi.runtime.util.SchemaFactory
Reads a Schema annotation into a model.
readSchema(IndexView, AnnotationInstance) - Static method in class io.smallrye.openapi.runtime.util.SchemaFactory
Reads a Schema annotation into a model.
readSchema(IndexView, Schema, AnnotationInstance, ClassInfo) - Static method in class io.smallrye.openapi.runtime.util.SchemaFactory
Populates the schema using the @Schema on the provided class.
readSchema(IndexView, Schema, AnnotationInstance, ClassInfo, Map<String, Object>) - Static method in class io.smallrye.openapi.runtime.util.SchemaFactory
Populates the schema using the @Schema on the provided class.
readSchema(IndexView, Schema, AnnotationInstance, Map<String, Object>) - Static method in class io.smallrye.openapi.runtime.util.SchemaFactory
 
ref(String) - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
ref(String) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
ref(String) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
ref(String) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
ref(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
ref(String) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
ref(String) - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
ref(String) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
ref(String) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
ref(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
REF_PREFIX_API_RESPONSE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
REF_PREFIX_CALLBACK - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
REF_PREFIX_EXAMPLE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
REF_PREFIX_HEADER - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
REF_PREFIX_LINK - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
REF_PREFIX_PARAMETER - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
REF_PREFIX_REQUEST_BODY - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
REF_PREFIX_SCHEMA - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
REF_PREFIX_SECURITY_SCHEME - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
refreshUrl(String) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
refValue(AnnotationInstance, JandexUtil.RefType) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Reads a string property named "ref" value from the given annotation and converts it to a value appropriate for setting on a model's "$ref" property.
register(Type, Schema) - Method in class io.smallrye.openapi.runtime.scanner.SchemaRegistry
Register the provided Schema for the provided Type.
registerCustomSchemas(SchemaRegistry) - Method in interface io.smallrye.openapi.runtime.scanner.CustomSchemaRegistry
Registers types with a custom schema.
remove() - Static method in class io.smallrye.openapi.runtime.scanner.SchemaRegistry
 
removeAllOf(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
removeAnyOf(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
removeAPIResponse(String) - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
removeCallback(String) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
removeCallback(String) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
removeEncoding(String) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
removeEnumeration(Object) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
removeEnumeration(String) - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
removeExample(String) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
removeExample(String) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
removeExample(String) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
removeExample(String) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
removeExtension(String) - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
removeExtension(String) - Method in class io.smallrye.openapi.api.models.ExtensibleImpl
 
removeExtension(String) - Method in class io.smallrye.openapi.api.models.PathsImpl
 
removeExtension(String) - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
removeExtension(String) - Method in class io.smallrye.openapi.api.models.security.ScopesImpl
 
removeExtension(String) - Method in class io.smallrye.openapi.api.models.servers.ServerVariablesImpl
 
removeHeader(String) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
removeHeader(String) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
removeHeader(String) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
removeLink(String) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
removeLink(String) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
removeMapping(String) - Method in class io.smallrye.openapi.api.models.media.DiscriminatorImpl
 
removeMediaType(String) - Method in class io.smallrye.openapi.api.models.media.ContentImpl
 
removeOneOf(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
removeParameter(String) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
removeParameter(String) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
removeParameter(Parameter) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
removeParameter(Parameter) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
removePathItem(String) - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
removePathItem(String) - Method in class io.smallrye.openapi.api.models.PathsImpl
 
removeProperty(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
removeRequestBody(String) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
removeRequired(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
removeResponse(String) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
removeSchema(String) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
removeScheme(String) - Method in class io.smallrye.openapi.api.models.security.SecurityRequirementImpl
 
removeScope(String) - Method in class io.smallrye.openapi.api.models.security.ScopesImpl
 
removeSecurityRequirement(SecurityRequirement) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
removeSecurityRequirement(SecurityRequirement) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
removeSecurityScheme(String) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
removeServer(Server) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
removeServer(Server) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
removeServer(Server) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
removeServerVariable(String) - Method in class io.smallrye.openapi.api.models.servers.ServerVariablesImpl
 
removeTag(Tag) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
removeTag(String) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
requestBodies(Map<String, RequestBody>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
requestBody(Object) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
requestBody(RequestBody) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
requestBodyHasSchema(RequestBody) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Returns true only if the given RequestBody has a schema defined for it.
RequestBodyImpl - Class in io.smallrye.openapi.api.models.parameters
An implementation of the RequestBody OpenAPI model interface.
RequestBodyImpl() - Constructor for class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
required(Boolean) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
required(List<String>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
required(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
required(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
reset() - Method in class io.smallrye.openapi.api.OpenApiDocument
Reset the holder.
resolveAsyncType(Type) - Method in interface io.smallrye.openapi.runtime.scanner.AnnotationScannerExtension
Unwraps an asynchronous type such as CompletionStage<X> into its resolved type X
resolveType() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.TypeResolver
Resolve the type that was used to initially construct this TypeResolver
resolveWildcard(WildcardType) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
resolveWildcard(Type) - Static method in class io.smallrye.openapi.runtime.util.TypeUtil
 
ResourceParameters() - Constructor for class io.smallrye.openapi.runtime.scanner.ParameterProcessor.ResourceParameters
 
responses(Map<String, APIResponse>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
responses(APIResponses) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
responses(Operation) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Gets the APIResponses child model from the given operation.
rootNode(AnnotationTarget, ClassInfo, Type, Schema) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque
Create a root node (first entry in graph).

S

scan() - Method in class io.smallrye.openapi.runtime.scanner.OpenApiAnnotationScanner
Scan the deployment for relevant annotations.
SCAN_DEPENDENCIES_DISABLE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
SCAN_DEPENDENCIES_JARS - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
scanClasses() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
scanClasses() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
scanDependenciesDisable() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
scanDependenciesDisable() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
scanDependenciesJars() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
scanDependenciesJars() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
scanDisable() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
scanDisable() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
scanExcludeClasses() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
scanExcludeClasses() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
scanExcludePackages() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
scanExcludePackages() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
scanPackages() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
scanPackages() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
schema(Schema) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
schema(Schema) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
schema(Schema) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
SCHEMA_REFERENCES_ENABLE - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
SchemaFactory - Class in io.smallrye.openapi.runtime.util
 
SchemaImpl - Class in io.smallrye.openapi.api.models.media
An implementation of the Content OpenAPI model interface.
SchemaImpl() - Constructor for class io.smallrye.openapi.api.models.media.SchemaImpl
 
schemaReferencesEnable() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
schemaReferencesEnable() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
schemaReferenceSupported() - Method in class io.smallrye.openapi.runtime.scanner.SchemaRegistry
 
SchemaRegistry - Class in io.smallrye.openapi.runtime.scanner
A simple registry used to track schemas that have been generated and inserted into the #/components section of the
schemas(Map<String, Schema>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
scheme(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
scopes(Scopes) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
ScopesImpl - Class in io.smallrye.openapi.api.models.security
An implementation of the Scopes OpenAPI model interface.
ScopesImpl() - Constructor for class io.smallrye.openapi.api.models.security.ScopesImpl
 
security(List<SecurityRequirement>) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
security(List<SecurityRequirement>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
SecurityRequirementImpl - Class in io.smallrye.openapi.api.models.security
An implementation of the SecurityRequirement OpenAPI model interface.
SecurityRequirementImpl() - Constructor for class io.smallrye.openapi.api.models.security.SecurityRequirementImpl
 
SecuritySchemeImpl - Class in io.smallrye.openapi.api.models.security
An implementation of the SecurityScheme OpenAPI model interface.
SecuritySchemeImpl() - Constructor for class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
securitySchemes(Map<String, SecurityScheme>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
serialize(OpenAPI, OpenApiSerializer.Format) - Static method in class io.smallrye.openapi.runtime.io.OpenApiSerializer
Serializes the given OpenAPI object into either JSON or YAML and returns it as a string.
server(Server) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
ServerImpl - Class in io.smallrye.openapi.api.models.servers
An implementation of the Server OpenAPI model interface.
ServerImpl() - Constructor for class io.smallrye.openapi.api.models.servers.ServerImpl
 
servers(List<Server>) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
servers(List<Server>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
servers(List<Server>) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
servers() - Method in interface io.smallrye.openapi.api.OpenApiConfig
 
servers() - Method in class io.smallrye.openapi.api.OpenApiConfigImpl
 
ServersUtil - Class in io.smallrye.openapi.api.util
Used to configure server information from config properties.
ServerVariableImpl - Class in io.smallrye.openapi.api.models.servers
An implementation of the ServerVariable OpenAPI model interface.
ServerVariableImpl() - Constructor for class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
ServerVariablesImpl - Class in io.smallrye.openapi.api.models.servers
An implementation of the ServerVariables OpenAPI model interface.
ServerVariablesImpl() - Constructor for class io.smallrye.openapi.api.models.servers.ServerVariablesImpl
 
set(OpenAPI) - Method in class io.smallrye.openapi.api.OpenApiDocument
Set the final OpenAPI document.
SET_INTERFACE_NAME - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
SET_TYPE - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
setAdditionalPropertiesBoolean(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setAdditionalPropertiesSchema(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setAllOf(List<Schema>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setAllowEmptyValue(Boolean) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setAllowEmptyValue(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setAllowReserved(Boolean) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
setAllowReserved(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setAnyOf(List<Schema>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setAPIResponses(Map<String, APIResponse>) - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
setAttribute(Boolean) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
setAuthorizationCode(OAuthFlow) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
setAuthorizationUrl(String) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
setBearerFormat(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
setCallbacks(Map<String, Callback>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
setCallbacks(Map<String, Callback>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setClientCredentials(OAuthFlow) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
setComponents(Components) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
setContact(Contact) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
setContent(Content) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setContent(Content) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setContent(Content) - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
setContent(Content) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
setContent(InputStream) - Method in class io.smallrye.openapi.runtime.OpenApiStaticFile
 
setContentType(String) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
setCurrentAppPath(String) - Method in class io.smallrye.openapi.runtime.scanner.OpenApiAnnotationScanner
 
setDefaultValue(Object) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setDefaultValue(APIResponse) - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
setDefaultValue(String) - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
setDELETE(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setDeprecated(Boolean) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setDeprecated(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setDeprecated(Boolean) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setDeprecated(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.ExternalDocumentationImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
setDescription(String) - Method in class io.smallrye.openapi.api.models.tags.TagImpl
 
setDiscriminator(Discriminator) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setEmail(String) - Method in class io.smallrye.openapi.api.models.info.ContactImpl
 
setEncoding(Map<String, Encoding>) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
setEnumeration(List<Object>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setEnumeration(List<String>) - Method in class io.smallrye.openapi.api.models.servers.ServerVariableImpl
 
setExample(Object) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setExample(Object) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
setExample(Object) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setExample(Object) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setExamples(Map<String, Example>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
setExamples(Map<String, Example>) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setExamples(Map<String, Example>) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
setExamples(Map<String, Example>) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setExclusiveMaximum(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setExclusiveMinimum(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setExplode(Boolean) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setExplode(Boolean) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
setExplode(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setExtensions(Map<String, Object>) - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
setExtensions(Map<String, Object>) - Method in class io.smallrye.openapi.api.models.ExtensibleImpl
 
setExtensions(Map<String, Object>) - Method in class io.smallrye.openapi.api.models.PathsImpl
 
setExtensions(Map<String, Object>) - Method in class io.smallrye.openapi.api.models.responses.APIResponsesImpl
 
setExtensions(Map<String, Object>) - Method in class io.smallrye.openapi.api.models.security.ScopesImpl
 
setExtensions(Map<String, Object>) - Method in class io.smallrye.openapi.api.models.servers.ServerVariablesImpl
 
setExternalDocs(ExternalDocumentation) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setExternalDocs(ExternalDocumentation) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
setExternalDocs(ExternalDocumentation) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setExternalDocs(ExternalDocumentation) - Method in class io.smallrye.openapi.api.models.tags.TagImpl
 
setExternalValue(String) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
setFlows(OAuthFlows) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
setFormat(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setFormat(OpenApiSerializer.Format) - Method in class io.smallrye.openapi.runtime.OpenApiStaticFile
 
setGET(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setHEAD(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setHeaders(Map<String, Header>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
setHeaders(Map<String, Header>) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
setHeaders(Map<String, Header>) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
setHidden(boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setImplicit(OAuthFlow) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
setIn(Parameter.In) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setIn(SecurityScheme.In) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
setInfo(Info) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
setItems(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setLicense(License) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
setLinks(Map<String, Link>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
setLinks(Map<String, Link>) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
setMapping(Map<String, String>) - Method in class io.smallrye.openapi.api.models.media.DiscriminatorImpl
 
setMaximum(BigDecimal) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setMaxItems(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setMaxLength(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setMaxProperties(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setMediaTypes(Map<String, MediaType>) - Method in class io.smallrye.openapi.api.models.media.ContentImpl
 
setMinimum(BigDecimal) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setMinItems(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setMinLength(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setMinProperties(Integer) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setMultipleOf(BigDecimal) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setName(String) - Method in class io.smallrye.openapi.api.models.info.ContactImpl
 
setName(String) - Method in class io.smallrye.openapi.api.models.info.LicenseImpl
 
setName(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setName(String) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
setName(String) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setName(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
setName(String) - Method in class io.smallrye.openapi.api.models.tags.TagImpl
 
setNamespace(String) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
setNot(Schema) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setNullable(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setOneOf(List<Schema>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setOpenapi(String) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
setOpenIdConnectUrl(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
setOperationId(String) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
setOperationId(String) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setOperationRef(String) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
setOPTIONS(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setParameters(Map<String, Parameter>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
setParameters(Map<String, Object>) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
setParameters(List<Parameter>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setParameters(List<Parameter>) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setParameterSchema(Parameter, Schema) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Sets the given Schema on the given Parameter.
setPassword(OAuthFlow) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowsImpl
 
setPATCH(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setPathItems(Map<String, PathItem>) - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
setPathItems(Map<String, PathItem>) - Method in class io.smallrye.openapi.api.models.PathsImpl
 
setPaths(Paths) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
setPattern(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setPOST(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setPrefix(String) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
setProperties(Map<String, Schema>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setPropertyName(String) - Method in class io.smallrye.openapi.api.models.media.DiscriminatorImpl
 
setPUT(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setReadOnly(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.callbacks.CallbackImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.responses.APIResponseImpl
 
setRef(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
setRefreshUrl(String) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
setRequestBodies(Map<String, RequestBody>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
setRequestBody(Object) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
setRequestBody(RequestBody) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setRequestBodySchema(RequestBody, Schema, String[]) - Static method in class io.smallrye.openapi.runtime.util.ModelUtil
Sets the given Schema on the given RequestBody.
setRequired(Boolean) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setRequired(List<String>) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setRequired(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setRequired(Boolean) - Method in class io.smallrye.openapi.api.models.parameters.RequestBodyImpl
 
setRequired(AnnotationTarget, String) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.AnnotationTargetProcessor
 
setRequired(AnnotationTarget, String) - Method in interface io.smallrye.openapi.runtime.scanner.dataobject.BeanValidationScanner.RequirementHandler
 
setResponses(Map<String, APIResponse>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
setResponses(APIResponses) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setSchema(Schema) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setSchema(Schema) - Method in class io.smallrye.openapi.api.models.media.MediaTypeImpl
 
setSchema(Schema) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setSchema(Schema) - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
setSchemas(Map<String, Schema>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
setScheme(String) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
setSchemes(Map<String, List<String>>) - Method in class io.smallrye.openapi.api.models.security.SecurityRequirementImpl
 
setScopes(Scopes) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
setScopes(Map<String, String>) - Method in class io.smallrye.openapi.api.models.security.ScopesImpl
 
setSecurity(List<SecurityRequirement>) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
setSecurity(List<SecurityRequirement>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setSecuritySchemes(Map<String, SecurityScheme>) - Method in class io.smallrye.openapi.api.models.ComponentsImpl
 
setServer(Server) - Method in class io.smallrye.openapi.api.models.links.LinkImpl
 
setServers(List<Server>) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
setServers(List<Server>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setServers(List<Server>) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setServerVariables(Map<String, ServerVariable>) - Method in class io.smallrye.openapi.api.models.servers.ServerVariablesImpl
 
setStyle(Header.Style) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
setStyle(Encoding.Style) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
setStyle(Parameter.Style) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
setSummary(String) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
setSummary(String) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setSummary(String) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setTags(List<Tag>) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
setTags(List<String>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
setTermsOfService(String) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
setTitle(String) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
setTitle(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setTokenUrl(String) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
setTRACE(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
setType(Schema.SchemaType) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setType(SecurityScheme.Type) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
setUniqueItems(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setUrl(String) - Method in class io.smallrye.openapi.api.models.ExternalDocumentationImpl
 
setUrl(String) - Method in class io.smallrye.openapi.api.models.info.ContactImpl
 
setUrl(String) - Method in class io.smallrye.openapi.api.models.info.LicenseImpl
 
setUrl(String) - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 
setValue(Object) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
setVariables(Map<String, ServerVariable>) - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 
setVariables(ServerVariables) - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 
setVersion(String) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
setWrapped(Boolean) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
setWriteOnly(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
setXml(XML) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
size() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque
 
STRING_TYPE - Static variable in class io.smallrye.openapi.runtime.scanner.OpenApiDataObjectScanner
 
stringListValue(AnnotationInstance, String) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Reads a String array property value from the given annotation instance.
stringProperty(JsonNode, String) - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
Extract a string property from the given json tree.
stringProperty(ObjectNode, String, String) - Static method in class io.smallrye.openapi.runtime.io.JsonUtil
Sets the value of a property for a given json node.
stringValue(AnnotationInstance, String) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Reads a String property value from the given annotation instance.
style(Header.Style) - Method in class io.smallrye.openapi.api.models.headers.HeaderImpl
 
style(Encoding.Style) - Method in class io.smallrye.openapi.api.models.media.EncodingImpl
 
style(Parameter.Style) - Method in class io.smallrye.openapi.api.models.parameters.ParameterImpl
 
summary(String) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
summary(String) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
summary(String) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 

T

TagImpl - Class in io.smallrye.openapi.api.models.tags
An implementation of the Tag OpenAPI model interface.
TagImpl() - Constructor for class io.smallrye.openapi.api.models.tags.TagImpl
 
tags(List<Tag>) - Method in class io.smallrye.openapi.api.models.OpenAPIImpl
 
tags(List<String>) - Method in class io.smallrye.openapi.api.models.OperationImpl
 
termsOfService(String) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
title(String) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 
title(String) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
tokenUrl(String) - Method in class io.smallrye.openapi.api.models.security.OAuthFlowImpl
 
toString() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
toStringWithGraph() - Method in class io.smallrye.openapi.runtime.scanner.dataobject.DataObjectDeque.PathEntry
 
TRACE(Operation) - Method in class io.smallrye.openapi.api.models.PathItemImpl
 
type(Schema.SchemaType) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
type(SecurityScheme.Type) - Method in class io.smallrye.openapi.api.models.security.SecuritySchemeImpl
 
TypeProcessor - Class in io.smallrye.openapi.runtime.scanner.dataobject
Process Type instances.
TypeProcessor(AugmentedIndexView, DataObjectDeque, DataObjectDeque.PathEntry, TypeResolver, Type, Schema, AnnotationTarget) - Constructor for class io.smallrye.openapi.runtime.scanner.dataobject.TypeProcessor
 
TypeResolver - Class in io.smallrye.openapi.runtime.scanner.dataobject
 
typeToSchema(IndexView, Type, List<AnnotationScannerExtension>) - Static method in class io.smallrye.openapi.runtime.util.SchemaFactory
Converts a Jandex type to a Schema model.
TypeUtil - Class in io.smallrye.openapi.runtime.util
 

U

uniqueItems(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
url(String) - Method in class io.smallrye.openapi.api.models.ExternalDocumentationImpl
 
url(String) - Method in class io.smallrye.openapi.api.models.info.ContactImpl
 
url(String) - Method in class io.smallrye.openapi.api.models.info.LicenseImpl
 
url(String) - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 

V

value(Object) - Method in class io.smallrye.openapi.api.models.examples.ExampleImpl
 
value(AnnotationInstance, String) - Static method in class io.smallrye.openapi.runtime.util.JandexUtil
Convenience method to retrieve the named parameter from an annotation.
valueOf(String) - Static method in enum io.smallrye.openapi.runtime.io.OpenApiSerializer.Format
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.smallrye.openapi.runtime.scanner.ParameterProcessor.JaxRsParameter
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.smallrye.openapi.runtime.util.JandexUtil.RefType
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.smallrye.openapi.runtime.io.OpenApiSerializer.Format
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.smallrye.openapi.runtime.scanner.ParameterProcessor.JaxRsParameter
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.smallrye.openapi.runtime.util.JandexUtil.RefType
Returns an array containing the constants of this enum type, in the order they are declared.
variables(ServerVariables) - Method in class io.smallrye.openapi.api.models.servers.ServerImpl
 
version(String) - Method in class io.smallrye.openapi.api.models.info.InfoImpl
 

W

WEB_ARCHIVE_CLASS_PREFIX - Static variable in class io.smallrye.openapi.api.OpenApiConstants
 
wrapped(Boolean) - Method in class io.smallrye.openapi.api.models.media.XMLImpl
 
writeObject(ObjectNode, String, Object) - Method in class io.smallrye.openapi.runtime.io.OpenApiSerializer
 
writeOnly(Boolean) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
writeServerToNode(ObjectNode, Server) - Method in class io.smallrye.openapi.runtime.io.OpenApiSerializer
Writes a Server model to the given JSON node.

X

xml(XML) - Method in class io.smallrye.openapi.api.models.media.SchemaImpl
 
XMLImpl - Class in io.smallrye.openapi.api.models.media
An implementation of the XML OpenAPI model interface.
XMLImpl() - Constructor for class io.smallrye.openapi.api.models.media.XMLImpl
 
A B C D E F G H I J L M N O P R S T U V W X 
Skip navigation links

Copyright © 2018–2020. All rights reserved.