C E F G I J M O P R S T U V W Y _

C

canUseSchema(FormatSchema) - Method in class io.micronaut.openapi.util.YAMLGenerator

canWriteFormattedNumbers() - Method in class io.micronaut.openapi.util.YAMLGenerator

canWriteObjectId() - Method in class io.micronaut.openapi.util.YAMLGenerator

canWriteTypeId() - Method in class io.micronaut.openapi.util.YAMLGenerator

close() - Method in class io.micronaut.openapi.util.YAMLGenerator

collectDefaults() - Static method in enum io.micronaut.openapi.util.YAMLGenerator.Feature

Method that calculates bit set (flags) of all features that are enabled by default.

E

enabledByDefault() - Method in enum io.micronaut.openapi.util.YAMLGenerator.Feature

enabledIn(int) - Method in enum io.micronaut.openapi.util.YAMLGenerator.Feature

F

finish(VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

flush() - Method in class io.micronaut.openapi.util.YAMLGenerator

fromSpecification(String, Properties) - Static method in class io.micronaut.openapi.view.OpenApiViewConfig

Creates an OpenApiViewConfig form a String representation.

G

getFormatFeatures() - Method in class io.micronaut.openapi.util.YAMLGenerator

getMask() - Method in enum io.micronaut.openapi.util.YAMLGenerator.Feature

getMethodDescription() - Method in class io.micronaut.openapi.javadoc.JavadocDescription

getOutputBuffered() - Method in class io.micronaut.openapi.util.YAMLGenerator

SnakeYAML does not expose buffered content amount, so we can only return -1 from here.

getOutputTarget() - Method in class io.micronaut.openapi.util.YAMLGenerator

getParameters() - Method in class io.micronaut.openapi.javadoc.JavadocDescription

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.

getTitle() - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Returns the title for the generated views.

I

io.micronaut.openapi.javadoc - package io.micronaut.openapi.javadoc

io.micronaut.openapi.util - package io.micronaut.openapi.util

io.micronaut.openapi.view - package io.micronaut.openapi.view

io.micronaut.openapi.visitor - package io.micronaut.openapi.visitor

isEnabled() - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Returns true when the generation of views is enabled.

J

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

M

mapper() - Static method in class io.micronaut.openapi.util.Yaml

Obtains the YAML mapper.

MICRONAUT_OPENAPI_ADDITIONAL_FILES - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

System property that specifies the location of additional swagger YAML 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_EXPAND_PREFIX - Static variable in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

Prefix for expandable properties.

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.

O

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 TypeElementVisitor the builds the Swagger model from Micronaut controllers at compile time.

OpenApiControllerVisitor() - Constructor for class io.micronaut.openapi.visitor.OpenApiControllerVisitor

OpenApiViewConfig - Class in io.micronaut.openapi.view

OpenApi view configuration for Swagger-ui, ReDoc and RapiDoc.

overrideFormatFeatures(int, int) - Method in class io.micronaut.openapi.util.YAMLGenerator

P

parse(String) - Method in class io.micronaut.openapi.javadoc.JavadocParser

Parse the javadoc in a JavadocDescription.

R

render(Path, VisitorContext) - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Generates the views given this configuration.

S

setMethodDescription(String) - Method in class io.micronaut.openapi.javadoc.JavadocDescription

Sets the method description.

setPrettyPrinter(PrettyPrinter) - Method in class io.micronaut.openapi.util.YAMLGenerator

Not sure what to do here; will always indent, but uses YAML-specific settings etc.

setReturnDescription(String) - Method in class io.micronaut.openapi.javadoc.JavadocDescription

Sets the return description.

setSpecFile(String) - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Sets the generated openApi specification file name.

setTitle(String) - Method in class io.micronaut.openapi.view.OpenApiViewConfig

Sets the title for the generated views.

T

toString() - Method in class io.micronaut.openapi.view.OpenApiViewConfig

U

useDefaultPrettyPrinter() - Method in class io.micronaut.openapi.util.YAMLGenerator

Not sure what to do here; could reset indentation to some value maybe?.

V

valueOf(String) - Static method in enum io.micronaut.openapi.util.YAMLGenerator.Feature

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.micronaut.openapi.util.YAMLGenerator.Feature

Returns an array containing the constants of this enum type, in the order they are declared.

version() - Method in class io.micronaut.openapi.util.YAMLGenerator

visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiApplicationVisitor

visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

visitMethod(MethodElement, VisitorContext) - Method in class io.micronaut.openapi.visitor.OpenApiControllerVisitor

W

writeBinary(Base64Variant, byte[], int, int) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeBoolean(boolean) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeEndArray() - Method in class io.micronaut.openapi.util.YAMLGenerator

writeEndObject() - Method in class io.micronaut.openapi.util.YAMLGenerator

writeFieldName(String) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeFieldName(SerializableString) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeNull() - Method in class io.micronaut.openapi.util.YAMLGenerator

writeNumber(int) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeNumber(long) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeNumber(BigInteger) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeNumber(double) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeNumber(float) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeNumber(BigDecimal) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeNumber(String) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeObjectId(Object) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeObjectRef(Object) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeRaw(String) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeRaw(String, int, int) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeRaw(char[], int, int) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeRaw(char) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeRawUTF8String(byte[], int, int) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeRawValue(String) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeRawValue(String, int, int) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeRawValue(char[], int, int) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeStartArray() - Method in class io.micronaut.openapi.util.YAMLGenerator

writeStartObject() - Method in class io.micronaut.openapi.util.YAMLGenerator

writeString(String) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeString(char[], int, int) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeString(SerializableString) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeStringField(String, String) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeTypeId(Object) - Method in class io.micronaut.openapi.util.YAMLGenerator

writeUTF8String(byte[], int, int) - Method in class io.micronaut.openapi.util.YAMLGenerator

Y

Yaml - Class in io.micronaut.openapi.util

Helper class for generating Swagger YAML.

Yaml() - Constructor for class io.micronaut.openapi.util.Yaml

YAMLGenerator - Class in io.micronaut.openapi.util

Copied from YAMLGenerator to support snakeyaml >= 1.2.

YAMLGenerator.Feature - Enum in io.micronaut.openapi.util

Enumeration that defines all togglable features for YAML generators.

_

_defaultState - Variable in enum io.micronaut.openapi.util.YAMLGenerator.Feature

_mask - Variable in enum io.micronaut.openapi.util.YAMLGenerator.Feature

_releaseBuffers() - Method in class io.micronaut.openapi.util.YAMLGenerator

_verifyValueWrite(String) - Method in class io.micronaut.openapi.util.YAMLGenerator

C E F G I J M O P R S T U V W Y _