docs/generators/asciidoc.md
| Property | Value | Notes |
|---|---|---|
| generator name | asciidoc | pass this to the generate command after -g |
| generator stability | STABLE | |
| generator type | DOCUMENTATION | |
| generator language | Java | |
| generator default templating engine | mustache | |
| helpTxt | Generates asciidoc markup based documentation. |
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.
| Option | Description | Values | Default |
|---|---|---|---|
| allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false | false | |
| appDescription | description of the application | null | |
| appName | short name of the application | null | |
| artifactId | artifactId in generated pom.xml. This also becomes part of the generated library's filename | null | |
| artifactVersion | artifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option. | null | |
| disallowAdditionalPropertiesIfNotPresent | If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default. | <dl><dt>false</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>true</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl> | true |
| ensureUniqueParams | Whether to ensure parameter names are unique in an operation (rename parameters that are not). | true | |
| enumUnknownDefaultCase | If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response. With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case. | <dl><dt>false</dt><dd>No changes to the enums are made, this is the default option.</dd><dt>true</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl> | false |
| groupId | groupId in generated pom.xml | null | |
| headerAttributes | generation of asciidoc header meta data attributes (set to false to suppress, default: true) | true | |
| infoEmail | an email address to contact for inquiries about the application | null | |
| infoUrl | a URL where users can get more information about the application | null | |
| invokerPackage | root package for generated code | null | |
| legacyDiscriminatorBehavior | Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default). | <dl><dt>true</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>false</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl> | true |
| licenseInfo | a short description of the license | null | |
| licenseUrl | a URL pointing to the full license | null | |
| prependFormOrBodyParameters | Add form or body parameters to the beginning of the parameter list. | false | |
| skipExamples | skip examples sections (default: false) | false | |
| snippetDir | path with includable markup snippets (e.g. test output generated by restdoc, default: .) | . | |
| sortModelPropertiesByRequiredFlag | Sort model properties to place required parameters before optional parameters. | true | |
| sortParamsByRequiredFlag | Sort method arguments to place required parameters before optional parameters. | true | |
| specDir | path with includable markup spec files (e.g. handwritten additional docs, default: ..) | .. | |
| useIntroduction | use introduction section, rather than an initial abstract (default: false) | false | |
| useMethodAndPath | Use HTTP method and path as operation heading, instead of operation id (default: false) | false | |
| useTableTitles | Use titles for tables, rather than wrapping tables instead their own section (default: false) | false |
| Type/Alias | Imports |
|---|
| Type/Alias | Instantiated By |
|---|
| Name | Supported | Defined By |
|---|---|---|
| BasePath | ✗ | ToolingExtension |
| Authorizations | ✗ | ToolingExtension |
| UserAgent | ✗ | ToolingExtension |
| MockServer | ✗ | ToolingExtension |
| Name | Supported | Defined By |
|---|---|---|
| Custom | ✗ | OAS2,OAS3 |
| Int32 | ✓ | OAS2,OAS3 |
| Int64 | ✓ | OAS2,OAS3 |
| Float | ✓ | OAS2,OAS3 |
| Double | ✓ | OAS2,OAS3 |
| Decimal | ✓ | ToolingExtension |
| String | ✓ | OAS2,OAS3 |
| Byte | ✓ | OAS2,OAS3 |
| Binary | ✓ | OAS2,OAS3 |
| Boolean | ✓ | OAS2,OAS3 |
| Date | ✓ | OAS2,OAS3 |
| DateTime | ✓ | OAS2,OAS3 |
| Password | ✓ | OAS2,OAS3 |
| File | ✓ | OAS2 |
| Uuid | ✗ | |
| Array | ✓ | OAS2,OAS3 |
| Null | ✗ | OAS3 |
| AnyType | ✗ | OAS2,OAS3 |
| Object | ✓ | OAS2,OAS3 |
| Maps | ✓ | ToolingExtension |
| CollectionFormat | ✓ | OAS2 |
| CollectionFormatMulti | ✓ | OAS2 |
| Enum | ✓ | OAS2,OAS3 |
| ArrayOfEnum | ✓ | ToolingExtension |
| ArrayOfModel | ✓ | ToolingExtension |
| ArrayOfCollectionOfPrimitives | ✓ | ToolingExtension |
| ArrayOfCollectionOfModel | ✓ | ToolingExtension |
| ArrayOfCollectionOfEnum | ✓ | ToolingExtension |
| MapOfEnum | ✓ | ToolingExtension |
| MapOfModel | ✓ | ToolingExtension |
| MapOfCollectionOfPrimitives | ✓ | ToolingExtension |
| MapOfCollectionOfModel | ✓ | ToolingExtension |
| MapOfCollectionOfEnum | ✓ | ToolingExtension |
| Name | Supported | Defined By |
|---|---|---|
| Readme | ✗ | ToolingExtension |
| Model | ✗ | ToolingExtension |
| Api | ✗ | ToolingExtension |
| Name | Supported | Defined By |
|---|---|---|
| Host | ✗ | OAS2,OAS3 |
| BasePath | ✗ | OAS2,OAS3 |
| Info | ✗ | OAS2,OAS3 |
| Schemes | ✗ | OAS2,OAS3 |
| PartialSchemes | ✗ | OAS2,OAS3 |
| Consumes | ✗ | OAS2 |
| Produces | ✗ | OAS2 |
| ExternalDocumentation | ✗ | OAS2,OAS3 |
| Examples | ✗ | OAS2,OAS3 |
| XMLStructureDefinitions | ✗ | OAS2,OAS3 |
| MultiServer | ✗ | OAS3 |
| ParameterizedServer | ✗ | OAS3 |
| ParameterStyling | ✗ | OAS3 |
| Callbacks | ✗ | OAS3 |
| LinkObjects | ✗ | OAS3 |
| Name | Supported | Defined By |
|---|---|---|
| Path | ✓ | OAS2,OAS3 |
| Query | ✓ | OAS2,OAS3 |
| Header | ✓ | OAS2,OAS3 |
| Body | ✓ | OAS2 |
| FormUnencoded | ✓ | OAS2 |
| FormMultipart | ✓ | OAS2 |
| Cookie | ✓ | OAS3 |
| Name | Supported | Defined By |
|---|---|---|
| Simple | ✗ | OAS2,OAS3 |
| Composite | ✗ | OAS2,OAS3 |
| Polymorphism | ✗ | OAS2,OAS3 |
| Union | ✗ | OAS3 |
| allOf | ✗ | OAS2,OAS3 |
| anyOf | ✗ | OAS3 |
| oneOf | ✗ | OAS3 |
| not | ✗ | OAS3 |
| Name | Supported | Defined By |
|---|---|---|
| BasicAuth | ✗ | OAS2,OAS3 |
| ApiKey | ✗ | OAS2,OAS3 |
| OpenIDConnect | ✗ | OAS3 |
| BearerToken | ✗ | OAS3 |
| OAuth2_Implicit | ✗ | OAS2,OAS3 |
| OAuth2_Password | ✗ | OAS2,OAS3 |
| OAuth2_ClientCredentials | ✗ | OAS2,OAS3 |
| OAuth2_AuthorizationCode | ✗ | OAS2,OAS3 |
| SignatureAuth | ✗ | OAS3 |
| AWSV4Signature | ✗ | ToolingExtension |
| Name | Supported | Defined By |
|---|---|---|
| JSON | ✓ | OAS2,OAS3 |
| XML | ✓ | OAS2,OAS3 |
| PROTOBUF | ✗ | ToolingExtension |
| Custom | ✗ | OAS2,OAS3 |