Index

A B C D E F G H I J L M N O P Q R S T V W X Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractMergeUtils - Class in com.github.chhorz.openapi.spring.util
Abstract class for merging OpenAPI domain objects.
AbstractMergeUtils(LogUtils) - Constructor for class com.github.chhorz.openapi.spring.util.AbstractMergeUtils
 
AbstractPostProcessorProperties - Class in com.github.chhorz.openapi.common.properties.domain
Base class for custom post processor properties.
AbstractPostProcessorProperties(Map<String, Object>) - Constructor for class com.github.chhorz.openapi.common.properties.domain.AbstractPostProcessorProperties
 
AbstractTypeMirrorMapper - Class in com.github.chhorz.openapi.common.spi.mapping
 
AbstractTypeMirrorMapper() - Constructor for class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
addEnumValue(String) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
addParameterObject(Parameter) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
addParameterObjects(List<Parameter>) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
addRequired(String) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
addTag(Tag) - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
addTag(String) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
addVariable(String, ServerVariableObject) - Method in class com.github.chhorz.openapi.common.domain.Server
 
AliasUtils - Class in com.github.chhorz.openapi.spring.util
 
AliasUtils() - Constructor for class com.github.chhorz.openapi.spring.util.AliasUtils
 
apiKey - Enum constant in enum class com.github.chhorz.openapi.common.domain.SecurityScheme.Type
 
ARRAY - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Type
 
ArrayTypeMirrorMapper - Class in com.github.chhorz.openapi.common.spi.mapping
 
ArrayTypeMirrorMapper() - Constructor for class com.github.chhorz.openapi.common.spi.mapping.ArrayTypeMirrorMapper
 
AsciidoctorAttributes - Class in com.github.chhorz.openapi.spi.asciidoctor
 
AsciidoctorAttributes() - Constructor for class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorAttributes
 
AsciidoctorAttributes(Map<String, Object>) - Constructor for class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorAttributes
 
AsciidoctorPostProcessor - Class in com.github.chhorz.openapi.spi.asciidoctor
The Asciidoctor post processor that used the Freemarker template engine to convert the internal OpenAPI domain object into an Asciidoctor file.
AsciidoctorPostProcessor(LogUtils, ParserProperties) - Constructor for class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorPostProcessor
Instantiation of the Asciidoctor post processor and configuration of the Freemarker template engine.
AsciidoctorProperties - Class in com.github.chhorz.openapi.spi.asciidoctor
Java class representing the configuration properties for the Asciidoctor post processor.
AsciidoctorProperties() - Constructor for class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
AsciidoctorProperties(Map<String, Object>) - Constructor for class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
AsciidoctorProvider - Class in com.github.chhorz.openapi.spi.asciidoctor
PostProcessorProvider to instantiate the Asciidoctor post processor.
AsciidoctorProvider() - Constructor for class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProvider
 

B

BINARY - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 
BOOLEAN - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Type
 
BYTE - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 

C

Callback - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#callback-object
Callback() - Constructor for class com.github.chhorz.openapi.common.domain.Callback
 
ClassTypeMirrorMapper - Class in com.github.chhorz.openapi.common.spi.mapping
 
ClassTypeMirrorMapper() - Constructor for class com.github.chhorz.openapi.common.spi.mapping.ClassTypeMirrorMapper
 
com.github.chhorz.openapi.common - package com.github.chhorz.openapi.common
 
com.github.chhorz.openapi.common.annotation - package com.github.chhorz.openapi.common.annotation
 
com.github.chhorz.openapi.common.domain - package com.github.chhorz.openapi.common.domain
 
com.github.chhorz.openapi.common.domain.meta - package com.github.chhorz.openapi.common.domain.meta
 
com.github.chhorz.openapi.common.exception - package com.github.chhorz.openapi.common.exception
 
com.github.chhorz.openapi.common.javadoc - package com.github.chhorz.openapi.common.javadoc
 
com.github.chhorz.openapi.common.properties - package com.github.chhorz.openapi.common.properties
 
com.github.chhorz.openapi.common.properties.domain - package com.github.chhorz.openapi.common.properties.domain
 
com.github.chhorz.openapi.common.spi - package com.github.chhorz.openapi.common.spi
 
com.github.chhorz.openapi.common.spi.mapping - package com.github.chhorz.openapi.common.spi.mapping
 
com.github.chhorz.openapi.common.util - package com.github.chhorz.openapi.common.util
 
com.github.chhorz.openapi.common.util.jackson - package com.github.chhorz.openapi.common.util.jackson
 
com.github.chhorz.openapi.jaxrs - package com.github.chhorz.openapi.jaxrs
 
com.github.chhorz.openapi.schema - package com.github.chhorz.openapi.schema
 
com.github.chhorz.openapi.spi.asciidoctor - package com.github.chhorz.openapi.spi.asciidoctor
 
com.github.chhorz.openapi.spring - package com.github.chhorz.openapi.spring
 
com.github.chhorz.openapi.spring.util - package com.github.chhorz.openapi.spring.util
 
Components - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#components-object
Components() - Constructor for class com.github.chhorz.openapi.common.domain.Components
 
ComponentUtils - Class in com.github.chhorz.openapi.common.util
 
ComponentUtils() - Constructor for class com.github.chhorz.openapi.common.util.ComponentUtils
 
configureWithComponent(String) - Method in class com.github.chhorz.openapi.common.util.LogUtils
Creates a cloned LogUtils class with the given component log group.
Contact - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#contact-object
Contact() - Constructor for class com.github.chhorz.openapi.common.domain.Contact
 
CONTACT_EMAIL - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
CONTACT_NAME - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
CONTACT_URL - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
ContactProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
ContactProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.ContactProperties
 
convertSchemaMap(Map<TypeMirror, Schema>) - Static method in class com.github.chhorz.openapi.common.util.ComponentUtils
 
cookie - Enum constant in enum class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey.In
 
COOKIE - Enum constant in enum class com.github.chhorz.openapi.common.domain.Parameter.In
 
create(LogUtils, ParserProperties) - Method in class com.github.chhorz.openapi.common.spi.FileWriterProvider
Creates a post processor instance with the given properties.
create(LogUtils, ParserProperties) - Method in interface com.github.chhorz.openapi.common.spi.PostProcessorProvider
Creates a post processor instance with the given properties.
create(LogUtils, ParserProperties) - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProvider
Creates a post processor instance with the given properties.
createExternalDocsFromProperties() - Method in class com.github.chhorz.openapi.common.properties.GeneratorPropertyLoader
 
createInfoFromProperties() - Method in class com.github.chhorz.openapi.common.properties.GeneratorPropertyLoader
 
createJavadocParser() - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Initializes a new instance of the external JavaDocParser.
createMediaType(TypeMirror) - Method in class com.github.chhorz.openapi.common.util.SchemaUtils
 
createSchemasFromDocComment(JavaDoc) - Method in class com.github.chhorz.openapi.common.util.SchemaUtils
 
createSecuritySchemesFromProperties() - Method in class com.github.chhorz.openapi.common.properties.GeneratorPropertyLoader
 
createServerFromProperties() - Method in class com.github.chhorz.openapi.common.properties.GeneratorPropertyLoader
 
createStringSchemaMap(TypeMirror) - Method in class com.github.chhorz.openapi.common.util.SchemaUtils
 
createTag(String) - Method in class com.github.chhorz.openapi.common.util.TagUtils
Create a tag with a given name.
createTypeMirrorFromString(String) - Method in class com.github.chhorz.openapi.common.util.ProcessingUtils
 
createTypeMirrorSchemaMap(TypeMirror) - Method in class com.github.chhorz.openapi.common.util.SchemaUtils
 

D

DATE - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 
DATE_TIME - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 
DEBUG - Static variable in class com.github.chhorz.openapi.common.util.LogUtils
 
Descriminator - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#discriminator-object
Descriminator() - Constructor for class com.github.chhorz.openapi.common.domain.Descriminator
 
description() - Element in annotation interface com.github.chhorz.openapi.common.annotation.OpenAPIResponse
Description of the response with the given status code and schema.
deserialize(JsonParser, DeserializationContext) - Method in class com.github.chhorz.openapi.common.util.jackson.SchemaPropertyDeserializer
 
doesTypeDiffer(TypeMirror, TypeMirror) - Method in class com.github.chhorz.openapi.common.util.ProcessingUtils
Check if both types are not equal.
DOMAIN_OBJECT - Enum constant in enum class com.github.chhorz.openapi.common.spi.PostProcessorType
Processing of the internal domain object.
DOUBLE - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 

E

elements - Variable in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
elements - Variable in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
Encoding - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#encoding-object
Encoding() - Constructor for class com.github.chhorz.openapi.common.domain.Encoding
 
ENUM - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Type
 
EnumerationTypeMirrorMapper - Class in com.github.chhorz.openapi.common.spi.mapping
 
EnumerationTypeMirrorMapper() - Constructor for class com.github.chhorz.openapi.common.spi.mapping.EnumerationTypeMirrorMapper
 
equals(Object) - Method in class com.github.chhorz.openapi.common.domain.ExternalDocumentation
 
equals(Object) - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
equals(Object) - Method in class com.github.chhorz.openapi.common.domain.Server
 
equals(Object) - Method in class com.github.chhorz.openapi.common.domain.ServerVariableObject
 
equals(Object) - Method in class com.github.chhorz.openapi.common.domain.Tag
 
ERROR - Static variable in class com.github.chhorz.openapi.common.util.LogUtils
 
Example - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#example-object
Example() - Constructor for class com.github.chhorz.openapi.common.domain.Example
 
exclude(ExecutableElement) - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Checks if the given method should be excluded from the generated OpenAPI file.
execute(OpenAPI) - Method in class com.github.chhorz.openapi.common.spi.FileWriterPostProcessor
This method must be overridden for the actual post-processing call.
execute(OpenAPI) - Method in interface com.github.chhorz.openapi.common.spi.OpenAPIPostProcessor
This method must be overridden for the actual post-processing call.
execute(OpenAPI) - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorPostProcessor
This method must be overridden for the actual post-processing call.
execute(String, PostProcessorType) - Method in interface com.github.chhorz.openapi.common.spi.OpenAPIPostProcessor
This method must be overridden for the actual post-processing call.
execute(Path, PostProcessorType) - Method in interface com.github.chhorz.openapi.common.spi.OpenAPIPostProcessor
This method must be overridden for the actual post-processing call.
EXTERNAL_DOCS_DESCRIPTION - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
EXTERNAL_DOCS_URL - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
ExternalDocsProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
ExternalDocsProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.ExternalDocsProperties
 
ExternalDocumentation - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#external-documentation-object
ExternalDocumentation() - Constructor for class com.github.chhorz.openapi.common.domain.ExternalDocumentation
 

F

FileUtils - Class in com.github.chhorz.openapi.common.util
 
FileUtils(LogUtils, ParserProperties) - Constructor for class com.github.chhorz.openapi.common.util.FileUtils
 
FileWriterPostProcessor - Class in com.github.chhorz.openapi.common.spi
A custom OpenAPIPostProcessor that writes the OpenAPI domain object to a local file.
FileWriterProvider - Class in com.github.chhorz.openapi.common.spi
FileWriterProvider() - Constructor for class com.github.chhorz.openapi.common.spi.FileWriterProvider
 
FLOAT - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 
forRequestBody(String) - Static method in class com.github.chhorz.openapi.common.domain.Reference
Creates a new reference for a request body.
forSchema(String) - Static method in class com.github.chhorz.openapi.common.domain.Reference
Creates a new schema reference.
fromSchema(Schema, String[], String) - Method in class com.github.chhorz.openapi.common.util.ResponseUtils
 
fromTypeMirror(TypeMirror, String[], String) - Method in class com.github.chhorz.openapi.common.util.ResponseUtils
 

G

GeneratorProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
GeneratorProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
GeneratorPropertiesDefaults - Class in com.github.chhorz.openapi.common.properties
 
GeneratorPropertyLoader - Class in com.github.chhorz.openapi.common.properties
Utility class to load property file into domain objects.
GeneratorPropertyLoader(Messager, Map<String, String>) - Constructor for class com.github.chhorz.openapi.common.properties.GeneratorPropertyLoader
 
get$ref() - Method in class com.github.chhorz.openapi.common.domain.Reference
 
getAdditionalProperties() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getAllowEmptyValue() - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
getAllTags(PathItemObject) - Method in class com.github.chhorz.openapi.common.util.TagUtils
Method to aggregate all tags from a given PathItemObject.
getAsciidoctorAttributes() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
getAuthorizationCode() - Method in class com.github.chhorz.openapi.common.domain.OAuthFlows
 
getAuthorizationCode() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowsProperties
 
getAuthorizationUrl() - Method in class com.github.chhorz.openapi.common.domain.OAuthFlow
 
getAuthorizationUrl() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowProperties
 
getBearerFormat() - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeHttp
 
getBearerFormat() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
getBoolean(String, boolean) - Method in class com.github.chhorz.openapi.common.properties.domain.AbstractPostProcessorProperties
Get a boolean value for the given key.
getClientCredentials() - Method in class com.github.chhorz.openapi.common.domain.OAuthFlows
 
getClientCredentials() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowsProperties
 
getComponents() - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
getContact() - Method in class com.github.chhorz.openapi.common.domain.Info
 
getContact() - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
getContent() - Method in class com.github.chhorz.openapi.common.domain.RequestBody
 
getContent() - Method in class com.github.chhorz.openapi.common.domain.Response
 
getDefaultValue() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getDefaultValue() - Method in class com.github.chhorz.openapi.common.domain.ServerVariableObject
 
getDefaultValue() - Method in class com.github.chhorz.openapi.common.properties.domain.ServerVariableProperties
 
getDelete() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getDeprecated() - Method in class com.github.chhorz.openapi.common.domain.Operation
 
getDeprecated() - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
getDeprecated() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.ExternalDocumentation
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.Info
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.Operation
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.RequestBody
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.Response
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.SecurityScheme
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.Server
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.ServerVariableObject
 
getDescription() - Method in class com.github.chhorz.openapi.common.domain.Tag
 
getDescription() - Method in class com.github.chhorz.openapi.common.javadoc.ResponseTag
 
getDescription() - Method in class com.github.chhorz.openapi.common.properties.domain.ExternalDocsProperties
 
getDescription() - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
getDescription() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
getDescription() - Method in class com.github.chhorz.openapi.common.properties.domain.ServerProperties
 
getDescription() - Method in class com.github.chhorz.openapi.common.properties.domain.ServerVariableProperties
 
getDescription() - Method in class com.github.chhorz.openapi.common.properties.domain.TagProperties
 
getDescriptionForTag(String) - Method in class com.github.chhorz.openapi.common.properties.GeneratorPropertyLoader
 
getEmail() - Method in class com.github.chhorz.openapi.common.domain.Contact
 
getEmail() - Method in class com.github.chhorz.openapi.common.properties.domain.ContactProperties
 
getEnabled() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getEnumValue() - Method in class com.github.chhorz.openapi.common.domain.ServerVariableObject
 
getEnumValues() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getEnumValues() - Method in class com.github.chhorz.openapi.common.properties.domain.ServerVariableProperties
 
getExceptionLogging() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
getExternalDocs() - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
getExternalDocs() - Method in class com.github.chhorz.openapi.common.domain.Tag
 
getExternalDocs() - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
getExternalDocs() - Method in class com.github.chhorz.openapi.common.properties.domain.TagProperties
 
getExternalDocumentationForTag(String) - Method in class com.github.chhorz.openapi.common.properties.GeneratorPropertyLoader
 
getFlows() - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeOAuth2
 
getFlows() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
getFormat() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getGet() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getHead() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getIcons() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorAttributes
 
getIdentifier() - Method in class com.github.chhorz.openapi.common.domain.License
 
getImplicit() - Method in class com.github.chhorz.openapi.common.domain.OAuthFlows
 
getImplicit() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowsProperties
 
getIn() - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
getIn() - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey
 
getIn() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
getIncludeGetters() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getInfo() - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
getInfo() - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
getInteger(String, Integer) - Method in class com.github.chhorz.openapi.common.properties.domain.AbstractPostProcessorProperties
Get a integer value for the given key.
getItems() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getJavaLangTypeAndFormat(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
getKey(TypeMirror) - Static method in class com.github.chhorz.openapi.common.util.ComponentUtils
 
getLicense() - Method in class com.github.chhorz.openapi.common.domain.Info
 
getLicense() - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
getLocalizedLookup() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
getLogLevel() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getMappingAnnotation(Element) - Method in class com.github.chhorz.openapi.spring.util.AliasUtils
 
getMaximum() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getMaxItems() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getMaxLength() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getMinimum() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getMinItems() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getMinLength() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getName() - Method in class com.github.chhorz.openapi.common.domain.Contact
 
getName() - Method in class com.github.chhorz.openapi.common.domain.License
 
getName() - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
getName() - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey
 
getName() - Method in class com.github.chhorz.openapi.common.domain.Tag
 
getName() - Method in class com.github.chhorz.openapi.common.properties.domain.ContactProperties
 
getName() - Method in class com.github.chhorz.openapi.common.properties.domain.LicenseProperties
 
getName() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
getObject(String, Class<T>) - Method in class com.github.chhorz.openapi.common.properties.domain.AbstractPostProcessorProperties
Get a object value for the given key.
getOpenapi() - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
getOpenApiValue() - Method in enum class com.github.chhorz.openapi.common.domain.Parameter.In
 
getOpenApiValue() - Method in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 
getOpenApiValue() - Method in enum class com.github.chhorz.openapi.common.domain.Schema.Type
 
getOpenIdConnectUrl() - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeOpenIdConnect
 
getOpenIdConnectUrl() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
getOperationId() - Method in class com.github.chhorz.openapi.common.domain.Operation
 
getOperationId(ExecutableElement) - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Creates an OpenAPI operation id from a java method executableElement.
getOperationId(ExecutableElement, OpenAPI) - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
getOptions() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getOutputDir() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getOutputFile() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getOutputFile() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
getOutputFormat() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getOutputPath() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
getParameterObjects() - Method in class com.github.chhorz.openapi.common.domain.Operation
 
getParser() - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
getParserProperties() - Method in class com.github.chhorz.openapi.common.properties.GeneratorPropertyLoader
Returns the parser properties from the given configuration file or a new instance with default values if the parser object is null.
getPassword() - Method in class com.github.chhorz.openapi.common.domain.OAuthFlows
 
getPassword() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowsProperties
 
getPatch() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getPaths() - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
getPattern() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getPost() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getPostProcessor() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getPostProcessor(String, Class<T>) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getPostProcessorOrder() - Method in class com.github.chhorz.openapi.common.spi.FileWriterPostProcessor
Returns the value for the order in which the post processor should be executed.
getPostProcessorOrder() - Method in interface com.github.chhorz.openapi.common.spi.OpenAPIPostProcessor
Returns the value for the order in which the post processor should be executed.
getPostProcessorOrder() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorPostProcessor
Returns the value for the order in which the post processor should be executed.
getPostProcessorProperties() - Method in class com.github.chhorz.openapi.common.properties.domain.AbstractPostProcessorProperties
 
getPostProcessorType() - Method in class com.github.chhorz.openapi.common.spi.FileWriterPostProcessor
Defines the input types of the current post processor.
getPostProcessorType() - Method in interface com.github.chhorz.openapi.common.spi.OpenAPIPostProcessor
Defines the input types of the current post processor.
getPostProcessorType() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorPostProcessor
Defines the input types of the current post processor.
getPrimitiveTypeAndFormat(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
getProperties() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getPut() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getRefreshUrl() - Method in class com.github.chhorz.openapi.common.domain.OAuthFlow
 
getRefreshUrl() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowProperties
 
getRequestBodies() - Method in class com.github.chhorz.openapi.common.domain.Components
 
getRequestBodyObject() - Method in class com.github.chhorz.openapi.common.domain.Operation
 
getRequired() - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
getRequired() - Method in class com.github.chhorz.openapi.common.domain.RequestBody
 
getRequired() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getResponses() - Method in class com.github.chhorz.openapi.common.domain.Components
 
getResponses() - Method in class com.github.chhorz.openapi.common.domain.Operation
 
getResponseType() - Method in class com.github.chhorz.openapi.common.javadoc.ResponseTag
 
getSchema() - Method in class com.github.chhorz.openapi.common.domain.MediaType
 
getSchema() - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
getSchemaDir() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getSchemaFile() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getSchemaForTypeMirror(TypeMirror) - Method in class com.github.chhorz.openapi.common.util.SchemaUtils
 
getSchemaPackages() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
getSchemas() - Method in class com.github.chhorz.openapi.common.domain.Components
 
getScheme() - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeHttp
 
getScheme() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
getScopes() - Method in class com.github.chhorz.openapi.common.domain.OAuthFlow
 
getScopes() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowProperties
 
getSecurity() - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
getSecurity() - Method in class com.github.chhorz.openapi.common.domain.Operation
 
getSecurityInformation(ExecutableElement, OpenAPI, JavaDoc, OpenAPI) - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Creates a map of security information for a give method.
getSecurityRequirement() - Method in class com.github.chhorz.openapi.common.javadoc.SecurityTag
 
getSecuritySchemes() - Method in class com.github.chhorz.openapi.common.domain.Components
 
getSecuritySchemes() - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
getServers() - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
getServers() - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
getShortName(TypeMirror) - Static method in class com.github.chhorz.openapi.common.util.ProcessingUtils
 
getStandaloneFile() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
getStatusCode() - Method in class com.github.chhorz.openapi.common.javadoc.ResponseTag
 
getString(String, String) - Method in class com.github.chhorz.openapi.common.properties.domain.AbstractPostProcessorProperties
Get a string value for the given key.
getSummary() - Method in class com.github.chhorz.openapi.common.domain.Info
 
getSummary() - Method in class com.github.chhorz.openapi.common.domain.Operation
 
getSummary() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getSupportedAnnotationClasses() - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Create a stream of all supported annotation classes
getSupportedAnnotationClasses() - Method in class com.github.chhorz.openapi.jaxrs.JaxRSOpenApiProcessor
 
getSupportedAnnotationClasses() - Method in class com.github.chhorz.openapi.schema.SchemaOpenApiProcessor
 
getSupportedAnnotationClasses() - Method in class com.github.chhorz.openapi.spring.SpringWebOpenApiProcessor
 
getSupportedAnnotationTypes() - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
getSupportedOptions() - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Returns a set of all annotation processor options that will be recognized by the implementations of this interface.
getSupportedOptions() - Method in class com.github.chhorz.openapi.schema.SchemaOpenApiProcessor
 
getSupportedSourceVersion() - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
getTagName() - Method in class com.github.chhorz.openapi.common.javadoc.TagTag
 
getTags() - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
getTags() - Method in class com.github.chhorz.openapi.common.domain.Operation
 
getTags() - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
getTags(JavaDoc, OpenAPI) - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Creates a list of tags from the given input sources.
getTemplateFile() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
getTemplatePath() - Method in class com.github.chhorz.openapi.spi.asciidoctor.AsciidoctorProperties
 
getTermsOfService() - Method in class com.github.chhorz.openapi.common.domain.Info
 
getTermsOfService() - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
getTitle() - Method in class com.github.chhorz.openapi.common.domain.Info
 
getTitle() - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
getTokenUrl() - Method in class com.github.chhorz.openapi.common.domain.OAuthFlow
 
getTokenUrl() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowProperties
 
getTrace() - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
getType() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
getType() - Method in class com.github.chhorz.openapi.common.domain.SecurityScheme
 
getType() - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
getUrl() - Method in class com.github.chhorz.openapi.common.domain.Contact
 
getUrl() - Method in class com.github.chhorz.openapi.common.domain.ExternalDocumentation
 
getUrl() - Method in class com.github.chhorz.openapi.common.domain.License
 
getUrl() - Method in class com.github.chhorz.openapi.common.domain.Server
 
getUrl() - Method in class com.github.chhorz.openapi.common.properties.domain.ContactProperties
 
getUrl() - Method in class com.github.chhorz.openapi.common.properties.domain.ExternalDocsProperties
 
getUrl() - Method in class com.github.chhorz.openapi.common.properties.domain.LicenseProperties
 
getUrl() - Method in class com.github.chhorz.openapi.common.properties.domain.ServerProperties
 
getValue(T, Function<T, String>, Function<T, String>, String) - Method in class com.github.chhorz.openapi.spring.util.AliasUtils
 
getVariables() - Method in class com.github.chhorz.openapi.common.domain.Server
 
getVariables() - Method in class com.github.chhorz.openapi.common.properties.domain.ServerProperties
 
getVersion() - Method in class com.github.chhorz.openapi.common.domain.Info
 
getVersion() - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
getxGeneratedBy() - Method in class com.github.chhorz.openapi.common.domain.Info
 
getxGeneratedTs() - Method in class com.github.chhorz.openapi.common.domain.Info
 

H

hashCode() - Method in class com.github.chhorz.openapi.common.domain.ExternalDocumentation
 
hashCode() - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
hashCode() - Method in class com.github.chhorz.openapi.common.domain.Server
 
hashCode() - Method in class com.github.chhorz.openapi.common.domain.ServerVariableObject
 
hashCode() - Method in class com.github.chhorz.openapi.common.domain.Tag
 
hasJsonOutputFormat() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
hasYamlOutputFormat() - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
header - Enum constant in enum class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey.In
 
Header - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#header-object
Header() - Constructor for class com.github.chhorz.openapi.common.domain.Header
 
HEADER - Enum constant in enum class com.github.chhorz.openapi.common.domain.Parameter.In
 
http - Enum constant in enum class com.github.chhorz.openapi.common.domain.SecurityScheme.Type
 

I

INCLUDE_GETTERS - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
Info - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#info-object
Info() - Constructor for class com.github.chhorz.openapi.common.domain.Info
 
INFO - Static variable in class com.github.chhorz.openapi.common.util.LogUtils
 
INFO_DESCRIPTION - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
INFO_SUMMARY - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
INFO_TERMS_OF_SERVICE - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
INFO_TITLE - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
INFO_VERSION - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
InfoProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
InfoProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
init(ProcessingEnvironment) - Method in class com.github.chhorz.openapi.jaxrs.JaxRSOpenApiProcessor
 
init(ProcessingEnvironment) - Method in class com.github.chhorz.openapi.schema.SchemaOpenApiProcessor
 
init(ProcessingEnvironment) - Method in class com.github.chhorz.openapi.spring.SpringWebOpenApiProcessor
 
init(ProcessingEnvironment, List<Class<?>>) - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
initializeFromJavadoc(JavaDoc, OpenAPI, String[], String, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.util.ResponseUtils
 
initializeFromProperties(GeneratorPropertyLoader) - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Initializes a new OpenAPI domain object with the information from the configuration file.
INT32 - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 
INT64 - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 
INTEGER - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Type
 
isAssignableTo(TypeMirror, Class<?>) - Method in class com.github.chhorz.openapi.common.util.ProcessingUtils
Checks if the given type is assignable to the type of a given class.
isClassAvailable(String) - Static method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Check if the given class is available on the classpath.
isInterface(TypeMirror) - Method in class com.github.chhorz.openapi.common.util.ProcessingUtils
Checks if the given type belongs to an interface element.
isSameType(TypeMirror, Class<?>) - Method in class com.github.chhorz.openapi.common.util.ProcessingUtils
Checks if the given type is of a certain class.
isTypeInPackage(TypeMirror, PackageElement) - Method in class com.github.chhorz.openapi.common.util.ProcessingUtils
Checks if the given type resides within the given package.
isValidKey(String) - Static method in class com.github.chhorz.openapi.common.domain.Components
 
isVoidType(TypeMirror) - Method in class com.github.chhorz.openapi.common.util.SchemaUtils
 

J

javaDocParser - Variable in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
javaLangPackage - Variable in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
javaMathPackage - Variable in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
JavaObjectTypeMirrorMapper - Class in com.github.chhorz.openapi.common.spi.mapping
 
JavaObjectTypeMirrorMapper() - Constructor for class com.github.chhorz.openapi.common.spi.mapping.JavaObjectTypeMirrorMapper
 
JavaPackageTypeMirrorMapper - Class in com.github.chhorz.openapi.common.spi.mapping
 
JavaPackageTypeMirrorMapper() - Constructor for class com.github.chhorz.openapi.common.spi.mapping.JavaPackageTypeMirrorMapper
 
javaTimePackage - Variable in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
JavaUtilTypeMirrorMapper - Class in com.github.chhorz.openapi.common.spi.mapping
 
JavaUtilTypeMirrorMapper() - Constructor for class com.github.chhorz.openapi.common.spi.mapping.JavaUtilTypeMirrorMapper
 
JaxRSOpenApiProcessor - Class in com.github.chhorz.openapi.jaxrs
 
JaxRSOpenApiProcessor() - Constructor for class com.github.chhorz.openapi.jaxrs.JaxRSOpenApiProcessor
 
JSON_FILE - Enum constant in enum class com.github.chhorz.openapi.common.spi.PostProcessorType
Processing type for generated JSON file.
JSON_STRING - Enum constant in enum class com.github.chhorz.openapi.common.spi.PostProcessorType
Processing type for JSON content as string.

L

License - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#license-object
License() - Constructor for class com.github.chhorz.openapi.common.domain.License
 
LICENSE_NAME - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
LICENSE_URL - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
LicenseProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
LicenseProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.LicenseProperties
 
Link - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#link-object
Link() - Constructor for class com.github.chhorz.openapi.common.domain.Link
 
logDebug(String, Object...) - Method in class com.github.chhorz.openapi.common.util.LogUtils
Prints the given log message if the log level is "DEBUG".
logError(String, Exception, Object...) - Method in class com.github.chhorz.openapi.common.util.LogUtils
Prints the given log message.
logError(String, Object...) - Method in class com.github.chhorz.openapi.common.util.LogUtils
Prints the given log message.
logInfo(String, Object...) - Method in class com.github.chhorz.openapi.common.util.LogUtils
Prints the given log message if the log level is not "ERROR".
logUtils - Variable in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
logUtils - Variable in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
logUtils - Variable in class com.github.chhorz.openapi.spring.util.AbstractMergeUtils
 
LogUtils - Class in com.github.chhorz.openapi.common.util
Internal logging utility class.
LogUtils(Messager, ParserProperties) - Constructor for class com.github.chhorz.openapi.common.util.LogUtils
Creates a new LogUtils instance.
LogUtils(Messager, ParserProperties, String) - Constructor for class com.github.chhorz.openapi.common.util.LogUtils
Creates a new LogUtils instance.

M

map(TypeMirror, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.spi.mapping.ArrayTypeMirrorMapper
 
map(TypeMirror, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.spi.mapping.ClassTypeMirrorMapper
 
map(TypeMirror, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.spi.mapping.EnumerationTypeMirrorMapper
 
map(TypeMirror, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.spi.mapping.JavaObjectTypeMirrorMapper
 
map(TypeMirror, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.spi.mapping.JavaPackageTypeMirrorMapper
 
map(TypeMirror, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.spi.mapping.JavaUtilTypeMirrorMapper
 
map(TypeMirror, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.spi.mapping.ObjectTypeMirrorMapper
 
map(TypeMirror, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.spi.mapping.PrimitiveTypeMirrorMapper
 
map(TypeMirror, Map<TypeMirror, Schema>) - Method in interface com.github.chhorz.openapi.common.spi.mapping.TypeMirrorMapper
Mapping method to map the java type to a map of OpenAPI schema.
mapPathVariable(String, VariableElement, List<ParamTag>) - Method in class com.github.chhorz.openapi.spring.util.ParameterUtils
 
mapRequestHeader(VariableElement, List<ParamTag>) - Method in class com.github.chhorz.openapi.spring.util.ParameterUtils
 
mapRequestParam(VariableElement, List<ParamTag>) - Method in class com.github.chhorz.openapi.spring.util.ParameterUtils
 
Markdown - Annotation Interface in com.github.chhorz.openapi.common.domain.meta
Indicates that the annotated attribute may be documented using markdown for rich text representation.
MediaType - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#media-type-object
MediaType() - Constructor for class com.github.chhorz.openapi.common.domain.MediaType
 
mergeClassAndMethodMappings(RequestMapping, RequestMapping) - Method in class com.github.chhorz.openapi.spring.util.AliasUtils
 
mergeDescription(String, String) - Method in class com.github.chhorz.openapi.spring.util.AbstractMergeUtils
Merges two description strings
mergePathItems(PathItemObject, PathItemObject) - Method in class com.github.chhorz.openapi.spring.util.PathItemUtils
Merges the given PathItemObjects and all of their internal components.
mergeSchemas(Schema, Schema) - Static method in class com.github.chhorz.openapi.common.util.SchemaUtils
 
mergeSummary(String, String) - Method in class com.github.chhorz.openapi.spring.util.AbstractMergeUtils
Merges two summary strings
mutualTLS - Enum constant in enum class com.github.chhorz.openapi.common.domain.SecurityScheme.Type
 

N

NUMBER - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Type
 

O

oauth2 - Enum constant in enum class com.github.chhorz.openapi.common.domain.SecurityScheme.Type
 
OAuthFlow - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#oauth-flow-object
OAuthFlow() - Constructor for class com.github.chhorz.openapi.common.domain.OAuthFlow
 
OAuthFlows - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#oauth-flows-object
OAuthFlows() - Constructor for class com.github.chhorz.openapi.common.domain.OAuthFlows
 
OBJECT - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Type
 
ObjectTypeMirrorMapper - Class in com.github.chhorz.openapi.common.spi.mapping
 
ObjectTypeMirrorMapper() - Constructor for class com.github.chhorz.openapi.common.spi.mapping.ObjectTypeMirrorMapper
 
of(String) - Static method in enum class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey.In
 
OPEN_API_VERSION - Static variable in class com.github.chhorz.openapi.common.OpenAPIConstants
 
openApi - Variable in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
OpenAPI - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#openapi-object
OpenAPI - Annotation Interface in com.github.chhorz.openapi.common.annotation
This annotation is a more structured way to document data that could be added with custom Javadoc tags.
OpenAPI() - Constructor for class com.github.chhorz.openapi.common.domain.OpenAPI
 
OPENAPI_LOG_GROUP - Static variable in class com.github.chhorz.openapi.common.util.LogUtils
 
OpenAPIConstants - Class in com.github.chhorz.openapi.common
Basic set of project internal constants.
OpenAPIConstants() - Constructor for class com.github.chhorz.openapi.common.OpenAPIConstants
 
OpenAPIExclusion - Annotation Interface in com.github.chhorz.openapi.common.annotation
This annotation can be used to mark specific java classes or methods that should not be included within the generated OpenAPI file.
OpenAPIPostProcessor - Interface in com.github.chhorz.openapi.common.spi
This interface declares the actual post-processing method.
OpenAPIProcessor - Class in com.github.chhorz.openapi.common
Abstract annotation processor to provide some common functionality for all specific OpenAPI annotation processors.
OpenAPIProcessor() - Constructor for class com.github.chhorz.openapi.common.OpenAPIProcessor
 
OpenAPIResponse - Annotation Interface in com.github.chhorz.openapi.common.annotation
Structured annotation to document operation responses in a more structured way as the Javadoc tag @response.
OpenAPISchema - Annotation Interface in com.github.chhorz.openapi.common.annotation
This annotation can be used to annotate specific java classes as a OpenAPI schema.
openIdConnect - Enum constant in enum class com.github.chhorz.openapi.common.domain.SecurityScheme.Type
 
Operation - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#operation-object
Operation() - Constructor for class com.github.chhorz.openapi.common.domain.Operation
 
OPTION_PROPERTIES_PATH - Static variable in class com.github.chhorz.openapi.common.OpenAPIConstants
 
OPTION_SCHEMA_FILE_PATH - Static variable in class com.github.chhorz.openapi.common.OpenAPIConstants
 
OPTION_VERSION - Static variable in class com.github.chhorz.openapi.common.OpenAPIConstants
 

P

Parameter - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#parameter-object
Parameter() - Constructor for class com.github.chhorz.openapi.common.domain.Parameter
 
Parameter.In - Enum Class in com.github.chhorz.openapi.common.domain
 
ParameterUtils - Class in com.github.chhorz.openapi.spring.util
 
ParameterUtils(SchemaUtils, ProcessingUtils, AliasUtils) - Constructor for class com.github.chhorz.openapi.spring.util.ParameterUtils
 
parsePackages(List<String>) - Method in class com.github.chhorz.openapi.common.util.SchemaUtils
 
parser - Variable in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
PARSER_ENABLED - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
PARSER_LOG_LEVEL - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
PARSER_OUTPUT_DIR - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
PARSER_OUTPUT_FILE - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
PARSER_OUTPUT_FORMAT - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
PARSER_POST_PROCESSOR - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
PARSER_SCHEMA_DIR - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
PARSER_SCHEMA_FILE - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
PARSER_SCHEMA_PACKAGES - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
parserProperties - Variable in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
parserProperties - Variable in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
ParserProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
ParserProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
PASSWORD - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 
PATH - Enum constant in enum class com.github.chhorz.openapi.common.domain.Parameter.In
 
PathItemObject - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#path-item-object
PathItemObject() - Constructor for class com.github.chhorz.openapi.common.domain.PathItemObject
 
PathItemUtils - Class in com.github.chhorz.openapi.spring.util
Utility class to merge OpenAPI PathItemObject.
PathItemUtils(LogUtils) - Constructor for class com.github.chhorz.openapi.spring.util.PathItemUtils
Creates a new instance of this utility class with the given logger.
populateTypeParameterMap(TypeElement, Map<TypeMirror, Map<TypeParameterElement, TypeMirror>>) - Method in class com.github.chhorz.openapi.common.util.ProcessingUtils
 
PostProcessorProvider - Interface in com.github.chhorz.openapi.common.spi
Instances of this interface will be used to create post processor instances.
PostProcessorType - Enum Class in com.github.chhorz.openapi.common.spi
Enumeration of post processor types.
prependSlash(String) - Method in class com.github.chhorz.openapi.spring.util.AliasUtils
 
PrimitiveTypeMirrorMapper - Class in com.github.chhorz.openapi.common.spi.mapping
 
PrimitiveTypeMirrorMapper() - Constructor for class com.github.chhorz.openapi.common.spi.mapping.PrimitiveTypeMirrorMapper
 
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class com.github.chhorz.openapi.jaxrs.JaxRSOpenApiProcessor
 
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class com.github.chhorz.openapi.schema.SchemaOpenApiProcessor
 
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class com.github.chhorz.openapi.spring.SpringWebOpenApiProcessor
 
processingUtils - Variable in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
processingUtils - Variable in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
ProcessingUtils - Class in com.github.chhorz.openapi.common.util
 
ProcessingUtils(Elements, Types, LogUtils) - Constructor for class com.github.chhorz.openapi.common.util.ProcessingUtils
 
propertyLoader - Variable in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
putAllParsedSchemas(Map<String, Schema>) - Method in class com.github.chhorz.openapi.common.domain.Components
 
putAllSchemas(Map<String, Schema>) - Method in class com.github.chhorz.openapi.common.domain.Components
 
putContent(String, MediaType) - Method in class com.github.chhorz.openapi.common.domain.RequestBody
 
putContent(String, MediaType) - Method in class com.github.chhorz.openapi.common.domain.Response
 
putDefaultResponse(Response) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
putPathItemObject(String, PathItemObject) - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
putProperty(String, Reference) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
putProperty(String, Schema) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
putRequestBody(String, RequestBody) - Method in class com.github.chhorz.openapi.common.domain.Components
 
putResponse(String, Response) - Method in class com.github.chhorz.openapi.common.domain.Operation
 

Q

query - Enum constant in enum class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey.In
 
QUERY - Enum constant in enum class com.github.chhorz.openapi.common.domain.Parameter.In
 

R

readOpenApiFile(ParserProperties) - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Loads an existing OpenAPI schema file.
readOpenAPIObjectFromFile() - Method in class com.github.chhorz.openapi.common.util.FileUtils
 
recursion(TypeMirror, Map<TypeMirror, Schema>) - Method in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
Reference - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#reference-object
Reference() - Constructor for class com.github.chhorz.openapi.common.domain.Reference
 
Reference(String) - Constructor for class com.github.chhorz.openapi.common.domain.Reference
 
removeEnclosingType(TypeMirror, Class<?>) - Method in class com.github.chhorz.openapi.common.util.ProcessingUtils
 
RequestBody - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#request-body-object
RequestBody() - Constructor for class com.github.chhorz.openapi.common.domain.RequestBody
 
Required - Annotation Interface in com.github.chhorz.openapi.common.domain.meta
Indicates that the annotated attribute must be present in the resulting OpenAPI document.
Response - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#response-object
Response() - Constructor for class com.github.chhorz.openapi.common.domain.Response
 
responses() - Element in annotation interface com.github.chhorz.openapi.common.annotation.OpenAPI
List of responses for the given method.
ResponseTag - Class in com.github.chhorz.openapi.common.javadoc
Custom Javadoc tag for structured parsing.
ResponseTag() - Constructor for class com.github.chhorz.openapi.common.javadoc.ResponseTag
Represents a tag in the following form: @response 200 String the content as string
responseUtils - Variable in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
ResponseUtils - Class in com.github.chhorz.openapi.common.util
 
ResponseUtils(Elements, Types, ParserProperties, LogUtils) - Constructor for class com.github.chhorz.openapi.common.util.ResponseUtils
 
runPostProcessors(ParserProperties, OpenAPI) - Method in class com.github.chhorz.openapi.common.OpenAPIProcessor
Runs all registered post processors from the service loader.

S

schema() - Element in annotation interface com.github.chhorz.openapi.common.annotation.OpenAPIResponse
Class of the given response schema.
Schema - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#schema-object
Schema() - Constructor for class com.github.chhorz.openapi.common.domain.Schema
 
Schema.Format - Enum Class in com.github.chhorz.openapi.common.domain
 
Schema.Type - Enum Class in com.github.chhorz.openapi.common.domain
 
SchemaOpenApiProcessor - Class in com.github.chhorz.openapi.schema
 
SchemaOpenApiProcessor() - Constructor for class com.github.chhorz.openapi.schema.SchemaOpenApiProcessor
 
SchemaPropertyDeserializer - Class in com.github.chhorz.openapi.common.util.jackson
 
SchemaPropertyDeserializer() - Constructor for class com.github.chhorz.openapi.common.util.jackson.SchemaPropertyDeserializer
 
SchemaPropertyDeserializer(Class<?>) - Constructor for class com.github.chhorz.openapi.common.util.jackson.SchemaPropertyDeserializer
 
schemaUtils - Variable in class com.github.chhorz.openapi.common.OpenAPIProcessor
 
SchemaUtils - Class in com.github.chhorz.openapi.common.util
 
SchemaUtils(Elements, Types, ParserProperties, LogUtils) - Constructor for class com.github.chhorz.openapi.common.util.SchemaUtils
 
SchemaUtils(Elements, Types, ParserProperties, LogUtils, List<Class<?>>) - Constructor for class com.github.chhorz.openapi.common.util.SchemaUtils
 
SECURITY_SCHEME_BEARER_FORMAT - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_DESCRIPTION - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_IN - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_NAME - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_OAUTH_FLOW - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_OAUTH_FLOW_AUTH_URL - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_OAUTH_FLOW_REFRESH_URL - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_OAUTH_FLOW_SCOPES - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_OAUTH_FLOW_TOKEN_URL - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_OAUTH_FLOWS - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_OPEN_ID_URL - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_SCHEME - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SECURITY_SCHEME_TYPE - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
SecurityRequirement - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#security-requirement-object
SecurityRequirement() - Constructor for class com.github.chhorz.openapi.common.domain.SecurityRequirement
 
SecurityScheme - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#security-scheme-object
SecurityScheme() - Constructor for class com.github.chhorz.openapi.common.domain.SecurityScheme
 
SecurityScheme.Type - Enum Class in com.github.chhorz.openapi.common.domain
 
SecuritySchemeApiKey - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#api-key-sample
SecuritySchemeApiKey() - Constructor for class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey
 
SecuritySchemeApiKey.In - Enum Class in com.github.chhorz.openapi.common.domain
 
SecuritySchemeHttp - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#basic-authentication-sample
SecuritySchemeHttp() - Constructor for class com.github.chhorz.openapi.common.domain.SecuritySchemeHttp
 
SecuritySchemeOAuth2 - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#implicit-oauth2-sample
SecuritySchemeOAuth2(OAuthFlows) - Constructor for class com.github.chhorz.openapi.common.domain.SecuritySchemeOAuth2
 
SecuritySchemeOAuthFlowProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
SecuritySchemeOAuthFlowProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowProperties
 
SecuritySchemeOAuthFlowsProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
SecuritySchemeOAuthFlowsProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowsProperties
 
SecuritySchemeOpenIdConnect - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#security-scheme-object
SecuritySchemeOpenIdConnect() - Constructor for class com.github.chhorz.openapi.common.domain.SecuritySchemeOpenIdConnect
 
SecuritySchemeProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
SecuritySchemeProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
securitySchemes() - Element in annotation interface com.github.chhorz.openapi.common.annotation.OpenAPI
List of security scheme names from the oas-generator.yml file
SecurityTag - Class in com.github.chhorz.openapi.common.javadoc
Custom Javadoc tag for structured parsing.
SecurityTag() - Constructor for class com.github.chhorz.openapi.common.javadoc.SecurityTag
Represents a tag in the following form: @security read_role
Server - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#server-object
Server() - Constructor for class com.github.chhorz.openapi.common.domain.Server
 
ServerProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
ServerProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.ServerProperties
 
ServerVariableObject - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#server-variable-object
ServerVariableObject() - Constructor for class com.github.chhorz.openapi.common.domain.ServerVariableObject
 
ServerVariableProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
ServerVariableProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.ServerVariableProperties
 
setAdditionalProperties(Object) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setAllowEmptyValue(Boolean) - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
setAuthorizationCode(OAuthFlow) - Method in class com.github.chhorz.openapi.common.domain.OAuthFlows
 
setAuthorizationCode(SecuritySchemeOAuthFlowProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowsProperties
 
setAuthorizationUrl(String) - Method in class com.github.chhorz.openapi.common.domain.OAuthFlow
 
setAuthorizationUrl(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowProperties
 
setBearerFormat(String) - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeHttp
 
setBearerFormat(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
setClientCredentials(OAuthFlow) - Method in class com.github.chhorz.openapi.common.domain.OAuthFlows
 
setClientCredentials(SecuritySchemeOAuthFlowProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowsProperties
 
setComponents(Components) - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
setContact(Contact) - Method in class com.github.chhorz.openapi.common.domain.Info
 
setContact(ContactProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
setDefaultValue(Object) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setDefaultValue(String) - Method in class com.github.chhorz.openapi.common.domain.ServerVariableObject
 
setDefaultValue(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ServerVariableProperties
 
setDelete(Operation) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setDeprecated(Boolean) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
setDeprecated(Boolean) - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
setDeprecated(Boolean) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.ExternalDocumentation
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.Info
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.RequestBody
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.Response
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.SecurityScheme
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.Server
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.ServerVariableObject
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.domain.Tag
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ExternalDocsProperties
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ServerProperties
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ServerVariableProperties
 
setDescription(String) - Method in class com.github.chhorz.openapi.common.properties.domain.TagProperties
 
setEmail(String) - Method in class com.github.chhorz.openapi.common.domain.Contact
 
setEmail(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ContactProperties
 
setEnabled(boolean) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setEnumValue(List<String>) - Method in class com.github.chhorz.openapi.common.domain.ServerVariableObject
 
setEnumValues(List<String>) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setEnumValues(List<String>) - Method in class com.github.chhorz.openapi.common.properties.domain.ServerVariableProperties
 
setExternalDocs(ExternalDocumentation) - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
setExternalDocs(ExternalDocumentation) - Method in class com.github.chhorz.openapi.common.domain.Tag
 
setExternalDocs(ExternalDocsProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
setExternalDocs(ExternalDocsProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.TagProperties
 
setFlows(SecuritySchemeOAuthFlowsProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
setFormat(Schema.Format) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setGet(Operation) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setHead(Operation) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setIdentifier(String) - Method in class com.github.chhorz.openapi.common.domain.License
 
setImplicit(OAuthFlow) - Method in class com.github.chhorz.openapi.common.domain.OAuthFlows
 
setImplicit(SecuritySchemeOAuthFlowProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowsProperties
 
setIn(Parameter.In) - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
setIn(SecuritySchemeApiKey.In) - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey
 
setIn(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
setIncludeGetters(boolean) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setInfo(Info) - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
setInfo(InfoProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
setItems(Object) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setLicense(License) - Method in class com.github.chhorz.openapi.common.domain.Info
 
setLicense(LicenseProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
setLogLevel(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setMaximum(Long) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setMaxItems(Integer) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setMaxLength(Integer) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setMinimum(Long) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setMinItems(Integer) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setMinLength(Integer) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setName(String) - Method in class com.github.chhorz.openapi.common.domain.Contact
 
setName(String) - Method in class com.github.chhorz.openapi.common.domain.License
 
setName(String) - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
setName(String) - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey
 
setName(String) - Method in class com.github.chhorz.openapi.common.domain.Tag
 
setName(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ContactProperties
 
setName(String) - Method in class com.github.chhorz.openapi.common.properties.domain.LicenseProperties
 
setName(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
setOpenapi(String) - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
setOpenIdConnectUrl(String) - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeOpenIdConnect
 
setOpenIdConnectUrl(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
setOperationId(String) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
setOptions(Operation) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setOutputDir(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setOutputFile(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setOutputFormat(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setParser(ParserProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
setPassword(OAuthFlow) - Method in class com.github.chhorz.openapi.common.domain.OAuthFlows
 
setPassword(SecuritySchemeOAuthFlowProperties) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowsProperties
 
setPatch(Operation) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setPattern(String) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setPost(Operation) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setPostProcessor(Map<String, LinkedHashMap>) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setPostProcessorProperties(Map<String, Object>) - Method in class com.github.chhorz.openapi.common.properties.domain.AbstractPostProcessorProperties
 
setPut(Operation) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setRefreshUrl(String) - Method in class com.github.chhorz.openapi.common.domain.OAuthFlow
 
setRefreshUrl(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowProperties
 
setRequestBodyObject(RequestBody) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
setRequired(Boolean) - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
setRequired(Boolean) - Method in class com.github.chhorz.openapi.common.domain.RequestBody
 
setResponses(Map<String, Response>) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
setSchema(Schema) - Method in class com.github.chhorz.openapi.common.domain.Parameter
 
setSchema(Object) - Method in class com.github.chhorz.openapi.common.domain.MediaType
 
setSchemaDir(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setSchemaFile(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setSchemaPackages(List<String>) - Method in class com.github.chhorz.openapi.common.properties.domain.ParserProperties
 
setScheme(String) - Method in class com.github.chhorz.openapi.common.domain.SecuritySchemeHttp
 
setScheme(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
setScopes(Map<String, String>) - Method in class com.github.chhorz.openapi.common.domain.OAuthFlow
 
setScopes(Map<String, String>) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowProperties
 
setSecurity(List<SecurityRequirement>) - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
setSecurity(List<Map<String, List<String>>>) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
setSecuritySchemes(Map<String, SecurityScheme>) - Method in class com.github.chhorz.openapi.common.domain.Components
 
setSecuritySchemes(Map<String, SecuritySchemeProperties>) - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
setServers(List<Server>) - Method in class com.github.chhorz.openapi.common.domain.OpenAPI
 
setServers(List<ServerProperties>) - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
setSummary(String) - Method in class com.github.chhorz.openapi.common.domain.Info
 
setSummary(String) - Method in class com.github.chhorz.openapi.common.domain.Operation
 
setSummary(String) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setTags(Map<String, TagProperties>) - Method in class com.github.chhorz.openapi.common.properties.domain.GeneratorProperties
 
setTermsOfService(String) - Method in class com.github.chhorz.openapi.common.domain.Info
 
setTermsOfService(URL) - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
setTitle(String) - Method in class com.github.chhorz.openapi.common.domain.Info
 
setTitle(String) - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
setTokenUrl(String) - Method in class com.github.chhorz.openapi.common.domain.OAuthFlow
 
setTokenUrl(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeOAuthFlowProperties
 
setTrace(Operation) - Method in class com.github.chhorz.openapi.common.domain.PathItemObject
 
setType(Schema.Type) - Method in class com.github.chhorz.openapi.common.domain.Schema
 
setType(SecurityScheme.Type) - Method in class com.github.chhorz.openapi.common.domain.SecurityScheme
 
setType(String) - Method in class com.github.chhorz.openapi.common.properties.domain.SecuritySchemeProperties
 
setup(Elements, Types, LogUtils, ParserProperties, List<TypeMirrorMapper>) - Method in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 
setup(Elements, Types, LogUtils, ParserProperties, List<TypeMirrorMapper>) - Method in class com.github.chhorz.openapi.common.spi.mapping.ObjectTypeMirrorMapper
 
setup(Elements, Types, LogUtils, ParserProperties, List<TypeMirrorMapper>) - Method in interface com.github.chhorz.openapi.common.spi.mapping.TypeMirrorMapper
Constructor method that will be used to fill custom classes.
setUrl(String) - Method in class com.github.chhorz.openapi.common.domain.Contact
 
setUrl(String) - Method in class com.github.chhorz.openapi.common.domain.ExternalDocumentation
 
setUrl(String) - Method in class com.github.chhorz.openapi.common.domain.License
 
setUrl(String) - Method in class com.github.chhorz.openapi.common.domain.Server
 
setUrl(String) - Method in class com.github.chhorz.openapi.common.properties.domain.ServerProperties
 
setUrl(URL) - Method in class com.github.chhorz.openapi.common.properties.domain.ContactProperties
 
setUrl(URL) - Method in class com.github.chhorz.openapi.common.properties.domain.ExternalDocsProperties
 
setUrl(URL) - Method in class com.github.chhorz.openapi.common.properties.domain.LicenseProperties
 
setVariables(Map<String, ServerVariableObject>) - Method in class com.github.chhorz.openapi.common.domain.Server
 
setVariables(Map<String, ServerVariableProperties>) - Method in class com.github.chhorz.openapi.common.properties.domain.ServerProperties
 
setVersion(String) - Method in class com.github.chhorz.openapi.common.domain.Info
 
setVersion(String) - Method in class com.github.chhorz.openapi.common.properties.domain.InfoProperties
 
setxGeneratedBy(String) - Method in class com.github.chhorz.openapi.common.domain.Info
 
setxGeneratedTs(String) - Method in class com.github.chhorz.openapi.common.domain.Info
 
SpecificationExtension - Annotation Interface in com.github.chhorz.openapi.common.domain.meta
Indicates that the annotated attribute is a OpenAPI specification extension.
SpecificationViolationException - Exception in com.github.chhorz.openapi.common.exception
This exception will be thrown if the openapi specification will be violated at some point.
SpecificationViolationException(String) - Constructor for exception com.github.chhorz.openapi.common.exception.SpecificationViolationException
The openapi specification was violated because of the given reason.
SpringWebOpenApiProcessor - Class in com.github.chhorz.openapi.spring
 
SpringWebOpenApiProcessor() - Constructor for class com.github.chhorz.openapi.spring.SpringWebOpenApiProcessor
 
status() - Element in annotation interface com.github.chhorz.openapi.common.annotation.OpenAPIResponse
The status code of the response.
STRING - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Type
 

T

Tag - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#tag-object
Tag() - Constructor for class com.github.chhorz.openapi.common.domain.Tag
 
TAG_DESCRIPTION - Static variable in class com.github.chhorz.openapi.common.properties.GeneratorPropertiesDefaults
 
TagProperties - Class in com.github.chhorz.openapi.common.properties.domain
 
TagProperties() - Constructor for class com.github.chhorz.openapi.common.properties.domain.TagProperties
 
tags() - Element in annotation interface com.github.chhorz.openapi.common.annotation.OpenAPI
List of OpenAPI tags that are described in the oas-generator.yml file.
TagTag - Class in com.github.chhorz.openapi.common.javadoc
Custom Javadoc tag for structured parsing.
TagTag() - Constructor for class com.github.chhorz.openapi.common.javadoc.TagTag
Represents a tag in the following form: @tag tag_name
TagUtils - Class in com.github.chhorz.openapi.common.util
Utility class for OpenAPI Tags.
TagUtils(GeneratorPropertyLoader) - Constructor for class com.github.chhorz.openapi.common.util.TagUtils
 
test(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.ArrayTypeMirrorMapper
 
test(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.ClassTypeMirrorMapper
 
test(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.EnumerationTypeMirrorMapper
 
test(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.JavaObjectTypeMirrorMapper
 
test(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.JavaPackageTypeMirrorMapper
 
test(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.JavaUtilTypeMirrorMapper
 
test(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.ObjectTypeMirrorMapper
 
test(TypeMirror) - Method in class com.github.chhorz.openapi.common.spi.mapping.PrimitiveTypeMirrorMapper
 
test(TypeMirror) - Method in interface com.github.chhorz.openapi.common.spi.mapping.TypeMirrorMapper
Test method to check if the mapper supports the current type mirror.
TIME - Enum constant in enum class com.github.chhorz.openapi.common.domain.Schema.Format
 
toString() - Method in class com.github.chhorz.openapi.common.domain.Reference
 
toString() - Method in class com.github.chhorz.openapi.common.domain.Schema
 
TypeMirrorMapper - Interface in com.github.chhorz.openapi.common.spi.mapping
Interface for mapper of java types to OpenAPI schema
types - Variable in class com.github.chhorz.openapi.common.spi.mapping.AbstractTypeMirrorMapper
 

V

valueOf(String) - Static method in enum class com.github.chhorz.openapi.common.domain.Parameter.In
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.chhorz.openapi.common.domain.Schema.Format
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.chhorz.openapi.common.domain.Schema.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.chhorz.openapi.common.domain.SecurityScheme.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey.In
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.chhorz.openapi.common.spi.PostProcessorType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.github.chhorz.openapi.common.domain.Parameter.In
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.chhorz.openapi.common.domain.Schema.Format
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.chhorz.openapi.common.domain.Schema.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.chhorz.openapi.common.domain.SecurityScheme.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.chhorz.openapi.common.domain.SecuritySchemeApiKey.In
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.chhorz.openapi.common.spi.PostProcessorType
Returns an array containing the constants of this enum class, in the order they are declared.

W

writeToFile(OpenAPI) - Method in class com.github.chhorz.openapi.common.util.FileUtils
Writes the given OpenAPI object to .json and .yaml files.

X

X_GENERATED_FIELD - Static variable in class com.github.chhorz.openapi.common.OpenAPIConstants
 
Xml - Class in com.github.chhorz.openapi.common.domain
https://spec.openapis.org/oas/v3.1.0#xml-object
Xml() - Constructor for class com.github.chhorz.openapi.common.domain.Xml
 

Y

YAML_FILE - Enum constant in enum class com.github.chhorz.openapi.common.spi.PostProcessorType
Processing type for generated YAML file.
YAML_STRING - Enum constant in enum class com.github.chhorz.openapi.common.spi.PostProcessorType
Processing type for YAML content as string.
A B C D E F G H I J L M N O P Q R S T V W X Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form