A C D E F G H I J L M N O P R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractOpenApiEndpointVisitor - Class in io.micronaut.openapi.visitor
-
A
TypeElementVisitorthe builds the Swagger model from Micronaut controllers at compile time. - AbstractOpenApiEndpointVisitor() - Constructor for class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
- addAlways() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIDecorator
- addMissingDiscriminatorType(OpenAPI) - Method in class io.micronaut.openapi.postprocessors.JacksonDiscriminatorPostProcessor
-
Add the missing discriminator property to the schemas related to another schema referencing them.
- annotationType() - Method in class io.micronaut.openapi.annotation.mappers.OpenAPIManagementAnnotationMapper
- annotationType() - Method in class io.micronaut.openapi.annotation.mappers.OpenAPISecurityAnnotationMapper
- AnnProcessorEnvironment - Class in io.micronaut.openapi.visitor
-
Specific environment for annotation processing level.
- AnnProcessorEnvironment(ApplicationContextConfiguration, VisitorContext) - Constructor for class io.micronaut.openapi.visitor.AnnProcessorEnvironment
-
Construct a new environment for the given configuration.
- ApiResponseRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ApiResponseRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ApiResponseRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ApiResponsesRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ApiResponsesRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ApiResponsesRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- arraySchema(Schema) - Static method in class io.micronaut.openapi.visitor.SchemaUtils
- ArraySchemaRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ArraySchemaRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ArraySchemaRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ATTR_OPENAPI - Static variable in class io.micronaut.openapi.visitor.Utils
- ATTR_TEST_MODE - Static variable in class io.micronaut.openapi.visitor.Utils
- ATTR_VISITED_ELEMENTS - Static variable in class io.micronaut.openapi.visitor.Utils
C
- CallbackConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- CallbackConfiguration() - Constructor for class io.micronaut.openapi.introspections.CallbackConfiguration
- CallbackRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- CallbackRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.CallbackRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- CallbacksRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- CallbacksRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.CallbacksRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- classes() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIInclude
- classExternalDocs - Variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
- classNames() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIInclude
- classTags - Variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
- classTags(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns the class tags.
- classTags(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- classTags(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- COMPONENTS_CALLBACKS_PREFIX - Static variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
- consumesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns the consumes media types.
- consumesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- consumesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- ContactRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ContactRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ContactRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ContentRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ContentRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ContentRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- CONTEXT_CHILD_OP_ID_PREFIX - Static variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
- CONTEXT_CHILD_OP_ID_SUFFIX - Static variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
- CONTEXT_CHILD_OP_ID_SUFFIX_ADD_ALWAYS - Static variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
- CONTEXT_CHILD_PATH - Static variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
- ContextUtils - Class in io.micronaut.openapi.visitor
-
Convert utilities methods.
- ConvertUtils - Class in io.micronaut.openapi.visitor
-
Convert utilities methods.
D
- DEFAULT_MEDIA_TYPES - Static variable in class io.micronaut.openapi.visitor.Utils
- description(MethodElement) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns the description for the element.
- description(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- description(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- DiscriminatorMappingRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- DiscriminatorMappingRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.DiscriminatorMappingRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
E
- EncodingRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- EncodingRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.EncodingRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ExampleConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- ExampleConfiguration() - Constructor for class io.micronaut.openapi.introspections.ExampleConfiguration
- ExampleObjectMappingRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ExampleObjectMappingRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ExampleObjectMappingRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- expandProperties(String, List<Map.Entry<String, String>>, VisitorContext) - Static method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- ExtensionPropertyRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ExtensionPropertyRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ExtensionPropertyRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ExtensionRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ExtensionRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ExtensionRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ExtensionsRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ExtensionsRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ExtensionsRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ExternalDocumentationRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ExternalDocumentationRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ExternalDocumentationRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
F
- finish(VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- fromSpecification(String, Properties) - Static method in class io.micronaut.openapi.view.OpenApiViewConfig
-
Creates an OpenApiViewConfig form a String representation.
G
- getActiveEnvs(VisitorContext) - Static method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- getConfigurationProperty(String, VisitorContext) - Static method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- getConvertJsonMapper() - Static method in class io.micronaut.openapi.visitor.ConvertUtils
- getEnv(VisitorContext) - Static method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- getExpandableProperties(VisitorContext) - Static method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- getJavadocParser() - Static method in class io.micronaut.openapi.visitor.Utils
- getJsonMapper() - Static method in class io.micronaut.openapi.visitor.ConvertUtils
- getMethodDescription() - Method in class io.micronaut.openapi.javadoc.JavadocDescription
- getMethodSummary() - Method in class io.micronaut.openapi.javadoc.JavadocDescription
- getOrder() - Method in class io.micronaut.openapi.visitor.OpenApiJacksonVisitor
- getParameters() - Method in class io.micronaut.openapi.javadoc.JavadocDescription
- getPropertyPlaceholderResolver() - Static method in class io.micronaut.openapi.visitor.Utils
- getReturnDescription() - Method in class io.micronaut.openapi.javadoc.JavadocDescription
-
The return description.
- getSpecURL() - Method in class io.micronaut.openapi.view.OpenApiViewConfig
-
Returns the relative openApi specification url path.
- getSupportedAnnotationNames() - Method in class io.micronaut.openapi.visitor.OpenApiJacksonVisitor
- getTestJsonReference() - Static method in class io.micronaut.openapi.visitor.Utils
- getTestReference() - Static method in class io.micronaut.openapi.visitor.Utils
- getTestReferenceAfterPlaceholders() - Static method in class io.micronaut.openapi.visitor.Utils
- getTestYamlReference() - Static method in class io.micronaut.openapi.visitor.Utils
- getTitle() - Method in class io.micronaut.openapi.view.OpenApiViewConfig
-
Returns the title for the generated views.
- getVisitedElements(VisitorContext) - Static method in class io.micronaut.openapi.visitor.ContextUtils
- getVisitorKind() - Method in class io.micronaut.openapi.visitor.OpenApiJacksonVisitor
- getYamlMapper() - Static method in class io.micronaut.openapi.visitor.ConvertUtils
H
- HeaderConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- HeaderConfiguration() - Constructor for class io.micronaut.openapi.introspections.HeaderConfiguration
- HeaderRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- HeaderRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.HeaderRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- HiddenRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- HiddenRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.HiddenRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- httpMethod(MethodElement) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns the HttpMethod of the element.
- httpMethod(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- httpMethod(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
I
- ignore(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns true if the specified element should not be processed.
- ignore(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- ignore(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- ignore(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns true if the specified element should not be processed.
- ignore(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- ignore(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- InfoConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- InfoConfiguration() - Constructor for class io.micronaut.openapi.introspections.InfoConfiguration
- InfoRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- InfoRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.InfoRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- io.micronaut.openapi.annotation - package io.micronaut.openapi.annotation
- io.micronaut.openapi.annotation.mappers - package io.micronaut.openapi.annotation.mappers
- io.micronaut.openapi.annotation.transformers - package io.micronaut.openapi.annotation.transformers
- io.micronaut.openapi.introspections - package io.micronaut.openapi.introspections
- io.micronaut.openapi.javadoc - package io.micronaut.openapi.javadoc
- io.micronaut.openapi.postprocessors - package io.micronaut.openapi.postprocessors
- io.micronaut.openapi.view - package io.micronaut.openapi.view
- io.micronaut.openapi.visitor - package io.micronaut.openapi.visitor
- IS_PROCESS_PARENT_CLASS - Static variable in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
- isContainerType(ClassElement) - Static method in class io.micronaut.openapi.visitor.Utils
- isEnabled() - Method in class io.micronaut.openapi.view.OpenApiViewConfig
-
Returns true when the generation of views is enabled.
- isReturnTypeFile(ClassElement) - Static method in class io.micronaut.openapi.visitor.Utils
- isTestMode() - Static method in class io.micronaut.openapi.visitor.Utils
J
- JacksonDiscriminatorPostProcessor - Class in io.micronaut.openapi.postprocessors
-
Utility class to add missing "discriminator" property when using Jackson
JsonTypeInfoandJsonSubTypes. - JacksonDiscriminatorPostProcessor() - Constructor for class io.micronaut.openapi.postprocessors.JacksonDiscriminatorPostProcessor
- JavadocDescription - Class in io.micronaut.openapi.javadoc
-
A parsed javadoc description.
- JavadocDescription() - Constructor for class io.micronaut.openapi.javadoc.JavadocDescription
- JavadocParser - Class in io.micronaut.openapi.javadoc
-
Very simple javadoc parser that can used to parse out the first paragraph description and parameter / return descriptions.
- JavadocParser() - Constructor for class io.micronaut.openapi.javadoc.JavadocParser
L
- LicenseRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- LicenseRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.LicenseRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- LinkParameterRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- LinkParameterRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.LinkParameterRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- LinkRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- LinkRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.LinkRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- LinksConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- LinksConfiguration() - Constructor for class io.micronaut.openapi.introspections.LinksConfiguration
M
- map(AnnotationValue<OpenAPIManagement>, VisitorContext) - Method in class io.micronaut.openapi.annotation.mappers.OpenAPIManagementAnnotationMapper
- map(AnnotationValue<OpenAPISecurity>, VisitorContext) - Method in class io.micronaut.openapi.annotation.mappers.OpenAPISecurityAnnotationMapper
- mapToSecurityRequirement(AnnotationValue<SecurityRequirement>) - Static method in class io.micronaut.openapi.visitor.ConvertUtils
-
Maps annotation value to
SecurityRequirement. - MediaConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- MediaConfiguration() - Constructor for class io.micronaut.openapi.introspections.MediaConfiguration
- methodSecurityRequirements(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns the security requirements at method level.
- methodSecurityRequirements(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- methodSecurityRequirements(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- methodServers(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns the servers at method level.
- methodServers(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- methodServers(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- MICRONAUT_CONFIG_FILE_LOCATIONS - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
Config file locations.
- MICRONAUT_ENVIRONMENT_ENABLED - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
Is this property true, properties wll be loaded in the standard way from application.yml.
- MICRONAUT_OPENAPI_ADDITIONAL_FILES - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
System property that specifies the location of additional swagger YAML and JSON files to read from.
- MICRONAUT_OPENAPI_CONFIG_FILE - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
System property that enables setting the open api config file.
- MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
System property for server context path.
- MICRONAUT_OPENAPI_ENDPOINT_CLASS_TAGS - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
The name of the entry for Endpoint class tags in the context.
- MICRONAUT_OPENAPI_ENDPOINT_SECURITY_REQUIREMENTS - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
The name of the entry for Endpoint security requirements in the context.
- MICRONAUT_OPENAPI_ENDPOINT_SERVERS - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
The name of the entry for Endpoint servers in the context.
- MICRONAUT_OPENAPI_ENVIRONMENTS - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
Active micronaut environments which will be used for @Requires annotations.
- MICRONAUT_OPENAPI_EXPAND_PREFIX - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
Prefix for expandable properties.
- MICRONAUT_OPENAPI_JSON_FORMAT - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
Is this property true, output file format will be JSON, otherwise YAML.
- MICRONAUT_OPENAPI_PROPERTY_NAMING_STRATEGY - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
System property for naming strategy.
- MICRONAUT_OPENAPI_TARGET_FILE - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
System property that enables setting the target file to write to.
- MICRONAUT_OPENAPI_VIEWS_SPEC - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
System property for views specification.
- ModelConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- ModelConfiguration() - Constructor for class io.micronaut.openapi.introspections.ModelConfiguration
N
- normalizeEnumValues(Map<CharSequence, Object>, Map<String, Class<T>>) - Static method in class io.micronaut.openapi.visitor.Utils
-
Normalizes enum values stored in the map.
- normalizeValue(String, String) - Static method in class io.micronaut.openapi.visitor.ConvertUtils
O
- OAuthFlowRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- OAuthFlowRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.OAuthFlowRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- OAuthFlowsRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- OAuthFlowsRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.OAuthFlowsRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- OAuthScopeRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- OAuthScopeRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.OAuthScopeRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- OPENAPI_CONFIG_FILE - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
-
Default openapi config file.
- OpenApiApplicationVisitor - Class in io.micronaut.openapi.visitor
-
Visits the application class.
- OpenApiApplicationVisitor() - Constructor for class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- OpenApiControllerVisitor - Class in io.micronaut.openapi.visitor
-
A
TypeElementVisitorthe builds the Swagger model from Micronaut controllers at compile time. - OpenApiControllerVisitor() - Constructor for class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- OpenApiControllerVisitor(List<AnnotationValue<Tag>>, List<AnnotationValue<SecurityRequirement>>, String) - Constructor for class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- OpenAPIDecorator - Annotation Type in io.micronaut.openapi.annotation
-
The annotation can be used to add suffix and prefix for operationIds.
- OpenAPIDefinitionRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- OpenAPIDefinitionRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.OpenAPIDefinitionRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- OpenApiEndpointVisitor - Class in io.micronaut.openapi.visitor
-
A
TypeElementVisitorthe builds the Swagger model from Micronaut controllers at compile time. - OpenApiEndpointVisitor() - Constructor for class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- OpenApiEndpointVisitor(boolean) - Constructor for class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- OpenApiEndpointVisitor(boolean, List<AnnotationValue<Tag>>, List<AnnotationValue<SecurityRequirement>>) - Constructor for class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- OpenAPIInclude - Annotation Type in io.micronaut.openapi.annotation
-
The annotation can be used to include additional @
ControllerorEndpointclasses to be processed for OpenAPI definition. - OpenAPIIncludes - Annotation Type in io.micronaut.openapi.annotation
-
Allows
OpenAPIIncludeto be repeatable. - OpenApiIncludeVisitor - Class in io.micronaut.openapi.visitor
-
A
TypeElementVisitorthat builds the Swagger model from Micronaut controllers included by @OpenAPIIncludeat the compile time. - OpenApiIncludeVisitor() - Constructor for class io.micronaut.openapi.visitor.OpenApiIncludeVisitor
- OpenApiJacksonVisitor - Class in io.micronaut.openapi.visitor
-
A
TypeElementVisitorthat builds appropriateSchemaannotation for the parent class of a hierarchy when using JacksonJsonTypeInfoandJsonSubTypes. - OpenApiJacksonVisitor() - Constructor for class io.micronaut.openapi.visitor.OpenApiJacksonVisitor
- OpenAPIManagement - Annotation Type in io.micronaut.openapi.annotation
-
The annotation to include Micronaut management endpoints.
- OpenAPIManagementAnnotationMapper - Class in io.micronaut.openapi.annotation.mappers
-
Mapper for management endpoints.
- OpenAPIManagementAnnotationMapper() - Constructor for class io.micronaut.openapi.annotation.mappers.OpenAPIManagementAnnotationMapper
- OpenApiOperationsPostProcessor - Class in io.micronaut.openapi.postprocessors
-
A helper class that post process OpenApi operations.
- OpenApiOperationsPostProcessor() - Constructor for class io.micronaut.openapi.postprocessors.OpenApiOperationsPostProcessor
- OpenAPISecurity - Annotation Type in io.micronaut.openapi.annotation
-
The annotation to include Micronaut security endpoints.
- OpenAPISecurityAnnotationMapper - Class in io.micronaut.openapi.annotation.mappers
-
Mapper for security endpoints.
- OpenAPISecurityAnnotationMapper() - Constructor for class io.micronaut.openapi.annotation.mappers.OpenAPISecurityAnnotationMapper
- OpenApiViewConfig - Class in io.micronaut.openapi.view
-
OpenApi view configuration for Swagger-ui, ReDoc and RapiDoc.
- OperationRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- OperationRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.OperationRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- opIdPrefix() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIDecorator
- opIdSuffix() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIDecorator
P
- ParameterRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ParameterRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ParameterRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ParametersConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- ParametersConfiguration() - Constructor for class io.micronaut.openapi.introspections.ParametersConfiguration
- ParametersRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ParametersRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ParametersRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- parse(String) - Method in class io.micronaut.openapi.javadoc.JavadocParser
-
Parse the javadoc in a
JavadocDescription. - processOperations(OpenAPI) - Method in class io.micronaut.openapi.postprocessors.OpenApiOperationsPostProcessor
-
Process operations, making operation ids unique.
- producesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns the produces media types.
- producesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- producesMediaTypes(MethodElement) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
R
- readOpenApiConfigFile(VisitorContext) - Static method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- readPropertySourceList(String) - Method in class io.micronaut.openapi.visitor.AnnProcessorEnvironment
- readPropertySources(String) - Method in class io.micronaut.openapi.visitor.AnnProcessorEnvironment
- render(Path, VisitorContext) - Method in class io.micronaut.openapi.view.OpenApiViewConfig
-
Generates the views given this configuration.
- RequestBodyRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- RequestBodyRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.RequestBodyRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- resolveComponents(OpenAPI) - Static method in class io.micronaut.openapi.visitor.Utils
-
Resolve the components.
- resolveExtensions(JsonNode) - Static method in class io.micronaut.openapi.visitor.ConvertUtils
- resolveOpenAPI(VisitorContext) - Static method in class io.micronaut.openapi.visitor.Utils
-
Resolve the
OpenAPIinstance. - resolvePlaceholders(JsonNode, UnaryOperator<String>) - Static method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- resolvePlaceholders(ArrayNode, UnaryOperator<String>) - Static method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- resolvePlaceholders(ObjectNode, UnaryOperator<String>) - Static method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- resolveSchemas(OpenAPI) - Static method in class io.micronaut.openapi.visitor.SchemaUtils
- RESOURCE_DIR - Static variable in class io.micronaut.openapi.view.OpenApiViewConfig
- ResponsesConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- ResponsesConfiguration() - Constructor for class io.micronaut.openapi.introspections.ResponsesConfiguration
S
- schemaRef(String) - Static method in class io.micronaut.openapi.visitor.SchemaUtils
- SchemaRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- SchemaRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.SchemaRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- SchemaUtils - Class in io.micronaut.openapi.visitor
-
Some schema util methods.
- security() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIInclude
-
A declaration of which security mechanisms can be used across the API.
- security() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIManagement
-
A declaration of which security mechanisms can be used across the API.
- security() - Method in annotation type io.micronaut.openapi.annotation.OpenAPISecurity
-
A declaration of which security mechanisms can be used across the API.
- SecurityConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- SecurityConfiguration() - Constructor for class io.micronaut.openapi.introspections.SecurityConfiguration
- SecurityRequirementRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- SecurityRequirementRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.SecurityRequirementRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- SecurityRequirementsRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- SecurityRequirementsRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.SecurityRequirementsRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- SecuritySchemeRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- SecuritySchemeRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.SecuritySchemeRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- SecuritySchemesRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- SecuritySchemesRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.SecuritySchemesRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ServerConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- ServerConfiguration() - Constructor for class io.micronaut.openapi.introspections.ServerConfiguration
- ServerRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ServerRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ServerRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ServersRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ServersRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ServersRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- ServerVariableRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- ServerVariableRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.ServerVariableRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- setJavadocParser(JavadocParser) - Static method in class io.micronaut.openapi.visitor.Utils
- setMethodDescription(String) - Method in class io.micronaut.openapi.javadoc.JavadocDescription
-
Sets the method description.
- setMethodSummary(String) - Method in class io.micronaut.openapi.javadoc.JavadocDescription
-
Sets the method summary.
- setReturnDescription(String) - Method in class io.micronaut.openapi.javadoc.JavadocDescription
-
Sets the return description.
- setServerContextPath(String) - Method in class io.micronaut.openapi.view.OpenApiViewConfig
-
Sets the server context path.
- setSpecFile(String) - Method in class io.micronaut.openapi.view.OpenApiViewConfig
-
Sets the generated openApi specification file name.
- setTestJsonReference(String) - Static method in class io.micronaut.openapi.visitor.Utils
- setTestReference(OpenAPI) - Static method in class io.micronaut.openapi.visitor.Utils
- setTestReferenceAfterPlaceholders(OpenAPI) - Static method in class io.micronaut.openapi.visitor.Utils
- setTestYamlReference(String) - Static method in class io.micronaut.openapi.visitor.Utils
- setTitle(String) - Method in class io.micronaut.openapi.view.OpenApiViewConfig
-
Sets the title for the generated views.
- SLASH - Static variable in class io.micronaut.openapi.view.OpenApiViewConfig
T
- TagRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- TagRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.TagRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- tags() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIInclude
-
A list of tags used by the specification with additional metadata.
- tags() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIManagement
-
A list of tags used by the specification with additional metadata.
- tags() - Method in annotation type io.micronaut.openapi.annotation.OpenAPISecurity
-
A list of tags used by the specification with additional metadata.
- TagsConfiguration - Class in io.micronaut.openapi.introspections
-
OpenApi introspection configuration for Swagger-model.
- TagsConfiguration() - Constructor for class io.micronaut.openapi.introspections.TagsConfiguration
- TagsRetentionPolicyAnnotationTransformer - Class in io.micronaut.openapi.annotation.transformers
-
Changes the Retention Policy of the annotation to SOURCE.
- TagsRetentionPolicyAnnotationTransformer() - Constructor for class io.micronaut.openapi.annotation.transformers.TagsRetentionPolicyAnnotationTransformer
-
Changes the Retention Policy of the annotation to SOURCE.
- TEMPLATES - Static variable in class io.micronaut.openapi.view.OpenApiViewConfig
- TEMPLATES_RAPIDOC - Static variable in class io.micronaut.openapi.view.OpenApiViewConfig
- TEMPLATES_RAPIPDF - Static variable in class io.micronaut.openapi.view.OpenApiViewConfig
- TEMPLATES_REDOC - Static variable in class io.micronaut.openapi.view.OpenApiViewConfig
- TEMPLATES_SWAGGER_UI - Static variable in class io.micronaut.openapi.view.OpenApiViewConfig
- THEMES_DIR - Static variable in class io.micronaut.openapi.view.OpenApiViewConfig
- treeToValue(JsonNode, Class<T>) - Static method in class io.micronaut.openapi.visitor.ConvertUtils
-
Converts Json node into a class' instance or throws 'com.fasterxml.jackson.core.JsonProcessingException', adds extensions if present.
U
- uri() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIInclude
- uriMatchTemplates(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Returns the uri paths of the element.
- uriMatchTemplates(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor
- uriMatchTemplates(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- Utils - Class in io.micronaut.openapi.visitor
-
Some util methods.
V
- value() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIDecorator
- value() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIInclude
- value() - Method in annotation type io.micronaut.openapi.annotation.OpenAPIIncludes
- visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Executed when a class is encountered that matches the generic class.
- visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor
- visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiEndpointVisitor
- visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiIncludeVisitor
- visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiJacksonVisitor
- visitMethod(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.AbstractOpenApiEndpointVisitor
-
Executed when a method is encountered that matches the generic element.
All Classes All Packages