Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Grouping by TAG for OpenAPI v3.0 is ignored #440

Open
micobarac opened this issue May 7, 2022 · 0 comments
Open

Grouping by TAG for OpenAPI v3.0 is ignored #440

micobarac opened this issue May 7, 2022 · 0 comments

Comments

@micobarac
Copy link

I have created a fork of swagger2markup-maven-plugin and modified it to execute OpenAPI converter, but, grouping by TAG never happens...

This is my configuration:

                <configuration>
                    <swaggerInput>${project.basedir}/target/swagger/swagger.json</swaggerInput>
                    <outputDir>${project.basedir}/target/docs/asciidoc</outputDir>
                    <config>
                        <swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
                        <swagger2markup.pathsGroupedBy>TAGS</swagger2markup.pathsGroupedBy>
                        <swagger2markup.generatedExamplesEnabled>true</swagger2markup.generatedExamplesEnabled>

                        <swagger2markup.extensions.dynamicOverview.contentPath>${project.basedir}/src/docs/asciidoc/extensions/overview</swagger2markup.extensions.dynamicOverview.contentPath>
                        <swagger2markup.extensions.dynamicDefinitions.contentPath>${project.basedir}/src/docs/asciidoc/extensions/definitions</swagger2markup.extensions.dynamicDefinitions.contentPath>
                        <swagger2markup.extensions.dynamicPaths.contentPath>${project.basedir}/src/docs/asciidoc/extensions/paths</swagger2markup.extensions.dynamicPaths.contentPath>
                        <swagger2markup.extensions.dynamicSecurity.contentPath>${project.basedir}src/docs/asciidoc/extensions/security/</swagger2markup.extensions.dynamicSecurity.contentPath>

                        <swagger2markup.extensions.springRestDocs.snippetBaseUri>${project.basedir}/target/docs/asciidoc/snippets</swagger2markup.extensions.springRestDocs.snippetBaseUri>
                        <swagger2markup.extensions.springRestDocs.defaultSnippets>true</swagger2markup.extensions.springRestDocs.defaultSnippets>
                    </config>
                </configuration>
include::{generated}/overview.adoc[]
include::example.adoc[]
include::{generated}/paths.adoc[]
include::{generated}/security.adoc[]
include::{generated}/definitions.adoc[]

Tags are only appended to overview.adoc like this:

== Tags
User JWT::Public users::Account::Users::

It even breaks my layout by not adding page break for next document (example.adoc):

image

image

Debugging the plugin, I can see that pathsGroupedBy configuration is set fine to TAGS, but the transformation never happens.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant