Index (swagger2markup 1.2.0 API)

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

A

ANCHOR_PREFIX - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
apply(MarkupDocBuilder, BodyParameterComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.BodyParameterComponent
apply(MarkupDocBuilder, ConsumesComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.ConsumesComponent
apply(MarkupDocBuilder, ContactInfoComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.ContactInfoComponent
apply(MarkupDocBuilder, DefinitionComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.DefinitionComponent
apply(MarkupDocBuilder, LicenseInfoComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.LicenseInfoComponent
apply(MarkupDocBuilder, ParameterTableComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.ParameterTableComponent
apply(MarkupDocBuilder, PathOperationComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.PathOperationComponent
apply(MarkupDocBuilder, ProducesComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.ProducesComponent
apply(MarkupDocBuilder, PropertiesTableComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.PropertiesTableComponent
apply(MarkupDocBuilder, ResponseComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.ResponseComponent
apply(MarkupDocBuilder, SecuritySchemeComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.SecuritySchemeComponent
apply(MarkupDocBuilder, SecuritySchemeDefinitionComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.SecuritySchemeDefinitionComponent
apply(MarkupDocBuilder, TableComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.TableComponent
apply(MarkupDocBuilder, TagsComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.TagsComponent
apply(MarkupDocBuilder, UriSchemeComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.UriSchemeComponent
apply(MarkupDocBuilder, VersionInfoComponent.Parameters) - Method in class io.github.swagger2markup.internal.component.VersionInfoComponent
apply(MarkupDocBuilder, DefinitionsDocument.Parameters) - Method in class io.github.swagger2markup.internal.document.DefinitionsDocument: Builds the definitions MarkupDocument.
apply(MarkupDocBuilder, OverviewDocument.Parameters) - Method in class io.github.swagger2markup.internal.document.OverviewDocument: Builds the overview MarkupDocument.
apply(MarkupDocBuilder, PathsDocument.Parameters) - Method in class io.github.swagger2markup.internal.document.PathsDocument: Builds the paths MarkupDocument.
apply(MarkupDocBuilder, SecurityDocument.Parameters) - Method in class io.github.swagger2markup.internal.document.SecurityDocument: Builds the security MarkupDocument.
apply(String) - Method in class io.github.swagger2markup.internal.resolver.DefinitionDocumentNameResolver
apply(String) - Method in class io.github.swagger2markup.internal.resolver.DefinitionDocumentResolverDefault
apply(String) - Method in class io.github.swagger2markup.internal.resolver.DefinitionDocumentResolverFromDefinition
apply(String) - Method in class io.github.swagger2markup.internal.resolver.DefinitionDocumentResolverFromOperation
apply(PathOperation) - Method in class io.github.swagger2markup.internal.resolver.OperationDocumentNameResolver
apply(PathOperation) - Method in class io.github.swagger2markup.internal.resolver.OperationDocumentResolverDefault
apply(String) - Method in class io.github.swagger2markup.internal.resolver.SecurityDocumentResolver
apply(DefinitionsDocumentExtension.Context) - Method in class io.github.swagger2markup.spi.DefinitionsDocumentExtension
apply(OverviewDocumentExtension.Context) - Method in class io.github.swagger2markup.spi.OverviewDocumentExtension
apply(PathsDocumentExtension.Context) - Method in class io.github.swagger2markup.spi.PathsDocumentExtension
apply(SecurityDocumentExtension.Context) - Method in class io.github.swagger2markup.spi.SecurityDocumentExtension
apply(Swagger) - Method in class io.github.swagger2markup.spi.SwaggerModelExtension
ArrayType - Class in io.github.swagger2markup.internal.type: Array type abstraction
ArrayType(String, Type) - Constructor for class io.github.swagger2markup.internal.type.ArrayType
ArrayType(String, Type, String) - Constructor for class io.github.swagger2markup.internal.type.ArrayType
AUTHORIZATION_URL - Static variable in class io.github.swagger2markup.Labels

B

BASE_PATH - Static variable in class io.github.swagger2markup.Labels
BASE_PATH_PREFIX_ENABLED - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
BasicType - Class in io.github.swagger2markup.internal.type: Base type abstraction (string, integer, ...)
BasicType(String, String) - Constructor for class io.github.swagger2markup.internal.type.BasicType
BasicType(String, String, String) - Constructor for class io.github.swagger2markup.internal.type.BasicType
BODY_PARAMETER - Static variable in class io.github.swagger2markup.Labels
BodyParameterComponent - Class in io.github.swagger2markup.internal.component
BodyParameterComponent(Swagger2MarkupConverter.Context, DocumentResolver) - Constructor for class io.github.swagger2markup.internal.component.BodyParameterComponent
BodyParameterComponent.Parameters - Class in io.github.swagger2markup.internal.component
boldText(MarkupDocBuilder, String) - Static method in class io.github.swagger2markup.internal.utils.MarkupDocBuilderUtils
build() - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Builds the Swagger2MarkupConfig.
build() - Method in class io.github.swagger2markup.builder.Swagger2MarkupExtensionRegistryBuilder
build() - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Builder

C

COLON - Static variable in class io.github.swagger2markup.spi.MarkupComponent
config - Variable in class io.github.swagger2markup.spi.MarkupComponent
CONSUMES - Static variable in class io.github.swagger2markup.Labels
ConsumesComponent - Class in io.github.swagger2markup.internal.component
ConsumesComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.component.ConsumesComponent
ConsumesComponent.Parameters - Class in io.github.swagger2markup.internal.component
CONTACT_EMAIL - Static variable in class io.github.swagger2markup.Labels
CONTACT_INFORMATION - Static variable in class io.github.swagger2markup.Labels
CONTACT_NAME - Static variable in class io.github.swagger2markup.Labels
ContactInfoComponent - Class in io.github.swagger2markup.internal.component
ContactInfoComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.component.ContactInfoComponent
ContactInfoComponent.Parameters - Class in io.github.swagger2markup.internal.component
ContentContext - Class in io.github.swagger2markup.spi
Context(DefinitionsDocumentExtension.Position, MarkupDocBuilder) - Constructor for class io.github.swagger2markup.spi.DefinitionsDocumentExtension.Context
Context(DefinitionsDocumentExtension.Position, MarkupDocBuilder, String, Model) - Constructor for class io.github.swagger2markup.spi.DefinitionsDocumentExtension.Context
context - Variable in class io.github.swagger2markup.spi.MarkupComponent
Context(OverviewDocumentExtension.Position, MarkupDocBuilder) - Constructor for class io.github.swagger2markup.spi.OverviewDocumentExtension.Context
Context(PathsDocumentExtension.Position, MarkupDocBuilder) - Constructor for class io.github.swagger2markup.spi.PathsDocumentExtension.Context: Context for positions DOCUMENT_*
Context(PathsDocumentExtension.Position, MarkupDocBuilder, PathOperation) - Constructor for class io.github.swagger2markup.spi.PathsDocumentExtension.Context: Context for all other positions
Context(SecurityDocumentExtension.Position, MarkupDocBuilder) - Constructor for class io.github.swagger2markup.spi.SecurityDocumentExtension.Context
Context(SecurityDocumentExtension.Position, MarkupDocBuilder, String, SecuritySchemeDefinition) - Constructor for class io.github.swagger2markup.spi.SecurityDocumentExtension.Context
Context(Swagger2MarkupConfig, Swagger2MarkupExtensionRegistry, Swagger, URI) - Constructor for class io.github.swagger2markup.Swagger2MarkupConverter.Context
convertExample(String, String) - Static method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Convert a string value to specified type.
convertUriWithoutSchemeToFileScheme(URI) - Static method in class io.github.swagger2markup.utils.URIUtils: Convert an URI without a scheme to a file scheme.
copyMarkupDocBuilder(MarkupDocBuilder) - Static method in class io.github.swagger2markup.internal.utils.MarkupDocBuilderUtils
create(String) - Static method in class io.github.swagger2markup.utils.URIUtils: Creates a URI from a String representation of a URI or a Path.
createInlineType(Type, String, String, List<ObjectType>) - Static method in class io.github.swagger2markup.internal.utils.InlineSchemaUtils: Returns a RefType to a new inlined type named with name and uniqueName.
createMarkupDocBuilder() - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Context
crossReference(MarkupDocBuilder, String, String, String) - Static method in class io.github.swagger2markup.internal.utils.MarkupDocBuilderUtils
CURRENT_VERSION - Static variable in class io.github.swagger2markup.Labels

D

DEFAULT_COLUMN - Static variable in class io.github.swagger2markup.Labels
DEFINITION_ORDER_BY - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
DefinitionComponent - Class in io.github.swagger2markup.internal.component
DefinitionComponent(Swagger2MarkupConverter.Context, DocumentResolver) - Constructor for class io.github.swagger2markup.internal.component.DefinitionComponent
DefinitionComponent.Parameters - Class in io.github.swagger2markup.internal.component
DefinitionDocumentNameResolver - Class in io.github.swagger2markup.internal.resolver
DefinitionDocumentNameResolver(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.resolver.DefinitionDocumentNameResolver
DefinitionDocumentResolverDefault - Class in io.github.swagger2markup.internal.resolver: Default DocumentResolver functor
DefinitionDocumentResolverDefault(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.resolver.DefinitionDocumentResolverDefault
DefinitionDocumentResolverFromDefinition - Class in io.github.swagger2markup.internal.resolver: Overrides definition document resolver functor for inter-document cross-references from definitions files.
DefinitionDocumentResolverFromDefinition(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.resolver.DefinitionDocumentResolverFromDefinition
DefinitionDocumentResolverFromOperation - Class in io.github.swagger2markup.internal.resolver: Overrides definition document resolver functor for inter-document cross-references from operations files.
DefinitionDocumentResolverFromOperation(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.resolver.DefinitionDocumentResolverFromOperation
DEFINITIONS - Static variable in class io.github.swagger2markup.Labels
DEFINITIONS_DOCUMENT - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
DefinitionsDocument - Class in io.github.swagger2markup.internal.document
DefinitionsDocument(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.document.DefinitionsDocument
DefinitionsDocument.Parameters - Class in io.github.swagger2markup.internal.document
DefinitionsDocumentExtension - Class in io.github.swagger2markup.spi: DefinitionsDocumentExtension extension point can be used to extend the definitions document content.
DefinitionsDocumentExtension() - Constructor for class io.github.swagger2markup.spi.DefinitionsDocumentExtension
DefinitionsDocumentExtension.Context - Class in io.github.swagger2markup.spi
DefinitionsDocumentExtension.Position - Enum in io.github.swagger2markup.spi
DEPRECATED_OPERATION - Static variable in class io.github.swagger2markup.Labels
DESCRIPTION - Static variable in class io.github.swagger2markup.Labels
DESCRIPTION_COLUMN - Static variable in class io.github.swagger2markup.Labels
discriminator - Variable in class io.github.swagger2markup.internal.type.ObjectTypePolymorphism
displayDefaultValue(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
displayDescription(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
displaySchema(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
displaySchema(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.type.ArrayType
displaySchema(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.type.BasicType
displaySchema(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.type.EnumType
displaySchema(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.type.MapType
displaySchema(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.type.ObjectType
displaySchema(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.type.RefType
displaySchema(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.type.Type
displayType(MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
DocumentResolver - Class in io.github.swagger2markup.internal.resolver: A functor to return the document part of an inter-document cross-references, depending on the context.
DocumentResolver(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.resolver.DocumentResolver

E

EnumType - Class in io.github.swagger2markup.internal.type: Enum type abstraction
EnumType(String, List<String>) - Constructor for class io.github.swagger2markup.internal.type.EnumType
EXAMPLE_COLUMN - Static variable in class io.github.swagger2markup.Labels
EXAMPLE_REQUEST - Static variable in class io.github.swagger2markup.Labels
EXAMPLE_RESPONSE - Static variable in class io.github.swagger2markup.Labels
ExamplesUtil - Class in io.github.swagger2markup.internal.utils
ExamplesUtil() - Constructor for class io.github.swagger2markup.internal.utils.ExamplesUtil
EXTENSION_PREFIX - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties: Prefix for Swagger2Markup extension properties
extensionRegistry - Variable in class io.github.swagger2markup.spi.MarkupComponent

F

FLAGS_COLUMN - Static variable in class io.github.swagger2markup.Labels
FLAGS_OPTIONAL - Static variable in class io.github.swagger2markup.Labels
FLAGS_READ_ONLY - Static variable in class io.github.swagger2markup.Labels
FLAGS_REQUIRED - Static variable in class io.github.swagger2markup.Labels
FLAT_BODY_ENABLED - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
FLOW - Static variable in class io.github.swagger2markup.Labels
format - Variable in class io.github.swagger2markup.internal.type.BasicType
from(URI) - Static method in class io.github.swagger2markup.Swagger2MarkupConverter: Creates a Swagger2MarkupConverter.Builder from a URI.
from(URL) - Static method in class io.github.swagger2markup.Swagger2MarkupConverter: Creates a Swagger2MarkupConverter.Builder using a remote URL.
from(Path) - Static method in class io.github.swagger2markup.Swagger2MarkupConverter: Creates a Swagger2MarkupConverter.Builder using a local Path.
from(Swagger) - Static method in class io.github.swagger2markup.Swagger2MarkupConverter: Creates a Swagger2MarkupConverter.Builder from a given Swagger model.
from(String) - Static method in class io.github.swagger2markup.Swagger2MarkupConverter: Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON String.
from(Reader) - Static method in class io.github.swagger2markup.Swagger2MarkupConverter: Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON reader.

G

GENERATED_EXAMPLES_ENABLED - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
generateExample(AbstractSerializableParameter) - Static method in class io.github.swagger2markup.internal.adapter.ParameterAdapter: Generate a default example value for parameter.
generateExample(Property, MarkupDocBuilder) - Static method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Generate a default example value for property.
generateRequestExampleMap(boolean, PathOperation, Map<String, Model>, DocumentResolver, MarkupDocBuilder) - Static method in class io.github.swagger2markup.internal.utils.ExamplesUtil: Generates examples for request
generateResponseExampleMap(boolean, PathOperation, Map<String, Model>, DocumentResolver, MarkupDocBuilder) - Static method in class io.github.swagger2markup.internal.utils.ExamplesUtil: Generates a Map of response examples
getAccess() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
getAnchorPrefix() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Optionally prefix all anchors for uniqueness.
getBoolean(String, boolean) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the boolean property value associated with the given key, or defaultValue if the key cannot be resolved.
getCollectionFormat() - Method in class io.github.swagger2markup.internal.type.ArrayType
getConfig() - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Context
getContext() - Method in class io.github.swagger2markup.Swagger2MarkupConverter: Returns the global Context
getDefaultValue() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter: Retrieves the default value of a parameter
getDefaultValue() - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Retrieves the default value of a property
getDefinitionName() - Method in class io.github.swagger2markup.spi.DefinitionsDocumentExtension.Context
getDefinitionOrderBy() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies definition ordering.
getDefinitionOrdering() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies a custom comparator function to order definitions.
getDefinitionsDocument() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Definitions document name (without extension).
getDefinitionsDocumentExtensions() - Method in interface io.github.swagger2markup.Swagger2MarkupExtensionRegistry: DefinitionsDocumentExtension extension point can be used to extend the definitions document content.
getDescription() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
getDiscriminator() - Method in class io.github.swagger2markup.internal.type.ObjectTypePolymorphism
getDocument() - Method in class io.github.swagger2markup.internal.type.RefType
getExample(boolean, MarkupDocBuilder) - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Return example display string for the given property.
getExclusiveMax() - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Retrieves the exclusiveMaximum value of a property
getExclusiveMin() - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Retrieves the exclusiveMinimum value of a property
getExtensionRegistry() - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Context
getExtensionsProperties() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Returns properties for extensions.
getFormat() - Method in class io.github.swagger2markup.internal.type.BasicType
getGroupBy(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the GroupBy property value associated with the given key, or defaultValue if the key cannot be resolved.
getHeaderPattern() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies the regex pattern used for header matching
getHeaderPattern(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties
getId() - Method in class io.github.swagger2markup.model.PathOperation: Returns an unique id for the operation.
getIn() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
getInlineDefinitions() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
getInt(String, int) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the int property value associated with the given key, or defaultValue if the key cannot be resolved.
getInteger(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Returns an optional Integer property value associated with the given key.
getInterDocumentCrossReferencesPrefix() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Inter-document cross-references optional prefix.
getKeys() - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the list of keys.
getKeys(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Get the list of the keys contained in the configuration that match the specified prefix.
getKeyType() - Method in class io.github.swagger2markup.internal.type.MapType
getLabel(String) - Method in class io.github.swagger2markup.Labels: Gets a label for the given key from this resource bundle.
getLabels() - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Context
getLanguage(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the Language property value associated with the given key, or defaultValue if the key cannot be resolved.
getLineSeparator() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies the line separator which should be used.
getMarkupDocBuilder() - Method in class io.github.swagger2markup.spi.ContentContext
getMarkupLanguage() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies the markup language which should be used to generate the files.
getMarkupLanguage(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the MarkupLanguage property value associated with the given key, or defaultValue if the key cannot be resolved.
getMax() - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Retrieves the minimum value of a property
getMaxlength() - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Retrieves the maxLength of a property
getMethod() - Method in class io.github.swagger2markup.model.PathOperation
getMin() - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Retrieves the minimum value of a property
getMinlength() - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Retrieves the minLength of a property
getModel() - Method in class io.github.swagger2markup.spi.DefinitionsDocumentExtension.Context
getName() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
getName() - Method in class io.github.swagger2markup.internal.type.Type
getNature() - Method in class io.github.swagger2markup.internal.type.ObjectTypePolymorphism
getOfType() - Method in class io.github.swagger2markup.internal.type.ArrayType
getOperation() - Method in class io.github.swagger2markup.model.PathOperation
getOperation() - Method in class io.github.swagger2markup.spi.PathsDocumentExtension.Context
getOperationOrderBy() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies operation ordering.
getOperationOrdering() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies a custom comparator function to order operations.
getOrderBy(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the OrderBy property value associated with the given key, or defaultValue if the key cannot be resolved.
getOutputLanguage() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies labels language of output files.
getOutputPath() - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Context
getOverviewDocument() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Overview document name (without extension).
getOverviewDocumentExtensions() - Method in interface io.github.swagger2markup.Swagger2MarkupExtensionRegistry: OverviewDocumentExtension extension point can be used to extend the overview document content.
getPageBreakLocations() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Returns the list of page break locations
getPageBreakLocations(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties
getParameterOrderBy() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies parameter ordering.
getParameterOrdering() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies a custom comparator function to order parameters.
getPath() - Method in class io.github.swagger2markup.model.PathOperation
getPath(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the Path property value associated with the given key, or defaultValue if the key cannot be resolved.
getPathsDocument() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Paths document name (without extension).
getPathsDocumentExtensions() - Method in interface io.github.swagger2markup.Swagger2MarkupExtensionRegistry: PathsDocumentExtension extension point can be used to extend the paths document content.
getPathsGroupedBy() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies if the operations should be grouped by tags or stay as-is.
getPattern() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
getPattern() - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Retrieves the pattern of a property
getPolymorphism() - Method in class io.github.swagger2markup.internal.type.ObjectType
getPosition() - Method in class io.github.swagger2markup.spi.DefinitionsDocumentExtension.Context
getPosition() - Method in class io.github.swagger2markup.spi.OverviewDocumentExtension.Context
getPosition() - Method in class io.github.swagger2markup.spi.PathsDocumentExtension.Context
getPosition() - Method in class io.github.swagger2markup.spi.SecurityDocumentExtension.Context
getProperties() - Method in class io.github.swagger2markup.internal.type.ObjectType
getPropertyOrderBy() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies property ordering.
getPropertyOrdering() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies a custom comparator function to order properties.
getReadOnly() - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Checks if a property is read-only.
getRefType() - Method in class io.github.swagger2markup.internal.type.RefType
getRequired() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
getRequiredBoolean(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the boolean property value associated with the given key (never null).
getRequiredInt(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the int property value associated with the given key (never null).
getRequiredMarkupLanguage(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the MarkupLanguage property value associated with the given key (never null).
getRequiredPath(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the Path property value associated with the given key (never null).
getRequiredString(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the String property value associated with the given key (never null).
getRequiredURI(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the URI property value associated with the given key (never null).
getResponseOrderBy() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies response ordering.
getResponseOrdering() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies a custom comparator function to order responses.
getSecurityDocument() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Security document name (without extension).
getSecurityDocumentExtensions() - Method in interface io.github.swagger2markup.Swagger2MarkupExtensionRegistry: SecurityContentExtension extension point can be used to extend the security document content.
getSecurityScheme() - Method in class io.github.swagger2markup.spi.SecurityDocumentExtension.Context
getSecuritySchemeName() - Method in class io.github.swagger2markup.spi.SecurityDocumentExtension.Context
getSeparatedDefinitionsFolder() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Separated definitions sub-folder name.
getSeparatedOperationsFolder() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Separated operations sub-folder name.
getString(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Returns an optional String property value associated with the given key.
getString(String, String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the String property value associated with the given key, or defaultValue if the key cannot be resolved.
getSwagger() - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Context
getSwaggerLocation() - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Context
getSwaggerMarkupLanguage() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies the markup language used in Swagger descriptions.
getSwaggerModelExtensions() - Method in interface io.github.swagger2markup.Swagger2MarkupExtensionRegistry: SwaggerModelExtension extension point can be used to preprocess the Swagger model.
getTagOrderBy() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies tag ordering.
getTagOrdering() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies a custom comparator function to order tags.
getTitle() - Method in class io.github.swagger2markup.model.PathOperation: Returns the display title for an operation
getType() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
getType(DocumentResolver) - Method in class io.github.swagger2markup.internal.adapter.PropertyAdapter: Retrieves the type and format of a property.
getType() - Method in class io.github.swagger2markup.internal.type.BasicType
getType(Model, Map<String, Model>, DocumentResolver) - Static method in class io.github.swagger2markup.internal.utils.ModelUtils: Retrieves the type of a model, or otherwise null
getUniqueName() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
getUniqueName() - Method in class io.github.swagger2markup.internal.type.Type
getURI(String) - Method in class io.github.swagger2markup.Swagger2MarkupProperties: Return the URI property value associated with the given key, or defaultValue if the key cannot be resolved.
getValues() - Method in class io.github.swagger2markup.internal.type.EnumType
getValueType() - Method in class io.github.swagger2markup.internal.type.MapType
getVendorExtensions() - Method in class io.github.swagger2markup.internal.adapter.ParameterAdapter
GroupBy - Enum in io.github.swagger2markup
groupOperationsByRegex(List<PathOperation>, Pattern) - Static method in class io.github.swagger2markup.internal.utils.RegexUtils: Groups the operations by regex group.
groupOperationsByTag(List<PathOperation>, Comparator<PathOperation>) - Static method in class io.github.swagger2markup.internal.utils.TagUtils: Groups the operations by tag.

H

HEADER_COLUMN - Static variable in class io.github.swagger2markup.internal.component.TableComponent
HEADER_REGEX - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
HEADERS_COLUMN - Static variable in class io.github.swagger2markup.Labels
HOST - Static variable in class io.github.swagger2markup.Labels
HTTP_CODE_COLUMN - Static variable in class io.github.swagger2markup.Labels

I

IN - Static variable in class io.github.swagger2markup.Labels
INLINE_SCHEMA_ENABLED - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
InlineSchemaUtils - Class in io.github.swagger2markup.internal.utils
InlineSchemaUtils() - Constructor for class io.github.swagger2markup.internal.utils.InlineSchemaUtils
INTER_DOCUMENT_CROSS_REFERENCES_ENABLED - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
INTER_DOCUMENT_CROSS_REFERENCES_PREFIX - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
io.github.swagger2markup - package io.github.swagger2markup
io.github.swagger2markup.builder - package io.github.swagger2markup.builder
io.github.swagger2markup.internal.adapter - package io.github.swagger2markup.internal.adapter
io.github.swagger2markup.internal.component - package io.github.swagger2markup.internal.component
io.github.swagger2markup.internal.document - package io.github.swagger2markup.internal.document
io.github.swagger2markup.internal.resolver - package io.github.swagger2markup.internal.resolver
io.github.swagger2markup.internal.type - package io.github.swagger2markup.internal.type
io.github.swagger2markup.internal.utils - package io.github.swagger2markup.internal.utils
io.github.swagger2markup.model - package io.github.swagger2markup.model
io.github.swagger2markup.spi - package io.github.swagger2markup.spi
io.github.swagger2markup.utils - package io.github.swagger2markup.utils
IOUtils - Class in io.github.swagger2markup.utils
IOUtils() - Constructor for class io.github.swagger2markup.utils.IOUtils
isBasePathPrefixEnabled() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Prepend the base path to all paths.
isFlatBodyEnabled() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Optionally isolate the body parameter, if any, from other parameters.
isGeneratedExamplesEnabled() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Include generated examples into the documents.
isInlineSchemaEnabled() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Specifies if inline schemas are detailed
isInterDocumentCrossReferencesEnabled() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Enable use of inter-document cross-references when needed.
isNotBlank(StringColumn) - Static method in class io.github.swagger2markup.internal.component.TableComponent
isPathSecuritySectionEnabled() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: Optionally disable the security section for path sections
isSeparatedDefinitionsEnabled() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: In addition to the Definitions file, also create separate definition files for each model definition.
isSeparatedOperationsEnabled() - Method in interface io.github.swagger2markup.Swagger2MarkupConfig: In addition to the Paths file, also create separate operation files for each operation.
italicText(MarkupDocBuilder, String) - Static method in class io.github.swagger2markup.internal.utils.MarkupDocBuilderUtils

L

Labels - Class in io.github.swagger2markup
Labels(Swagger2MarkupConfig) - Constructor for class io.github.swagger2markup.Labels
labels - Variable in class io.github.swagger2markup.spi.MarkupComponent
Language - Enum in io.github.swagger2markup
LENGTH_COLUMN - Static variable in class io.github.swagger2markup.Labels
levelOffset(DefinitionsDocumentExtension.Context) - Method in class io.github.swagger2markup.spi.DefinitionsDocumentExtension: Returns title level offset from 1 to apply to content
levelOffset(OverviewDocumentExtension.Context) - Method in class io.github.swagger2markup.spi.OverviewDocumentExtension: Returns title level offset from 1 to apply to content
levelOffset(PathsDocumentExtension.Context) - Method in class io.github.swagger2markup.spi.PathsDocumentExtension: Returns title level offset from 1 to apply to content
levelOffset(SecurityDocumentExtension.Context) - Method in class io.github.swagger2markup.spi.SecurityDocumentExtension: Returns title level offset from 1 to apply to content
LICENSE - Static variable in class io.github.swagger2markup.Labels
LICENSE_INFORMATION - Static variable in class io.github.swagger2markup.Labels
LICENSE_URL - Static variable in class io.github.swagger2markup.Labels
LicenseInfoComponent - Class in io.github.swagger2markup.internal.component
LicenseInfoComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.component.LicenseInfoComponent
LicenseInfoComponent.Parameters - Class in io.github.swagger2markup.internal.component
LINE_SEPARATOR - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
literalText(MarkupDocBuilder, String) - Static method in class io.github.swagger2markup.internal.utils.MarkupDocBuilderUtils
logger - Variable in class io.github.swagger2markup.spi.MarkupComponent

M

MapType - Class in io.github.swagger2markup.internal.type: Array type abstraction
MapType(String, Type) - Constructor for class io.github.swagger2markup.internal.type.MapType
MapUtils - Class in io.github.swagger2markup.internal.utils
MapUtils() - Constructor for class io.github.swagger2markup.internal.utils.MapUtils
MARKUP_LANGUAGE - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
MarkupComponent<T> - Class in io.github.swagger2markup.spi
MarkupComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.spi.MarkupComponent
markupDescription(MarkupLanguage, MarkupDocBuilder, String) - Static method in class io.github.swagger2markup.internal.utils.MarkupDocBuilderUtils
MarkupDocBuilderUtils - Class in io.github.swagger2markup.internal.utils
MarkupDocBuilderUtils() - Constructor for class io.github.swagger2markup.internal.utils.MarkupDocBuilderUtils
MAXLENGTH_COLUMN - Static variable in class io.github.swagger2markup.Labels
MAXVALUE_COLUMN - Static variable in class io.github.swagger2markup.Labels
MAXVALUE_EXCLUSIVE_COLUMN - Static variable in class io.github.swagger2markup.Labels
MINLENGTH_COLUMN - Static variable in class io.github.swagger2markup.Labels
MINVALUE_COLUMN - Static variable in class io.github.swagger2markup.Labels
MINVALUE_EXCLUSIVE_COLUMN - Static variable in class io.github.swagger2markup.Labels
ModelUtils - Class in io.github.swagger2markup.internal.utils
ModelUtils() - Constructor for class io.github.swagger2markup.internal.utils.ModelUtils

N

name - Variable in class io.github.swagger2markup.internal.type.Type
NAME - Static variable in class io.github.swagger2markup.Labels
NAME_COLUMN - Static variable in class io.github.swagger2markup.Labels
nature - Variable in class io.github.swagger2markup.internal.type.ObjectTypePolymorphism
NO_CONTENT - Static variable in class io.github.swagger2markup.Labels
normalizeName(String) - Static method in class io.github.swagger2markup.utils.IOUtils: Create a normalized name from an arbitrary string.

O

ObjectType - Class in io.github.swagger2markup.internal.type: Complex object abstraction
ObjectType(String, ObjectTypePolymorphism, Map<String, Property>) - Constructor for class io.github.swagger2markup.internal.type.ObjectType
ObjectType(String, Map<String, Property>) - Constructor for class io.github.swagger2markup.internal.type.ObjectType
ObjectTypePolymorphism - Class in io.github.swagger2markup.internal.type
ObjectTypePolymorphism(ObjectTypePolymorphism.Nature, String) - Constructor for class io.github.swagger2markup.internal.type.ObjectTypePolymorphism
ObjectTypePolymorphism.Nature - Enum in io.github.swagger2markup.internal.type
OPERATION_ORDER_BY - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
OperationDocumentNameResolver - Class in io.github.swagger2markup.internal.resolver
OperationDocumentNameResolver(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.resolver.OperationDocumentNameResolver
OperationDocumentResolver - Class in io.github.swagger2markup.internal.resolver: A functor to return the document part of an inter-document cross-references, depending on the context.
OperationDocumentResolver(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.resolver.OperationDocumentResolver
OperationDocumentResolverDefault - Class in io.github.swagger2markup.internal.resolver: Default DocumentResolver functor
OperationDocumentResolverDefault(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.resolver.OperationDocumentResolverDefault
OPERATIONS - Static variable in class io.github.swagger2markup.Labels
OrderBy - Enum in io.github.swagger2markup
OUTPUT_LANGUAGE - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
OVERVIEW - Static variable in class io.github.swagger2markup.Labels
OVERVIEW_DOCUMENT - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
OverviewDocument - Class in io.github.swagger2markup.internal.document
OverviewDocument(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.document.OverviewDocument
OverviewDocument.Parameters - Class in io.github.swagger2markup.internal.document
OverviewDocumentExtension - Class in io.github.swagger2markup.spi: OverviewDocumentExtension extension point can be used to extend the overview document content.
OverviewDocumentExtension() - Constructor for class io.github.swagger2markup.spi.OverviewDocumentExtension
OverviewDocumentExtension.Context - Class in io.github.swagger2markup.spi
OverviewDocumentExtension.Position - Enum in io.github.swagger2markup.spi

P

PAGE_BREAK_LOCATIONS - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
PageBreakLocations - Enum in io.github.swagger2markup
PARAMETER_ORDER_BY - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
ParameterAdapter - Class in io.github.swagger2markup.internal.adapter
ParameterAdapter(Swagger2MarkupConverter.Context, PathOperation, Parameter, DocumentResolver) - Constructor for class io.github.swagger2markup.internal.adapter.ParameterAdapter
parameters(PathOperation, List<ObjectType>) - Static method in class io.github.swagger2markup.internal.component.BodyParameterComponent
Parameters(PathOperation, List<ObjectType>) - Constructor for class io.github.swagger2markup.internal.component.BodyParameterComponent.Parameters
parameters(List<String>, int) - Static method in class io.github.swagger2markup.internal.component.ConsumesComponent
Parameters(List<String>, int) - Constructor for class io.github.swagger2markup.internal.component.ConsumesComponent.Parameters
parameters(Contact, int) - Static method in class io.github.swagger2markup.internal.component.ContactInfoComponent
Parameters(Contact, int) - Constructor for class io.github.swagger2markup.internal.component.ContactInfoComponent.Parameters
parameters(String, Model, int) - Static method in class io.github.swagger2markup.internal.component.DefinitionComponent
Parameters(String, Model, int) - Constructor for class io.github.swagger2markup.internal.component.DefinitionComponent.Parameters
parameters(Info, int) - Static method in class io.github.swagger2markup.internal.component.LicenseInfoComponent
Parameters(Info, int) - Constructor for class io.github.swagger2markup.internal.component.LicenseInfoComponent.Parameters
parameters(PathOperation, List<ObjectType>, int) - Static method in class io.github.swagger2markup.internal.component.ParameterTableComponent
Parameters(PathOperation, List<ObjectType>, int) - Constructor for class io.github.swagger2markup.internal.component.ParameterTableComponent.Parameters
parameters(PathOperation) - Static method in class io.github.swagger2markup.internal.component.PathOperationComponent
Parameters(PathOperation) - Constructor for class io.github.swagger2markup.internal.component.PathOperationComponent.Parameters
parameters(List<String>, int) - Static method in class io.github.swagger2markup.internal.component.ProducesComponent
Parameters(List<String>, int) - Constructor for class io.github.swagger2markup.internal.component.ProducesComponent.Parameters
parameters(Map<String, Property>, String, List<ObjectType>) - Static method in class io.github.swagger2markup.internal.component.PropertiesTableComponent
Parameters(Map<String, Property>, String, List<ObjectType>) - Constructor for class io.github.swagger2markup.internal.component.PropertiesTableComponent.Parameters
parameters(PathOperation, int, List<ObjectType>) - Static method in class io.github.swagger2markup.internal.component.ResponseComponent
Parameters(PathOperation, int, List<ObjectType>) - Constructor for class io.github.swagger2markup.internal.component.ResponseComponent.Parameters
parameters(PathOperation, int) - Static method in class io.github.swagger2markup.internal.component.SecuritySchemeComponent
Parameters(PathOperation, int) - Constructor for class io.github.swagger2markup.internal.component.SecuritySchemeComponent.Parameters
parameters(String, SecuritySchemeDefinition, int) - Static method in class io.github.swagger2markup.internal.component.SecuritySchemeDefinitionComponent
Parameters(String, SecuritySchemeDefinition, int) - Constructor for class io.github.swagger2markup.internal.component.SecuritySchemeDefinitionComponent.Parameters
parameters(StringColumn...) - Static method in class io.github.swagger2markup.internal.component.TableComponent
Parameters(StringColumn...) - Constructor for class io.github.swagger2markup.internal.component.TableComponent.Parameters
parameters(List<Tag>, int) - Static method in class io.github.swagger2markup.internal.component.TagsComponent
Parameters(List<Tag>, int) - Constructor for class io.github.swagger2markup.internal.component.TagsComponent.Parameters
parameters(Swagger, int) - Static method in class io.github.swagger2markup.internal.component.UriSchemeComponent
Parameters(Swagger, int) - Constructor for class io.github.swagger2markup.internal.component.UriSchemeComponent.Parameters
parameters(Info, int) - Static method in class io.github.swagger2markup.internal.component.VersionInfoComponent
Parameters(Info, int) - Constructor for class io.github.swagger2markup.internal.component.VersionInfoComponent.Parameters
parameters(Map<String, Model>) - Static method in class io.github.swagger2markup.internal.document.DefinitionsDocument
Parameters(Map<String, Model>) - Constructor for class io.github.swagger2markup.internal.document.DefinitionsDocument.Parameters
parameters(Swagger) - Static method in class io.github.swagger2markup.internal.document.OverviewDocument
Parameters(Swagger) - Constructor for class io.github.swagger2markup.internal.document.OverviewDocument.Parameters
parameters(Map<String, Path>) - Static method in class io.github.swagger2markup.internal.document.PathsDocument
Parameters(Map<String, Path>) - Constructor for class io.github.swagger2markup.internal.document.PathsDocument.Parameters
parameters(Map<String, SecuritySchemeDefinition>) - Static method in class io.github.swagger2markup.internal.document.SecurityDocument
Parameters(Map<String, SecuritySchemeDefinition>) - Constructor for class io.github.swagger2markup.internal.document.SecurityDocument.Parameters
PARAMETERS - Static variable in class io.github.swagger2markup.Labels
ParameterTableComponent - Class in io.github.swagger2markup.internal.component
ParameterTableComponent.Parameters - Class in io.github.swagger2markup.internal.component
PATH_SECURITY_SECTION_ENABLED - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
PathOperation - Class in io.github.swagger2markup.model
PathOperation(HttpMethod, String, Operation) - Constructor for class io.github.swagger2markup.model.PathOperation
PathOperationComponent - Class in io.github.swagger2markup.internal.component
PathOperationComponent(Swagger2MarkupConverter.Context, DocumentResolver, DocumentResolver) - Constructor for class io.github.swagger2markup.internal.component.PathOperationComponent
PathOperationComponent.Parameters - Class in io.github.swagger2markup.internal.component
PATHS - Static variable in class io.github.swagger2markup.Labels
PATHS_DOCUMENT - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
PATHS_GROUPED_BY - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
PathsDocument - Class in io.github.swagger2markup.internal.document
PathsDocument(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.document.PathsDocument
PathsDocument.Parameters - Class in io.github.swagger2markup.internal.document
PathsDocumentExtension - Class in io.github.swagger2markup.spi: PathsDocumentExtension extension point can be used to extend the paths document content.
PathsDocumentExtension() - Constructor for class io.github.swagger2markup.spi.PathsDocumentExtension
PathsDocumentExtension.Context - Class in io.github.swagger2markup.spi
PathsDocumentExtension.Position - Enum in io.github.swagger2markup.spi
PathUtils - Class in io.github.swagger2markup.internal.utils
PathUtils() - Constructor for class io.github.swagger2markup.internal.utils.PathUtils
PATTERN_COLUMN - Static variable in class io.github.swagger2markup.Labels
POLYMORPHISM_COLUMN - Static variable in class io.github.swagger2markup.Labels
POLYMORPHISM_DISCRIMINATOR_COLUMN - Static variable in class io.github.swagger2markup.Labels
POLYMORPHISM_NATURE_COMPOSITION - Static variable in class io.github.swagger2markup.Labels
POLYMORPHISM_NATURE_INHERITANCE - Static variable in class io.github.swagger2markup.Labels
PRODUCES - Static variable in class io.github.swagger2markup.Labels
ProducesComponent - Class in io.github.swagger2markup.internal.component
ProducesComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.component.ProducesComponent
ProducesComponent.Parameters - Class in io.github.swagger2markup.internal.component
PROPERTIES_PREFIX - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties: Prefix for Swagger2Markup properties
PropertiesTableComponent - Class in io.github.swagger2markup.internal.component
PropertiesTableComponent.Parameters - Class in io.github.swagger2markup.internal.component
PROPERTY_ORDER_BY - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
PropertyAdapter - Class in io.github.swagger2markup.internal.adapter
PropertyAdapter(Property) - Constructor for class io.github.swagger2markup.internal.adapter.PropertyAdapter

R

RefType - Class in io.github.swagger2markup.internal.type: Reference to a type defined elsewhere
RefType(String, Type) - Constructor for class io.github.swagger2markup.internal.type.RefType
RefType(Type) - Constructor for class io.github.swagger2markup.internal.type.RefType
RegexUtils - Class in io.github.swagger2markup.internal.utils
RegexUtils() - Constructor for class io.github.swagger2markup.internal.utils.RegexUtils
REQUEST - Static variable in class io.github.swagger2markup.Labels
resolveRefType(Type) - Static method in class io.github.swagger2markup.internal.utils.ModelUtils: Recursively resolve referenced type if type is of type RefType
RESOURCES - Static variable in class io.github.swagger2markup.Labels
RESPONSE - Static variable in class io.github.swagger2markup.Labels
RESPONSE_ORDER_BY - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
ResponseComponent - Class in io.github.swagger2markup.internal.component
ResponseComponent.Parameters - Class in io.github.swagger2markup.internal.component
RESPONSES - Static variable in class io.github.swagger2markup.Labels

S

SCHEMA_COLUMN - Static variable in class io.github.swagger2markup.Labels
SCHEMES - Static variable in class io.github.swagger2markup.Labels
SCOPES_COLUMN - Static variable in class io.github.swagger2markup.Labels
SECTION_TITLE_LEVEL - Static variable in class io.github.swagger2markup.internal.document.OverviewDocument
SECURITY - Static variable in class io.github.swagger2markup.Labels
SECURITY_DOCUMENT - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
SecurityDocument - Class in io.github.swagger2markup.internal.document
SecurityDocument(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.document.SecurityDocument
SecurityDocument.Parameters - Class in io.github.swagger2markup.internal.document
SecurityDocumentExtension - Class in io.github.swagger2markup.spi: SecurityContentExtension extension point can be used to extend the security document content.
SecurityDocumentExtension() - Constructor for class io.github.swagger2markup.spi.SecurityDocumentExtension
SecurityDocumentExtension.Context - Class in io.github.swagger2markup.spi
SecurityDocumentExtension.Position - Enum in io.github.swagger2markup.spi
SecurityDocumentResolver - Class in io.github.swagger2markup.internal.resolver
SecurityDocumentResolver(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.resolver.SecurityDocumentResolver
SecuritySchemeComponent - Class in io.github.swagger2markup.internal.component
SecuritySchemeComponent(Swagger2MarkupConverter.Context, DocumentResolver) - Constructor for class io.github.swagger2markup.internal.component.SecuritySchemeComponent
SecuritySchemeComponent.Parameters - Class in io.github.swagger2markup.internal.component
SecuritySchemeDefinitionComponent - Class in io.github.swagger2markup.internal.component
SecuritySchemeDefinitionComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.component.SecuritySchemeDefinitionComponent
SecuritySchemeDefinitionComponent.Parameters - Class in io.github.swagger2markup.internal.component
SEPARATED_DEFINITIONS_ENABLED - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
SEPARATED_DEFINITIONS_FOLDER - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
SEPARATED_OPERATIONS_ENABLED - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
SEPARATED_OPERATIONS_FOLDER - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
setCollectionFormat(String) - Method in class io.github.swagger2markup.internal.type.ArrayType
setDiscriminator(String) - Method in class io.github.swagger2markup.internal.type.ObjectTypePolymorphism
setDocument(String) - Method in class io.github.swagger2markup.internal.type.RefType
setFormat(String) - Method in class io.github.swagger2markup.internal.type.BasicType
setName(String) - Method in class io.github.swagger2markup.internal.type.Type
setNature(ObjectTypePolymorphism.Nature) - Method in class io.github.swagger2markup.internal.type.ObjectTypePolymorphism
setOfType(Type) - Method in class io.github.swagger2markup.internal.type.ArrayType
setOutputPath(Path) - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Context
setPolymorphism(ObjectTypePolymorphism) - Method in class io.github.swagger2markup.internal.type.ObjectType
setProperties(Map<String, Property>) - Method in class io.github.swagger2markup.internal.type.ObjectType
setRefType(Type) - Method in class io.github.swagger2markup.internal.type.RefType
setType(String) - Method in class io.github.swagger2markup.internal.type.BasicType
setUniqueName(String) - Method in class io.github.swagger2markup.internal.type.Type
setValues(List<String>) - Method in class io.github.swagger2markup.internal.type.EnumType
setValueType(Type) - Method in class io.github.swagger2markup.internal.type.MapType
Swagger2MarkupConfig - Interface in io.github.swagger2markup: Swagger2Markup configuration interface.
Swagger2MarkupConfigBuilder - Class in io.github.swagger2markup.builder
Swagger2MarkupConfigBuilder() - Constructor for class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder
Swagger2MarkupConfigBuilder(Properties) - Constructor for class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder
Swagger2MarkupConfigBuilder(Map<String, String>) - Constructor for class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder
Swagger2MarkupConfigBuilder(Configuration) - Constructor for class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder
Swagger2MarkupConverter - Class in io.github.swagger2markup
Swagger2MarkupConverter(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.Swagger2MarkupConverter
Swagger2MarkupConverter.Builder - Class in io.github.swagger2markup
Swagger2MarkupConverter.Context - Class in io.github.swagger2markup
Swagger2MarkupExtensionRegistry - Interface in io.github.swagger2markup: Extension points registry interface.
Swagger2MarkupExtensionRegistryBuilder - Class in io.github.swagger2markup.builder
Swagger2MarkupExtensionRegistryBuilder() - Constructor for class io.github.swagger2markup.builder.Swagger2MarkupExtensionRegistryBuilder
Swagger2MarkupProperties - Class in io.github.swagger2markup
Swagger2MarkupProperties(Properties) - Constructor for class io.github.swagger2markup.Swagger2MarkupProperties
Swagger2MarkupProperties(Map<String, String>) - Constructor for class io.github.swagger2markup.Swagger2MarkupProperties
Swagger2MarkupProperties(Configuration) - Constructor for class io.github.swagger2markup.Swagger2MarkupProperties
SWAGGER_MARKUP_LANGUAGE - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
SwaggerModelExtension - Class in io.github.swagger2markup.spi: SwaggerModelExtension extension point can be used to preprocess the Swagger model.
SwaggerModelExtension() - Constructor for class io.github.swagger2markup.spi.SwaggerModelExtension

T

TableComponent - Class in io.github.swagger2markup.internal.component
TableComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.component.TableComponent
TableComponent.Parameters - Class in io.github.swagger2markup.internal.component
TAG_ORDER_BY - Static variable in class io.github.swagger2markup.Swagger2MarkupProperties
TAGS - Static variable in class io.github.swagger2markup.Labels
TagsComponent - Class in io.github.swagger2markup.internal.component
TagsComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.component.TagsComponent
TagsComponent.Parameters - Class in io.github.swagger2markup.internal.component
TagUtils - Class in io.github.swagger2markup.internal.utils
TagUtils() - Constructor for class io.github.swagger2markup.internal.utils.TagUtils
TERMS_OF_SERVICE - Static variable in class io.github.swagger2markup.Labels
toFile(Path) - Method in class io.github.swagger2markup.Swagger2MarkupConverter: Converts the Swagger specification the given outputFile.
toFileWithoutExtension(Path) - Method in class io.github.swagger2markup.Swagger2MarkupConverter: Converts the Swagger specification the given outputFile.
toFolder(Path) - Method in class io.github.swagger2markup.Swagger2MarkupConverter: Converts the Swagger specification into the given outputDirectory.
TOKEN_URL - Static variable in class io.github.swagger2markup.Labels
toLocale() - Method in enum io.github.swagger2markup.Language
toPath(Path) - Method in class io.github.swagger2markup.Swagger2MarkupConverter: Converts the Swagger specification into the outputPath which can be either a directory (e.g /tmp) or a file without extension (e.g /tmp/swagger).
toPathOperationsList(Map<String, Path>, String, Comparator<PathOperation>) - Static method in class io.github.swagger2markup.internal.utils.PathUtils: Converts the Swagger paths into a list of PathOperations.
toPathOperationsList(String, Path) - Static method in class io.github.swagger2markup.internal.utils.PathUtils: Converts a Swagger path into a PathOperation.
toSortedArray(Set<String>) - Static method in class io.github.swagger2markup.internal.utils.RegexUtils: Alphabetically sort the list of groups
toSortedMap(Map<K, V>, Comparator<? super K>) - Static method in class io.github.swagger2markup.internal.utils.MapUtils: Returns the the Map either ordered or as-is, if the comparator is null.
toSortedMap(List<Tag>, Comparator<String>) - Static method in class io.github.swagger2markup.internal.utils.TagUtils: Converts the global Tag list into a Map where the tag name is the key and the Tag the value.
toString() - Method in class io.github.swagger2markup.model.PathOperation
toString() - Method in class io.github.swagger2markup.Swagger2MarkupConverter: Builds the document returns it as a String.
type - Variable in class io.github.swagger2markup.internal.type.BasicType: Basic type
Type - Class in io.github.swagger2markup.internal.type: Type abstraction for display purpose
Type(String, String) - Constructor for class io.github.swagger2markup.internal.type.Type
Type(String) - Constructor for class io.github.swagger2markup.internal.type.Type
TYPE - Static variable in class io.github.swagger2markup.Labels
TYPE_COLUMN - Static variable in class io.github.swagger2markup.Labels

U

UNKNOWN - Static variable in class io.github.swagger2markup.Labels
URI_SCHEME - Static variable in class io.github.swagger2markup.Labels
uriParent(URI) - Static method in class io.github.swagger2markup.utils.URIUtils: Return URI parent
uriReader(URI) - Static method in class io.github.swagger2markup.utils.IOUtils: Create a reader from specified source.
UriSchemeComponent - Class in io.github.swagger2markup.internal.component
UriSchemeComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.component.UriSchemeComponent
UriSchemeComponent.Parameters - Class in io.github.swagger2markup.internal.component
URIUtils - Class in io.github.swagger2markup.utils
URIUtils() - Constructor for class io.github.swagger2markup.utils.URIUtils

V

valueOf(String) - Static method in enum io.github.swagger2markup.GroupBy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.swagger2markup.internal.type.ObjectTypePolymorphism.Nature: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.swagger2markup.Language: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.swagger2markup.OrderBy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.swagger2markup.PageBreakLocations: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.swagger2markup.spi.DefinitionsDocumentExtension.Position: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.swagger2markup.spi.OverviewDocumentExtension.Position: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.swagger2markup.spi.PathsDocumentExtension.Position: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.swagger2markup.spi.SecurityDocumentExtension.Position: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.github.swagger2markup.GroupBy: Returns an array containing the constants of this enum type, in the order they are declared.
values - Variable in class io.github.swagger2markup.internal.type.EnumType
values() - Static method in enum io.github.swagger2markup.internal.type.ObjectTypePolymorphism.Nature: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.swagger2markup.Language: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.swagger2markup.OrderBy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.swagger2markup.PageBreakLocations: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.swagger2markup.spi.DefinitionsDocumentExtension.Position: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.swagger2markup.spi.OverviewDocumentExtension.Position: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.swagger2markup.spi.PathsDocumentExtension.Position: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.swagger2markup.spi.SecurityDocumentExtension.Position: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION - Static variable in class io.github.swagger2markup.Labels
VersionInfoComponent - Class in io.github.swagger2markup.internal.component
VersionInfoComponent(Swagger2MarkupConverter.Context) - Constructor for class io.github.swagger2markup.internal.component.VersionInfoComponent
VersionInfoComponent.Parameters - Class in io.github.swagger2markup.internal.component

W

WIDTH_RATIO - Static variable in class io.github.swagger2markup.internal.component.TableComponent
withAnchorPrefix(String) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Optionally prefix all anchors for uniqueness.
withBasePathPrefix() - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Prepend the base path to all paths.
withConfig(Swagger2MarkupConfig) - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Builder
withDefinitionOrdering(OrderBy) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies definition ordering.
withDefinitionOrdering(Comparator<String>) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies a custom comparator function to order definitions.
withDefinitionsDocumentExtension(DefinitionsDocumentExtension) - Method in class io.github.swagger2markup.builder.Swagger2MarkupExtensionRegistryBuilder
withExtensionRegistry(Swagger2MarkupExtensionRegistry) - Method in class io.github.swagger2markup.Swagger2MarkupConverter.Builder
withFlatBody() - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Optionally isolate the body parameter, if any, from other parameters.
withGeneratedExamples() - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Include generated examples into the documents.
withHeaderRegex(String) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies the regex pattern to use for grouping paths.
withInterDocumentCrossReferences(String) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Enable use of inter-document cross-references when needed.
withInterDocumentCrossReferences() - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Enable use of inter-document cross-references when needed.
withLineSeparator(LineSeparator) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies the line separator which should be used.
withMarkupLanguage(MarkupLanguage) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies the markup language which should be used to generate the files.
withOperationOrdering(OrderBy) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies operation ordering.
withOperationOrdering(Comparator<PathOperation>) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies a custom comparator function to order operations.
withoutInlineSchema() - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Disable inline schema support.
withoutPathSecuritySection() - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Optionally disable the security section for path sections
withOutputLanguage(Language) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies labels language of output files.
withOverviewDocumentExtension(OverviewDocumentExtension) - Method in class io.github.swagger2markup.builder.Swagger2MarkupExtensionRegistryBuilder
withPageBreaks(List<PageBreakLocations>) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Set the page break locations
withParameterOrdering(OrderBy) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies parameter ordering.
withParameterOrdering(Comparator<Parameter>) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies a custom comparator function to order parameters.
withPathsDocumentExtension(PathsDocumentExtension) - Method in class io.github.swagger2markup.builder.Swagger2MarkupExtensionRegistryBuilder
withPathsGroupedBy(GroupBy) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies if the paths should be grouped by tags or stay as-is.
withPropertyOrdering(OrderBy) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies property ordering.
withPropertyOrdering(Comparator<String>) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies a custom comparator function to order properties.
withResponseOrdering(OrderBy) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies response ordering.
withResponseOrdering(Comparator<String>) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies a custom comparator function to order responses.
withSecurityDocumentExtension(SecurityDocumentExtension) - Method in class io.github.swagger2markup.builder.Swagger2MarkupExtensionRegistryBuilder
withSeparatedDefinitions() - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: In addition to the Definitions file, also create separate definition files for each model definition.
withSeparatedOperations() - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: In addition to the Paths file, also create separate operation files for each operation.
withSwaggerMarkupLanguage(MarkupLanguage) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies the markup language used in Swagger descriptions.
withSwaggerModelExtension(SwaggerModelExtension) - Method in class io.github.swagger2markup.builder.Swagger2MarkupExtensionRegistryBuilder
withTagOrdering(OrderBy) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies tag ordering.
withTagOrdering(Comparator<String>) - Method in class io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder: Specifies a custom comparator function to order tags.

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