fixed gh pages

Revert "Added signing"

.github/workflows/gradle-build.yml

@@ -0,0 +1,82 @@
+# This workflow will build a Java project with Gradle
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+name: Build
+on:
+  push:
+    branches: [ 1.3.x ]
+  pull_request:
+    branches: [ 1.3.x ]
+jobs:
+  validation:
+    name: "Gradle wrapper validation"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.5
+      - uses: gradle/wrapper-validation-action@v1.0.4
+  build:
+    name: "Build and publish"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.5
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up JDK 11
+        uses: actions/setup-java@v2
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v2.1.6
+        if: env.SONAR_TOKEN != null && env.SONAR_TOKEN != ''
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Build
+        id: gradle
+        uses: eskatos/gradle-command-action@v1
+        with:
+          arguments: check
+          wrapper-cache-enabled: true
+          dependencies-cache-enabled: true
+          configuration-cache-enabled: true
+      - name: "Comment build scan url"
+        uses: actions/github-script@v5
+        if: github.event_name == 'pull_request' && failure()
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            github.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: '❌ ${{ github.workflow }} failed: ${{ steps.gradle.outputs.build-scan-url }}'
+            })
+      - name: Publish Unit Test Results
+        uses: EnricoMi/publish-unit-test-result-action/composite@v1
+        if: always()
+        with:
+          files: '**/test-results/**/*.xml'
+      - name: Analyze with SonarCloud
+        continue-on-error: true
+        if: env.SONAR_TOKEN != null && env.SONAR_TOKEN != ''
+        uses: eskatos/gradle-command-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          arguments: sonarqube -Psonar.organization=swagger2markup
+          dependencies-cache-enabled: true
+          configuration-cache-enabled: true
+      - name: Publish to Sonatype
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/1.3.x' }}
+        uses: eskatos/gradle-command-action@v1
+        env:
+          ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USER }}
+          ORG_GRADLE_PROJECT_sonatypePassword : ${{ secrets.SONATYPE_PASSWORD }}
+        with:
+          arguments: publishToSonatype
+          dependencies-cache-enabled: true
+          configuration-cache-enabled: true          

.gitignore

@@ -3,3 +3,6 @@
 .gradle
 build
 /bin/
+/.classpath
+/.project
+/.settings/

.travis.yml

@@ -1,19 +1,18 @@
 language: java
 jdk:
-- oraclejdk7
+- openjdk8
 before_install:
 - chmod +x gradlew
 after_success:
 - ./gradlew jacocoTestReport coveralls
 - ./gradlew artifactoryPublish -PbintrayUsername="${BINTRAY_USER}" -PbintrayApiKey="${BINTRAY_KEY}"
+- ./gradlew publishGhPages -PgithubUser="${GITHUB_USER}" -PgithubPassword="${GITHUB_PASSWORD}"
+  --stacktrace
 notifications:
-  webhooks:
-    urls:
-    - https://webhooks.gitter.im/e/9c620e84679284b7d621
-    on_success: change
-    on_failure: always
-    on_start: false
+  slack: swagger2markup:Zz5kz0SnvtG6aVvZUM8yMkER
 env:
   global:
-  - secure: "SPKolgUdjIa/uJ+7/B/GPFlsa8IZg7NuZdFA8zROTaqew/xu+oX7qVGImseeBpPIEPJb02ac6hr7Y3/zvv0GJxIPtIbyDzVh73ImQUhT1ttLYGJfITAWqAPFF7RNNMtuOl3S2DLZ5OMJddkcFp00pa9nyI82Gk47B8GsaGIntAI="
-  - secure: "nXXuHfvFACZwdiFM3Ta0x/f49N7cAgi0AMkgEnQrh/2xWlvQk2z2ySGJQLkhJ7Wy8LDY7Yt1b1GUt6DlP3PuFFMW/cT4iARewqiJRXZXxUQz8fpTDeTo1nmVmW/zzII6Qj3QHM3NRbR/xDOVSJiT30Hnq2hcCBQJWYsTICmzjRk="
+  - secure: SPKolgUdjIa/uJ+7/B/GPFlsa8IZg7NuZdFA8zROTaqew/xu+oX7qVGImseeBpPIEPJb02ac6hr7Y3/zvv0GJxIPtIbyDzVh73ImQUhT1ttLYGJfITAWqAPFF7RNNMtuOl3S2DLZ5OMJddkcFp00pa9nyI82Gk47B8GsaGIntAI=
+  - secure: nXXuHfvFACZwdiFM3Ta0x/f49N7cAgi0AMkgEnQrh/2xWlvQk2z2ySGJQLkhJ7Wy8LDY7Yt1b1GUt6DlP3PuFFMW/cT4iARewqiJRXZXxUQz8fpTDeTo1nmVmW/zzII6Qj3QHM3NRbR/xDOVSJiT30Hnq2hcCBQJWYsTICmzjRk=
+  - secure: Ia/wJ572M2II76roFeGEVCzIiktG4v2j/reSn60fpk1gnoEPQEObL4j1dbVCgXBLz54YWcaQ3mICvOfBPPEl9IIV3Y6DDE2sBOmB3soznfdA/YVnJx0h0f1pfXu1dwqoiv1sgc1wewQuUWq+FV7xeDhFE3cnh9CXIexe9ykip8k=
+  - secure: GWfhYDsHRmTfOuEOIcHY8kT4jKBTbdhNLDQ/2amY06xenFblb4pEn6pgmn4IdK3ytjNovnZPTOOK8HqdEjhbfIGoQt6PZwuyANn4Df+zdqOC0+V+7DFG2QhEhbRCyEwPlDqTPjxlOMfAmvjFuY/NvQywoF3PYUyMfJwUV8ehmYk=

ISSUE_TEMPLATE

@@ -0,0 +1,5 @@
+Thanks for raising a Swagger2Markup issue. Please provide a brief description of your problem along with the Swagger2Markup version you are using. If possible, please also consider putting together a complete Swagger specification that reproduces the issue. It's better if the Swagger specification is small and isolate the issue.
+
+Swagger2Markup version:
+
+Problem description:

README.adoc

@@ -2,11 +2,22 @@
 :author: Robert Winkler
 :hardbreaks:
 
-image:https://travis-ci.org/Swagger2Markup/swagger2markup.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/swagger2markup"] image:https://coveralls.io/repos/Swagger2Markup/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/Swagger2Markup/swagger2markup"] image:https://api.bintray.com/packages/robwin/maven/swagger2markup/images/download.svg[link="https://bintray.com/robwin/maven/swagger2markup/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
+image:https://travis-ci.org/Swagger2Markup/swagger2markup.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/swagger2markup"] image:https://coveralls.io/repos/Swagger2Markup/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/Swagger2Markup/swagger2markup"] image:https://api.codacy.com/project/badge/grade/498a6a39d7d84ff687546359f58ee18d["Codacy code quality", link="https://www.codacy.com/app/robwin/swagger2markup"] image:https://api.bintray.com/packages/swagger2markup/Maven/swagger2markup/images/download.svg[link="https://bintray.com/swagger2markup/Maven/swagger2markup/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
 
 
 == Overview
 
+
+NOTE: Dear community,
+unfortunately I can't maintain Swagger2Markup alone anymore. There are many interesting new topics:
+1) Swagger v3 support
+2) Fixing bugs
+2) Merge Swagger2Markup repositories and create a new multi-module repository.
+Any help is welcome.
+Kind regards,
+Robert
+
+
 The primary goal of this project is to *simplify the generation of an up-to-date RESTful API documentation by combining documentation that's been hand-written with auto-generated API documentation* produced by https://github.com/swagger-api[Swagger]. The result is intended to be an *up-to-date, easy-to-read, on- and offline user guide*, comparable to https://developer.github.com/v3/[GitHub's API documentation]. The output of Swagger2Markup can be used as an alternative to https://github.com/swagger-api/swagger-ui[swagger-ui] and can be served as static content.
 NOTE: The Swagger Specification has been donated to to the https://openapis.org/[Open API Initiative (OAI)] and has been renamed to the https://github.com/OAI/OpenAPI-Specification[OpenAPI Specification].
 
@@ -18,16 +29,16 @@ http://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc] is preferable to M
 
 You can generate your HTML5, PDF and EPUB documentation via https://github.com/asciidoctor/asciidoctorj[asciidoctorj] or even better via the https://github.com/asciidoctor/asciidoctor-gradle-plugin[asciidoctor-gradle-plugin] or https://github.com/asciidoctor/asciidoctor-maven-plugin[asciidoctor-maven-plugin].
 
-The project requires at least JDK 7.
+The project requires at least JDK 8.
 
 == Example
 
-image::src/docs/asciidoc/images/Swagger2Markup.PNG[]
+image::swagger2markup-documentation/src/docs/asciidoc/images/Swagger2Markup.PNG[]
 
-image::src/docs/asciidoc/images/Swagger2Markup_definitions.PNG[]
+image::swagger2markup-documentation/src/docs/asciidoc/images/Swagger2Markup_definitions.PNG[]
 
 == Reference documentation
-- http://swagger2markup.readme.io/[Reference Documentation]
+- http://swagger2markup.github.io/swagger2markup/1.3.4/[Reference Documentation]
 - https://github.com/Swagger2Markup/swagger2markup/blob/master/RELEASENOTES.adoc[Release notes]
 - https://github.com/Swagger2Markup/spring-swagger2markup-demo[Demo using Swagger2Markup, Spring Boot, Springfox and spring-restdocs]
 
@@ -37,14 +48,6 @@ image::src/docs/asciidoc/images/Swagger2Markup_definitions.PNG[]
 
 Pull requests are welcome.
 
-* New feature https://github.com/Swagger2Markup/swagger2markup/issues/18[Swagger2Markup/swagger2Markup#18] by https://github.com/sg-ad[@sg-ad]: In addition to the definitions.adoc you can also generate separate files for each definition model (ex: person.adoc, address.adoc, purchase.adoc).
-
-* New feature https://github.com/Swagger2Markup/swagger2markup/issues/21[Swagger2Markup/swagger2Markup#21] by https://github.com/redowl[@redowl]: Support for both reference models and composed models.
-
-* New feature https://github.com/Swagger2Markup/swagger2markup/issues/27[Swagger2Markup/swagger2Markup#27] by https://github.com/zmitrok[@zmitrok]: Added a hook to preprocess a Swagger Model before it is converted.
-
-* New feature https://github.com/Swagger2Markup/swagger2markup/issues/48[Swagger2Markup/swagger2Markup#48] by https://github.com/MeteorBoom[@MeteorBoom]: Multi language support.
-
 === Questions
 You can ask questions about Swagger2Markup in https://gitter.im/Swagger2Markup/swagger2markup[Gitter].
 
@@ -61,6 +64,9 @@ If you’d like an enhancement to be made to Swagger2Markup, pull requests are m
 * http://www.qaware.de/[QAware GmbH]
 * http://www.appdirect.com/[AppDirect] -- The leading commerce platform for selling cloud services.
 * http://www.wescale.com[wescale]
+* http://taskassure.com[TaskAssure] 
+* https://www.isaac.nl[ISAAC]
+* https://www.spreadshirt.de[Spreadshirt]
 
 == License
 

RELEASENOTES.adoc

@@ -3,6 +3,21 @@
 == Version 0.1.0
 * Initial version with support for AsciiDoc and Markdown
 
+=== Version 0.1.1
+* Signed jar files
+
+=== Version 0.1.2
+* Removed logback from compile dependency
+
+=== Version 0.1.3
+* Removed commons.io from compile dependency
+
+=== Version 0.1.4
+* Fixed SECTION_TITLE_LEVEL3 in Markdown enum
+
+=== Version 0.1.5
+* Added SECTION_TITLE_LEVEL4
+
 == Version 0.2.0
 * This version is not downward compatible. This version supports includes of example files and JSON/XML Schema files. See documentation.
 
@@ -78,9 +93,80 @@
 
 === Version 0.9.3
 * Updated swagger-parser from v1.0.13 to v1.0.16
-* Enhancement #61 Refactor separated documents logic to support inter-document cross-references
-* Enhancement #53 : support for tags, paths and methods ordering
-* Enhancement #51 : Support for separated operations files
+* Enhancement #61: Refactor separated documents logic to support inter-document cross-references
+* Enhancement #53: Support for tags, paths and methods ordering
+* Enhancement #51: Support for separated operations files
 * Enhancement #52: Markdown generation for inline schemas
 
+== Version 1.0.0
+* New configuration API
+* New extension SPI
+* Added new languages: turkish, german, france
+* New security document
+* Inline schema support
+* New configuration options
+* Support of deprecated path operations
+
+=== Version 1.0.1
+* Enhancement: Support to render validation constraints of properties
+* Enhancement: Possibility to disable rendering of the security chapter below operations
+
+== Version 1.1.0
+* PR #177: Fixed rendering of recursive examples
+* PR #186: Add support for Chinese language
+* PR #190: Add support for Spanish language
+* PR #192: Updated min/max value to format correctly based on the data type
+* PR #193: Added support for exclusiveMin and exclusiveMax
+* Changed bold to ** and italic to __ so that special chars in the text are possible
+
+=== Version 1.1.1
+* Issue #194: Added a config parameter which allows to prepend the basePath to all paths.
+* Updated swagger-parser from v1.0.16 to v1.0.23
+* Added javslang v2.0.4 as a dependency
+* Added paleo-core v0.10.1 as a dependency
+* Updated markup-document-builder from 1.0.0 to 1.1.0
+* PR #201: Add support for Brazilian Portuguese language
+* PR #202: Add support for Japanese language
+* Issue #205: Fixed the option to influence resource ordering
+* Issue #198: Chinese chinese language encoding
+* Issue #207: Properties that start with an underscore are displayed correctly now
+* Refactored Swagger2Markup to use a Component-Based design. A document can be composed of components and components can be composed of other components.
+* Added a method to add page breaks.
+
+== Version 1.1.2
+* Improve code blocks in markdown
+
+== Version 1.2.0
+* Issue #214: Add page break locations
+* Issue #223: Improve example rendering
+* Issue #215: Add ability to group operations by RegEx
+* Added new configuration options: pageBreakLocations, headerRegex
+* Added new valid value for configuration headerRegex: REGEX
+* Updated markup-document-builder from 1.1.0 to 1.1.1
+
+== Version 1.3.0
+* Updated javslang from 2.0.4 to 2.0.5
+* Updated paleo-core from 0.10.1 to 0.10.2
+* Updated swagger-parser from v1.0.23 to v1.0.25
+* Decimal numbers are formatted into locale-specific strings
+
+=== Version 1.3.1
+* PR #247: Fix request path and query params example support.
+
+=== Version 1.3.2
+* PR #290: Fixed list parsing in properties file
+* PR #293: Fixed crash on empty tables
+* Updated markup-document-builder from 1.1.1 to 1.1.2
+
+=== Version 1.3.3
+* Updated swagger-parser from v1.0.25 to 1.0.35
+* PR #294: Examples always start with a newline if there is other content in the same cell
+* PR 307: Include required parameters in example request
+
+=== Version 1.3.4
+* Moved from bintray to Sonatype
+* Introduced Github actions
+* Certain bug fixes
+* Added support for MIME types with structured syntax suffixes (#410)
+
 

build.gradle

@@ -1,134 +1,117 @@
-buildscript {
+plugins {
+    id "org.sonarqube" version "2.7"
+    id "me.champeau.gradle.jmh" version "0.4.8"
+    id 'org.asciidoctor.convert' version '1.6.0'
+    id "org.ajoberstar.github-pages" version "1.7.2"
+    id "io.github.gradle-nexus.publish-plugin"  version "1.1.0"
+}
+apply plugin: 'idea'
+apply from: "${rootDir}/libraries.gradle"
+
+ext {
+    releaseVersion = '1.3.4'
+}
+
+allprojects {
+    apply plugin: 'jacoco'
+    apply plugin: 'me.champeau.gradle.jmh'
+
+    version = '1.3.4'
+    group 'io.github.swagger2markup'
+    description = 'swagger2markup Build'
+
     repositories {
         jcenter()
         mavenCentral()
     }
-    dependencies {
-        classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.3'
-        classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.10.1'
-        classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1'
-        classpath 'org.asciidoctor:asciidoctorj:1.5.2'
-        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2'
-        classpath "org.jfrog.buildinfo:build-info-extractor-gradle:4.0.0"
-    }
-}
-description = 'swagger2markup Build'
-version = '1.0.0-SNAPSHOT'
-group = 'io.github.robwin'
-
-apply plugin: 'java'
-apply plugin: 'maven-publish'
-apply plugin: 'org.asciidoctor.convert'
-apply plugin: 'jacoco'
-apply plugin: 'com.github.kt3k.coveralls'
-apply plugin: 'com.jfrog.bintray'
-apply plugin: "com.jfrog.artifactory"
-apply from: 'gradle/publishing.gradle'
-
-tasks.withType(JavaCompile) {
-    sourceCompatibility = "1.7"
-    targetCompatibility = "1.7"
-    options.deprecation = true
-    options.encoding = 'UTF-8'
-    options.compilerArgs << "-Xlint:unchecked"
-}
-
-repositories {
-    maven {
-        url "https://oss.jfrog.org/artifactory/oss-snapshot-local"
-    }
-    jcenter()
-    mavenCentral()
-    //mavenLocal()
-}
-
-dependencies {
-    compile 'io.github.robwin:markup-document-builder:0.1.6-SNAPSHOT'
-    compile 'io.swagger:swagger-compat-spec-parser:1.0.17'
-    testCompile 'junit:junit:4.11'
-    testCompile 'org.asciidoctor:asciidoctorj:1.5.4'
-    testCompile 'ch.qos.logback:logback-classic:1.1.2'
-    testCompile 'org.assertj:assertj-core:2.2.0'
-    testCompile 'com.sksamuel.diff:diff:1.1.11'
-}
-
-task sourcesJar(type: Jar, dependsOn: classes) {
-    classifier = 'sources'
-    from sourceSets.main.allSource
-}
-
-task javadocJar(type: Jar, dependsOn: javadoc) {
-    classifier = 'javadoc'
-    from javadoc.destinationDir
-}
-
-artifacts {
-    archives sourcesJar
-    archives javadocJar
 }
+//artifactoryPublish.skip = true // apply to all projects except the root
 
 ext {
-    generatedDocumentation = file('build/docs/asciidoc/generated')
-}
-
-asciidoctor {
-    sources {
-        include 'index.adoc'
+    coreProjects = subprojects.findAll {
+        p -> !p.name.endsWith("-bom")
     }
-    backends = ['html5', 'pdf']
-    attributes = [
-            doctype: 'book',
-            toc: 'left',
-            toclevels: '3',
-            numbered: '',
-            sectlinks: '',
-            sectanchors: '',
-            hardbreaks: '',
-            generated: generatedDocumentation
-    ]
 }
 
-artifactory {
-    contextUrl = 'https://oss.jfrog.org'
-    resolve {
-        repository {
-            repoKey = 'libs-release'
+configure(project.coreProjects) {
+    apply plugin: 'signing'
+    apply plugin: 'java'
+    apply plugin: 'maven'
+    apply plugin: 'maven-publish'
+    apply from: "${rootDir}/publishing.gradle"
+    apply plugin: 'jacoco'
+
+    tasks.withType(JavaCompile) {
+        sourceCompatibility = "11"
+        targetCompatibility = "11"
+        options.deprecation = true
+        options.encoding = 'UTF-8'
+        options.compilerArgs += ["-Xlint:unchecked", "-parameters"]
+    }
+    tasks.withType(Javadoc){
+        options.encoding = 'UTF-8'
+    }
+    jmh {
+        duplicateClassesStrategy = 'warn'
+    }
+    configurations.all {
+        resolutionStrategy {
+            failOnVersionConflict()
         }
     }
-    publish {
-        repository {
-            repoKey = 'oss-snapshot-local' //The Artifactory repository key to publish to
-            //when using oss.jfrog.org the credentials are from Bintray. For local build we expect them to be found in
-            //~/.gradle/gradle.properties, otherwise to be set in the build server
-            username = project.hasProperty('bintrayUsername') ? project.bintrayUsername : System.getenv('BINTRAY_USER')
-            password = project.hasProperty('bintrayApiKey') ? project.bintrayApiKey : System.getenv('BINTRAY_KEY')
-        }
-        defaults {
-            publications('mavenJava')
+}
+
+nexusPublishing {
+    repositories {
+        sonatype()
+    }
+}
+
+sonarqube {
+    properties {
+        property "sonar.host.url", "https://sonarcloud.io"
+        property "sonar.organization", "swagger2markup"
+        property "sonar.projectName", "swagger2markup"
+        property "sonar.projectKey", "Swagger2Markup_swagger2markup"
+        property "sonar.links.homepage", "https://github.com/Swagger2Markup/swagger2markup"
+        property "sonar.links.ci", "https://travis-ci.org/Swagger2Markup/swagger2markup"
+        property "sonar.links.scm", "https://github.com/Swagger2Markup/swagger2markup"
+        property "sonar.links.issue", "https://github.com/Swagger2Markup/swagger2markup/issues"
+        property "sonar.language", "java"
+    }
+}
+def allTestCoverageFile = "$buildDir/jacoco/allTestCoverage.exec"
+
+task jacocoMergeTest(type: JacocoMerge) {
+    destinationFile = file(allTestCoverageFile)
+    executionData = project.fileTree(dir: '.', include: '**/build/jacoco/test.exec')
+}
+
+task jacocoMerge(dependsOn: ['jacocoMergeTest']) {
+    // used to run the other merge tasks
+}
+
+subprojects {
+    sonarqube {
+        properties {
+            property "sonar.jacoco.reportPaths", allTestCoverageFile
         }
     }
-    if (System.properties['https.proxyHost']) {
-        clientConfig.proxy.host = System.properties['https.proxyHost']
-        clientConfig.proxy.port = System.properties['https.proxyPort'].toInteger()
-    }
-
-}
-
-jacocoTestReport {
-    reports {
-        xml.enabled = true // coveralls plugin depends on xml format report
-        html.enabled = true
+    afterEvaluate {
+        // exclude subprojects that don't produce a jar file or by design.
+        if (!project.name.equals('swagger2markup-bom') && !project.name.equals('swagger2markup-documentation')) {
+            jar {
+                inputs.property('moduleName', moduleName)
+                manifest.attributes(
+                        'Automatic-Module-Name': moduleName
+                )
+            }
+        }
     }
 }
 
-tasks.coveralls {
-    dependsOn 'check'
-}
+tasks.check.dependsOn tasks.jacocoTestReport
 
-tasks.artifactoryPublish {
-    dependsOn 'check'
-}
-
-task wrapper(type: Wrapper) {
-    gradleVersion = '2.10'
+test {
+    dependsOn(subprojects.test) // required by cobertura to aggregate report
 }

gradle.properties

@@ -0,0 +1,2 @@
+systemProp.file.encoding=UTF-8
+systemProp.sun.jnu.encoding=UTF-8

gradle/publishing.gradle

@@ -1,100 +0,0 @@
-import java.text.SimpleDateFormat
-
-Date buildTimeAndDate = new Date()
-ext {
-    buildDate = new SimpleDateFormat('yyyy-MM-dd').format(buildTimeAndDate)
-    buildTime = new SimpleDateFormat('HH:mm:ss.SSSZ').format(buildTimeAndDate)
-}
-
-def projectArtifactId = 'swagger2markup'
-
-jar {
-    manifest {
-        attributes(
-                'Built-By': 'Robert Winkler',
-                'Created-By': System.properties['java.version'] + " (" + System.properties['java.vendor'] + " " + System.properties['java.vm.version'] + ")",
-                'Build-Date': project.buildDate,
-                'Build-Time': project.buildTime,
-                'Specification-Title': projectArtifactId,
-                'Specification-Version': project.version,
-                'Implementation-Title': projectArtifactId,
-                'Implementation-Version': project.version
-        )
-    }
-}
-
-if (!project.hasProperty('bintrayUsername')) ext.bintrayUsername = ''
-if (!project.hasProperty('bintrayApiKey')) ext.bintrayApiKey = ''
-if (!project.hasProperty('gpgPassphrase')) ext.gpgPassphrase = ''
-if (!project.hasProperty('ossUser')) ext.ossUser = ''
-if (!project.hasProperty('ossPassword')) ext.ossPassword = ''
-
-bintray {
-    user = project.bintrayUsername
-    key = project.bintrayApiKey
-    dryRun = false //Whether to run this as dry-run, without deploying
-    publish = true //If version should be auto published after an upload
-    publications = ['mavenJava']
-    pkg {
-        repo = 'maven'
-        name = 'swagger2markup'
-        websiteUrl = 'https://github.com/Swagger2Markup/swagger2markup'
-        issueTrackerUrl = 'https://github.com/Swagger2Markup/swagger2markup/issues'
-        vcsUrl = 'https://github.com/Swagger2Markup/swagger2markup.git'
-        desc = 'A Swagger to Markup (AsciiDoc and Markdown) converter.'
-        licenses = ['Apache-2.0']
-        version {
-            vcsTag = project.version
-            gpg {
-                sign = true //Determines whether to GPG sign the files. The default is false
-                passphrase = project.gpgPassphrase //Optional. The passphrase for GPG signing'
-            }
-            mavenCentralSync {
-                sync = true //Optional (true by default). Determines whether to sync the version to Maven Central.
-                user = ossUser //OSS user token
-                password = ossPassword //OSS user password
-            }
-        }
-    }
-}
-
-publishing {
-    publications {
-        mavenJava(MavenPublication) {
-            from components.java
-            pom.withXml {
-                def devs = ['RobWin': 'Robert Winkler']
-                def root = asNode()
-
-                root.dependencies.'*'.findAll() {
-                    it.scope.text() == 'runtime' && project.configurations.compile.allDependencies.find { dep ->
-                        dep.name == it.artifactId.text()
-                    }
-                }.each() {
-                    it.scope*.value = 'compile'
-                }
-
-                root.appendNode('name', 'swagger2markup')
-                root.appendNode('packaging', 'jar')
-                root.appendNode('url', 'https://github.com/Swagger2Markup/swagger2markup')
-                root.appendNode('description', 'A Swagger to Markup (AsciiDoc and Markdown) converter.')
-
-                def license = root.appendNode('licenses').appendNode('license')
-                license.appendNode('name', 'Apache-2.0')
-                license.appendNode('url', 'https://github.com/Swagger2Markup/swagger2markup/blob/master/LICENSE.txt')
-                license.appendNode('distribution', 'repo')
-
-                root.appendNode('scm').appendNode('url', 'https://github.com/Swagger2Markup/swagger2markup.git')
-
-                def developers = root.appendNode('developers')
-                devs.each {
-                    def d = developers.appendNode('developer')
-                    d.appendNode('id', it.key)
-                    d.appendNode('name', it.value)
-                }
-            }
-            artifact sourcesJar
-            artifact javadocJar
-        }
-    }
-}

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Wed Feb 10 11:09:13 CET 2016
+#Mon Oct 21 16:35:38 BST 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-2.10-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.3-all.zip

gradlew

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
 
 ##############################################################################
 ##
@@ -6,42 +6,6 @@
 ##
 ##############################################################################
 
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
-
-APP_NAME="Gradle"
-APP_BASE_NAME=`basename "$0"`
-
-# Use the maximum available, or set MAX_FD != -1 to use that value.
-MAX_FD="maximum"
-
-warn ( ) {
-    echo "$*"
-}
-
-die ( ) {
-    echo
-    echo "$*"
-    echo
-    exit 1
-}
-
-# OS specific support (must be 'true' or 'false').
-cygwin=false
-msys=false
-darwin=false
-case "`uname`" in
-  CYGWIN* )
-    cygwin=true
-    ;;
-  Darwin* )
-    darwin=true
-    ;;
-  MINGW* )
-    msys=true
-    ;;
-esac
-
 # Attempt to set APP_HOME
 # Resolve links: $0 may be a link
 PRG="$0"
@@ -60,6 +24,46 @@ cd "`dirname \"$PRG\"`/" >/dev/null
 APP_HOME="`pwd -P`"
 cd "$SAVED" >/dev/null
 
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
 # Determine the Java command to use to start the JVM.
@@ -85,7 +89,7 @@ location of your Java installation."
 fi
 
 # Increase the maximum file descriptors if we can.
-if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
     MAX_FD_LIMIT=`ulimit -H -n`
     if [ $? -eq 0 ] ; then
         if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
@@ -150,11 +154,19 @@ if $cygwin ; then
     esac
 fi
 
-# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
-function splitJvmOpts() {
-    JVM_OPTS=("$@")
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
 }
-eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
-JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
+APP_ARGS=$(save "$@")
 
-exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -8,14 +8,14 @@
 @rem Set local scope for the variables with windows NT shell
 if "%OS%"=="Windows_NT" setlocal
 
-@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
-
 set DIRNAME=%~dp0
 if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS=
+
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome
 
@@ -46,10 +46,9 @@ echo location of your Java installation.
 goto fail
 
 :init
-@rem Get command-line arguments, handling Windowz variants
+@rem Get command-line arguments, handling Windows variants
 
 if not "%OS%" == "Windows_NT" goto win9xME_args
-if "%@eval[2+2]" == "4" goto 4NT_args
 
 :win9xME_args
 @rem Slurp the command line arguments.
@@ -60,11 +59,6 @@ set _SKIP=2
 if "x%~1" == "x" goto execute
 
 set CMD_LINE_ARGS=%*
-goto execute
-
-:4NT_args
-@rem Get arguments from the 4NT Shell from JP Software
-set CMD_LINE_ARGS=%$
 
 :execute
 @rem Setup the command line

libraries.gradle

@@ -0,0 +1,52 @@
+// Allows centralized definition of the version of artifacts to
+// use.  In that respect it serves a role similar to <dependencyManagement> in Maven
+ext {
+    implLibraries = [:]
+    testLibraries = [:]
+    dependencyOverrides = [:]
+}
+implLibraries = [
+        asciiDocJApi  : "org.asciidoctor:asciidoctorj-api:2.2.0",
+        commonsBeanUtils   : "commons-beanutils:commons-beanutils:1.9.4",
+        commonsCodec       : "commons-codec:commons-codec:1.13",
+        commonsCollections4: "org.apache.commons:commons-collections4:4.4",
+        commonsConf2       : "org.apache.commons:commons-configuration2:2.6",
+        commonsLang3       : "org.apache.commons:commons-lang3:3.9",
+        commonsIO          : "commons-io:commons-io:2.6",
+        commonsText        : "org.apache.commons:commons-text:1.8",
+        guava              : 'com.google.guava:guava:27.0.1-android',
+        jacksonDatabind    : 'com.fasterxml.jackson.core:jackson-databind:2.9.10',
+        mark2Ascii         : "nl.jworks.markdown_to_asciidoc:markdown_to_asciidoc:1.1",
+        paleo              : "ch.netzwerg:paleo-core:0.14.0",
+        pegdown            : "org.pegdown:pegdown:1.6.0",
+        slf4j              : "org.slf4j:slf4j-api:1.7.28",
+        swaggerV2          : "io.swagger:swagger-parser:1.0.47",
+        swaggerV2Converter : "io.swagger.parser.v3:swagger-parser-v2-converter:2.0.15",
+        swaggerV3          : "io.swagger.parser.v3:swagger-parser:2.0.15",
+        vavr               : "io.vavr:vavr:0.10.2"
+]
+
+testLibraries = [
+        asciiDocJ  : "org.asciidoctor:asciidoctorj:2.2.0",
+        assertj    : "org.assertj:assertj-core:3.13.2",
+        assertjDiff: "io.github.robwin:assertj-diff:0.1.1",
+        junit      : "junit:junit:4.12",
+        logback    : "ch.qos.logback:logback-classic:1.2.3",
+        mockito    : "org.mockito:mockito-core:3.1.0"
+]
+
+dependencyOverrides = [
+        assertj        : testLibraries.assertj,
+        commonsCodec   : implLibraries.commonsCodec,
+        commonsIO      : implLibraries.commonsIO,
+        commonsLang3   : implLibraries.commonsLang3,
+        findBugs       : 'com.google.code.findbugs:jsr305:3.0.2',
+        guava          : implLibraries.guava,
+        jaksonCore     : 'com.github.fge:jackson-coreutils:1.8',
+        jacksonDatabind: implLibraries.jacksonDatabind,
+        jnrConstants   : 'com.github.jnr:jnr-constants:0.9.12',
+        jnrEnxio       : 'com.github.jnr:jnr-enxio:0.19',
+        jnrPosix       : 'com.github.jnr:jnr-posix:3.0.49',
+        jodaTime       : 'joda-time:joda-time:2.9.9',
+        slf4j          : implLibraries.slf4j,
+]

publishing.gradle

@@ -0,0 +1,91 @@
+import java.text.SimpleDateFormat
+
+Date buildTimeAndDate = new Date()
+ext {
+    buildDate = new SimpleDateFormat('yyyy-MM-dd').format(buildTimeAndDate)
+    buildTime = new SimpleDateFormat('HH:mm:ss.SSSZ').format(buildTimeAndDate)
+    licenseUrl = 'https://github.com/Swagger2Markup/swagger2markup/blob/master/LICENSE.txt'
+    scmUrl = 'https://github.com/Swagger2Markup/swagger2markup.git'
+}
+
+def projectArtifactId = 'swagger2markup'
+def projectUrl = 'https://github.com/Swagger2Markup/swagger2markup'
+def licenseUrl = 'https://github.com/Swagger2Markup/swagger2markup/blob/master/LICENSE.txt'
+def scmUrl = 'https://github.com/Swagger2Markup/swagger2markup.git'
+def issuesUrl = 'https://github.com/Swagger2Markup/swagger2markup/issues'
+
+jar {
+    manifest {
+        attributes(
+                'Built-By': 'Robert Winkler',
+                'Created-By': System.properties['java.version'] + " (" + System.properties['java.vendor'] + " " + System.properties['java.vm.version'] + ")",
+                'Build-Date': project.buildDate,
+                'Build-Time': project.buildTime,
+                'Specification-Title': projectArtifactId,
+                'Specification-Version': project.version,
+                'Implementation-Title': projectArtifactId,
+                'Implementation-Version': project.version
+        )
+    }
+}
+
+task sourcesJar(type: Jar) {
+    from sourceSets.main.allJava
+    archiveClassifier = 'sources'
+}
+
+task javadocJar(type: Jar) {
+    from javadoc
+    archiveClassifier = 'javadoc'
+}
+
+artifacts {
+    archives sourcesJar
+    archives javadocJar
+}
+
+signing {
+    sign publishing.publications
+}
+
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+            from components.java
+            pom.withXml {
+                def devs = ['RobWin': 'Robert Winkler',
+                            'austek': 'Ali Ustek']
+                def root = asNode()
+
+                root.dependencies.'*'.findAll() {
+                    it.scope.text() == 'runtime' && project.configurations.compile.allDependencies.find { dep ->
+                        dep.name == it.artifactId.text()
+                    }
+                }.each() {
+                    it.scope*.value = 'compile'
+                }
+
+                root.appendNode('name', projectArtifactId)
+                root.appendNode('packaging', 'jar')
+                root.appendNode('url', projectUrl)
+                root.appendNode('description', project.description)
+
+                def license = root.appendNode('licenses').appendNode('license')
+                license.appendNode('name', 'Apache-2.0')
+                license.appendNode('url', licenseUrl)
+                license.appendNode('distribution', 'repo')
+
+                root.appendNode('scm').appendNode('url', scmUrl)
+
+                def developers = root.appendNode('developers')
+                devs.each {
+                    def d = developers.appendNode('developer')
+                    d.appendNode('id', it.key)
+                    d.appendNode('name', it.value)
+                }
+            }
+            artifact sourcesJar
+            artifact javadocJar
+        }
+    }
+}

settings.gradle

@@ -1 +1,9 @@
-rootProject.name = 'swagger2markup'
+rootProject.name = 'swagger2markup'
+
+include 'swagger2markup-asciidoc'
+include 'swagger2markup-bom'
+include 'swagger2markup-builder'
+include 'swagger2markup-documentation'
+include 'swagger2markup'
+include 'swagger2markup-core'
+

src/docs/asciidoc/getting_started.adoc

@@ -1,36 +0,0 @@
-== Getting started
-
-The project is published in JCenter and Maven Central. If you use Gradle or Maven, you can include Swagger2Markup as follows.
-
-=== Gradle
-[source,groovy, subs="attributes"]
-----
-repositories {
-    mavenCentral()
-    jCenter()
-}
-
-compile "io.github.robwin:swagger2markup:{project-version}"
-----
-
-=== Maven
-[source,xml, subs="attributes, verbatim"]
-----
-<repositories>
-    <repository>
-        <snapshots>
-            <enabled>false</enabled>
-        </snapshots>
-        central
-        <name>bintray</name>
-        <url>http://jcenter.bintray.com</url>
-    </repository>
-</repositories>
-
-<dependency>
-    <groupId>io.github.robwin</groupId>
-    <artifactId>swagger2markup</artifactId>
-    <version>{project-version}</version>
-</dependency>
-----
-

src/docs/asciidoc/index.adoc

@@ -1,20 +0,0 @@
-= Swagger2Markup User Guide
-Robert Winkler
-:toc: left
-:toclevels: 3
-:source-highlighter: coderay
-:numbered:
-:hardbreaks:
-:revnumber: {project-version}
-:revdate: {localdate}
-:icons: font
-:pagenums:
-
-include::introduction.adoc[]
-
-include::getting_started.adoc[]
-
-include::usage_guide.adoc[]
-
-include::license.adoc[]
-

src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConfig.java

@@ -1,764 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup;
-
-import com.google.common.base.Function;
-import com.google.common.collect.Ordering;
-import io.github.robwin.markup.builder.LineSeparator;
-import io.github.robwin.markup.builder.MarkupLanguage;
-import io.github.robwin.swagger2markup.internal.model.PathOperation;
-import io.github.robwin.swagger2markup.internal.utils.IOUtils;
-import io.swagger.models.HttpMethod;
-import io.swagger.models.parameters.Parameter;
-import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.lang3.Validate;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.net.URI;
-import java.nio.file.Path;
-import java.util.Comparator;
-import java.util.Properties;
-
-public class Swagger2MarkupConfig {
-
-    private static final Logger logger = LoggerFactory.getLogger(Swagger2MarkupConfig.class);
-
-    private MarkupLanguage markupLanguage;
-    private boolean generatedExamplesEnabled;
-    private boolean operationDescriptionsEnabled;
-    private URI operationDescriptionsUri;
-    private boolean definitionDescriptionsEnabled;
-    private URI definitionDescriptionsUri;
-    private boolean separatedDefinitionsEnabled;
-    private boolean separatedOperationsEnabled;
-    private GroupBy operationsGroupedBy;
-    private Language outputLanguage;
-    private int inlineSchemaDepthLevel;
-    private OrderBy tagOrderBy;
-    private Comparator<String> tagOrdering;
-    private OrderBy operationOrderBy;
-    private Comparator<PathOperation> operationOrdering;
-    private OrderBy definitionOrderBy;
-    private Comparator<String> definitionOrdering;
-    private OrderBy parameterOrderBy;
-    private Comparator<Parameter> parameterOrdering;
-    private OrderBy propertyOrderBy;
-    private Comparator<String> propertyOrdering;
-    private OrderBy responseOrderBy;
-    private Comparator<String> responseOrdering;
-    private boolean interDocumentCrossReferencesEnabled;
-    private String interDocumentCrossReferencesPrefix;
-    private boolean flatBodyEnabled;
-    private String anchorPrefix;
-    private LineSeparator lineSeparator;
-
-    private String overviewDocument;
-    private String pathsDocument;
-    private String definitionsDocument;
-    private String securityDocument;
-    private String separatedOperationsFolder;
-    private String separatedDefinitionsFolder;
-
-    public static Builder ofDefaults() {
-        return new Builder();
-    }
-
-    public static Builder ofProperties(Properties properties) {
-        return new Builder(properties);
-    }
-
-    /**
-     * Global context lazy initialization
-     *
-     * @param globalContext Partially initialized global context (globalContext.extensionRegistry == null)
-     */
-    public void setGlobalContext(Swagger2MarkupConverter.Context globalContext) {
-        configureDefaultContentPaths(globalContext.getSwaggerLocation());
-    }
-
-    /**
-     * Automatically set default path for external content files based on specified {@code swaggerLocation}.<br/>
-     * If {@code swaggerLocation} is null, default path can't be set and features are disabled.<br/>
-     * Paths have to be explicitly set when swaggerLocation.scheme != 'file' to limit the number of URL requests.
-     *
-     * @param swaggerLocation base path to set default paths
-     * @throws RuntimeException if basePath == null and any path is not configured
-     */
-    private void configureDefaultContentPaths(URI swaggerLocation) {
-        URI baseURI = null;
-
-        if (swaggerLocation != null) {
-            if (swaggerLocation.getScheme().equals("file"))
-                baseURI = IOUtils.uriParent(swaggerLocation);
-        }
-
-        if (operationDescriptionsEnabled && operationDescriptionsUri == null) {
-            if (baseURI == null) {
-                if (logger.isWarnEnabled())
-                    logger.warn("Disable {} > No explicit '{}' set and no default available > Disable {}", "operationDescriptionsEnabled", "operationDescriptionsUri");
-                operationDescriptionsEnabled = false;
-            } else
-                operationDescriptionsUri = baseURI;
-        }
-
-        if (definitionDescriptionsEnabled && definitionDescriptionsUri == null) {
-            if (baseURI == null) {
-                if (logger.isWarnEnabled())
-                    logger.warn("Disable {} > No explicit '{}' set and no default available > Disable {}", "definitionDescriptionsEnabled", "definitionDescriptionsUri");
-                definitionDescriptionsEnabled = false;
-            } else
-                definitionDescriptionsUri = baseURI;
-        }
-    }
-
-    public MarkupLanguage getMarkupLanguage() {
-        return markupLanguage;
-    }
-
-    public boolean isGeneratedExamplesEnabled() {
-        return generatedExamplesEnabled;
-    }
-
-    public boolean isOperationDescriptionsEnabled() {
-        return operationDescriptionsEnabled;
-    }
-
-    public URI getOperationDescriptionsUri() {
-        return operationDescriptionsUri;
-    }
-
-    public boolean isDefinitionDescriptionsEnabled() {
-        return definitionDescriptionsEnabled;
-    }
-
-    public URI getDefinitionDescriptionsUri() {
-        return definitionDescriptionsUri;
-    }
-
-    public boolean isSeparatedDefinitionsEnabled() {
-        return separatedDefinitionsEnabled;
-    }
-
-    public boolean isSeparatedOperationsEnabled() {
-        return separatedOperationsEnabled;
-    }
-
-    public GroupBy getOperationsGroupedBy() {
-        return operationsGroupedBy;
-    }
-
-    public Language getOutputLanguage() {
-        return outputLanguage;
-    }
-
-    public int getInlineSchemaDepthLevel() {
-        return inlineSchemaDepthLevel;
-    }
-
-    public OrderBy getTagOrderBy() {
-        return tagOrderBy;
-    }
-
-    public Comparator<String> getTagOrdering() {
-        return tagOrdering;
-    }
-
-    public OrderBy getOperationOrderBy() {
-        return operationOrderBy;
-    }
-
-    public Comparator<PathOperation> getOperationOrdering() {
-        return operationOrdering;
-    }
-
-    public OrderBy getDefinitionOrderBy() {
-        return definitionOrderBy;
-    }
-
-    public Comparator<String> getDefinitionOrdering() {
-        return definitionOrdering;
-    }
-
-    public OrderBy getParameterOrderBy() {
-        return parameterOrderBy;
-    }
-
-    public Comparator<Parameter> getParameterOrdering() {
-        return parameterOrdering;
-    }
-
-    public OrderBy getPropertyOrderBy() {
-        return propertyOrderBy;
-    }
-
-    public Comparator<String> getPropertyOrdering() {
-        return propertyOrdering;
-    }
-
-    public OrderBy getResponseOrderBy() {
-        return responseOrderBy;
-    }
-
-    public Comparator<String> getResponseOrdering() {
-        return responseOrdering;
-    }
-
-    public boolean isInterDocumentCrossReferencesEnabled() {
-        return interDocumentCrossReferencesEnabled;
-    }
-
-    public String getInterDocumentCrossReferencesPrefix() {
-        return interDocumentCrossReferencesPrefix;
-    }
-
-    public boolean isFlatBodyEnabled() {
-        return flatBodyEnabled;
-    }
-
-    public String getAnchorPrefix() {
-        return anchorPrefix;
-    }
-
-    public String getOverviewDocument() {
-        return overviewDocument;
-    }
-
-    public String getPathsDocument() {
-        return pathsDocument;
-    }
-
-    public String getDefinitionsDocument() {
-        return definitionsDocument;
-    }
-
-    public String getSecurityDocument() {
-        return securityDocument;
-    }
-
-    public String getSeparatedOperationsFolder() {
-        return separatedOperationsFolder;
-    }
-
-    public String getSeparatedDefinitionsFolder() {
-        return separatedDefinitionsFolder;
-    }
-
-    public LineSeparator getLineSeparator() {
-        return lineSeparator;
-    }
-
-    public static class Builder {
-
-        private static final String PROPERTIES_PREFIX = "swagger2markup.";
-        private static final String PROPERTIES_DEFAULT = "/io/github/robwin/swagger2markup/config/default.properties";
-
-        static final Ordering<PathOperation> OPERATION_METHOD_NATURAL_ORDERING = Ordering
-                .explicit(HttpMethod.POST, HttpMethod.GET, HttpMethod.PUT, HttpMethod.DELETE, HttpMethod.PATCH, HttpMethod.HEAD, HttpMethod.OPTIONS)
-                .onResultOf(new Function<PathOperation, HttpMethod>() {
-                    public HttpMethod apply(PathOperation operation) {
-                        return operation.getMethod();
-                    }
-                });
-
-        static final Ordering<PathOperation> OPERATION_PATH_NATURAL_ORDERING = Ordering
-                .natural()
-                .onResultOf(new Function<PathOperation, String>() {
-                    public String apply(PathOperation operation) {
-                        return operation.getPath();
-                    }
-                });
-
-        static final Ordering<Parameter> PARAMETER_IN_NATURAL_ORDERING = Ordering
-                .explicit("header", "path", "query", "formData", "body")
-                .onResultOf(new Function<Parameter, String>() {
-                    public String apply(Parameter parameter) {
-                        return parameter.getIn();
-                    }
-                });
-
-        static final Ordering<Parameter> PARAMETER_NAME_NATURAL_ORDERING = Ordering
-                .natural()
-                .onResultOf(new Function<Parameter, String>() {
-                    public String apply(Parameter parameter) {
-                        return parameter.getName();
-                    }
-                });
-
-        Swagger2MarkupConfig config = new Swagger2MarkupConfig();
-
-        Builder() {
-            this(new Properties());
-        }
-
-        Builder(Properties properties) {
-
-            Properties safeProperties = new Properties(defaultProperties());
-            safeProperties.putAll(properties);
-
-            config.markupLanguage = MarkupLanguage.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "markupLanguage"));
-            config.generatedExamplesEnabled = Boolean.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "generatedExamplesEnabled"));
-            config.operationDescriptionsEnabled = Boolean.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "operationDescriptionsEnabled"));
-            if (safeProperties.containsKey(PROPERTIES_PREFIX + "operationDescriptionsUri"))
-                config.operationDescriptionsUri = URI.create(safeProperties.getProperty(PROPERTIES_PREFIX + "operationDescriptionsUri"));
-            config.definitionDescriptionsEnabled = Boolean.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "definitionDescriptionsEnabled"));
-            if (safeProperties.containsKey(PROPERTIES_PREFIX + "definitionDescriptionsUri"))
-                config.definitionDescriptionsUri = URI.create(safeProperties.getProperty(PROPERTIES_PREFIX + "definitionDescriptionsUri"));
-            config.separatedDefinitionsEnabled = Boolean.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "separatedDefinitionsEnabled"));
-            config.separatedOperationsEnabled = Boolean.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "separatedOperationsEnabled"));
-            config.operationsGroupedBy = GroupBy.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "operationsGroupedBy"));
-            config.outputLanguage = Language.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "outputLanguage"));
-            config.inlineSchemaDepthLevel = Integer.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "inlineSchemaDepthLevel"));
-            config.interDocumentCrossReferencesEnabled = Boolean.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "interDocumentCrossReferencesEnabled"));
-            config.interDocumentCrossReferencesPrefix = safeProperties.getProperty(PROPERTIES_PREFIX + "interDocumentCrossReferencesPrefix");
-            config.flatBodyEnabled = Boolean.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "flatBodyEnabled"));
-            config.anchorPrefix = safeProperties.getProperty(PROPERTIES_PREFIX + "anchorPrefix");
-            config.overviewDocument = safeProperties.getProperty(PROPERTIES_PREFIX + "overviewDocument");
-            config.pathsDocument = safeProperties.getProperty(PROPERTIES_PREFIX + "pathsDocument");
-            config.definitionsDocument = safeProperties.getProperty(PROPERTIES_PREFIX + "definitionsDocument");
-            config.securityDocument = safeProperties.getProperty(PROPERTIES_PREFIX + "securityDocument");
-            config.separatedOperationsFolder = safeProperties.getProperty(PROPERTIES_PREFIX + "separatedOperationsFolder");
-            config.separatedDefinitionsFolder = safeProperties.getProperty(PROPERTIES_PREFIX + "separatedDefinitionsFolder");
-            config.tagOrderBy = OrderBy.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "tagOrderBy"));
-            config.operationOrderBy = OrderBy.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "operationOrderBy"));
-            config.definitionOrderBy = OrderBy.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "definitionOrderBy"));
-            config.parameterOrderBy = OrderBy.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "parameterOrderBy"));
-            config.propertyOrderBy = OrderBy.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "propertyOrderBy"));
-            config.responseOrderBy = OrderBy.valueOf(safeProperties.getProperty(PROPERTIES_PREFIX + "responseOrderBy"));
-            String lineSeparator = safeProperties.getProperty(PROPERTIES_PREFIX + "lineSeparator");
-            if(StringUtils.isNoneBlank(lineSeparator)){
-                config.lineSeparator = LineSeparator.valueOf(lineSeparator);
-            }
-        }
-
-        private Properties defaultProperties() {
-            Properties defaultProperties = new Properties();
-            try {
-                InputStream defaultPropertiesStream = Swagger2MarkupConfig.class.getResourceAsStream(PROPERTIES_DEFAULT);
-                if (defaultPropertiesStream == null)
-                    throw new RuntimeException(String.format("Can't load default properties '%s'", PROPERTIES_DEFAULT));
-                defaultProperties.load(defaultPropertiesStream);
-            } catch (IOException e) {
-                throw new RuntimeException(String.format("Can't load default properties '%s'", PROPERTIES_DEFAULT), e);
-            }
-
-            return defaultProperties;
-        }
-
-        public Swagger2MarkupConfig build() {
-            buildNaturalOrdering();
-
-            return config;
-        }
-
-        private void buildNaturalOrdering() {
-            if (config.tagOrderBy == OrderBy.NATURAL)
-                config.tagOrdering = Ordering.natural();
-            if (config.operationOrderBy == OrderBy.NATURAL)
-                config.operationOrdering = OPERATION_PATH_NATURAL_ORDERING.compound(OPERATION_METHOD_NATURAL_ORDERING);
-            if (config.definitionOrderBy == OrderBy.NATURAL)
-                config.definitionOrdering = Ordering.natural();
-            if (config.parameterOrderBy == OrderBy.NATURAL)
-                config.parameterOrdering = PARAMETER_IN_NATURAL_ORDERING.compound(PARAMETER_NAME_NATURAL_ORDERING);
-            if (config.propertyOrderBy == OrderBy.NATURAL)
-                config.propertyOrdering = Ordering.natural();
-            if (config.responseOrderBy == OrderBy.NATURAL)
-                config.responseOrdering = Ordering.natural();
-        }
-
-        /**
-         * Specifies the markup language which should be used to generate the files
-         *
-         * @param markupLanguage the markup language which is used to generate the files
-         * @return this builder
-         */
-        public Builder withMarkupLanguage(MarkupLanguage markupLanguage) {
-            Validate.notNull(markupLanguage, "%s must not be null", "markupLanguage");
-            config.markupLanguage = markupLanguage;
-            return this;
-        }
-
-        /**
-         * Include generated examples into the Paths document
-         *
-         * @return this builder
-         */
-        public Builder withGeneratedExamples() {
-            config.generatedExamplesEnabled = true;
-            return this;
-        }
-
-        /**
-         * Include hand-written descriptions into the Paths document
-         *
-         * @param operationDescriptionsUri the URI to the folder where the description documents reside.
-         * @return this builder
-         */
-        public Builder withOperationDescriptions(URI operationDescriptionsUri) {
-            Validate.notNull(operationDescriptionsUri, "%s must not be null", "operationDescriptionsUri");
-            config.operationDescriptionsEnabled = true;
-            config.operationDescriptionsUri = operationDescriptionsUri;
-            return this;
-        }
-
-        /**
-         * Include hand-written descriptions into the Paths document
-         *
-         * @param operationDescriptionsPath the path to the folder where the description documents reside.
-         * @return this builder
-         */
-        public Builder withOperationDescriptions(Path operationDescriptionsPath) {
-            Validate.notNull(operationDescriptionsPath, "%s must not be null", "operationDescriptionsPath");
-            return withOperationDescriptions(operationDescriptionsPath.toUri());
-        }
-
-        /**
-         * Include hand-written descriptions into the Paths document.<br/>
-         * Use default URI.
-         *
-         * @return this builder
-         */
-        public Builder withOperationDescriptions() {
-            config.operationDescriptionsEnabled = true;
-            return this;
-        }
-
-        /**
-         * Include hand-written descriptions into the Definitions document
-         *
-         * @param definitionDescriptionsUri the URI to the folder where the description documents reside.
-         * @return this builder
-         */
-        public Builder withDefinitionDescriptions(URI definitionDescriptionsUri) {
-            Validate.notNull(definitionDescriptionsUri, "%s must not be null", "definitionDescriptionsUri");
-            config.definitionDescriptionsEnabled = true;
-            config.definitionDescriptionsUri = definitionDescriptionsUri;
-            return this;
-        }
-
-        /**
-         * Include hand-written descriptions into the Definitions document
-         *
-         * @param definitionDescriptionsPath the path to the folder where the description documents reside.
-         * @return this builder
-         */
-        public Builder withDefinitionDescriptions(Path definitionDescriptionsPath) {
-            Validate.notNull(definitionDescriptionsPath, "%s must not be null", "definitionDescriptionsPath");
-            return withDefinitionDescriptions(definitionDescriptionsPath.toUri());
-        }
-
-        /**
-         * Include hand-written descriptions into the Definitions document.<br/>
-         * Use default URI.
-         *
-         * @return this builder
-         */
-        public Builder withDefinitionDescriptions() {
-            config.definitionDescriptionsEnabled = true;
-            return this;
-        }
-
-        /**
-         * In addition to the definitions file, also create separate definition files for each model definition.
-         *
-         * @return this builder
-         */
-        public Builder withSeparatedDefinitions() {
-            config.separatedDefinitionsEnabled = true;
-            return this;
-        }
-
-
-        /**
-         * In addition to the paths file, also create separate path files for each path.
-         *
-         * @return this builder
-         */
-        public Builder withSeparatedOperations() {
-            config.separatedOperationsEnabled = true;
-            return this;
-        }
-
-
-        /**
-         * Specifies if the paths should be grouped by tags or stay as-is.
-         *
-         * @param pathsGroupedBy the GroupBy enum
-         * @return this builder
-         */
-        public Builder withPathsGroupedBy(GroupBy pathsGroupedBy) {
-            Validate.notNull(pathsGroupedBy, "%s must not be null", "pathsGroupedBy");
-            config.operationsGroupedBy = pathsGroupedBy;
-            return this;
-        }
-
-        /**
-         * Specifies labels language of output files
-         *
-         * @param language the enum
-         * @return this builder
-         */
-        public Builder withOutputLanguage(Language language) {
-            Validate.notNull(language, "%s must not be null", "language");
-            config.outputLanguage = language;
-            return this;
-        }
-
-        /**
-         * Specifies maximum depth level for inline object schema displaying (0 = no inline schemasEnabled)
-         *
-         * @param inlineSchemaDepthLevel number of recursion levels for inline schemasEnabled display
-         * @return this builder
-         */
-        public Builder withInlineSchemaDepthLevel(int inlineSchemaDepthLevel) {
-            Validate.isTrue(inlineSchemaDepthLevel >= 0, "%s must be >= 0", "inlineSchemaDepthLevel");
-            config.inlineSchemaDepthLevel = inlineSchemaDepthLevel;
-            return this;
-        }
-
-        /**
-         * Specifies tag ordering.<br/>
-         * By default tag ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.<br/>
-         * Use {@link #withTagOrdering(Comparator)} to set a custom ordering.
-         *
-         * @param orderBy tag ordering
-         * @return this builder
-         */
-        public Builder withTagOrdering(OrderBy orderBy) {
-            Validate.notNull(orderBy, "%s must not be null", "orderBy");
-            Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
-            config.tagOrderBy = orderBy;
-            return this;
-        }
-
-        /**
-         * Specifies a custom comparator function to order tags.
-         *
-         * @param tagOrdering tag ordering
-         * @return this builder
-         */
-        public Builder withTagOrdering(Comparator<String> tagOrdering) {
-            Validate.notNull(tagOrdering, "%s must not be null", "tagOrdering");
-            config.tagOrderBy = OrderBy.CUSTOM;
-            config.tagOrdering = tagOrdering;
-            return this;
-        }
-
-        /**
-         * Specifies operation ordering.<br/>
-         * By default operation ordering == {@link io.github.robwin.swagger2markup.OrderBy#AS_IS}.<br/>
-         * Use {@link #withOperationOrdering(Comparator)} to set a custom ordering.
-         *
-         * @param orderBy operation ordering
-         * @return this builder
-         */
-        public Builder withOperationOrdering(OrderBy orderBy) {
-            Validate.notNull(orderBy, "%s must not be null", "orderBy");
-            Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
-            config.operationOrderBy = orderBy;
-            return this;
-        }
-
-        /**
-         * Specifies a custom comparator function to order operations.
-         *
-         * @param operationOrdering operation ordering
-         * @return this builder
-         */
-        public Builder withOperationOrdering(Comparator<PathOperation> operationOrdering) {
-            Validate.notNull(operationOrdering, "%s must not be null", "operationOrdering");
-            config.operationOrderBy = OrderBy.CUSTOM;
-            config.operationOrdering = operationOrdering;
-            return this;
-        }
-
-        /**
-         * Specifies definition ordering.<br/>
-         * By default definition ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.<br/>
-         * Use {@link #withDefinitionOrdering(Comparator)} to set a custom ordering.
-         *
-         * @param orderBy definition ordering
-         * @return this builder
-         */
-        public Builder withDefinitionOrdering(OrderBy orderBy) {
-            Validate.notNull(orderBy, "%s must not be null", "orderBy");
-            Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
-            config.definitionOrderBy = orderBy;
-            return this;
-        }
-
-        /**
-         * Specifies a custom comparator function to order definitions.
-         *
-         * @param definitionOrdering definition ordering
-         * @return this builder
-         */
-        public Builder withDefinitionOrdering(Comparator<String> definitionOrdering) {
-            Validate.notNull(definitionOrdering, "%s must not be null", "definitionOrdering");
-            config.definitionOrderBy = OrderBy.CUSTOM;
-            config.definitionOrdering = definitionOrdering;
-            return this;
-        }
-
-        /**
-         * Specifies parameter ordering.<br/>
-         * By default parameter ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.<br/>
-         * Use {@link #withParameterOrdering(Comparator)} to set a custom ordering.
-         *
-         * @param orderBy parameter ordering
-         * @return this builder
-         */
-        public Builder withParameterOrdering(OrderBy orderBy) {
-            Validate.notNull(orderBy, "%s must not be null", "orderBy");
-            Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
-            config.parameterOrderBy = orderBy;
-            return this;
-        }
-
-        /**
-         * Specifies a custom comparator function to order parameters.
-         *
-         * @param parameterOrdering parameter ordering
-         * @return this builder
-         */
-        public Builder withParameterOrdering(Comparator<Parameter> parameterOrdering) {
-            Validate.notNull(parameterOrdering, "%s must not be null", "parameterOrdering");
-
-            config.parameterOrderBy = OrderBy.CUSTOM;
-            config.parameterOrdering = parameterOrdering;
-            return this;
-        }
-
-        /**
-         * Specifies property ordering.<br/>
-         * By default property ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.<br/>
-         * Use {@link #withPropertyOrdering(Comparator)} to set a custom ordering.
-         *
-         * @param orderBy property ordering
-         * @return this builder
-         */
-        public Builder withPropertyOrdering(OrderBy orderBy) {
-            Validate.notNull(orderBy, "%s must not be null", "orderBy");
-            Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
-            config.propertyOrderBy = orderBy;
-            return this;
-        }
-
-        /**
-         * Specifies a custom comparator function to order propertys.
-         *
-         * @param propertyOrdering property ordering
-         * @return this builder
-         */
-        public Builder withPropertyOrdering(Comparator<String> propertyOrdering) {
-            Validate.notNull(propertyOrdering, "%s must not be null", "propertyOrdering");
-
-            config.propertyOrderBy = OrderBy.CUSTOM;
-            config.propertyOrdering = propertyOrdering;
-            return this;
-        }
-
-        /**
-         * Specifies response ordering.<br/>
-         * By default response ordering == {@link io.github.robwin.swagger2markup.OrderBy#NATURAL}.<br/>
-         * Use {@link #withResponseOrdering(Comparator)} to set a custom ordering.
-         *
-         * @param orderBy response ordering
-         * @return this builder
-         */
-        public Builder withResponseOrdering(OrderBy orderBy) {
-            Validate.notNull(orderBy, "%s must not be null", "orderBy");
-            Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
-            config.responseOrderBy = orderBy;
-            return this;
-        }
-
-        /**
-         * Specifies a custom comparator function to order responses.
-         *
-         * @param responseOrdering response ordering
-         * @return this builder
-         */
-        public Builder withResponseOrdering(Comparator<String> responseOrdering) {
-            Validate.notNull(responseOrdering, "%s must not be null", "responseOrdering");
-
-            config.responseOrderBy = OrderBy.CUSTOM;
-            config.responseOrdering = responseOrdering;
-            return this;
-        }
-
-        /**
-         * Enable use of inter-document cross-references when needed
-         *
-         * @param prefix Prefix to document in all inter-document cross-references.
-         * @return this builder
-         */
-        public Builder withInterDocumentCrossReferences(String prefix) {
-            Validate.notNull(prefix, "%s must not be null", "prefix");
-            config.interDocumentCrossReferencesEnabled = true;
-            config.interDocumentCrossReferencesPrefix = prefix;
-            return this;
-        }
-
-        /**
-         * Enable use of inter-document cross-references when needed.
-         *
-         * @return this builder
-         */
-        public Builder withInterDocumentCrossReferences() {
-            config.interDocumentCrossReferencesEnabled = true;
-            return this;
-        }
-
-        /**
-         * Optionally isolate the body parameter, if any, from other parameters
-         *
-         * @return this builder
-         */
-        public Builder withFlatBody() {
-            config.flatBodyEnabled = true;
-            return this;
-        }
-
-        /**
-         * Optionally prefix all anchors for unicity
-         *.
-         * @param anchorPrefix anchor prefix.
-         * @return this builder
-         */
-        public Builder withAnchorPrefix(String anchorPrefix) {
-            Validate.notNull(anchorPrefix, "%s must no be null", "anchorPrefix");
-            config.anchorPrefix = anchorPrefix;
-            return this;
-        }
-
-        /**
-         * Specifies the line separator which should be used .
-         *
-         * @param lineSeparator the lineSeparator
-         * @return this builder
-         */
-        public Builder withLineSeparator(LineSeparator lineSeparator) {
-            Validate.notNull(lineSeparator, "%s must no be null", "lineSeparator");
-            config.lineSeparator = lineSeparator;
-            return this;
-        }
-
-    }
-
-}

src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConverter.java

@@ -1,292 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup;
-
-import com.google.common.annotations.VisibleForTesting;
-import io.github.robwin.swagger2markup.internal.document.builder.DefinitionsDocumentBuilder;
-import io.github.robwin.swagger2markup.internal.document.builder.OverviewDocumentBuilder;
-import io.github.robwin.swagger2markup.internal.document.builder.PathsDocumentBuilder;
-import io.github.robwin.swagger2markup.internal.document.builder.SecurityDocumentBuilder;
-import io.github.robwin.swagger2markup.spi.Extension;
-import io.github.robwin.swagger2markup.spi.SwaggerModelExtension;
-import io.swagger.models.Swagger;
-import io.swagger.parser.SwaggerParser;
-import org.apache.commons.io.IOUtils;
-import org.apache.commons.lang3.Validate;
-
-import java.io.IOException;
-import java.io.Reader;
-import java.io.StringReader;
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.net.URL;
-import java.nio.charset.StandardCharsets;
-import java.nio.file.Path;
-
-
-/**
- * @author Robert Winkler
- */
-public class Swagger2MarkupConverter {
-
-    private Context context;
-
-    public Swagger2MarkupConverter(Context globalContext) {
-        this.context = globalContext;
-    }
-
-    /**
-     * Returns the global Context
-     *
-     * @return the global Context
-     */
-    @VisibleForTesting
-    Context getContext(){
-        return context;
-    }
-
-    /**
-     * Creates a Swagger2MarkupConverter.Builder using a remote URL.
-     *
-     * @param swaggerURL the remote URL
-     * @return a Swagger2MarkupConverter
-     */
-    public static Builder from(URL swaggerURL){
-        Validate.notNull(swaggerURL, "swaggerURL must not be null");
-        return new Builder(swaggerURL);
-    }
-
-    /**
-     * Creates a Swagger2MarkupConverter.Builder using a local Path.
-     *
-     * @param swaggerPath the local Path
-     * @return a Swagger2MarkupConverter
-     */
-    public static Builder from(Path swaggerPath) {
-        Validate.notNull(swaggerPath, "swaggerPath must not be null");
-        return new Builder(swaggerPath);
-    }
-
-    /**
-     * Creates a Swagger2MarkupConverter.Builder from a given Swagger model.
-     *
-     * @param swagger the Swagger source.
-     * @return a Swagger2MarkupConverter
-     */
-    public static Builder from(Swagger swagger) {
-        Validate.notNull(swagger, "swagger must not be null");
-        return new Builder(swagger);
-    }
-
-    /**
-     * Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON String.
-     *
-     * @param swaggerString the Swagger YAML or JSON String.
-     * @return a Swagger2MarkupConverter
-     * @throws java.io.IOException if String can not be parsed
-     */
-    public static Builder from(String swaggerString) throws IOException {
-        Validate.notEmpty(swaggerString, "swaggerString must not be null");
-        return from(new StringReader(swaggerString));
-    }
-
-    /**
-     * Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON reader.
-     *
-     * @param swaggerReader the Swagger YAML or JSON reader.
-     * @return a Swagger2MarkupConverter
-     * @throws java.io.IOException if source can not be parsed
-     */
-    public static Builder from(Reader swaggerReader) throws IOException {
-        Validate.notNull(swaggerReader, "swaggerReader must not be null");
-        Swagger swagger = new SwaggerParser().parse(IOUtils.toString(swaggerReader));
-        if (swagger == null)
-            throw new IllegalArgumentException("Swagger source is in a wrong format");
-
-        return new Builder(swagger);
-    }
-
-    /**
-     * Builds the document with the given markup language and stores
-     * the files in the given folder.
-     *
-     * @param outputPath the output directory path
-     * @throws IOException if the files cannot be written
-     */
-    public void intoFolder(Path outputPath) throws IOException {
-        Validate.notNull(outputPath, "outputPath must not be null");
-
-        applySwaggerExtensions();
-        buildDocuments(outputPath);
-    }
-
-    /**
-     * Builds the document with the given markup language and returns it as a String
-     *
-     * @return a the document as a String
-     * @throws java.io.IOException if files can not be read
-     */
-    public String asString() throws IOException {
-        applySwaggerExtensions();
-        return buildDocuments();
-    }
-
-    private void applySwaggerExtensions() {
-        for (SwaggerModelExtension swaggerModelExtension : context.extensionRegistry.getExtensions(SwaggerModelExtension.class)) {
-            swaggerModelExtension.apply(context.getSwagger());
-        }
-    }
-
-    /**
-     * Builds all documents and writes them to a directory
-     *
-     * @param outputPath the directory path where the generated file should be stored
-     * @throws IOException if a file cannot be written
-     */
-    private void buildDocuments(Path outputPath) throws IOException {
-        new OverviewDocumentBuilder(context, outputPath).build().writeToFile(outputPath.resolve(context.config.getOverviewDocument()), StandardCharsets.UTF_8);
-        new PathsDocumentBuilder(context, outputPath).build().writeToFile(outputPath.resolve(context.config.getPathsDocument()), StandardCharsets.UTF_8);
-        new DefinitionsDocumentBuilder(context, outputPath).build().writeToFile(outputPath.resolve(context.config.getDefinitionsDocument()), StandardCharsets.UTF_8);
-        new SecurityDocumentBuilder(context, outputPath).build().writeToFile(outputPath.resolve(context.config.getSecurityDocument()), StandardCharsets.UTF_8);
-    }
-
-    /**
-     * Returns all documents as a String
-     *
-     * @return a the document as a String
-     */
-    private String buildDocuments() {
-        StringBuilder sb = new StringBuilder();
-        sb.append(new OverviewDocumentBuilder(context, null).build().toString());
-        sb.append(new PathsDocumentBuilder(context, null).build().toString());
-        sb.append(new DefinitionsDocumentBuilder(context, null).build().toString());
-        sb.append(new SecurityDocumentBuilder(context, null).build().toString());
-        return sb.toString();
-    }
-
-    public static class Builder {
-        private final Swagger swagger;
-        private final URI swaggerLocation;
-        private Swagger2MarkupConfig config;
-        private Swagger2MarkupExtensionRegistry extensionRegistry;
-
-        /**
-         * Creates a Builder from a remote URL.
-         *
-         * @param swaggerUrl the remote URL
-         */
-        Builder(URL swaggerUrl) {
-            try {
-                this.swaggerLocation = swaggerUrl.toURI();
-            } catch (URISyntaxException e) {
-                throw new IllegalArgumentException("swaggerURL is in a wrong format", e);
-            }
-            this.swagger = readSwagger(swaggerUrl.toString());
-        }
-
-        /**
-         * Creates a Builder from a local Path.
-         *
-         * @param swaggerPath the local Path
-         */
-        Builder(Path swaggerPath) {
-            this.swaggerLocation = swaggerPath.toAbsolutePath().toUri();
-            this.swagger = readSwagger(swaggerPath.toString());
-        }
-
-        /**
-         * Creates a Builder using a given Swagger model.
-         *
-         * @param swagger the Swagger source.
-         */
-        Builder(Swagger swagger) {
-            this.swagger = swagger;
-            this.swaggerLocation = null;
-        }
-
-        /**
-         * Uses the SwaggerParser to read the Swagger source.
-         *
-         * @param swaggerLocation the location of the Swagger source
-         * @return the Swagger model
-         */
-        private Swagger readSwagger(String swaggerLocation){
-            Swagger swagger = new SwaggerParser().read(swaggerLocation);
-            if (swagger == null) {
-                throw new IllegalArgumentException("Failed to read the Swagger source");
-            }
-            return swagger;
-        }
-
-        public Builder withConfig(Swagger2MarkupConfig config) {
-            Validate.notNull(config, "config must not be null");
-            this.config = config;
-            return this;
-        }
-
-        public Builder withExtensionRegistry(Swagger2MarkupExtensionRegistry registry) {
-            Validate.notNull(config, "registry must not be null");
-            this.extensionRegistry = registry;
-            return this;
-        }
-
-        public Swagger2MarkupConverter build() {
-            if (config == null)
-                config = Swagger2MarkupConfig.ofDefaults().build();
-
-            if (extensionRegistry == null)
-                extensionRegistry = Swagger2MarkupExtensionRegistry.ofDefaults().build();
-
-            Context context = new Context(config, extensionRegistry, swagger, swaggerLocation);
-            config.setGlobalContext(context);
-
-            for (Extension extension : extensionRegistry.getExtensions())
-                extension.setGlobalContext(context);
-            return new Swagger2MarkupConverter(context);
-        }
-    }
-
-    public static class Context {
-        private Swagger2MarkupConfig config;
-        private Swagger2MarkupExtensionRegistry extensionRegistry;
-        private Swagger swagger;
-        private URI swaggerLocation;
-
-        Context(Swagger2MarkupConfig config, Swagger2MarkupExtensionRegistry extensionRegistry, Swagger swagger, URI swaggerLocation) {
-            this.config = config;
-            this.extensionRegistry = extensionRegistry;
-            this.swagger = swagger;
-            this.swaggerLocation = swaggerLocation;
-        }
-
-        public Swagger2MarkupConfig getConfig() {
-            return config;
-        }
-
-        public Swagger2MarkupExtensionRegistry getExtensionRegistry() {
-            return extensionRegistry;
-        }
-
-        public Swagger getSwagger() {
-            return swagger;
-        }
-
-        public URI getSwaggerLocation() {
-            return swaggerLocation;
-        }
-    }
-
-}

src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupExtensionRegistry.java

@@ -1,112 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup;
-
-import com.google.common.collect.Multimap;
-import com.google.common.collect.MultimapBuilder;
-import io.github.robwin.swagger2markup.internal.extensions.DynamicDefinitionsDocumentExtension;
-import io.github.robwin.swagger2markup.internal.extensions.DynamicPathsDocumentExtension;
-import io.github.robwin.swagger2markup.internal.extensions.DynamicOverviewDocumentExtension;
-import io.github.robwin.swagger2markup.internal.extensions.DynamicSecurityDocumentExtension;
-import io.github.robwin.swagger2markup.spi.*;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Map;
-
-public class Swagger2MarkupExtensionRegistry {
-
-    protected static final List<Class<? extends Extension>> EXTENSION_POINTS = Arrays.<Class<? extends Extension>>asList(
-            SwaggerModelExtension.class,
-            OverviewDocumentExtension.class,
-            SecurityDocumentExtension.class,
-            DefinitionsDocumentExtension.class,
-            PathsDocumentExtension.class
-    );
-
-    protected final Multimap<Class<? extends Extension>, Extension> extensions;
-
-    public Swagger2MarkupExtensionRegistry(Multimap<Class<? extends Extension>, Extension> extensions) {
-        this.extensions = extensions;
-    }
-
-    public static Builder ofEmpty() {
-        return new Builder(false);
-    }
-
-    public static Builder ofDefaults() {
-        return new Builder(true);
-    }
-
-    public static class Builder {
-
-        private final Multimap<Class<? extends Extension>, Extension> extensions;
-
-        Builder(boolean useDefaults) {
-            extensions = MultimapBuilder.hashKeys().arrayListValues().build();
-            if (useDefaults) {
-                withExtension(new DynamicOverviewDocumentExtension());
-                withExtension(new DynamicSecurityDocumentExtension());
-                withExtension(new DynamicPathsDocumentExtension());
-                withExtension(new DynamicDefinitionsDocumentExtension());
-            }
-        }
-
-        public Swagger2MarkupExtensionRegistry build() {
-            return new Swagger2MarkupExtensionRegistry(extensions);
-        }
-
-        public Builder withExtension(Extension extension) {
-            registerExtension(extension);
-            return this;
-        }
-
-        public void registerExtension(Extension extension) {
-            for (Class<? extends Extension> extensionPoint : EXTENSION_POINTS) {
-                if (extensionPoint.isInstance(extension)) {
-                    extensions.put(extensionPoint, extension);
-                    return;
-                }
-            }
-
-            throw new IllegalArgumentException("Provided extension class does not extend any of the supported extension points");
-        }
-    }
-
-    @SuppressWarnings(value = "unchecked")
-    public <T extends Extension> List<T> getExtensions(Class<T> extensionClass) {
-        List<T> ret = new ArrayList<>();
-
-        for (Map.Entry<Class<? extends Extension>, Extension> entry : extensions.entries()) {
-            if (extensionClass.isAssignableFrom(entry.getKey())) {
-                if (extensionClass.isInstance(entry.getValue()))
-                    ret.add((T) entry.getValue());
-            }
-        }
-
-        return ret;
-    }
-
-    /**
-     * Get all extensions
-     * @return all extensions
-     */
-    public List<Extension> getExtensions() {
-        return getExtensions(Extension.class);
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/document/MarkupDocument.java

@@ -1,49 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.document;
-
-import io.github.robwin.markup.builder.MarkupDocBuilder;
-
-import java.io.IOException;
-import java.nio.charset.Charset;
-import java.nio.file.Path;
-
-public class MarkupDocument {
-
-    private MarkupDocBuilder markupDocBuilder;
-
-    public MarkupDocument(MarkupDocBuilder markupDocBuilder) {
-        this.markupDocBuilder = markupDocBuilder;
-    }
-
-    /**
-     * Returns a string representation of the document.
-     */
-    public String toString() {
-        return markupDocBuilder.toString();
-    }
-
-    /**
-     * Writes the content of the builder to a file.
-     *
-     * @param file    the generated file
-     * @param charset the the charset to use for encoding
-     * @throws IOException if the file cannot be written
-     */
-    public void writeToFile(Path file, Charset charset) throws IOException {
-        markupDocBuilder.writeToFile(file, charset);
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/document/builder/DefinitionsDocumentBuilder.java

@@ -1,398 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.document.builder;
-
-import com.google.common.base.Optional;
-import com.google.common.collect.ImmutableMap;
-import io.github.robwin.markup.builder.MarkupDocBuilder;
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.internal.document.MarkupDocument;
-import io.github.robwin.swagger2markup.spi.DefinitionsDocumentExtension;
-import io.github.robwin.swagger2markup.internal.type.ObjectType;
-import io.github.robwin.swagger2markup.internal.type.Type;
-import io.swagger.models.ComposedModel;
-import io.swagger.models.Model;
-import io.swagger.models.RefModel;
-import io.swagger.models.properties.Property;
-import io.swagger.models.refs.RefFormat;
-import org.apache.commons.collections4.CollectionUtils;
-import org.apache.commons.collections4.MapUtils;
-import org.apache.commons.io.IOUtils;
-import org.apache.commons.lang3.Validate;
-
-
-import java.io.File;
-import java.io.IOException;
-import java.io.Reader;
-import java.net.URI;
-import java.nio.charset.StandardCharsets;
-import java.nio.file.Path;
-import java.util.*;
-
-import static io.github.robwin.swagger2markup.internal.utils.IOUtils.normalizeName;
-import static io.github.robwin.swagger2markup.spi.DefinitionsDocumentExtension.*;
-import static org.apache.commons.lang3.StringUtils.defaultString;
-import static org.apache.commons.lang3.StringUtils.isNotBlank;
-import static io.github.robwin.swagger2markup.internal.utils.MapUtils.toKeySet;
-
-/**
- * @author Robert Winkler
- */
-public class DefinitionsDocumentBuilder extends MarkupDocumentBuilder {
-
-    private static final String DEFINITIONS_ANCHOR = "definitions";
-    private final String DEFINITIONS;
-    private static final List<String> IGNORED_DEFINITIONS = Collections.singletonList("Void");
-    private static final String DESCRIPTION_FILE_NAME = "description";
-
-    public DefinitionsDocumentBuilder(Swagger2MarkupConverter.Context context, Path outputPath) {
-        super(context, outputPath);
-
-        ResourceBundle labels = ResourceBundle.getBundle("io/github/robwin/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
-        DEFINITIONS = labels.getString("definitions");
-
-        if (config.isDefinitionDescriptionsEnabled()) {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Include hand-written definition descriptions is enabled.");
-            }
-        } else {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Include hand-written definition descriptions is disabled.");
-            }
-        }
-        if (config.isSeparatedDefinitionsEnabled()) {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Create separated definition files is enabled.");
-            }
-            Validate.notNull(outputPath, "Output directory is required for separated definition files!");
-        } else {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Create separated definition files is disabled.");
-            }
-        }
-    }
-
-    /**
-     * Builds the definitions MarkupDocument.
-     *
-     * @return the definitions MarkupDocument
-     */
-    @Override
-    public MarkupDocument build() {
-        Map<String, Model> definitions = globalContext.getSwagger().getDefinitions();
-        if (MapUtils.isNotEmpty(definitions)) {
-            applyDefinitionsDocumentExtension(new Context(Position.DOCUMENT_BEFORE, this.markupDocBuilder));
-            buildDefinitionsTitle(DEFINITIONS);
-            applyDefinitionsDocumentExtension(new Context(Position.DOCUMENT_BEGIN, this.markupDocBuilder));
-            buildDefinitionsSection(definitions);
-            applyDefinitionsDocumentExtension(new Context(Position.DOCUMENT_END, this.markupDocBuilder));
-        }
-        return new MarkupDocument(markupDocBuilder);
-    }
-
-    private void buildDefinitionsSection(Map<String, Model> definitions) {
-        Set<String> definitionNames = toKeySet(definitions, config.getDefinitionOrdering());
-        for (String definitionName : definitionNames) {
-            Model model = definitions.get(definitionName);
-            if (isNotBlank(definitionName)) {
-                if (checkThatDefinitionIsNotInIgnoreList(definitionName)) {
-                    buildDefinition(definitions, definitionName, model);
-                    if (logger.isInfoEnabled()) {
-                        logger.info("Definition processed: {}", definitionName);
-                    }
-                } else {
-                    if (logger.isDebugEnabled()) {
-                        logger.debug("Definition was ignored: {}", definitionName);
-                    }
-                }
-            }
-        }
-    }
-
-    private void buildDefinitionsTitle(String title) {
-        this.markupDocBuilder.sectionTitleWithAnchorLevel1(title, DEFINITIONS_ANCHOR);
-    }
-
-    /**
-     * Apply extension context to all DefinitionsContentExtension
-     *
-     * @param context context
-     */
-    private void applyDefinitionsDocumentExtension(Context context) {
-        for (DefinitionsDocumentExtension extension : globalContext.getExtensionRegistry().getExtensions(DefinitionsDocumentExtension.class)) {
-            extension.apply(context);
-        }
-    }
-
-    /**
-     * Create the definition filename depending on the generation mode
-     *
-     * @param definitionName definition name
-     * @return definition filename
-     */
-    private String resolveDefinitionDocument(String definitionName) {
-        if (config.isSeparatedDefinitionsEnabled())
-            return new File(config.getSeparatedDefinitionsFolder(), markupDocBuilder.addFileExtension(normalizeName(definitionName))).getPath();
-        else
-            return markupDocBuilder.addFileExtension(config.getDefinitionsDocument());
-    }
-
-    /**
-     * Generate definition files depending on the generation mode
-     *
-     * @param definitions    all available definitions to be able to verify references
-     * @param definitionName definition name to process
-     * @param model          definition model to process
-     */
-    private void buildDefinition(Map<String, Model> definitions, String definitionName, Model model) {
-
-        if (config.isSeparatedDefinitionsEnabled()) {
-            MarkupDocBuilder defDocBuilder = this.markupDocBuilder.copy();
-            buildDefinition(definitions, definitionName, model, defDocBuilder);
-            Path definitionFile = outputPath.resolve(resolveDefinitionDocument(definitionName));
-            try {
-                defDocBuilder.writeToFileWithoutExtension(definitionFile, StandardCharsets.UTF_8);
-            } catch (IOException e) {
-                if (logger.isWarnEnabled()) {
-                    logger.warn(String.format("Failed to write definition file: %s", definitionFile), e);
-                }
-            }
-            if (logger.isInfoEnabled()) {
-                logger.info("Separate definition file produced: {}", definitionFile);
-            }
-
-            definitionRef(definitionName, this.markupDocBuilder);
-
-        } else {
-            buildDefinition(definitions, definitionName, model, this.markupDocBuilder);
-        }
-    }
-
-    /**
-     * Checks that the definition is not in the list of ignored definitions.
-     *
-     * @param definitionName the name of the definition
-     * @return true if the definition can be processed
-     */
-    private boolean checkThatDefinitionIsNotInIgnoreList(String definitionName) {
-        return !IGNORED_DEFINITIONS.contains(definitionName);
-    }
-
-    /**
-     * Builds a concrete definition
-     *
-     * @param definitionName the name of the definition
-     * @param model          the Swagger Model of the definition
-     * @param docBuilder     the docbuilder do use for output
-     */
-    private void buildDefinition(Map<String, Model> definitions, String definitionName, Model model, MarkupDocBuilder docBuilder) {
-        buildDefinitionTitle(definitionName, null, docBuilder);
-        applyDefinitionsDocumentExtension(new Context(Position.DEFINITION_BEGIN, docBuilder, definitionName, model));
-        buildDescriptionParagraph(definitionName, model, docBuilder);
-        inlineDefinitions(propertiesSection(definitions, definitionName, model, docBuilder), definitionName, config.getInlineSchemaDepthLevel(), docBuilder);
-        applyDefinitionsDocumentExtension(new Context(Position.DEFINITION_END, docBuilder, definitionName, model));
-    }
-
-    /**
-     * Builds a cross-reference to a separated definition file.
-     *
-     * @param definitionName definition name to target
-     * @param docBuilder     the docbuilder do use for output
-     */
-    private void definitionRef(String definitionName, MarkupDocBuilder docBuilder) {
-        buildDefinitionTitle(docBuilder.copy().crossReference(new DefinitionDocumentResolverDefault().apply(definitionName), definitionName, definitionName).toString(), "ref-" + definitionName, docBuilder);
-    }
-
-    /**
-     * Builds definition title
-     *
-     * @param title      definition title
-     * @param anchor     optional anchor (null => auto-generate from title)
-     * @param docBuilder the docbuilder do use for output
-     */
-    private void buildDefinitionTitle(String title, String anchor, MarkupDocBuilder docBuilder) {
-        docBuilder.sectionTitleWithAnchorLevel2(title, anchor);
-    }
-
-    /**
-     * Override Property description functor for definitions.
-     * This implementation handles optional handwritten descriptions.
-     */
-    private class DefinitionPropertyDescriptor extends PropertyDescriptor {
-
-        public DefinitionPropertyDescriptor(Type type) {
-            super(type);
-        }
-
-        @Override
-        public String getDescription(Property property, String propertyName) {
-            if (config.isDefinitionDescriptionsEnabled()) {
-                Optional<String> description = handWrittenDefinitionDescription(new File(normalizeName(type.getName()), normalizeName(propertyName)).toString(), DESCRIPTION_FILE_NAME);
-                if (description.isPresent()) {
-                    return description.get();
-                } else {
-                    return defaultString(property.getDescription());
-                }
-            } else {
-                return defaultString(property.getDescription());
-            }
-        }
-    }
-
-    /**
-     * Builds the properties of a definition and inline schemas.
-     *
-     * @param definitions    all available definitions
-     * @param definitionName name of the definition to display
-     * @param model          model of the definition to display
-     * @param docBuilder     the docbuilder do use for output
-     * @return a list of inlined types.
-     */
-    private List<ObjectType> propertiesSection(Map<String, Model> definitions, String definitionName, Model model, MarkupDocBuilder docBuilder) {
-        Map<String, Property> properties = getAllProperties(definitions, model);
-        ObjectType type = new ObjectType(definitionName, properties);
-
-        return buildPropertiesTable(type, definitionName, 1, new PropertyDescriptor(type), new DefinitionDocumentResolverFromDefinition(), docBuilder);
-    }
-
-    private Map<String, Property> getAllProperties(Map<String, Model> definitions, Model model) {
-        if (model instanceof RefModel) {
-            RefModel refModel = (RefModel) model;
-            String ref;
-            if (refModel.getRefFormat().equals(RefFormat.INTERNAL)) {
-                ref = refModel.getSimpleRef();
-            } else {
-                ref = model.getReference();
-            }
-            return definitions.containsKey(ref)
-                    ? getAllProperties(definitions, definitions.get(ref))
-                    : null;
-        } else if (model instanceof ComposedModel) {
-            ComposedModel composedModel = (ComposedModel) model;
-            Map<String, Property> allProperties = new HashMap<>();
-            if (composedModel.getAllOf() != null) {
-                for (Model innerModel : composedModel.getAllOf()) {
-                    Map<String, Property> innerProperties = getAllProperties(definitions, innerModel);
-                    if (innerProperties != null) {
-                        allProperties.putAll(innerProperties);
-                    }
-                }
-            }
-            return ImmutableMap.copyOf(allProperties);
-        } else {
-            return model.getProperties();
-        }
-    }
-
-    private void buildDescriptionParagraph(String definitionName, Model model, MarkupDocBuilder docBuilder) {
-        if (config.isDefinitionDescriptionsEnabled()) {
-            Optional<String> description = handWrittenDefinitionDescription(normalizeName(definitionName), DESCRIPTION_FILE_NAME);
-            if (description.isPresent()) {
-                docBuilder.paragraph(description.get());
-            } else {
-                modelDescription(model, docBuilder);
-            }
-        } else {
-            modelDescription(model, docBuilder);
-        }
-    }
-
-    private void modelDescription(Model model, MarkupDocBuilder docBuilder) {
-        String description = model.getDescription();
-        if (isNotBlank(description)) {
-            docBuilder.paragraph(description);
-        }
-    }
-
-    /**
-     * Reads a hand-written description
-     *
-     * @param descriptionFolder   the name of the folder where the description file resides
-     * @param descriptionFileName the name of the description file
-     * @return the content of the file
-     */
-    private Optional<String> handWrittenDefinitionDescription(String descriptionFolder, String descriptionFileName) {
-        for (String fileNameExtension : config.getMarkupLanguage().getFileNameExtensions()) {
-            URI contentUri = config.getDefinitionDescriptionsUri().resolve(descriptionFolder).resolve(descriptionFileName + fileNameExtension);
-
-            try (Reader reader = io.github.robwin.swagger2markup.internal.utils.IOUtils.uriReader(contentUri)) {
-                if (logger.isInfoEnabled()) {
-                    logger.info("Definition description content processed {}", contentUri);
-                }
-
-                return Optional.of(IOUtils.toString(reader).trim());
-            } catch (IOException e) {
-                if (logger.isDebugEnabled()) {
-                    logger.debug("Failed to read Operation description content {} > {}", contentUri, e.getMessage());
-                }
-            }
-        }
-
-        return Optional.absent();
-    }
-
-    /**
-     * Builds the title of an inline schema.
-     * Inline definitions should never been referenced in TOC because they have no real existence, so they are just text.
-     *
-     * @param title      inline schema title
-     * @param anchor     inline schema anchor
-     * @param docBuilder the docbuilder do use for output
-     */
-    private void addInlineDefinitionTitle(String title, String anchor, MarkupDocBuilder docBuilder) {
-        docBuilder.anchor(anchor, null);
-        docBuilder.newLine();
-        docBuilder.boldTextLine(title);
-    }
-
-    /**
-     * Builds inline schema definitions
-     *
-     * @param definitions  all inline definitions to display
-     * @param uniquePrefix unique prefix to prepend to inline object names to enforce unicity
-     * @param depth        current inline schema depth
-     * @param docBuilder   the docbuilder do use for output
-     */
-    private void inlineDefinitions(List<ObjectType> definitions, String uniquePrefix, int depth, MarkupDocBuilder docBuilder) {
-        if (CollectionUtils.isNotEmpty(definitions)) {
-            for (ObjectType definition : definitions) {
-                addInlineDefinitionTitle(definition.getName(), definition.getUniqueName(), docBuilder);
-                List<ObjectType> localDefinitions = buildPropertiesTable(definition, uniquePrefix, depth, new DefinitionPropertyDescriptor(definition), new DefinitionDocumentResolverFromDefinition(), docBuilder);
-                for (ObjectType localDefinition : localDefinitions)
-                    inlineDefinitions(Collections.singletonList(localDefinition), uniquePrefix, depth - 1, docBuilder);
-            }
-        }
-    }
-
-    /**
-     * Overrides definition document resolver functor for inter-document cross-references from definitions files.
-     * This implementation simplify the path between two definitions because all definitions are in the same path.
-     */
-    class DefinitionDocumentResolverFromDefinition extends DefinitionDocumentResolverDefault {
-
-        public DefinitionDocumentResolverFromDefinition() {
-        }
-
-        public String apply(String definitionName) {
-            String defaultResolver = super.apply(definitionName);
-
-            if (defaultResolver != null && config.isSeparatedDefinitionsEnabled())
-                return defaultString(config.getInterDocumentCrossReferencesPrefix()) + markupDocBuilder.addFileExtension(normalizeName(definitionName));
-            else
-                return defaultResolver;
-        }
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java

@@ -1,188 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.document.builder;
-
-import io.github.robwin.markup.builder.MarkupDocBuilder;
-import io.github.robwin.markup.builder.MarkupDocBuilders;
-import io.github.robwin.markup.builder.MarkupLanguage;
-import io.github.robwin.markup.builder.MarkupTableColumn;
-import io.github.robwin.swagger2markup.Swagger2MarkupConfig;
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.internal.document.MarkupDocument;
-import io.github.robwin.swagger2markup.internal.type.DefinitionDocumentResolver;
-import io.github.robwin.swagger2markup.internal.type.ObjectType;
-import io.github.robwin.swagger2markup.internal.type.RefType;
-import io.github.robwin.swagger2markup.internal.type.Type;
-import io.github.robwin.swagger2markup.internal.utils.IOUtils;
-import io.github.robwin.swagger2markup.internal.utils.PropertyUtils;
-import io.swagger.models.properties.Property;
-import io.swagger.util.Json;
-import org.apache.commons.collections4.MapUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.io.File;
-import java.io.IOException;
-import java.nio.file.Path;
-import java.util.*;
-
-import static io.github.robwin.swagger2markup.internal.utils.MapUtils.toKeySet;
-import static org.apache.commons.lang3.StringUtils.defaultString;
-
-/**
- * @author Robert Winkler
- */
-public abstract class MarkupDocumentBuilder {
-
-    protected final String DEFAULT_COLUMN;
-    protected final String EXAMPLE_COLUMN;
-    protected final String REQUIRED_COLUMN;
-    protected final String SCHEMA_COLUMN;
-    protected final String NAME_COLUMN;
-    protected final String DESCRIPTION_COLUMN;
-    protected final String SCOPES_COLUMN;
-    protected final String DESCRIPTION;
-    protected final String PRODUCES;
-    protected final String CONSUMES;
-    protected final String TAGS;
-    protected final String NO_CONTENT;
-
-    protected Logger logger = LoggerFactory.getLogger(getClass());
-
-    protected Swagger2MarkupConverter.Context globalContext;
-    protected Swagger2MarkupConfig config;
-    protected MarkupDocBuilder markupDocBuilder;
-    protected Path outputPath;
-
-    MarkupDocumentBuilder(Swagger2MarkupConverter.Context globalContext, Path outputPath) {
-        this.globalContext = globalContext;
-        this.config = globalContext.getConfig();
-        this.outputPath = outputPath;
-
-        this.markupDocBuilder = MarkupDocBuilders.documentBuilder(config.getMarkupLanguage(), config.getLineSeparator()).withAnchorPrefix(config.getAnchorPrefix());
-
-        ResourceBundle labels = ResourceBundle.getBundle("io/github/robwin/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
-        DEFAULT_COLUMN = labels.getString("default_column");
-        EXAMPLE_COLUMN = labels.getString("example_column");
-        REQUIRED_COLUMN = labels.getString("required_column");
-        SCHEMA_COLUMN = labels.getString("schema_column");
-        NAME_COLUMN = labels.getString("name_column");
-        DESCRIPTION_COLUMN = labels.getString("description_column");
-        SCOPES_COLUMN = labels.getString("scopes_column");
-        DESCRIPTION = DESCRIPTION_COLUMN;
-        PRODUCES = labels.getString("produces");
-        CONSUMES = labels.getString("consumes");
-        TAGS = labels.getString("tags");
-        NO_CONTENT = labels.getString("no_content");
-    }
-
-    /**
-     * Builds the MarkupDocument.
-     *
-     * @return the built MarkupDocument
-     * @throws IOException if the files to include are not readable
-     */
-    public abstract MarkupDocument build() throws IOException;
-
-    /**
-     * Build a generic property table for any ObjectType
-     *
-     * @param type                       to display
-     * @param uniquePrefix               unique prefix to prepend to inline object names to enforce unicity
-     * @param depth                      current inline schema object depth
-     * @param propertyDescriptor         property descriptor to apply to properties
-     * @param definitionDocumentResolver definition document resolver to apply to property type cross-reference
-     * @param docBuilder                 the docbuilder do use for output
-     * @return a list of inline schemas referenced by some properties, for later display
-     */
-    protected List<ObjectType> buildPropertiesTable(ObjectType type, String uniquePrefix, int depth, PropertyDescriptor propertyDescriptor, DefinitionDocumentResolver definitionDocumentResolver, MarkupDocBuilder docBuilder) {
-        List<ObjectType> localDefinitions = new ArrayList<>();
-        List<List<String>> cells = new ArrayList<>();
-        List<MarkupTableColumn> cols = Arrays.asList(
-                new MarkupTableColumn(NAME_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"),
-                new MarkupTableColumn(DESCRIPTION_COLUMN, 6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6"),
-                new MarkupTableColumn(REQUIRED_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
-                new MarkupTableColumn(SCHEMA_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
-                new MarkupTableColumn(DEFAULT_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
-                new MarkupTableColumn(EXAMPLE_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
-        if (MapUtils.isNotEmpty(type.getProperties())) {
-            Set<String> propertyNames = toKeySet(type.getProperties(), config.getPropertyOrdering());
-            for (String propertyName : propertyNames) {
-                Property property = type.getProperties().get(propertyName);
-                Type propertyType = PropertyUtils.getType(property, definitionDocumentResolver);
-                if (depth > 0 && propertyType instanceof ObjectType) {
-                    if (MapUtils.isNotEmpty(((ObjectType) propertyType).getProperties())) {
-                        propertyType.setName(propertyName);
-                        propertyType.setUniqueName(uniquePrefix + " " + propertyName);
-                        localDefinitions.add((ObjectType) propertyType);
-
-                        propertyType = new RefType(propertyType);
-                    }
-                }
-
-                Object example = PropertyUtils.getExample(config.isGeneratedExamplesEnabled(), property, markupDocBuilder);
-
-                List<String> content = Arrays.asList(
-                        propertyName,
-                        propertyDescriptor.getDescription(property, propertyName),
-                        Boolean.toString(property.getRequired()),
-                        propertyType.displaySchema(docBuilder),
-                        PropertyUtils.getDefaultValue(property),
-                        example != null ? Json.pretty(example) : ""
-                );
-                cells.add(content);
-            }
-            docBuilder.tableWithColumnSpecs(cols, cells);
-        } else {
-            docBuilder.textLine(NO_CONTENT);
-        }
-
-        return localDefinitions;
-    }
-
-    /**
-     * A functor to return descriptions for a given property
-     */
-    class PropertyDescriptor {
-        protected Type type;
-
-        public PropertyDescriptor(Type type) {
-            this.type = type;
-        }
-
-        public String getDescription(Property property, String propertyName) {
-            return defaultString(property.getDescription());
-        }
-    }
-
-    /**
-     * Default {@code DefinitionDocumentResolver} functor
-     */
-    class DefinitionDocumentResolverDefault implements DefinitionDocumentResolver {
-
-        public DefinitionDocumentResolverDefault() {
-        }
-
-        public String apply(String definitionName) {
-            if (!config.isInterDocumentCrossReferencesEnabled() || outputPath == null)
-                return null;
-            else if (config.isSeparatedDefinitionsEnabled())
-                return defaultString(config.getInterDocumentCrossReferencesPrefix()) + new File(config.getSeparatedDefinitionsFolder(), markupDocBuilder.addFileExtension(IOUtils.normalizeName(definitionName))).getPath();
-            else
-                return defaultString(config.getInterDocumentCrossReferencesPrefix()) + markupDocBuilder.addFileExtension(config.getDefinitionsDocument());
-        }
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/document/builder/OverviewDocumentBuilder.java

@@ -1,204 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.document.builder;
-
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.internal.document.MarkupDocument;
-import io.github.robwin.swagger2markup.spi.OverviewDocumentExtension;
-import io.swagger.models.*;
-
-import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.ResourceBundle;
-
-import static io.github.robwin.swagger2markup.spi.OverviewDocumentExtension.*;
-import static org.apache.commons.collections4.CollectionUtils.isNotEmpty;
-import static org.apache.commons.lang3.StringUtils.*;
-
-public class OverviewDocumentBuilder extends MarkupDocumentBuilder {
-
-    private static final String OVERVIEW_ANCHOR = "overview";
-    private final String OVERVIEW;
-    private final String CURRENT_VERSION;
-    private final String VERSION;
-    private final String CONTACT_INFORMATION;
-    private final String CONTACT_NAME;
-    private final String CONTACT_EMAIL;
-    private final String LICENSE_INFORMATION;
-    private final String LICENSE;
-    private final String LICENSE_URL;
-    private final String TERMS_OF_SERVICE;
-    private final String URI_SCHEME;
-    private final String HOST;
-    private final String BASE_PATH;
-    private final String SCHEMES;
-
-    public OverviewDocumentBuilder(Swagger2MarkupConverter.Context context, Path outputPath){
-        super(context, outputPath);
-
-        ResourceBundle labels = ResourceBundle.getBundle("io/github/robwin/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
-        OVERVIEW = labels.getString("overview");
-        CURRENT_VERSION = labels.getString("current_version");
-        VERSION = labels.getString("version");
-        CONTACT_INFORMATION = labels.getString("contact_information");
-        CONTACT_NAME = labels.getString("contact_name");
-        CONTACT_EMAIL = labels.getString("contact_email");
-        LICENSE_INFORMATION = labels.getString("license_information");
-        LICENSE = labels.getString("license");
-        LICENSE_URL = labels.getString("license_url");
-        TERMS_OF_SERVICE = labels.getString("terms_of_service");
-        URI_SCHEME = labels.getString("uri_scheme");
-        HOST = labels.getString("host");
-        BASE_PATH = labels.getString("base_path");
-        SCHEMES = labels.getString("schemes");
-    }
-
-    /**
-     * Builds the overview MarkupDocument.
-     *
-     * @return the overview MarkupDocument
-     */
-    @Override
-    public MarkupDocument build(){
-        Swagger swagger = globalContext.getSwagger();
-        Info info = swagger.getInfo();
-        buildDocumentTitle(info.getTitle());
-        applyOverviewDocumentExtension(new Context(Position.DOCUMENT_BEFORE, this.markupDocBuilder));
-        buildOverviewTitle(OVERVIEW);
-        applyOverviewDocumentExtension(new Context(Position.DOCUMENT_BEGIN, this.markupDocBuilder));
-        buildDescription(info.getDescription());
-        buildVersionInfoSection(info.getVersion());
-        buildContactInfoSection(info.getContact());
-        buildLicenseInfoSection(info.getLicense(), info.getTermsOfService());
-        buildUriSchemeSection(swagger);
-        buildTagsSection(swagger.getTags());
-        buildConsumesSection(swagger.getConsumes());
-        buildProducesSection(swagger.getProduces());
-        applyOverviewDocumentExtension(new Context(Position.DOCUMENT_END, this.markupDocBuilder));
-        return new MarkupDocument(markupDocBuilder);
-    }
-
-    private void buildDocumentTitle(String title) {
-        this.markupDocBuilder.documentTitle(title);
-    }
-
-    private void buildOverviewTitle(String title) {
-        this.markupDocBuilder.sectionTitleWithAnchorLevel1(title, OVERVIEW_ANCHOR);
-    }
-
-    private void buildVersionInfoSection(String version) {
-        if(isNotBlank(version)){
-            this.markupDocBuilder.sectionTitleLevel2(CURRENT_VERSION);
-            this.markupDocBuilder.textLine(VERSION + " : " + version);
-        }
-    }
-
-    private void buildDescription(String description) {
-        if(isNotBlank(description)){
-            this.markupDocBuilder.textLine(description);
-        }
-    }
-
-    private void buildContactInfoSection(Contact contact) {
-        if(contact != null){
-            this.markupDocBuilder.sectionTitleLevel2(CONTACT_INFORMATION);
-            if(isNotBlank(contact.getName())){
-                this.markupDocBuilder.textLine(CONTACT_NAME + " : " + contact.getName());
-            }
-            if(isNotBlank(contact.getEmail())){
-                this.markupDocBuilder.textLine(CONTACT_EMAIL + " : " + contact.getEmail());
-            }
-        }
-    }
-
-    private void buildLicenseInfoSection(License license, String termOfService) {
-        if(license != null && (isNotBlank(license.getName()) || isNotBlank(license.getUrl()))) {
-            this.markupDocBuilder.sectionTitleLevel2(LICENSE_INFORMATION);
-            if (isNotBlank(license.getName())) {
-                this.markupDocBuilder.textLine(LICENSE + " : " + license.getName());
-            }
-            if (isNotBlank(license.getUrl())) {
-                this.markupDocBuilder.textLine(LICENSE_URL + " : " + license.getUrl());
-            }
-        }
-        if(isNotBlank(termOfService)){
-            this.markupDocBuilder.textLine(TERMS_OF_SERVICE + " : " + termOfService);
-        }
-    }
-
-    private void buildUriSchemeSection(Swagger swagger) {
-        if(isNotBlank(swagger.getHost()) || isNotBlank(swagger.getBasePath()) || isNotEmpty(swagger.getSchemes())) {
-            this.markupDocBuilder.sectionTitleLevel2(URI_SCHEME);
-            if (isNotBlank(swagger.getHost())) {
-                this.markupDocBuilder.textLine(HOST + " : " + swagger.getHost());
-            }
-            if (isNotBlank(swagger.getBasePath())) {
-                this.markupDocBuilder.textLine(BASE_PATH + " : " + swagger.getBasePath());
-            }
-            if (isNotEmpty(swagger.getSchemes())) {
-                List<String> schemes = new ArrayList<>();
-                for (Scheme scheme : swagger.getSchemes()) {
-                    schemes.add(scheme.toString());
-                }
-                this.markupDocBuilder.textLine(SCHEMES + " : " + join(schemes, ", "));
-            }
-        }
-    }
-
-    private void buildTagsSection(List<Tag> tags) {
-        if(isNotEmpty(tags)){
-            this.markupDocBuilder.sectionTitleLevel2(TAGS);
-            List<String> tagsList = new ArrayList<>();
-            for(Tag tag : tags){
-                String name = tag.getName();
-                String description = tag.getDescription();
-                if(isNoneBlank(description)){
-                    tagsList.add(name + " : " +   description);
-                }else{
-                    tagsList.add(name);
-                }
-            }
-            this.markupDocBuilder.unorderedList(tagsList);
-        }
-    }
-
-    private void buildConsumesSection(List<String> consumes) {
-        if (isNotEmpty(consumes)) {
-            this.markupDocBuilder.sectionTitleLevel2(CONSUMES);
-            this.markupDocBuilder.unorderedList(consumes);
-        }
-    }
-
-    private void buildProducesSection(List<String> consumes) {
-        if (isNotEmpty(consumes)) {
-            this.markupDocBuilder.sectionTitleLevel2(PRODUCES);
-            this.markupDocBuilder.unorderedList(consumes);
-        }
-    }
-
-    /**
-     * Apply extension context to all OverviewContentExtension
-     *
-     * @param context context
-     */
-    private void applyOverviewDocumentExtension(Context context) {
-        for (OverviewDocumentExtension extension : globalContext.getExtensionRegistry().getExtensions(OverviewDocumentExtension.class)) {
-            extension.apply(context);
-        }
-    }
-
-}

src/main/java/io/github/robwin/swagger2markup/internal/document/builder/PathsDocumentBuilder.java

@@ -1,812 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.document.builder;
-
-import com.google.common.base.Joiner;
-import com.google.common.base.Optional;
-import com.google.common.collect.Multimap;
-import io.github.robwin.markup.builder.*;
-import io.github.robwin.swagger2markup.GroupBy;
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.internal.document.MarkupDocument;
-import io.github.robwin.swagger2markup.internal.model.PathOperation;
-import io.github.robwin.swagger2markup.internal.type.ObjectType;
-import io.github.robwin.swagger2markup.internal.type.RefType;
-import io.github.robwin.swagger2markup.internal.type.Type;
-import io.github.robwin.swagger2markup.internal.utils.*;
-import io.github.robwin.swagger2markup.spi.PathsDocumentExtension;
-import io.swagger.models.*;
-import io.swagger.models.auth.SecuritySchemeDefinition;
-import io.swagger.models.parameters.Parameter;
-import io.swagger.models.properties.Property;
-import io.swagger.util.Json;
-import org.apache.commons.collections4.CollectionUtils;
-import org.apache.commons.collections4.MapUtils;
-import org.apache.commons.io.IOUtils;
-import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.lang3.Validate;
-import org.apache.commons.lang3.text.WordUtils;
-
-import java.io.File;
-import java.io.IOException;
-import java.io.Reader;
-import java.net.URI;
-import java.nio.charset.StandardCharsets;
-import java.util.*;
-
-import static io.github.robwin.swagger2markup.internal.utils.IOUtils.normalizeName;
-import static io.github.robwin.swagger2markup.internal.utils.ListUtils.*;
-import static io.github.robwin.swagger2markup.internal.utils.MapUtils.toKeySet;
-import static io.github.robwin.swagger2markup.internal.utils.TagUtils.convertTagsListToMap;
-import static io.github.robwin.swagger2markup.internal.utils.TagUtils.getTagDescription;
-import static io.github.robwin.swagger2markup.spi.PathsDocumentExtension.*;
-import static org.apache.commons.lang3.StringUtils.defaultString;
-import static org.apache.commons.lang3.StringUtils.isNotBlank;
-
-/**
- * @author Robert Winkler
- */
-public class PathsDocumentBuilder extends MarkupDocumentBuilder {
-
-    private final String RESPONSE;
-    private final String REQUEST;
-    private final String PATHS;
-    private final String RESOURCES;
-    private final String PARAMETERS;
-    private final String BODY_PARAMETER;
-    private final String RESPONSES;
-    private final String HEADERS_COLUMN;
-    private final String EXAMPLE_REQUEST;
-    private final String EXAMPLE_RESPONSE;
-
-    private final String SECURITY;
-    private final String TYPE_COLUMN;
-    private final String HTTP_CODE_COLUMN;
-
-    private final String DEPRECATED_OPERATION;
-    private final String UNKNOWN;
-
-    private static final String PATHS_ANCHOR = "paths";
-    private static final String DESCRIPTION_FILE_NAME = "description";
-
-
-    public PathsDocumentBuilder(Swagger2MarkupConverter.Context globalContext, java.nio.file.Path outputPath) {
-        super(globalContext, outputPath);
-
-        ResourceBundle labels = ResourceBundle.getBundle("io/github/robwin/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
-        RESPONSE = labels.getString("response");
-        REQUEST = labels.getString("request");
-        PATHS = labels.getString("paths");
-        RESOURCES = labels.getString("resources");
-        PARAMETERS = labels.getString("parameters");
-        BODY_PARAMETER = labels.getString("body_parameter");
-        RESPONSES = labels.getString("responses");
-        HEADERS_COLUMN = labels.getString("headers_column");
-        EXAMPLE_REQUEST = labels.getString("example_request");
-        EXAMPLE_RESPONSE = labels.getString("example_response");
-        SECURITY = labels.getString("security");
-        TYPE_COLUMN = labels.getString("type_column");
-        HTTP_CODE_COLUMN = labels.getString("http_code_column");
-        DEPRECATED_OPERATION = labels.getString("operation.deprecated");
-        UNKNOWN = labels.getString("unknown");
-
-        if (config.isGeneratedExamplesEnabled()) {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Include examples is enabled.");
-            }
-        } else {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Include examples is disabled.");
-            }
-        }
-        if (config.isOperationDescriptionsEnabled()) {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Include hand-written operation descriptions is enabled.");
-            }
-        } else {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Include hand-written operation descriptions is disabled.");
-            }
-        }
-
-        if (config.isSeparatedOperationsEnabled()) {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Create separated operation files is enabled.");
-            }
-            Validate.notNull(outputPath, "Output directory is required for separated operation files!");
-        } else {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Create separated operation files is disabled.");
-            }
-        }
-    }
-
-    /**
-     * Builds the paths MarkupDocument.
-     *
-     * @return the paths MarkupDocument
-     */
-    @Override
-    public MarkupDocument build() {
-        Map<String, Path> paths = globalContext.getSwagger().getPaths();
-        if (MapUtils.isNotEmpty(paths)) {
-            applyPathsDocumentExtension(new Context(Position.DOCUMENT_BEFORE, this.markupDocBuilder));
-            buildPathsTitle();
-            applyPathsDocumentExtension(new Context(Position.DOCUMENT_BEGIN, this.markupDocBuilder));
-            buildsPathsSection(paths);
-            applyPathsDocumentExtension(new Context(Position.DOCUMENT_END, this.markupDocBuilder));
-        }
-        return new MarkupDocument(markupDocBuilder);
-    }
-
-    private void buildsPathsSection(Map<String, Path> paths) {
-        Set<PathOperation> pathOperations = toPathOperationsSet(paths);
-        if (CollectionUtils.isNotEmpty(pathOperations)) {
-            if (config.getOperationsGroupedBy() == GroupBy.AS_IS) {
-                for (PathOperation operation : pathOperations) {
-                    buildOperation(operation);
-                }
-            } else {
-                Multimap<String, PathOperation> operationsGroupedByTag = TagUtils.groupOperationsByTag(pathOperations, config.getTagOrdering(), config.getOperationOrdering());
-                Map<String, Tag> tagsMap = convertTagsListToMap(globalContext.getSwagger().getTags());
-                for (String tagName : operationsGroupedByTag.keySet()) {
-                    this.markupDocBuilder.sectionTitleLevel2(WordUtils.capitalize(tagName));
-
-                    Optional<String> tagDescription = getTagDescription(tagsMap, tagName);
-                    if (tagDescription.isPresent()) {
-                        this.markupDocBuilder.paragraph(tagDescription.get());
-                    }
-
-                    for (PathOperation operation : operationsGroupedByTag.get(tagName)) {
-                        buildOperation(operation);
-                    }
-                }
-            }
-        }
-    }
-
-    /**
-     * Builds the path title depending on the operationsGroupedBy configuration setting.
-     */
-    private void buildPathsTitle() {
-        if (config.getOperationsGroupedBy() == GroupBy.AS_IS) {
-            buildPathsTitle(PATHS);
-        } else {
-            buildPathsTitle(RESOURCES);
-        }
-    }
-
-    /**
-     * Converts the Swagger paths into a list PathOperations.
-     *
-     * @param paths the Swagger paths
-     * @return the path operations
-     */
-    private Set<PathOperation> toPathOperationsSet(Map<String, Path> paths) {
-        Set<PathOperation> pathOperations;
-        if (config.getOperationOrdering() != null) {
-            pathOperations = new TreeSet<>(config.getOperationOrdering());
-        }else{
-            pathOperations = new LinkedHashSet<>();
-        }
-        for (Map.Entry<String, Path> path : paths.entrySet()) {
-            Map<HttpMethod, Operation> operations = path.getValue().getOperationMap(); // TODO AS_IS does not work because of https://github.com/swagger-api/swagger-core/issues/1696
-            if (MapUtils.isNotEmpty(operations)) {
-                for (Map.Entry<HttpMethod, Operation> operation : operations.entrySet()) {
-                    pathOperations.add(new PathOperation(operation.getKey(), path.getKey(), operation.getValue()));
-                }
-            }
-        }
-        return pathOperations;
-    }
-
-    private void buildPathsTitle(String title) {
-        this.markupDocBuilder.sectionTitleWithAnchorLevel1(title, PATHS_ANCHOR);
-    }
-
-    /**
-     * Apply extension context to all OperationsContentExtension.
-     *
-     * @param context context
-     */
-    private void applyPathsDocumentExtension(Context context) {
-        for (PathsDocumentExtension extension : globalContext.getExtensionRegistry().getExtensions(PathsDocumentExtension.class)) {
-            extension.apply(context);
-        }
-    }
-
-    /**
-     * Create the operation filename depending on the generation mode
-     *
-     * @param operation operation
-     * @return operation filename
-     */
-    private String resolveOperationDocument(PathOperation operation) {
-        if (config.isSeparatedOperationsEnabled())
-            return new File(config.getSeparatedOperationsFolder(), this.markupDocBuilder.addFileExtension(normalizeName(operation.getId()))).getPath();
-        else
-            return this.markupDocBuilder.addFileExtension(config.getPathsDocument());
-    }
-
-    /**
-     * Builds a path operation depending on generation mode.
-     *
-     * @param operation operation
-     */
-    private void buildOperation(PathOperation operation) {
-        if (config.isSeparatedOperationsEnabled()) {
-            MarkupDocBuilder pathDocBuilder = this.markupDocBuilder.copy();
-            buildOperation(operation, pathDocBuilder);
-            java.nio.file.Path operationFile = outputPath.resolve(resolveOperationDocument(operation));
-
-            try {
-                pathDocBuilder.writeToFileWithoutExtension(operationFile, StandardCharsets.UTF_8);
-            } catch (IOException e) {
-                if (logger.isWarnEnabled()) {
-                    logger.warn(String.format("Failed to write operation file: %s", operationFile), e);
-                }
-            }
-            if (logger.isInfoEnabled()) {
-                logger.info("Separate operation file produced: {}", operationFile);
-            }
-
-            buildOperationRef(operation, this.markupDocBuilder);
-
-        } else {
-            buildOperation(operation, this.markupDocBuilder);
-        }
-
-        if (logger.isInfoEnabled()) {
-            logger.info("Operation processed: {}", operation);
-        }
-    }
-
-    /**
-     * Returns the operation name depending on available informations.
-     * The summary is used to name the operation, or else the operation summary is used.
-     *
-     * @param operation operation
-     * @return operation name
-     */
-    private String operationName(PathOperation operation) {
-        return operation.getTitle();
-    }
-
-    /**
-     * Builds a path operation.
-     *
-     * @param operation  the Swagger Operation
-     * @param docBuilder the docbuilder do use for output
-     */
-    private void buildOperation(PathOperation operation, MarkupDocBuilder docBuilder) {
-        if (operation != null) {
-            applyPathsDocumentExtension(new Context(Position.OPERATION_BEGIN, docBuilder, operation));
-            buildDeprecatedSection(operation, docBuilder);
-            buildOperationTitle(operation, docBuilder);
-            buildDescriptionSection(operation, docBuilder);
-            inlineDefinitions(buildParametersSection(operation, docBuilder), operation.getPath() + " " + operation.getMethod(), config.getInlineSchemaDepthLevel(), docBuilder);
-            inlineDefinitions(buildBodyParameterSection(operation, docBuilder), operation.getPath() + " " + operation.getMethod(), config.getInlineSchemaDepthLevel(), docBuilder);
-            inlineDefinitions(buildResponsesSection(operation, docBuilder), operation.getPath() + " " + operation.getMethod(), config.getInlineSchemaDepthLevel(), docBuilder);
-            buildConsumesSection(operation, docBuilder);
-            buildProducesSection(operation, docBuilder);
-            buildTagsSection(operation, docBuilder);
-            buildSecuritySchemeSection(operation, docBuilder);
-            buildExamplesSection(operation, docBuilder);
-            applyPathsDocumentExtension(new Context(Position.OPERATION_END, docBuilder, operation));
-        }
-    }
-
-    /**
-     * Builds a cross-reference to a separated operation file
-     *
-     * @param operation  the Swagger Operation
-     * @param docBuilder the docbuilder do use for output
-     */
-    private void buildOperationRef(PathOperation operation, MarkupDocBuilder docBuilder) {
-        String document;
-        if (!config.isInterDocumentCrossReferencesEnabled() || outputPath == null)
-            document = null;
-        else if (config.isSeparatedOperationsEnabled())
-            document =  defaultString(config.getInterDocumentCrossReferencesPrefix()) + resolveOperationDocument(operation);
-        else
-            document = defaultString(config.getInterDocumentCrossReferencesPrefix()) + resolveOperationDocument(operation);
-        String operationName = operationName(operation);
-
-        buildOperationTitle(docBuilder.copy().crossReference(document, operationName, operationName).toString(), "ref-" + operationName, docBuilder);
-    }
-
-    /**
-     * Builds a warning if method is deprecated.
-     *
-     * @param operation  the Swagger Operation
-     * @param docBuilder the docbuilder do use for output
-     */
-    private void buildDeprecatedSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-        Boolean deprecated = operation.getOperation().isDeprecated();
-        if (deprecated != null && deprecated) {
-            docBuilder.block(DEPRECATED_OPERATION, MarkupBlockStyle.EXAMPLE, null, MarkupAdmonition.CAUTION);
-        }
-    }
-
-    /**
-     * Adds the operation title to the document. If the operation has a summary, the title is the summary.
-     * Otherwise the title is the method of the operation and the URL of the operation.
-     *
-     * @param operation  the Swagger Operation
-     * @param docBuilder the docbuilder do use for output
-     */
-    private void buildOperationTitle(PathOperation operation, MarkupDocBuilder docBuilder) {
-        String operationName = operationName(operation);
-
-        buildOperationTitle(operationName, null, docBuilder);
-        if (operationName.equals(operation.getOperation().getSummary())) {
-            docBuilder.listing(operation.getMethod() + " " + operation.getPath());
-        }
-    }
-
-    /**
-     * Adds a operation title to the document.
-     *
-     * @param title      the operation title
-     * @param anchor     optional anchor (null => auto-generate from title)
-     * @param docBuilder the MarkupDocBuilder to use
-     */
-    private void buildOperationTitle(String title, String anchor, MarkupDocBuilder docBuilder) {
-        if (config.getOperationsGroupedBy() == GroupBy.AS_IS) {
-            docBuilder.sectionTitleWithAnchorLevel2(title, anchor);
-        } else {
-            docBuilder.sectionTitleWithAnchorLevel3(title, anchor);
-        }
-    }
-
-    /**
-     * Adds a operation section title to the document.
-     *
-     * @param title      the section title
-     * @param docBuilder the MarkupDocBuilder to use
-     */
-    private void buildSectionTitle(String title, MarkupDocBuilder docBuilder) {
-        if (config.getOperationsGroupedBy() == GroupBy.AS_IS) {
-            docBuilder.sectionTitleLevel3(title);
-        } else {
-            docBuilder.sectionTitleLevel4(title);
-        }
-    }
-
-    /**
-     * Adds a response section title to the document.
-     *
-     * @param title      the response title
-     * @param docBuilder the MarkupDocBuilder to use
-     */
-    private void buildResponseTitle(String title, MarkupDocBuilder docBuilder) {
-        if (config.getOperationsGroupedBy() == GroupBy.AS_IS) {
-            docBuilder.sectionTitleLevel4(title);
-        } else {
-            docBuilder.sectionTitleLevel5(title);
-        }
-    }
-
-    /**
-     * Adds a operation description to the document.
-     * If hand-written descriptions exist, it tries to load the description from a file.
-     * If the file cannot be read, the description of the operation is returned.
-     * Operation folder search order :
-     * - normalizeOperationFileName(operation.operationId)
-     * - then, normalizeOperationFileName(operation.method + " " + operation.path)
-     * - then, normalizeOperationFileName(operation.summary)
-     *
-     * @param operation  the Swagger Operation
-     * @param docBuilder the docbuilder do use for output
-     */
-    private void buildDescriptionSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-        if (config.isOperationDescriptionsEnabled()) {
-            Optional<String> description = handWrittenOperationDescription(normalizeName(operation.getId()), DESCRIPTION_FILE_NAME);
-            if (!description.isPresent())
-                description = handWrittenOperationDescription(normalizeName(operation.getTitle()), DESCRIPTION_FILE_NAME);
-
-            if (description.isPresent()) {
-                operationDescription(description.get(), docBuilder);
-            } else {
-                operationDescription(operation.getOperation().getDescription(), docBuilder);
-            }
-        } else {
-            operationDescription(operation.getOperation().getDescription(), docBuilder);
-        }
-    }
-
-    private void operationDescription(String description, MarkupDocBuilder docBuilder) {
-        if (isNotBlank(description)) {
-            buildSectionTitle(DESCRIPTION, docBuilder);
-            docBuilder.paragraph(description);
-        }
-    }
-
-    /**
-     * Filter parameters to display in parameters section
-     *
-     * @param parameter parameter to filter
-     * @return true if parameter can be displayed
-     */
-    private boolean filterParameter(Parameter parameter) {
-        return (!config.isFlatBodyEnabled() || !StringUtils.equals(parameter.getIn(), "body"));
-    }
-
-    private List<ObjectType> buildParametersSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-        List<Parameter> parameters = operation.getOperation().getParameters();
-        if (config.getParameterOrdering() != null)
-            Collections.sort(parameters, config.getParameterOrdering());
-        List<ObjectType> localDefinitions = new ArrayList<>();
-
-        boolean displayParameters = false;
-        if (CollectionUtils.isNotEmpty(parameters)) {
-            for (Parameter p : parameters) {
-                if (filterParameter(p)) {
-                    displayParameters = true;
-                    break;
-                }
-            }
-        }
-
-        if (displayParameters) {
-            List<List<String>> cells = new ArrayList<>();
-            List<MarkupTableColumn> cols = Arrays.asList(
-                    new MarkupTableColumn(TYPE_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"),
-                    new MarkupTableColumn(NAME_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"),
-                    new MarkupTableColumn(DESCRIPTION_COLUMN, 6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6"),
-                    new MarkupTableColumn(REQUIRED_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
-                    new MarkupTableColumn(SCHEMA_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
-                    new MarkupTableColumn(DEFAULT_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
-            for (Parameter parameter : parameters) {
-                if (filterParameter(parameter)) {
-                    Type type = ParameterUtils.getType(parameter, new DefinitionDocumentResolverFromOperation());
-
-                    if (config.getInlineSchemaDepthLevel() > 0 && type instanceof ObjectType) {
-                        if (MapUtils.isNotEmpty(((ObjectType) type).getProperties())) {
-                            String localTypeName = parameter.getName();
-
-                            type.setName(localTypeName);
-                            type.setUniqueName(operation.getId() + " " + localTypeName);
-                            localDefinitions.add((ObjectType) type);
-                            type = new RefType(type);
-                        }
-                    }
-                    String parameterType = WordUtils.capitalize(parameter.getIn());
-
-                    List<String> content = Arrays.asList(
-                            parameterType,
-                            parameter.getName(),
-                            parameterDescription(operation, parameter),
-                            Boolean.toString(parameter.getRequired()),
-                            type.displaySchema(markupDocBuilder),
-                            ParameterUtils.getDefaultValue(parameter));
-                    cells.add(content);
-                }
-            }
-            buildSectionTitle(PARAMETERS, docBuilder);
-            docBuilder.tableWithColumnSpecs(cols, cells);
-        }
-
-        return localDefinitions;
-    }
-
-    /**
-     * Builds the body parameter section, if {@code Swagger2MarkupConfig.isIsolatedBody()} is true
-     *
-     * @param operation  the Swagger Operation
-     * @param docBuilder the docbuilder do use for output
-     * @return a list of inlined types.
-     */
-    private List<ObjectType> buildBodyParameterSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-        List<ObjectType> localDefinitions = new ArrayList<>();
-
-        if (config.isFlatBodyEnabled()) {
-            List<Parameter> parameters = operation.getOperation().getParameters();
-            if (CollectionUtils.isNotEmpty(parameters)) {
-                for (Parameter parameter : parameters) {
-                    if (StringUtils.equals(parameter.getIn(), "body")) {
-                        Type type = ParameterUtils.getType(parameter, new DefinitionDocumentResolverFromOperation());
-
-                        buildSectionTitle(BODY_PARAMETER, docBuilder);
-                        if (isNotBlank(parameter.getDescription())) {
-                            docBuilder.paragraph(parameter.getDescription());
-                        }
-
-                        MarkupDocBuilder typeInfos = MarkupDocBuilders.documentBuilder(config.getMarkupLanguage(), config.getLineSeparator());
-                        typeInfos.italicText(REQUIRED_COLUMN).textLine(": " + parameter.getRequired());
-                        typeInfos.italicText(NAME_COLUMN).textLine(": " + parameter.getName());
-                        if (!(type instanceof ObjectType)) {
-                            typeInfos.italicText(TYPE_COLUMN).textLine(": " + type.displaySchema(docBuilder));
-
-                            docBuilder.paragraph(typeInfos.toString());
-                        } else {
-                            docBuilder.paragraph(typeInfos.toString());
-
-                            localDefinitions.addAll(buildPropertiesTable((ObjectType) type, operation.getId(), config.getInlineSchemaDepthLevel(), new PropertyDescriptor(type), new DefinitionDocumentResolverFromOperation(), docBuilder));
-                        }
-                    }
-                }
-            }
-        }
-
-        return localDefinitions;
-    }
-
-    /**
-     * Retrieves the description of a parameter, or otherwise an empty String.
-     * If hand-written descriptions exist, it tries to load the description from a file.
-     * If the file cannot be read, the description of the parameter is returned.
-     * Operation folder search order :
-     * - normalizeOperationFileName(operation.operationId)
-     * - then, normalizeOperationFileName(operation.method + " " + operation.path)
-     * - then, normalizeOperationFileName(operation.summary)
-     *
-     * @param operation the Swagger Operation
-     * @param parameter the Swagger Parameter
-     * @return the description of a parameter.
-     */
-    private String parameterDescription(final PathOperation operation, Parameter parameter) {
-        if (config.isOperationDescriptionsEnabled()) {
-            final String parameterName = parameter.getName();
-            if (isNotBlank(parameterName)) {
-                Optional<String> description = handWrittenOperationDescription(new File(normalizeName(operation.getId()), parameterName).getPath(), DESCRIPTION_FILE_NAME);
-                if (!description.isPresent())
-                    description = handWrittenOperationDescription(new File(normalizeName(operation.getTitle()), parameterName).getPath(), DESCRIPTION_FILE_NAME);
-
-                if (description.isPresent()) {
-                    return description.get();
-                } else {
-                    return defaultString(parameter.getDescription());
-                }
-            } else {
-                return defaultString(parameter.getDescription());
-            }
-        } else {
-            return defaultString(parameter.getDescription());
-        }
-    }
-
-    private void buildConsumesSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-        List<String> consumes = operation.getOperation().getConsumes();
-        if (CollectionUtils.isNotEmpty(consumes)) {
-            buildSectionTitle(CONSUMES, docBuilder);
-            docBuilder.unorderedList(consumes);
-        }
-
-    }
-
-    private void buildProducesSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-        List<String> produces = operation.getOperation().getProduces();
-        if (CollectionUtils.isNotEmpty(produces)) {
-            buildSectionTitle(PRODUCES, docBuilder);
-            docBuilder.unorderedList(produces);
-        }
-    }
-
-    private void buildTagsSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-        if (config.getOperationsGroupedBy() == GroupBy.AS_IS) {
-            List<String> tags = operation.getOperation().getTags();
-            if (CollectionUtils.isNotEmpty(tags)) {
-                buildSectionTitle(TAGS, docBuilder);
-                Set<String> tagsSet = toSet(tags, config.getTagOrdering());
-                docBuilder.unorderedList(new ArrayList<>(tagsSet));
-            }
-        }
-    }
-
-    /**
-     * Builds the example section of a Swagger Operation.
-     *
-     * @param operation  the Swagger Operation
-     * @param docBuilder the docbuilder do use for output
-     */
-    private void buildExamplesSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-
-        Map<String, Object> generatedRequestExampleMap = ExamplesUtil.generateRequestExampleMap(config.isGeneratedExamplesEnabled(), operation, globalContext.getSwagger().getDefinitions(), markupDocBuilder);
-        Map<String, Object> generatedResponseExampleMap = ExamplesUtil.generateResponseExampleMap(config.isGeneratedExamplesEnabled(), operation.getOperation(), globalContext.getSwagger().getDefinitions(), markupDocBuilder);
-
-        exampleMap(generatedRequestExampleMap, EXAMPLE_REQUEST, REQUEST, docBuilder);
-        exampleMap(generatedResponseExampleMap, EXAMPLE_RESPONSE, RESPONSE, docBuilder);
-    }
-
-    private void exampleMap(Map<String, Object> exampleMap, String operationSectionTitle, String sectionTile, MarkupDocBuilder docBuilder) {
-        if (exampleMap.size() > 0) {
-            buildSectionTitle(operationSectionTitle, docBuilder);
-            for (Map.Entry<String, Object> entry : exampleMap.entrySet()) {
-                buildSectionTitle(sectionTile + " " + entry.getKey(), docBuilder);
-                docBuilder.listing(Json.pretty(entry.getValue()));
-            }
-        }
-    }
-
-    /**
-     * Builds the security section of a Swagger Operation.
-     *
-     * @param operation  the Swagger Operation
-     * @param docBuilder the MarkupDocBuilder document builder
-     */
-    private void buildSecuritySchemeSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-        List<Map<String, List<String>>> securitySchemes = operation.getOperation().getSecurity();
-        if (CollectionUtils.isNotEmpty(securitySchemes)) {
-            buildSectionTitle(SECURITY, docBuilder);
-            Map<String, SecuritySchemeDefinition> securityDefinitions = globalContext.getSwagger().getSecurityDefinitions();
-            List<List<String>> cells = new ArrayList<>();
-            List<MarkupTableColumn> cols = Arrays.asList(
-                    new MarkupTableColumn(TYPE_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
-                    new MarkupTableColumn(NAME_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"),
-                    new MarkupTableColumn(SCOPES_COLUMN, 6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6"));
-            for (Map<String, List<String>> securityScheme : securitySchemes) {
-                for (Map.Entry<String, List<String>> securityEntry : securityScheme.entrySet()) {
-                    String securityKey = securityEntry.getKey();
-                    String type = UNKNOWN;
-                    if (securityDefinitions != null && securityDefinitions.containsKey(securityKey)) {
-                        type = securityDefinitions.get(securityKey).getType();
-                    }
-                    List<String> content = Arrays.asList(type, docBuilder.copy().crossReference(securityKey, securityKey).toString(),
-                            Joiner.on(",").join(securityEntry.getValue()));
-                    cells.add(content);
-                }
-            }
-            docBuilder.tableWithColumnSpecs(cols, cells);
-        }
-    }
-
-    /**
-     * Reads a hand-written description
-     *
-     * @param descriptionFolder   the name of the folder where the description file resides
-     * @param descriptionFileName the name of the description file
-     * @return the content of the file
-     */
-    private Optional<String> handWrittenOperationDescription(String descriptionFolder, String descriptionFileName) {
-        for (String fileNameExtension : config.getMarkupLanguage().getFileNameExtensions()) {
-            URI contentUri = config.getOperationDescriptionsUri().resolve(descriptionFolder).resolve(descriptionFileName + fileNameExtension);
-
-            try (Reader reader = io.github.robwin.swagger2markup.internal.utils.IOUtils.uriReader(contentUri)) {
-                if (logger.isInfoEnabled()) {
-                    logger.info("Operation description content processed {}", contentUri);
-                }
-
-                return Optional.of(IOUtils.toString(reader).trim());
-            } catch (IOException e) {
-                if (logger.isDebugEnabled()) {
-                    logger.debug("Failed to read Operation description content {} > {}", contentUri, e.getMessage());
-                }
-            }
-        }
-        return Optional.absent();
-    }
-
-    private List<ObjectType> buildResponsesSection(PathOperation operation, MarkupDocBuilder docBuilder) {
-        Map<String, Response> responses = operation.getOperation().getResponses();
-        List<ObjectType> localDefinitions = new ArrayList<>();
-
-        if (MapUtils.isNotEmpty(responses)) {
-            buildSectionTitle(RESPONSES, docBuilder);
-
-            List<MarkupTableColumn> responseCols = Arrays.asList(
-                    new MarkupTableColumn(HTTP_CODE_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"),
-                    new MarkupTableColumn(DESCRIPTION_COLUMN, 3).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
-                    new MarkupTableColumn(SCHEMA_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
-
-            List<MarkupTableColumn> responseHeaderCols = Arrays.asList(
-                    new MarkupTableColumn(NAME_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"),
-                    new MarkupTableColumn(DESCRIPTION_COLUMN, 3).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
-                    new MarkupTableColumn(SCHEMA_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
-                    new MarkupTableColumn(DEFAULT_COLUMN, 1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
-
-            Set<String> responseNames = toKeySet(responses, config.getResponseOrdering());
-            for (String responseName : responseNames) {
-                List<List<String>> cells = new ArrayList<>();
-                List<List<String>> responseHeaderCells = new ArrayList<>();
-                Response response = responses.get(responseName);
-                if (response.getSchema() != null) {
-                    Property property = response.getSchema();
-                    Type type = PropertyUtils.getType(property, new DefinitionDocumentResolverFromOperation());
-                    if (config.getInlineSchemaDepthLevel() > 0 && type instanceof ObjectType) {
-                        if (MapUtils.isNotEmpty(((ObjectType) type).getProperties())) {
-                            String localTypeName = RESPONSE + " " + responseName;
-
-                            type.setName(localTypeName);
-                            type.setUniqueName(operation.getId() + " " + localTypeName);
-                            localDefinitions.add((ObjectType) type);
-                            type = new RefType(type);
-                        }
-                    }
-                    cells.add(Arrays.asList(responseName, response.getDescription(), type.displaySchema(markupDocBuilder)));
-                } else {
-                    cells.add(Arrays.asList(responseName, response.getDescription(), NO_CONTENT));
-                }
-
-                buildResponseTitle(HTTP_CODE_COLUMN + " " + responseName, docBuilder);
-                docBuilder.tableWithColumnSpecs(responseCols, cells);
-
-                Map<String, Property> headers = response.getHeaders();
-                if(MapUtils.isNotEmpty(headers)) {
-                    docBuilder.boldTextLine(HEADERS_COLUMN);
-                    for(Map.Entry<String, Property> entry : headers.entrySet()){
-                        Property property = entry.getValue();
-                        Type propertyType = PropertyUtils.getType(property, null);
-                        responseHeaderCells.add(Arrays.asList(entry.getKey(),
-                                response.getDescription(),
-                                propertyType.displaySchema(markupDocBuilder),
-                                PropertyUtils.getDefaultValue(property)));
-                    }
-                    docBuilder.tableWithColumnSpecs(responseHeaderCols, responseHeaderCells);
-                }
-            }
-        }
-        return localDefinitions;
-    }
-
-
-
-
-
-    /**
-     * Builds the title of an inline schema.
-     * Inline definitions should never been referenced in TOC because they have no real existence, so they are just text.
-     *
-     * @param title      inline schema title
-     * @param anchor     inline schema anchor
-     * @param docBuilder the docbuilder do use for output
-     */
-    private void addInlineDefinitionTitle(String title, String anchor, MarkupDocBuilder docBuilder) {
-        docBuilder.anchor(anchor);
-        docBuilder.newLine();
-        docBuilder.boldTextLine(title);
-    }
-
-    /**
-     * Builds inline schema definitions
-     *
-     * @param definitions  all inline definitions to display
-     * @param uniquePrefix unique prefix to prepend to inline object names to enforce unicity
-     * @param depth        current inline schema depth
-     * @param docBuilder   the docbuilder do use for output
-     */
-    private void inlineDefinitions(List<ObjectType> definitions, String uniquePrefix, int depth, MarkupDocBuilder docBuilder) {
-        if (CollectionUtils.isNotEmpty(definitions)) {
-            for (ObjectType definition : definitions) {
-                addInlineDefinitionTitle(definition.getName(), definition.getUniqueName(), docBuilder);
-
-                List<ObjectType> localDefinitions = buildPropertiesTable(definition, uniquePrefix, depth, new PropertyDescriptor(definition), new DefinitionDocumentResolverFromOperation(), docBuilder);
-                for (ObjectType localDefinition : localDefinitions)
-                    inlineDefinitions(Collections.singletonList(localDefinition), uniquePrefix, depth - 1, docBuilder);
-            }
-        }
-
-    }
-
-    /**
-     * Overrides definition document resolver functor for inter-document cross-references from operations files.
-     * This implementation adapt the relative paths to definitions files
-     */
-    class DefinitionDocumentResolverFromOperation extends DefinitionDocumentResolverDefault {
-
-        public DefinitionDocumentResolverFromOperation() {
-        }
-
-        public String apply(String definitionName) {
-            String defaultResolver = super.apply(definitionName);
-
-            if (defaultResolver != null && config.isSeparatedOperationsEnabled())
-                return defaultString(config.getInterDocumentCrossReferencesPrefix()) + new File("..", defaultResolver).getPath();
-            else
-                return defaultResolver;
-        }
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java

@@ -1,145 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.document.builder;
-
-import io.github.robwin.markup.builder.MarkupDocBuilder;
-import io.github.robwin.markup.builder.MarkupTableColumn;
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.internal.document.MarkupDocument;
-import io.github.robwin.swagger2markup.spi.SecurityDocumentExtension;
-import io.swagger.models.auth.ApiKeyAuthDefinition;
-import io.swagger.models.auth.OAuth2Definition;
-import io.swagger.models.auth.SecuritySchemeDefinition;
-import org.apache.commons.collections4.MapUtils;
-import org.apache.commons.lang3.StringUtils;
-
-import java.nio.file.Path;
-import java.util.*;
-
-import static io.github.robwin.swagger2markup.spi.SecurityDocumentExtension.Context;
-import static io.github.robwin.swagger2markup.spi.SecurityDocumentExtension.Position;
-import static org.apache.commons.lang3.StringUtils.isNotBlank;
-
-/**
- * @author Robert Winkler
- */
-public class SecurityDocumentBuilder extends MarkupDocumentBuilder {
-
-    private static final String SECURITY_ANCHOR = "security";
-    private final String SECURITY;
-    private final String TYPE;
-    private final String NAME;
-    private final String IN;
-    private final String FLOW;
-    private final String AUTHORIZATION_URL;
-    private final String TOKEN_URL;
-
-    public SecurityDocumentBuilder(Swagger2MarkupConverter.Context context, Path outputPath) {
-        super(context, outputPath);
-
-        ResourceBundle labels = ResourceBundle.getBundle("io/github/robwin/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
-        SECURITY = labels.getString("security");
-        TYPE = labels.getString("security_type");
-        NAME = labels.getString("security_name");
-        IN = labels.getString("security_in");
-        FLOW = labels.getString("security_flow");
-        AUTHORIZATION_URL = labels.getString("security_authorizationUrl");
-        TOKEN_URL = labels.getString("security_tokenUrl");
-    }
-
-    /**
-     * Builds the security MarkupDocument.
-     *
-     * @return the security MarkupDocument
-     */
-    @Override
-    public MarkupDocument build(){
-        Map<String, SecuritySchemeDefinition> definitions = globalContext.getSwagger().getSecurityDefinitions();
-        if (MapUtils.isNotEmpty(definitions)) {
-            applySecurityDocumentExtension(new Context(Position.DOCUMENT_BEFORE, this.markupDocBuilder));
-            buildSecurityTitle(SECURITY);
-            applySecurityDocumentExtension(new Context(Position.DOCUMENT_BEGIN, this.markupDocBuilder));
-            buildSecuritySchemeDefinitionsSection(definitions);
-            applySecurityDocumentExtension(new Context(Position.DOCUMENT_END, this.markupDocBuilder));
-        }
-        return new MarkupDocument(markupDocBuilder);
-    }
-
-    private void buildSecurityTitle(String title) {
-        this.markupDocBuilder.sectionTitleWithAnchorLevel1(title, SECURITY_ANCHOR);
-
-    }
-
-    private void buildSecuritySchemeDefinitionsSection(Map<String, SecuritySchemeDefinition> definitions) {
-        for (Map.Entry<String, SecuritySchemeDefinition> entry : definitions.entrySet()) {
-            String definitionName = entry.getKey();
-            SecuritySchemeDefinition definition = entry.getValue();
-            buildSecuritySchemeDefinitionTitle(definitionName);
-            applySecurityDocumentExtension(new Context(Position.DEFINITION_BEGIN, markupDocBuilder, definitionName, definition));
-            buildDescriptionParagraph(definition.getDescription());
-            buildSecurityScheme(definition);
-            applySecurityDocumentExtension(new Context(Position.DEFINITION_BEGIN, markupDocBuilder, definitionName, definition));
-        }
-    }
-
-    private void buildDescriptionParagraph(String description) {
-        if(StringUtils.isNotBlank(description)) {
-            markupDocBuilder.paragraph(description);
-        }
-    }
-
-    private MarkupDocBuilder buildSecuritySchemeDefinitionTitle(String definitionName) {
-        return markupDocBuilder.sectionTitleLevel2(definitionName);
-    }
-
-    private void buildSecurityScheme(SecuritySchemeDefinition securityScheme) {
-        String type = securityScheme.getType();
-        markupDocBuilder.textLine(TYPE + " : " + type);
-        if (securityScheme instanceof ApiKeyAuthDefinition) {
-            markupDocBuilder.textLine(NAME + " : " + ((ApiKeyAuthDefinition) securityScheme).getName());
-            markupDocBuilder.textLine(IN + " : " + ((ApiKeyAuthDefinition) securityScheme).getIn());
-        } else if (securityScheme instanceof OAuth2Definition) {
-            OAuth2Definition oauth2Scheme = (OAuth2Definition) securityScheme;
-            String flow = oauth2Scheme.getFlow();
-            markupDocBuilder.textLine(FLOW + " : " + flow);
-            if (isNotBlank(oauth2Scheme.getAuthorizationUrl())) {
-                markupDocBuilder.textLine(AUTHORIZATION_URL + " : " + oauth2Scheme.getAuthorizationUrl());
-            }
-            if (isNotBlank(oauth2Scheme.getTokenUrl())) {
-                markupDocBuilder.textLine(TOKEN_URL + " : " + oauth2Scheme.getTokenUrl());
-            }
-            List<List<String>> cells = new ArrayList<>();
-            List<MarkupTableColumn> cols = Arrays.asList(new MarkupTableColumn(NAME_COLUMN, 1),
-                    new MarkupTableColumn(DESCRIPTION_COLUMN, 6));
-            for (Map.Entry<String, String> scope : oauth2Scheme.getScopes().entrySet()) {
-                List<String> content = Arrays.asList(scope.getKey(), scope.getValue());
-                cells.add(content);
-            }
-            markupDocBuilder.tableWithColumnSpecs(cols, cells);
-        }
-    }
-
-    /**
-     * Apply extension context to all SecurityContentExtension
-     *
-     * @param context context
-     */
-    private void applySecurityDocumentExtension(Context context) {
-        for (SecurityDocumentExtension extension : globalContext.getExtensionRegistry().getExtensions(SecurityDocumentExtension.class)) {
-            extension.apply(context);
-        }
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/extensions/ContentExtension.java

@@ -1,98 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.extensions;
-
-import com.google.common.base.Optional;
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.spi.ContentContext;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.io.FileReader;
-import java.io.IOException;
-import java.io.Reader;
-import java.net.URI;
-import java.nio.file.Files;
-import java.nio.file.Path;
-
-class ContentExtension {
-
-    private static final Logger logger = LoggerFactory.getLogger(ContentExtension.class);
-
-    protected final Swagger2MarkupConverter.Context globalContext;
-    protected final ContentContext contentContext;
-
-
-    ContentExtension(Swagger2MarkupConverter.Context globalContext, ContentContext contentContext) {
-        this.globalContext = globalContext;
-        this.contentContext = contentContext;
-    }
-
-    /**
-     * Reads contents from a file
-     *
-     * @param contentPath content file path
-     * @return content reader
-     */
-    protected Optional<Reader> readContentPath(Path contentPath) {
-
-        if (Files.isReadable(contentPath)) {
-            if (logger.isInfoEnabled()) {
-                logger.info("Content file {} processed", contentPath);
-            }
-            try {
-                Reader contentReader = new FileReader(contentPath.toFile());
-
-                return Optional.of(contentReader);
-            } catch (IOException e) {
-                if (logger.isWarnEnabled()) {
-                    logger.warn("Failed to read content file {} > {}", contentPath, e.getMessage());
-                }
-            }
-        } else {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Failed to read content file {}", contentPath);
-            }
-        }
-
-        return Optional.absent();
-    }
-
-    /**
-     * Reads content from an Uri
-     *
-     * @param contentUri content file URI
-     * @return content reader
-     */
-    protected Optional<Reader> readContentUri(URI contentUri) {
-        try {
-            Reader reader = io.github.robwin.swagger2markup.internal.utils.IOUtils.uriReader(contentUri);
-
-            if (logger.isInfoEnabled()) {
-                logger.info("Content URI {} processed", contentUri);
-            }
-
-            return Optional.of(reader);
-        } catch (IOException e) {
-            if (logger.isDebugEnabled()) {
-                logger.debug("Failed to read content URI {} > {}", contentUri, e.getMessage());
-            }
-        }
-
-        return Optional.absent();
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/extensions/DynamicContentExtension.java

@@ -1,97 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.extensions;
-
-import com.google.common.base.Function;
-import com.google.common.base.Optional;
-import com.google.common.collect.Collections2;
-import com.google.common.collect.Lists;
-import com.google.common.collect.Ordering;
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.spi.ContentContext;
-import org.apache.commons.io.FilenameUtils;
-import org.apache.commons.lang3.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.io.IOException;
-import java.io.Reader;
-import java.nio.file.DirectoryStream;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.List;
-
-class DynamicContentExtension extends ContentExtension {
-
-    private static final Logger logger = LoggerFactory.getLogger(DynamicContentExtension.class);
-
-    DynamicContentExtension(Swagger2MarkupConverter.Context globalContext, ContentContext contentContext) {
-        super(globalContext, contentContext);
-    }
-
-    /**
-     * Builds extension sections
-     *
-     * @param contentPath the path where the content files reside
-     * @param prefix      extension file prefix
-     * @param levelOffset import markup level offset
-     */
-    public void extensionsSection(Path contentPath, final String prefix, int levelOffset) {
-        final Collection<String> filenameExtensions = Collections2.transform(globalContext.getConfig().getMarkupLanguage().getFileNameExtensions(), new Function<String, String>() {
-            public String apply(String input) {
-                return StringUtils.stripStart(input, ".");
-            }
-        });
-
-        DirectoryStream.Filter<Path> filter = new DirectoryStream.Filter<Path>() {
-            @Override
-            public boolean accept(Path entry) throws IOException {
-                String fileName = entry.getFileName().toString();
-                return fileName.startsWith(prefix) && FilenameUtils.isExtension(fileName, filenameExtensions);
-            }
-        };
-
-        try (DirectoryStream<Path> extensionFiles = Files.newDirectoryStream(contentPath, filter)) {
-
-            if (extensionFiles != null) {
-                List<Path> extensions = Lists.newArrayList(extensionFiles);
-                Collections.sort(extensions, Ordering.natural());
-
-                for (Path extension : extensions) {
-                    Optional<Reader> extensionContent = readContentPath(extension);
-
-                    if (extensionContent.isPresent()) {
-                        try {
-                            contentContext.getMarkupDocBuilder().importMarkup(extensionContent.get(), levelOffset);
-                        } catch (IOException e) {
-                            throw new RuntimeException(String.format("Failed to read extension file %s", extension), e);
-                        } finally {
-                            extensionContent.get().close();
-                        }
-                    }
-                }
-            }
-        } catch (IOException e) {
-            if (logger.isDebugEnabled())
-                logger.debug("Failed to read extension files from directory {}", contentPath);
-
-        }
-    }
-
-}

src/main/java/io/github/robwin/swagger2markup/internal/extensions/DynamicDefinitionsDocumentExtension.java

@@ -1,100 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.extensions;
-
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.internal.utils.IOUtils;
-import io.github.robwin.swagger2markup.spi.DefinitionsDocumentExtension;
-import org.apache.commons.lang3.Validate;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.nio.file.Path;
-import java.nio.file.Paths;
-
-/**
- * Dynamically search for markup files in {@code contentPath} to append in Definitions, with the format :<br/>
- * - {@code document-before-*.<markup.ext>} : import before Definitions document with levelOffset = 0<br/>
- * - {@code document-begin-*.<markup.ext>} : import just after Definitions document main title with levelOffset = 1<br/>
- * - {@code document-end-*.<markup.ext>} : import at the end of Definitions document with levelOffset = 1<br/>
- * - {@code definition-begin-*.<markup.ext>} : import just after each definition title with levelOffset = 2<br/>
- * - {@code definition-end-*.<markup.ext>} : import at the end of each definition with levelOffset = 2<br/>
- * <p/>
- * Markup files are appended in the natural order of their names, for each category.
- */
-public final class DynamicDefinitionsDocumentExtension extends DefinitionsDocumentExtension {
-
-    private static final Logger logger = LoggerFactory.getLogger(DynamicDefinitionsDocumentExtension.class);
-
-    protected Path contentPath;
-
-    public DynamicDefinitionsDocumentExtension(Path contentPath) {
-        super();
-
-        Validate.notNull(contentPath);
-        this.contentPath = contentPath;
-    }
-
-    public DynamicDefinitionsDocumentExtension() {
-        super();
-    }
-
-    @Override
-    public void init(Swagger2MarkupConverter.Context globalContext) {
-        if (contentPath == null) {
-            if (globalContext.getSwaggerLocation() == null || !globalContext.getSwaggerLocation().getScheme().equals("file")) {
-                if (logger.isWarnEnabled())
-                    logger.warn("Disable DynamicDefinitionsContentExtension > Can't set default contentPath from swaggerLocation. You have to explicitly configure the content path.");
-            } else {
-                contentPath = Paths.get(globalContext.getSwaggerLocation()).getParent();
-            }
-        }
-    }
-
-    @Override
-    public void apply(Context context) {
-        Validate.notNull(context);
-
-        if (contentPath != null) {
-            DynamicContentExtension dynamicContent = new DynamicContentExtension(globalContext, context);
-            DynamicDefinitionsDocumentExtension.Position position = context.getPosition();
-            switch (position) {
-                case DOCUMENT_BEFORE:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DOCUMENT_BEGIN:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DOCUMENT_END:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DEFINITION_BEGIN:
-                    dynamicContent.extensionsSection(contentPath.resolve(Paths.get(IOUtils.normalizeName(context.getDefinitionName().get()))), contentPrefix(position), levelOffset(context));
-                    break;
-                case DEFINITION_END:
-                    dynamicContent.extensionsSection(contentPath.resolve(Paths.get(IOUtils.normalizeName(context.getDefinitionName().get()))), contentPrefix(position), levelOffset(context));
-                    break;
-                default:
-                    throw new RuntimeException(String.format("Unknown position '%s'", position));
-            }
-        }
-    }
-
-    public String contentPrefix(Position position) {
-        return position.name().toLowerCase().replace('_', '-');
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/extensions/DynamicOverviewDocumentExtension.java

@@ -1,92 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.extensions;
-
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.spi.OverviewDocumentExtension;
-import org.apache.commons.lang3.Validate;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.nio.file.Path;
-import java.nio.file.Paths;
-
-/**
- * Dynamically search for markup files in {@code contentPath} to append to Overview, with the format :<br/>
- * - {@code document-before-*.<markup.ext>} : import before Overview document with levelOffset = 0<br/>
- * - {@code document-begin-*.<markup.ext>} : import just after Overview document main title with levelOffset = 1<br/>
- * - {@code document-end-*.<markup.ext>} : import at the end of Overview document with levelOffset = 1<br/>
- * <p/>
- * Markup files are appended in the natural order of their names, for each category.
- */
-public final class DynamicOverviewDocumentExtension extends OverviewDocumentExtension {
-
-    private static final Logger logger = LoggerFactory.getLogger(DynamicOverviewDocumentExtension.class);
-
-    protected Path contentPath;
-
-    public DynamicOverviewDocumentExtension() {
-        super();
-    }
-
-    public DynamicOverviewDocumentExtension(Path contentPath) {
-        super();
-
-        Validate.notNull(contentPath);
-        this.contentPath = contentPath;
-    }
-
-    @Override
-    public void init(Swagger2MarkupConverter.Context globalContext) {
-        if (contentPath == null) {
-            if (globalContext.getSwaggerLocation() == null || !globalContext.getSwaggerLocation().getScheme().equals("file")) {
-                if (logger.isWarnEnabled())
-                    logger.warn("Disable > DynamicOverviewContentExtension > Can't set default contentPath from swaggerLocation. You have to explicitly configure the content path.");
-            } else {
-                contentPath = Paths.get(globalContext.getSwaggerLocation()).getParent();
-            }
-        }
-    }
-
-    @Override
-    public void apply(Context context) {
-        Validate.notNull(context);
-
-        if (contentPath != null) {
-            DynamicContentExtension dynamicContent = new DynamicContentExtension(globalContext, context);
-            OverviewDocumentExtension.Position position = context.getPosition();
-            switch (position) {
-                case DOCUMENT_BEFORE:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DOCUMENT_BEGIN:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DOCUMENT_END:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                default:
-                    throw new RuntimeException(String.format("Unknown position '%s'", position));
-            }
-        }
-    }
-
-    private String contentPrefix(Position position) {
-        return position.name().toLowerCase().replace('_', '-');
-    }
-
-}

src/main/java/io/github/robwin/swagger2markup/internal/extensions/DynamicPathsDocumentExtension.java

@@ -1,101 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.extensions;
-
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.internal.utils.IOUtils;
-import io.github.robwin.swagger2markup.spi.PathsDocumentExtension;
-import org.apache.commons.lang3.Validate;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.nio.file.Path;
-import java.nio.file.Paths;
-
-/**
- * Dynamically search for markup files in {@code contentPath} to append to Operations, with the format :<br/>
- * - {@code document-before-*.<markup.ext>} : import before Paths document with levelOffset = 0<br/>
- * - {@code document-begin-*.<markup.ext>} : import just after Paths document main title with levelOffset = 1<br/>
- * - {@code document-end-*.<markup.ext>} : import at the end of Paths document with levelOffset = 1<br/>
- * - {@code operation-begin-*.<markup.ext>} : import just after each operation title with levelOffset = 2(GroupBy.AS_IS) | 3(GroupBy.TAGS)<br/>
- * - {@code operation-end-*.<markup.ext>} : import at the end of each operation with levelOffset = 2(GroupBy.AS_IS) | 3(GroupBy.TAGS)<br/>
- * <p/>
- * Markup files are appended in the natural order of their names, for each category.
- */
-public final class DynamicPathsDocumentExtension extends PathsDocumentExtension {
-
-    private static final Logger logger = LoggerFactory.getLogger(DynamicPathsDocumentExtension.class);
-
-    protected Path contentPath;
-
-    public DynamicPathsDocumentExtension() {
-        super();
-    }
-
-    public DynamicPathsDocumentExtension(Path contentPath) {
-        super();
-
-        Validate.notNull(contentPath);
-        this.contentPath = contentPath;
-    }
-
-    @Override
-    public void init(Swagger2MarkupConverter.Context globalContext) {
-        if (contentPath == null) {
-            if (globalContext.getSwaggerLocation() == null || !globalContext.getSwaggerLocation().getScheme().equals("file")) {
-                if (logger.isWarnEnabled())
-                    logger.warn("Disable DynamicOperationsContentExtension > Can't set default contentPath from swaggerLocation. You have to explicitly configure the content path.");
-            } else {
-                contentPath = Paths.get(globalContext.getSwaggerLocation()).getParent();
-            }
-        }
-    }
-
-    @Override
-    public void apply(Context context) {
-        Validate.notNull(context);
-
-        if (contentPath != null) {
-            DynamicContentExtension dynamicContent = new DynamicContentExtension(globalContext, context);
-            PathsDocumentExtension.Position position = context.getPosition();
-            switch (position) {
-                case DOCUMENT_BEFORE:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DOCUMENT_BEGIN:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DOCUMENT_END:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case OPERATION_BEGIN:
-                    dynamicContent.extensionsSection(contentPath.resolve(IOUtils.normalizeName(context.getOperation().get().getId())), contentPrefix(position), levelOffset(context));
-                    break;
-                case OPERATION_END:
-                    dynamicContent.extensionsSection(contentPath.resolve(IOUtils.normalizeName(context.getOperation().get().getId())), contentPrefix(position), levelOffset(context));
-                    break;
-                default:
-                    throw new RuntimeException(String.format("Unknown position '%s'", position));
-            }
-        }
-    }
-
-    private String contentPrefix(Position position) {
-        return position.name().toLowerCase().replace('_', '-');
-    }
-
-}

src/main/java/io/github/robwin/swagger2markup/internal/extensions/DynamicSecurityDocumentExtension.java

@@ -1,100 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.extensions;
-
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.internal.utils.IOUtils;
-import io.github.robwin.swagger2markup.spi.SecurityDocumentExtension;
-import org.apache.commons.lang3.Validate;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.nio.file.Path;
-import java.nio.file.Paths;
-
-/**
- * Dynamically search for markup files in {@code contentPath} to append to Overview, with the format :<br/>
- * - {@code document-before-*.<markup.ext>} : import before Overview document with levelOffset = 0<br/>
- * - {@code document-begin-*.<markup.ext>} : import just after Overview document main title with levelOffset = 1<br/>
- * - {@code document-end-*.<markup.ext>} : import at the end of Overview document with levelOffset = 1<br/>
- * - {@code definition-begin-*.<markup.ext>} : import just after each definition title with levelOffset = 2<br/>
- * - {@code definition-end-*.<markup.ext>} : import at the end of each definition with levelOffset = 2<br/>
- * <p/>
- * Markup files are appended in the natural order of their names, for each category.
- */
-public final class DynamicSecurityDocumentExtension extends SecurityDocumentExtension {
-
-    private static final Logger logger = LoggerFactory.getLogger(DynamicSecurityDocumentExtension.class);
-
-    protected Path contentPath;
-
-    public DynamicSecurityDocumentExtension() {
-        super();
-    }
-
-    public DynamicSecurityDocumentExtension(Path contentPath) {
-        super();
-
-        Validate.notNull(contentPath);
-        this.contentPath = contentPath;
-    }
-
-    @Override
-    public void init(Swagger2MarkupConverter.Context globalContext) {
-        if (contentPath == null) {
-            if (globalContext.getSwaggerLocation() == null || !globalContext.getSwaggerLocation().getScheme().equals("file")) {
-                if (logger.isWarnEnabled())
-                    logger.warn("Disable > DynamicSecurityContentExtension > Can't set default contentPath from swaggerLocation. You have to explicitly configure the content path.");
-            } else {
-                contentPath = Paths.get(globalContext.getSwaggerLocation()).getParent();
-            }
-        }
-    }
-
-    @Override
-    public void apply(Context context) {
-        Validate.notNull(context);
-
-        if (contentPath != null) {
-            DynamicContentExtension dynamicContent = new DynamicContentExtension(globalContext, context);
-            SecurityDocumentExtension.Position position = context.getPosition();
-            switch (position) {
-                case DOCUMENT_BEFORE:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DOCUMENT_BEGIN:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DOCUMENT_END:
-                    dynamicContent.extensionsSection(contentPath, contentPrefix(position), levelOffset(context));
-                    break;
-                case DEFINITION_BEGIN:
-                    dynamicContent.extensionsSection(contentPath.resolve(IOUtils.normalizeName(context.getDefinitionName().get())), contentPrefix(position), levelOffset(context));
-                    break;
-                case DEFINITION_END:
-                    dynamicContent.extensionsSection(contentPath.resolve(IOUtils.normalizeName(context.getDefinitionName().get())), contentPrefix(position), levelOffset(context));
-                    break;
-                default:
-                    throw new RuntimeException(String.format("Unknown position '%s'", position));
-            }
-        }
-    }
-
-    private String contentPrefix(Position position) {
-        return position.name().toLowerCase().replace('_', '-');
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/extensions/SchemaExtension.java

@@ -1,168 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.extensions;
-
-import com.google.common.base.Optional;
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.spi.DefinitionsDocumentExtension;
-import io.github.robwin.swagger2markup.internal.utils.IOUtils;
-import org.apache.commons.lang3.Validate;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.io.IOException;
-import java.io.Reader;
-import java.net.URI;
-import java.util.ArrayList;
-import java.util.List;
-
-/**
- * Add external schemas to content.<br/>
- * Supported formats are :
- * <ul>
- * <li>XML Schema (.xsd)</li>
- * <li>JSON Schema (.json)</li>
- * </ul>
- */
-public final class SchemaExtension extends DefinitionsDocumentExtension {
-
-    private static final Logger logger = LoggerFactory.getLogger(SchemaExtension.class);
-
-    private static final List<SchemaMetadata> DEFAULT_SCHEMAS = new ArrayList<SchemaMetadata>() {{
-        add(new SchemaMetadata("JSON Schema", "json", "json"));
-        add(new SchemaMetadata("XML Schema", "xsd", "xml"));
-    }};
-
-    protected List<SchemaMetadata> schemas = new ArrayList<>();
-
-    protected URI schemaBaseUri;
-
-    public SchemaExtension(URI schemaBaseUri) {
-        super();
-
-        Validate.notNull(schemaBaseUri);
-        this.schemaBaseUri = schemaBaseUri;
-    }
-
-    public SchemaExtension() {
-        super();
-    }
-
-    public SchemaExtension withDefaultSchemas() {
-        schemas.addAll(DEFAULT_SCHEMAS);
-        return this;
-    }
-
-    public SchemaExtension withSchemas(List<SchemaMetadata> schemas) {
-        schemas.addAll(schemas);
-        return this;
-    }
-
-    @Override
-    public void init(Swagger2MarkupConverter.Context globalContext) {
-        if (schemaBaseUri == null) {
-            if (globalContext.getSwaggerLocation() == null) {
-                if (logger.isWarnEnabled())
-                    logger.warn("Disable SchemaExtension > Can't set default schemaBaseUri from swaggerLocation. You have to explicitly configure the schemaBaseUri.");
-            } else {
-                schemaBaseUri = IOUtils.uriParent(globalContext.getSwaggerLocation());
-            }
-        }
-    }
-
-    @Override
-    public void apply(Context context) {
-        Validate.notNull(context);
-
-        if (schemaBaseUri != null) {
-            switch (context.getPosition()) {
-                case DOCUMENT_BEFORE:
-                case DOCUMENT_BEGIN:
-                case DOCUMENT_END:
-                case DEFINITION_BEGIN:
-                    break;
-                case DEFINITION_END:
-                    for (SchemaMetadata schema : DEFAULT_SCHEMAS) {
-                        schemaSection(context, schema, levelOffset(context));
-                    }
-                    break;
-                default:
-                    throw new RuntimeException(String.format("Unknown position '%s'", context.getPosition()));
-            }
-        }
-    }
-
-    /**
-     * Builds snippet URI for the given {@code definitionName} and {@code schema}.<br/>
-     * Default implementation use {@code <schemaBaseUri>/normalizeName(<definitionName>)/schema.<schema.extension>}.<br/>
-     * You can override this method to configure your own folder normalization.
-     *
-     * @param context        current context
-     * @param definitionName current definition name
-     * @return subdirectory normalized name
-     */
-    public URI definitionSchemaUri(Context context, String definitionName, SchemaMetadata schema) {
-        return schemaBaseUri.resolve(IOUtils.normalizeName(definitionName) + "/").resolve("schema" + (schema.extension != null ? "." + schema.extension : ""));
-    }
-
-    private void schemaSection(Context context, SchemaMetadata schema, int levelOffset) {
-        ContentExtension contentExtension = new ContentExtension(globalContext, context);
-        URI schemaUri = definitionSchemaUri(context, context.getDefinitionName().get(), schema);
-
-        try {
-            Optional<Reader> extensionContent = contentExtension.readContentUri(schemaUri);
-
-            if (extensionContent.isPresent()) {
-                try {
-                    context.getMarkupDocBuilder().sectionTitleLevel(1 + levelOffset, schema.title);
-                    context.getMarkupDocBuilder().listing(org.apache.commons.io.IOUtils.toString(extensionContent.get()).trim(), schema.language);
-                } catch (IOException e) {
-                    throw new RuntimeException(String.format("Failed to read schema URI : %s", schemaUri), e);
-                } finally {
-                    extensionContent.get().close();
-                }
-            }
-        } catch (IOException e) {
-            if (logger.isDebugEnabled())
-                logger.debug("Failed to read schema URI {}", schemaUri);
-        }
-    }
-
-    public static class SchemaMetadata {
-        /**
-         * Schema title
-         */
-        public String title;
-
-        /**
-         * Schema file extension, without dot (e.g.: xsd).<br/>
-         * Set to null if there's no extension
-         */
-        public String extension;
-
-        /**
-         * Schema content language (e.g.: xml)
-         */
-        public String language;
-
-        public SchemaMetadata(String title, String extension, String language) {
-            this.title = title;
-            this.extension = extension;
-            this.language = language;
-        }
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/extensions/SpringRestDocsExtension.java

@@ -1,150 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.extensions;
-
-import com.google.common.base.Optional;
-import com.google.common.base.Throwables;
-import io.github.robwin.swagger2markup.internal.model.PathOperation;
-import io.github.robwin.swagger2markup.Swagger2MarkupConverter;
-import io.github.robwin.swagger2markup.spi.PathsDocumentExtension;
-import io.github.robwin.swagger2markup.internal.utils.IOUtils;
-import org.apache.commons.lang3.Validate;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.io.IOException;
-import java.io.Reader;
-import java.net.URI;
-import java.util.LinkedHashMap;
-import java.util.Map;
-
-/**
- * Append Spring Rest docs generated snippets to Operations content.
- */
-public final class SpringRestDocsExtension extends PathsDocumentExtension {
-
-    private static final Logger logger = LoggerFactory.getLogger(SpringRestDocsExtension.class);
-
-    private static final Map<String, String> DEFAULT_SNIPPETS = new LinkedHashMap<String, String>() {{
-        put("http-request", "HTTP request");
-        put("http-response", "HTTP response");
-        put("curl-request", "Curl request");
-    }};
-
-    protected URI snippetBaseUri;
-    protected Map<String, String> snippets = new LinkedHashMap<>();
-
-    /**
-     * Instantiate extension
-     * @param snippetBaseUri base URI where are snippets are stored
-     */
-    public SpringRestDocsExtension(URI snippetBaseUri) {
-        super();
-
-        Validate.notNull(snippetBaseUri);
-        this.snippetBaseUri = snippetBaseUri;
-    }
-
-    public SpringRestDocsExtension() {
-        super();
-    }
-
-    @Override
-    public void init(Swagger2MarkupConverter.Context globalContext) {
-        if (snippetBaseUri == null) {
-            if (globalContext.getSwaggerLocation() == null) {
-                if (logger.isWarnEnabled())
-                    logger.warn("Disable SpringRestDocsExtension > Can't set default snippetBaseUri from swaggerLocation. You have to explicitly configure the snippetBaseUri.");
-            } else {
-                snippetBaseUri = IOUtils.uriParent(globalContext.getSwaggerLocation());
-            }
-        }
-    }
-
-    /**
-     * Add SpringRestDocs default snippets to list
-     * @return this instance
-     */
-    public SpringRestDocsExtension withDefaultSnippets() {
-        snippets.putAll(DEFAULT_SNIPPETS);
-
-        return this;
-    }
-
-    /**
-     * Add an explicit list of snippets to display.
-     * @param snippets snippets to add. key is snippet name (without extension, e.g.: 'http-request'), value is a custom section title for the snippet.
-     * @return this instance
-     */
-    public SpringRestDocsExtension withExplicitSnippets(Map<String, String> snippets) {
-        this.snippets.putAll(snippets);
-
-        return this;
-    }
-
-    /**
-     * Builds snippet URI for the given {@code operation} and {@code snippetName}.<br/>
-     * Default implementation use {@code <snippetBaseUri>/<normalizeName(<operation id>)>/<snippetName>.<markup ext>}.<br/>
-     * You can override this method to configure your own folder normalization.
-     *
-     * @param context current context
-     * @param operation current operation
-     * @return subdirectory normalized name
-     */
-    public URI operationSnippetUri(Context context, PathOperation operation, String snippetName) {
-        return snippetBaseUri.resolve(IOUtils.normalizeName(operation.getId()) + "/").resolve(context.getMarkupDocBuilder().addFileExtension(snippetName));
-    }
-
-    @Override
-    public void apply(Context context) {
-        Validate.notNull(context);
-
-        switch (context.getPosition()) {
-            case OPERATION_END:
-                snippets(context);
-                break;
-        }
-    }
-
-    public void snippets(Context context) {
-        for (Map.Entry<String, String> snippets : this.snippets.entrySet()) {
-            snippetSection(context, snippets.getKey(), snippets.getValue());
-        }
-    }
-
-    public void snippetSection(Context context, String snippetName, String title) {
-        ContentExtension content = new ContentExtension(globalContext, context);
-
-        URI snippetUri = operationSnippetUri(context, context.getOperation().get(), snippetName);
-        Optional<Reader> snippetContent = content.readContentUri(snippetUri);
-
-        if (snippetContent.isPresent()) {
-            try {
-                context.getMarkupDocBuilder().sectionTitleLevel(1 + levelOffset(context), title);
-                context.getMarkupDocBuilder().importMarkup(snippetContent.get(), levelOffset(context) + 1);
-            } catch (IOException e) {
-                throw new RuntimeException(String.format("Failed to process snippet URI : %s", snippetUri), e);
-            } finally {
-                try {
-                    snippetContent.get().close();
-                } catch (IOException e) {
-                    Throwables.propagate(e);
-                }
-            }
-        }
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/model/PathOperation.java

@@ -1,79 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.model;
-
-import io.swagger.models.HttpMethod;
-import io.swagger.models.Operation;
-
-import static org.apache.commons.lang3.StringUtils.isBlank;
-
-public class PathOperation {
-
-    protected HttpMethod method;
-    protected String path;
-    protected Operation operation;
-
-    public PathOperation(HttpMethod method, String path, Operation operation) {
-        this.method = method;
-        this.path = path;
-        this.operation = operation;
-    }
-
-    public HttpMethod getMethod() {
-        return method;
-    }
-
-    public String getPath() {
-        return path;
-    }
-
-    /**
-     * Returns the display title for an operation
-     * @return the operation title
-     */
-    public String getTitle() {
-        String operationName = operation.getSummary();
-        if (isBlank(operationName)) {
-            operationName = getMethod().toString() + " " + getPath();
-        }
-        return operationName;
-    }
-
-    /**
-     * Returns an unique id for the operation.<br/>
-     * Use {@code <operation id>}, then {@code <operation path> lowercase(<operation method>)} if operation id is not set.
-     *
-     * @return operation unique id
-     */
-    public String getId() {
-        String id = operation.getOperationId();
-
-        if (id == null)
-            id = getPath() + " " + getMethod().toString().toLowerCase();
-
-        return id;
-    }
-
-    public Operation getOperation() {
-        return operation;
-    }
-
-    @Override
-    public String toString() {
-        return getId();
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/utils/ExamplesUtil.java

@@ -1,284 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.internal.utils;
-
-import io.github.robwin.markup.builder.MarkupDocBuilder;
-import io.github.robwin.swagger2markup.internal.model.PathOperation;
-import io.swagger.models.*;
-import io.swagger.models.parameters.*;
-import io.swagger.models.properties.ArrayProperty;
-import io.swagger.models.properties.MapProperty;
-import io.swagger.models.properties.Property;
-import io.swagger.models.properties.RefProperty;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.util.HashMap;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-
-public class ExamplesUtil {
-
-    private static Logger logger = LoggerFactory.getLogger(ExamplesUtil.class);
-
-    /**
-     * Generates a Map of response examples
-     *
-     * @param operation the Swagger Operation
-     * @return map containing response examples.
-     */
-    public static Map<String, Object> generateResponseExampleMap(boolean generateMissingExamples, Operation operation, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
-        Map<String, Object> examples = new HashMap<>();
-        Map<String, Response> responses = operation.getResponses();
-        for (Map.Entry<String, Response> responseEntry : responses.entrySet()) {
-            Response response = responseEntry.getValue();
-            Object example = response.getExamples();
-            if (example == null) {
-                Property schema = response.getSchema();
-                if (schema != null) {
-                    example = schema.getExample();
-
-                    if (example == null && schema instanceof RefProperty) {
-                        String simpleRef = ((RefProperty) schema).getSimpleRef();
-                        example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder);
-                    }
-                    if (example == null && generateMissingExamples) {
-                        example = PropertyUtils.generateExample(schema, markupDocBuilder);
-                    }
-                }
-            }
-
-            if (example != null)
-                examples.put(responseEntry.getKey(), example);
-
-        }
-
-        return examples;
-    }
-
-    /**
-     * Generates examples for request
-     *
-     * @param pathOperation the Swagger Operation
-     * @return an Optional with the example content
-     */
-    public static Map<String, Object> generateRequestExampleMap(boolean generateMissingExamples, PathOperation pathOperation, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
-        Operation operation = pathOperation.getOperation();
-        List<Parameter> parameters = operation.getParameters();
-        Map<String, Object> examples = new HashMap<>();
-
-        // Path example should always be included (if generateMissingExamples):
-        if (generateMissingExamples)
-            examples.put("path", pathOperation.getPath());
-        for (Parameter parameter : parameters) {
-            Object example = null;
-            if (parameter instanceof BodyParameter) {
-                example = ((BodyParameter) parameter).getExamples();
-                if (example == null) {
-                    Model schema = ((BodyParameter) parameter).getSchema();
-                    if (schema instanceof RefModel) {
-                        String simpleRef = ((RefModel) schema).getSimpleRef();
-                        example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder);
-                    } else if (generateMissingExamples) {
-                        if (schema instanceof ComposedModel) {
-                            example = exampleMapForProperties(getPropertiesForComposedModel(
-                                    (ComposedModel) schema, definitions), definitions, markupDocBuilder);
-                        } else if (schema instanceof ArrayModel) {
-                            example = generateExampleForArrayModel((ArrayModel) schema, definitions, markupDocBuilder);
-                        } else {
-                            example = schema.getExample();
-                            if (example == null) {
-                                example = exampleMapForProperties(schema.getProperties(), definitions, markupDocBuilder);
-                            }
-                        }
-                    }
-                }
-            } else if (parameter instanceof AbstractSerializableParameter) {
-                if (generateMissingExamples) {
-                    Object abstractSerializableParameterExample;
-                    abstractSerializableParameterExample = ((AbstractSerializableParameter) parameter).getExample();
-                    if (abstractSerializableParameterExample == null) {
-                        Property item = ((AbstractSerializableParameter) parameter).getItems();
-                        if (item != null) {
-                            abstractSerializableParameterExample = PropertyUtils.convertExample(item.getExample(), item.getType());
-                            if (abstractSerializableParameterExample == null) {
-                                abstractSerializableParameterExample = PropertyUtils.generateExample(item, markupDocBuilder);
-                            }
-                        }
-                        if (abstractSerializableParameterExample == null) {
-                            abstractSerializableParameterExample = ParameterUtils.generateExample((AbstractSerializableParameter)parameter, markupDocBuilder);
-                        }
-                    }
-                    if (parameter instanceof PathParameter) {
-                        String pathExample = (String) examples.get("path");
-                        pathExample = pathExample.replace('{' + parameter.getName() + '}', String.valueOf(abstractSerializableParameterExample));
-                        example = pathExample;
-                    } else {
-                        example = abstractSerializableParameterExample;
-                    }
-                    if (parameter instanceof QueryParameter) {
-                        //noinspection unchecked
-                        @SuppressWarnings("unchecked")
-                        Map<String, Object> queryExampleMap = (Map<String, Object>) examples.get("query");
-                        if (queryExampleMap == null) {
-                            queryExampleMap = new HashMap<>();
-                        }
-                        queryExampleMap.put(parameter.getName(), abstractSerializableParameterExample);
-                        example = queryExampleMap;
-                    }
-                }
-            } else if (parameter instanceof RefParameter) {
-                String simpleRef = ((RefParameter) parameter).getSimpleRef();
-                example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder);
-            }
-
-            if (example != null)
-                examples.put(parameter.getIn(), example);
-        }
-
-        return examples;
-    }
-
-    /**
-     * Generates an example object from a simple reference
-     *
-     * @param simpleRef the simple reference string
-     * @return returns an Object or Map of examples
-     */
-    public static Object generateExampleForRefModel(boolean generateMissingExamples, String simpleRef, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
-        Model model = definitions.get(simpleRef);
-        Object example = null;
-        if (model != null) {
-            example = model.getExample();
-            if (example == null && generateMissingExamples) {
-                if (model instanceof ComposedModel) {
-                    example = exampleMapForProperties(getPropertiesForComposedModel((ComposedModel) model, definitions), definitions, markupDocBuilder);
-                } else {
-                    example = exampleMapForProperties(model.getProperties(), definitions, markupDocBuilder);
-                }
-            }
-        }
-        return example;
-    }
-
-    private static Map<String, Property> getPropertiesForComposedModel(ComposedModel model, Map<String, Model> definitions) {
-        Map<String, Property> combinedProperties;
-        if (model.getParent() instanceof RefModel) {
-            Map<String, Property> parentProperties = definitions.get(((RefModel) model.getParent()).getSimpleRef()).getProperties();
-            if (parentProperties == null) {
-                return null;
-            } else {
-                combinedProperties = new LinkedHashMap<>(parentProperties);
-            }
-
-        } else {
-            combinedProperties = new LinkedHashMap<>(model.getParent().getProperties());
-        }
-        Map<String, Property> childProperties;
-        if (model.getChild() instanceof RefModel) {
-            childProperties = definitions.get(((RefModel) model.getChild()).getSimpleRef()).getProperties();
-        } else {
-            childProperties = model.getChild().getProperties();
-        }
-        if (childProperties != null) {
-            combinedProperties.putAll(childProperties);
-        }
-        return combinedProperties;
-    }
-
-    /**
-     * Generates a map of examples from a map of properties. If defined examples are found, those are used. Otherwise,
-     * examples are generated from the type.
-     *
-     * @param properties map of properties
-     * @return a Map of examples
-     */
-    public static Map<String, Object> exampleMapForProperties(Map<String, Property> properties, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
-        Map<String, Object> exampleMap = new HashMap<>();
-        for (Map.Entry<String, Property> property : properties.entrySet()) {
-            Object exampleObject = PropertyUtils.convertExample(property.getValue().getExample(), property.getValue().getType());
-            if (exampleObject == null) {
-                if (property.getValue() instanceof RefProperty) {
-                    exampleObject = generateExampleForRefModel(true, ((RefProperty) property.getValue()).getSimpleRef(), definitions, markupDocBuilder);
-                } else if (property.getValue() instanceof ArrayProperty) {
-                    exampleObject = generateExampleForArrayProperty((ArrayProperty) property.getValue(), definitions, markupDocBuilder);
-                } else if (property.getValue() instanceof MapProperty) {
-                    exampleObject = generateExampleForMapProperty((MapProperty) property.getValue(), markupDocBuilder);
-                }
-                if (exampleObject == null) {
-                    Property valueProperty = property.getValue();
-                    exampleObject = PropertyUtils.generateExample(valueProperty, markupDocBuilder);
-                }
-            }
-            exampleMap.put(property.getKey(), exampleObject);
-        }
-        return exampleMap;
-    }
-
-    public static Object generateExampleForMapProperty(MapProperty property, MarkupDocBuilder markupDocBuilder) {
-        if (property.getExample() != null) {
-            return property.getExample();
-        }
-        Map<String, Object> exampleMap = new HashMap<>();
-        Property valueProperty = property.getAdditionalProperties();
-        if (valueProperty.getExample() != null) {
-            return valueProperty.getExample();
-        }
-        exampleMap.put("string", PropertyUtils.generateExample(valueProperty, markupDocBuilder));
-        return exampleMap;
-    }
-
-    public static Object generateExampleForArrayModel(ArrayModel model, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
-        if (model.getExample() != null) {
-            return model.getExample();
-        } else if (model.getProperties() != null) {
-            return new Object[]{exampleMapForProperties(model.getProperties(), definitions, markupDocBuilder)};
-        } else {
-            Property itemProperty = model.getItems();
-            if (itemProperty.getExample() != null) {
-                return new Object[]{PropertyUtils.convertExample(itemProperty.getExample(), itemProperty.getType())};
-            } else if (itemProperty instanceof ArrayProperty) {
-                return new Object[]{generateExampleForArrayProperty((ArrayProperty) itemProperty, definitions, markupDocBuilder)};
-            } else if (itemProperty instanceof RefProperty) {
-                return new Object[]{generateExampleForRefModel(true, ((RefProperty) itemProperty).getSimpleRef(), definitions, markupDocBuilder)};
-            } else {
-                return new Object[]{PropertyUtils.generateExample(itemProperty, markupDocBuilder)};
-            }
-        }
-    }
-
-    /**
-     * Generates examples from an ArrayProperty
-     *
-     * @param value ArrayProperty
-     * @return array of Object
-     */
-    public static Object[] generateExampleForArrayProperty(ArrayProperty value, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
-        Property property = value.getItems();
-        if (property.getExample() != null) {
-            return new Object[]{PropertyUtils.convertExample(property.getExample(), property.getType())};
-        } else if (property instanceof ArrayProperty) {
-            return new Object[]{generateExampleForArrayProperty((ArrayProperty) property, definitions, markupDocBuilder)};
-        } else if (property instanceof RefProperty) {
-            return new Object[]{generateExampleForRefModel(true, ((RefProperty) property).getSimpleRef(), definitions, markupDocBuilder)};
-        } else {
-            return new Object[]{PropertyUtils.generateExample(property, markupDocBuilder)};
-        }
-    }
-
-}

src/main/java/io/github/robwin/swagger2markup/internal/utils/ListUtils.java

@@ -1,40 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.utils;
-
-import java.util.*;
-
-public class ListUtils {
-
-    /**
-     * Returns the List as an Set either ordered or as-is, if the comparator is null.
-     *
-     * @param list the List
-     * @param comparator the comparator to use.
-     * @return the Set
-     */
-    public static Set<String> toSet(List<String> list, Comparator<String> comparator){
-        Set<String> set;
-        if (comparator == null)
-            set = new LinkedHashSet<>();
-        else
-            set = new TreeSet<>(comparator);
-        set.addAll(list);
-        return set;
-    }
-
-
-}

src/main/java/io/github/robwin/swagger2markup/internal/utils/ModelUtils.java

@@ -1,50 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.utils;
-
-import com.google.common.base.Function;
-import io.github.robwin.swagger2markup.internal.type.ArrayType;
-import io.github.robwin.swagger2markup.internal.type.ObjectType;
-import io.github.robwin.swagger2markup.internal.type.RefType;
-import io.github.robwin.swagger2markup.internal.type.Type;
-import io.swagger.models.ArrayModel;
-import io.swagger.models.Model;
-import io.swagger.models.ModelImpl;
-import io.swagger.models.RefModel;
-import org.apache.commons.lang3.Validate;
-
-public final class ModelUtils {
-
-    /**
-     * Retrieves the type of a model, or otherwise null
-     *
-     * @param model the model
-     * @return the type of the model, or otherwise null
-     */
-    public static Type getType(Model model, Function<String, String> definitionDocumentResolver) {
-        Validate.notNull(model, "model must not be null!");
-        if (model instanceof ModelImpl) {
-            return new ObjectType(null, model.getProperties());
-        } else if (model instanceof RefModel) {
-            String simpleRef = ((RefModel) model).getSimpleRef();
-            return new RefType(definitionDocumentResolver.apply(simpleRef), simpleRef);
-        } else if (model instanceof ArrayModel) {
-            ArrayModel arrayModel = ((ArrayModel) model);
-            return new ArrayType(null, PropertyUtils.getType(arrayModel.getItems(), definitionDocumentResolver));
-        }
-        return null;
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/utils/ParameterUtils.java

@@ -1,113 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.utils;
-
-import com.google.common.base.Function;
-import io.github.robwin.markup.builder.MarkupDocBuilder;
-import io.github.robwin.swagger2markup.internal.type.*;
-import io.swagger.models.Model;
-import io.swagger.models.parameters.AbstractSerializableParameter;
-import io.swagger.models.parameters.BodyParameter;
-import io.swagger.models.parameters.Parameter;
-import io.swagger.models.parameters.RefParameter;
-import org.apache.commons.collections4.CollectionUtils;
-import org.apache.commons.lang3.Validate;
-
-import java.util.List;
-
-import static org.apache.commons.lang3.StringUtils.defaultString;
-
-
-public final class ParameterUtils {
-
-    /**
-     * Retrieves the type of a parameter, or otherwise null
-     *
-     * @param parameter the parameter
-     * @return the type of the parameter, or otherwise null
-     */
-    public static Type getType(Parameter parameter, Function<String, String> definitionDocumentResolver){
-        Validate.notNull(parameter, "parameter must not be null!");
-        Type type = null;
-        if(parameter instanceof BodyParameter){
-            BodyParameter bodyParameter = (BodyParameter)parameter;
-            Model model = bodyParameter.getSchema();
-            if(model != null){
-                type = ModelUtils.getType(model, definitionDocumentResolver);
-            }else{
-                type = new BasicType("string");
-            }
-
-        }
-        else if(parameter instanceof AbstractSerializableParameter){
-            AbstractSerializableParameter serializableParameter = (AbstractSerializableParameter)parameter;
-            @SuppressWarnings("unchecked")
-            List<String> enums = serializableParameter.getEnum();
-            if(CollectionUtils.isNotEmpty(enums)){
-                type = new EnumType(null, enums);
-            }else{
-                type = new BasicType(serializableParameter.getType(), serializableParameter.getFormat());
-            }
-            if(type.getName().equals("array")){
-                String collectionFormat = serializableParameter.getCollectionFormat();
-                type = new ArrayType(null, PropertyUtils.getType(serializableParameter.getItems(), definitionDocumentResolver), collectionFormat);
-            }
-        }
-        else if(parameter instanceof RefParameter){
-            String simpleRef = ((RefParameter)parameter).getSimpleRef();
-            type = new RefType(definitionDocumentResolver.apply(simpleRef), simpleRef);
-        }
-        return type;
-    }
-
-    /**
-     * Retrieves the default value of a parameter, or otherwise an empty String
-     *
-     * @param parameter the parameter
-     * @return the default value of the parameter, or otherwise an empty String
-     */
-    public static String getDefaultValue(Parameter parameter){
-        Validate.notNull(parameter, "parameter must not be null!");
-        String defaultValue = "";
-        if(parameter instanceof AbstractSerializableParameter){
-            AbstractSerializableParameter serializableParameter = (AbstractSerializableParameter)parameter;
-            defaultValue = serializableParameter.getDefaultValue();
-        }
-        return defaultString(defaultValue);
-    }
-
-    /**
-     * Generate a default example value for parameter.
-     *
-     * @param parameter parameter
-     * @param markupDocBuilder doc builder
-     * @return a generated example for the parameter
-     */
-    public static Object generateExample(AbstractSerializableParameter parameter, MarkupDocBuilder markupDocBuilder) {
-        switch (parameter.getType()) {
-            case "integer":
-                return 0;
-            case "number":
-                return 0.0;
-            case "boolean":
-                return true;
-            case "string":
-                return "string";
-            default:
-                return parameter.getType();
-        }
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/utils/PropertyUtils.java

@@ -1,195 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.utils;
-
-import com.google.common.base.Function;
-import io.github.robwin.markup.builder.MarkupDocBuilder;
-import io.github.robwin.swagger2markup.internal.type.*;
-import io.swagger.models.properties.*;
-import io.swagger.models.refs.RefFormat;
-import org.apache.commons.collections4.CollectionUtils;
-import org.apache.commons.lang3.Validate;
-
-import java.util.*;
-
-import static org.apache.commons.lang3.StringUtils.isNotBlank;
-
-public final class PropertyUtils {
-
-    /**
-     * Retrieves the type and format of a property.
-     *
-     * @param property the property
-     * @return the type of the property
-     */
-    public static Type getType(Property property, Function<String, String> definitionDocumentResolver) {
-        Validate.notNull(property, "property must not be null");
-        Type type;
-        if (property instanceof RefProperty) {
-            RefProperty refProperty = (RefProperty) property;
-            if (refProperty.getRefFormat() == RefFormat.RELATIVE)
-                type = new ObjectType(null, null); // FIXME : Workaround for https://github.com/swagger-api/swagger-parser/issues/177
-            else
-                type = new RefType(definitionDocumentResolver.apply(refProperty.getSimpleRef()), refProperty.getSimpleRef());
-        } else if (property instanceof ArrayProperty) {
-            ArrayProperty arrayProperty = (ArrayProperty) property;
-            Property items = arrayProperty.getItems();
-            type = new ArrayType(null, getType(items, definitionDocumentResolver));
-        } else if (property instanceof StringProperty) {
-            StringProperty stringProperty = (StringProperty) property;
-            List<String> enums = stringProperty.getEnum();
-            if (CollectionUtils.isNotEmpty(enums)) {
-                type = new EnumType(null, enums);
-            } else {
-                type = new BasicType(property.getType());
-            }
-        } else if (property instanceof ObjectProperty) {
-            type = new ObjectType(null, ((ObjectProperty) property).getProperties());
-        } else {
-            if (isNotBlank(property.getFormat())) {
-                type = new BasicType(property.getType(), property.getFormat());
-            } else {
-                type = new BasicType(property.getType());
-            }
-        }
-        return type;
-    }
-
-    /**
-     * Retrieves the default value of a property, or otherwise returns an empty String.
-     *
-     * @param property the property
-     * @return the default value of the property, or otherwise an empty String
-     */
-    public static String getDefaultValue(Property property) {
-        Validate.notNull(property, "property must not be null");
-        String defaultValue = "";
-        if (property instanceof BooleanProperty) {
-            BooleanProperty booleanProperty = (BooleanProperty) property;
-            defaultValue = Objects.toString(booleanProperty.getDefault(), "");
-        } else if (property instanceof StringProperty) {
-            StringProperty stringProperty = (StringProperty) property;
-            defaultValue = Objects.toString(stringProperty.getDefault(), "");
-        } else if (property instanceof DoubleProperty) {
-            DoubleProperty doubleProperty = (DoubleProperty) property;
-            defaultValue = Objects.toString(doubleProperty.getDefault(), "");
-        } else if (property instanceof FloatProperty) {
-            FloatProperty floatProperty = (FloatProperty) property;
-            defaultValue = Objects.toString(floatProperty.getDefault(), "");
-        } else if (property instanceof IntegerProperty) {
-            IntegerProperty integerProperty = (IntegerProperty) property;
-            defaultValue = Objects.toString(integerProperty.getDefault(), "");
-        } else if (property instanceof LongProperty) {
-            LongProperty longProperty = (LongProperty) property;
-            defaultValue = Objects.toString(longProperty.getDefault(), "");
-        } else if (property instanceof UUIDProperty) {
-            UUIDProperty uuidProperty = (UUIDProperty) property;
-            defaultValue = Objects.toString(uuidProperty.getDefault(), "");
-        }
-        return defaultValue;
-    }
-
-    /**
-     * Return example display string for the given {@code property}.
-     *
-     * @param property         property
-     * @param markupDocBuilder doc builder
-     * @return property example display string
-     */
-    public static Object getExample(boolean generateMissingExamples, Property property, MarkupDocBuilder markupDocBuilder) {
-        Validate.notNull(property, "property must not be null");
-        Object examplesValue = null;
-        if (property.getExample() != null) {
-            examplesValue = convertExample(property.getExample(), property.getType());
-        } else if (property instanceof MapProperty) {
-            Property additionalProperty = ((MapProperty) property).getAdditionalProperties();
-            if (additionalProperty.getExample() != null) {
-                examplesValue = additionalProperty.getExample();
-            } else if (generateMissingExamples) {
-                Map<String, Object> exampleMap = new HashMap<>();
-                exampleMap.put("string", generateExample(additionalProperty, markupDocBuilder));
-                examplesValue = exampleMap;
-            }
-        } else if (property instanceof ArrayProperty) {
-            if (generateMissingExamples) {
-                Property itemProperty = ((ArrayProperty) property).getItems();
-                List<Object> exampleArray = new ArrayList<>();
-                exampleArray.add(generateExample(itemProperty, markupDocBuilder));
-                examplesValue = exampleArray;
-            }
-        } else if (generateMissingExamples) {
-            examplesValue = generateExample(property, markupDocBuilder);
-        }
-
-        return examplesValue;
-    }
-
-    /**
-     * Generate a default example value for property.
-     *
-     * @param property         property
-     * @param markupDocBuilder doc builder
-     * @return a generated example for the property
-     */
-    public static Object generateExample(Property property, MarkupDocBuilder markupDocBuilder) {
-        switch (property.getType()) {
-            case "integer":
-                return 0;
-            case "number":
-                return 0.0;
-            case "boolean":
-                return true;
-            case "string":
-                return "string";
-            case "ref":
-                if (property instanceof RefProperty) {
-                    return markupDocBuilder.copy().crossReference(((RefProperty) property).getSimpleRef()).toString();
-                }
-            default:
-                return property.getType();
-        }
-    }
-
-    /**
-     * Convert a string {@code value} to specified {@code type}.
-     *
-     * @param value value to convert
-     * @param type  target conversion type
-     * @return converted value as object
-     */
-    public static Object convertExample(String value, String type) {
-        if (value == null) {
-            return null;
-        }
-
-        try {
-            switch (type) {
-                case "integer":
-                    return Integer.valueOf(value);
-                case "number":
-                    return Float.valueOf(value);
-                case "boolean":
-                    return Boolean.valueOf(value);
-                case "string":
-                    return value;
-                default:
-                    return value;
-            }
-        } catch (NumberFormatException e) {
-            throw new RuntimeException(String.format("Value '%s' cannot be converted to '%s'", value, type), e);
-        }
-    }
-}

src/main/java/io/github/robwin/swagger2markup/internal/utils/TagUtils.java

@@ -1,101 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.internal.utils;
-
-import com.google.common.base.Optional;
-import com.google.common.collect.Multimap;
-import com.google.common.collect.MultimapBuilder;
-import com.google.common.collect.Ordering;
-import io.github.robwin.swagger2markup.internal.model.PathOperation;
-import io.swagger.models.Tag;
-import org.apache.commons.lang3.Validate;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.util.*;
-
-public class TagUtils {
-
-    private static Logger LOG = LoggerFactory.getLogger(TagUtils.class);
-
-    /**
-     * Converts the global Tag list into a Map where the tag name is the key and the Tag the value.
-     *
-     * @param tags the List of tags
-     * @return the Map of tags
-     */
-    public static Map<String, Tag> convertTagsListToMap(List<Tag> tags) {
-        if (tags == null) {
-            tags = new ArrayList<>();
-        }
-        Map<String, Tag> tagsMap = new HashMap<>();
-        for (Tag tag : tags) tagsMap.put(tag.getName(), tag);
-        return tagsMap;
-    }
-
-
-    /**
-     * Retrieves the optional description of a tag.
-     *
-     * @param tagsMap the Map of tags
-     * @param tagName the name of the tag
-     * @return the optional description of the tag
-     */
-    public static Optional<String> getTagDescription(Map<String, Tag> tagsMap, String tagName) {
-        Tag tag = tagsMap.get(tagName);
-        if(tag != null){
-            return Optional.fromNullable(tag.getDescription());
-        }
-        return Optional.absent();
-    }
-
-    /**
-     * Groups the operations by tag. The key of the Multimap is the tag name.
-     * The value of the Multimap is a PathOperation
-     *
-     * @param allOperations all operations
-     * @param tagOrdering comparator for tags
-     * @param operationOrdering comparator for operations, for a given tag
-     * @return Operations grouped by Tag
-     */
-    public static Multimap<String, PathOperation> groupOperationsByTag(Set<PathOperation> allOperations, Comparator<String> tagOrdering, Comparator<PathOperation> operationOrdering) {
-        MultimapBuilder.MultimapBuilderWithKeys<String> multimapBuilderWithKeys;
-
-        if (tagOrdering == null)
-            multimapBuilderWithKeys = MultimapBuilder.SortedSetMultimapBuilder.treeKeys(Ordering.<String>natural()); // FIXME as-is sorting not supported because of limitations in MultiMap::hashkeys(). Replaced with Ordering.natural()
-        else
-            multimapBuilderWithKeys = MultimapBuilder.SortedSetMultimapBuilder.treeKeys(tagOrdering);
-
-        Multimap<String, PathOperation> operationsGroupedByTag;
-        if (operationOrdering == null)
-            operationsGroupedByTag = multimapBuilderWithKeys.hashSetValues().build();
-        else
-            operationsGroupedByTag = multimapBuilderWithKeys.treeSetValues(operationOrdering).build();
-
-        for (PathOperation operation : allOperations) {
-            List<String> tags = operation.getOperation().getTags();
-            Validate.notEmpty(tags, "Can't GroupBy.TAGS > Operation '%s' has not tags", operation);
-            for (String tag : tags) {
-                if (LOG.isInfoEnabled()) {
-                    LOG.info("Added path operation '{}' to tag '{}'", operation, tag);
-                }
-                operationsGroupedByTag.put(tag, operation);
-            }
-        }
-
-        return operationsGroupedByTag;
-    }
-}

src/main/java/io/github/robwin/swagger2markup/spi/PathsDocumentExtension.java

@@ -1,108 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.github.robwin.swagger2markup.spi;
-
-import com.google.common.base.Optional;
-import io.github.robwin.markup.builder.MarkupDocBuilder;
-import io.github.robwin.swagger2markup.GroupBy;
-import io.github.robwin.swagger2markup.internal.model.PathOperation;
-import org.apache.commons.lang3.Validate;
-
-/**
- * A SecurityContentExtension can be used to extend the paths document.
- */
-public abstract class PathsDocumentExtension extends AbstractExtension {
-
-    public enum Position {
-        DOCUMENT_BEFORE,
-        DOCUMENT_BEGIN,
-        DOCUMENT_END,
-        OPERATION_BEGIN,
-        OPERATION_END
-    }
-
-    public static class Context extends ContentContext {
-        private Position position;
-        /**
-         * null if position == DOC_*
-         */
-        private PathOperation operation;
-
-        /**
-         * @param position the current position
-         * @param docBuilder the MarkupDocBuilder
-         */
-        public Context(Position position, MarkupDocBuilder docBuilder) {
-            super(docBuilder);
-            Validate.isTrue(position != Position.OPERATION_BEGIN && position != Position.OPERATION_END, "You must provide an operation for this position");
-            this.position = position;
-        }
-
-        /**
-         * @param position the current position
-         * @param docBuilder the MarkupDocBuilder
-         * @param operation the current path operation
-         */
-        public Context(Position position, MarkupDocBuilder docBuilder, PathOperation operation) {
-            super(docBuilder);
-            Validate.notNull(operation);
-            this.position = position;
-            this.operation = operation;
-        }
-
-        public Position getPosition() {
-            return position;
-        }
-
-        public Optional<PathOperation> getOperation() {
-            return Optional.fromNullable(operation);
-        }
-    }
-
-    public PathsDocumentExtension() {
-    }
-
-    public abstract void apply(Context context);
-
-    /**
-     * Returns title level offset from 1 to apply to content
-     *
-     * @param context context
-     * @return title level offset
-     */
-    protected int levelOffset(Context context) {
-        int levelOffset;
-        switch (context.position) {
-            case DOCUMENT_BEFORE:
-            case DOCUMENT_BEGIN:
-            case DOCUMENT_END:
-                levelOffset = 1;
-                break;
-            case OPERATION_BEGIN:
-            case OPERATION_END:
-                levelOffset = 2;
-                break;
-            default:
-                throw new RuntimeException(String.format("Unknown position '%s'", context.position));
-        }
-        if (globalContext.getConfig().getOperationsGroupedBy() == GroupBy.TAGS) {
-            levelOffset++;
-        }
-        return levelOffset;
-    }
-
-}

src/main/resources/io/github/robwin/swagger2markup/lang/labels_ru.properties

@@ -1,54 +0,0 @@
-definitions=\u041E\u043F\u0440\u0435\u0434\u0435\u043B\u0435\u043D\u0438\u044F
-json_schema=JSON \u0441\u0445\u0435\u043C\u0430
-xml_schema=XML \u0441\u0445\u0435\u043C\u0430
-
-default_column=\u041F\u043E \u0443\u043C\u043E\u043B\u0447\u0430\u043D\u0438\u044E
-required_column=\u041E\u0431\u044F\u0437\u0430\u0442\u0435\u043B\u044C\u043D\u043E
-example_column=\u041F\u0440\u0438\u043C\u0435\u0440
-schema_column=\u0421\u0445\u0435\u043C\u0430
-name_column=\u0418\u043C\u044F
-description_column=\u041E\u043F\u0438\u0441\u0430\u043D\u0438\u0435
-headers_column=Headers
-scopes_column=\u041E\u0431\u043B\u0430\u0441\u0442\u0438 \u043F\u0440\u0438\u043C\u0435\u043D\u0435\u043D\u0438\u044F
-produces=\u0412\u043E\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442
-consumes=\u041F\u0440\u0438\u043D\u0438\u043C\u0430\u0435\u0442
-tags=\u0422\u044D\u0433\u0438
-
-overview=\u041E\u0431\u0437\u043E\u0440
-current_version=\u0418\u043D\u0444\u043E\u0440\u043C\u0430\u0446\u0438\u044F \u043E \u0432\u0435\u0440\u0441\u0438\u0438
-version=\u0412\u0435\u0440\u0441\u0438\u044F\:\u0020
-contact_information=\u041A\u043E\u043D\u0442\u0430\u043A\u0442\u043D\u0430\u044F \u0438\u043D\u0444\u043E\u0440\u043C\u0430\u0446\u0438\u044F
-contact_name=\u041A\u043E\u043D\u0442\u0430\u043A\u0442\:\u0020
-contact_email=Email \u043A\u043E\u043D\u0442\u0430\u043A\u0442\u0430\:\u0020
-license_information=\u0418\u043D\u0444\u043E\u0440\u043C\u0430\u0446\u0438\u044F \u043E \u043B\u0438\u0446\u0435\u043D\u0446\u0438\u0438
-license=\u041B\u0438\u0446\u0435\u043D\u0437\u0438\u044F\:\u0020
-license_url=URL \u043B\u0438\u0446\u0435\u043D\u0437\u0438\u0438\:\u0020
-terms_of_service=\u0423\u0441\u043B\u043E\u0432\u0438\u044F \u0438\u0441\u043F\u043E\u043B\u044C\u0437\u043E\u0432\u0430\u043D\u0438\u044F\:\u0020
-uri_scheme=\u0421\u0445\u0435\u043C\u0430 URI
-host=\u0423\u0437\u0435\u043B\:\u0020
-base_path=\u041E\u0441\u043D\u043E\u0432\u043D\u043E\u0439 \u043F\u0443\u0442\u044C\:\u0020
-schemes=\u0421\u0445\u0435\u043C\u044B\:\u0020
-security_type=\u0422\u0438\u043F\:\u0020
-security_name=\u0418\u043C\u044F\:\u0020
-security_in=\u0421\u043E\u0434\u0435\u0440\u0436\u0438\u0442\u0441\u044F \u0432\:\u0020
-security_flow=\u041F\u043E\u0442\u043E\u043A\:\u0020
-security_authorizationUrl=URL \u0430\u0432\u0442\u043E\u0440\u0438\u0437\u0430\u0446\u0438\u0438\:\u0020
-security_tokenUrl=URL \u0442\u043E\u043A\u0435\u043D\u0430\:\u0020
-
-paths=\u041F\u0443\u0442\u0438
-resources=\u041E\u0442\u0432\u0435\u0442\u044B
-security=\u0411\u0435\u0437\u043E\u043F\u0430\u0441\u043D\u043E\u0441\u0442\u044C
-response=\u041E\u0442\u0432\u0435\u0442
-request=\u0417\u0430\u043F\u0440\u043E\u0441
-parameters=\u041F\u0430\u0440\u0430\u043C\u0435\u0442\u0440\u044B
-body_parameter=\u041F\u0430\u0440\u0430\u043C\u0435\u0442\u0440 \u0442\u0435\u043B\u0430 \u0437\u0430\u043F\u0440\u043E\u0441\u0430
-responses=\u041E\u0442\u0432\u0435\u0442\u044B
-example_request=\u041F\u0440\u0438\u043C\u0435\u0440 HTTP \u0437\u0430\u043F\u0440\u043E\u0441\u0430
-example_response=\u041F\u0440\u0438\u043C\u0435\u0440 HTTP \u0437\u0430\u043F\u0440\u043E\u0441\u0430
-type_column=\u0422\u0438\u043F
-http_code_column=HTTP \u043A\u043E\u0434
-parameter=\u041F\u0430\u0440\u0430\u043C\u0435\u0442\u0440
-
-unknown=Unknown
-no_content=\u0411\u0435\u0437 \u0441\u043E\u0434\u0435\u0440\u0436\u0438\u043C\u043E\u0433\u043E
-operation.deprecated=\u042D\u0442\u0430 \u043E\u043F\u0435\u0440\u0430\u0446\u0438\u044F \u0443\u0441\u0442\u0430\u0440\u0435\u043B\u0430.

src/test/java/io/github/robwin/swagger2markup/AsciidocConverterTest.java

@@ -1,459 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup;
-
-import io.github.robwin.swagger2markup.assertions.DiffUtils;
-import io.github.robwin.swagger2markup.internal.extensions.DynamicDefinitionsDocumentExtension;
-import io.github.robwin.swagger2markup.internal.extensions.DynamicPathsDocumentExtension;
-import io.github.robwin.swagger2markup.internal.extensions.SchemaExtension;
-import io.github.robwin.swagger2markup.internal.extensions.SpringRestDocsExtension;
-import org.apache.commons.io.FileUtils;
-import org.apache.commons.io.IOUtils;
-import org.junit.Before;
-import org.junit.Test;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.io.IOException;
-import java.net.URISyntaxException;
-import java.nio.charset.Charset;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.util.ArrayList;
-import java.util.List;
-
-import static java.util.Arrays.asList;
-import static org.assertj.core.api.Assertions.failBecauseExceptionWasNotThrown;
-import static org.assertj.core.api.BDDAssertions.assertThat;
-
-public class AsciidocConverterTest {
-
-    private static final Logger LOG = LoggerFactory.getLogger(AsciidocConverterTest.class);
-    private static final String[] EXPECTED_FILES = new String[]{"definitions.adoc", "overview.adoc", "paths.adoc", "security.adoc"};
-    private List<String> expectedFiles;
-    
-    @Before
-    public void setUp(){
-        expectedFiles = new ArrayList<>(asList(EXPECTED_FILES));
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionAsString() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-
-        //When
-        String asciiDocAsString = Swagger2MarkupConverter.from(file).build()
-                .asString();
-        //Then
-        assertThat(asciiDocAsString).isNotEmpty();
-    }
-
-
-    @Test
-    public void testSwagger2AsciiDocConversion() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .build();
-
-        Swagger2MarkupConverter.from(file).withConfig(config).build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-
-        Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected_results/asciidoc/default").toURI());
-        DiffUtils.assertThatAllFilesAreEqual(outputDirectory, expectedFilesDirectory, "testSwagger2AsciiDocConversion.html");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionFromString() throws IOException, URISyntaxException {
-        //Given
-        String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/yaml/swagger_petstore.yaml"));
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .build();
-
-        Swagger2MarkupConverter.from(swaggerJsonString).withConfig(config).build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-
-        Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected_results/asciidoc/default").toURI());
-        DiffUtils.assertThatAllFilesAreEqual(outputDirectory, expectedFilesDirectory, "testSwagger2AsciiDocConversion.html");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionWithSpringRestDocsExtension() throws IOException, URISyntaxException {
-        //Given
-        String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/yaml/swagger_petstore.yaml"));
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupExtensionRegistry registry = Swagger2MarkupExtensionRegistry.ofEmpty()
-                .withExtension(new SpringRestDocsExtension(Paths.get("src/test/resources/docs/asciidoc/paths").toUri()).withDefaultSnippets())
-                .build();
-
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .build();
-
-        Swagger2MarkupConverter.from(swaggerJsonString)
-                .withConfig(config)
-                .withExtensionRegistry(registry)
-                .build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-
-        Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected_results/asciidoc/spring_rest_docs").toURI());
-        DiffUtils.assertThatAllFilesAreEqual(outputDirectory, expectedFilesDirectory, "testSwagger2AsciiDocConversionWithSpringRestDocsExtension.html");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionWithExamples() throws IOException, URISyntaxException {
-        //Given
-        String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/json/swagger_examples.json"));
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .build();
-
-        Swagger2MarkupConverter.from(swaggerJsonString)
-                .withConfig(config)
-                .build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-        Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected_results/asciidoc/examples").toURI());
-        DiffUtils.assertThatAllFilesAreEqual(outputDirectory, expectedFilesDirectory, "testSwagger2AsciiDocConversionWithExamples.html");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionWithGeneratedExamples() throws IOException, URISyntaxException {
-        //Given
-        String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/json/swagger_examples.json"));
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withGeneratedExamples()
-                .build();
-
-        Swagger2MarkupConverter.from(swaggerJsonString)
-                .withConfig(config)
-                .build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-        Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected_results/asciidoc/generated_examples").toURI());
-        DiffUtils.assertThatAllFilesAreEqual(outputDirectory, expectedFilesDirectory, "testSwagger2AsciiDocConversionWithGeneratedExamples.html");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocWithInlineSchema() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_inlineSchema.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withInlineSchemaDepthLevel(1)
-                .build();
-        Swagger2MarkupConverter.from(file)
-                .withConfig(config)
-                .build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-        Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected_results/asciidoc/inline_schema").toURI());
-        DiffUtils.assertThatAllFilesAreEqual(outputDirectory, expectedFilesDirectory, "testSwagger2AsciiDocWithInlineSchema.html");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocGroupedByTags() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withPathsGroupedBy(GroupBy.TAGS)
-                .build();
-        Swagger2MarkupConverter.from(file)
-                .withConfig(config)
-                .build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-        Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected_results/asciidoc/group_by_tags").toURI());
-        DiffUtils.assertThatAllFilesAreEqual(outputDirectory, expectedFilesDirectory, "testSwagger2AsciiDocGroupedByTags.html");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocGroupedByTagsWithMissingTag() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/json/swagger_missing_tag.json").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-        //When
-        try {
-            Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                    .withPathsGroupedBy(GroupBy.TAGS)
-                    .build();
-
-            Swagger2MarkupConverter.from(file)
-                    .withConfig(config)
-                    .build()
-                    .intoFolder(outputDirectory);
-            // If NullPointerException was not thrown, test would fail the specified message
-            failBecauseExceptionWasNotThrown(NullPointerException.class);
-        } catch (Exception e) {
-            assertThat(e).hasMessage("Can't GroupBy.TAGS > Operation 'updatePet' has not tags");
-        }
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionWithDefinitionDescriptions() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withDefinitionDescriptions(Paths.get("src/test/resources/docs/asciidoc/definitions"))
-                .build();
-
-        Swagger2MarkupConverter.from(file)
-                .withConfig(config).build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionDoesNotContainUriScheme() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_should_not_contain_uri_scheme.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConverter.from(file).build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-
-        assertThat(new String(Files.readAllBytes(outputDirectory.resolve("overview.adoc"))))
-                .doesNotContain("=== URI scheme");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionContainsUriScheme() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_should_contain_uri_scheme.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConverter.from(file).build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        assertThat(files).hasSize(4).containsAll(expectedFiles);
-
-        assertThat(new String(Files.readAllBytes(outputDirectory.resolve("overview.adoc"))))
-                .contains("=== URI scheme");
-    }
-
-
-    @Test
-    public void testSwagger2AsciiDocConversionWithSeparatedDefinitions() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withSeparatedDefinitions()
-                .build();
-        Swagger2MarkupConverter.from(file).withConfig(config).build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        expectedFiles.add("definitions");
-        assertThat(files).hasSize(5).containsAll(expectedFiles);
-
-        Path definitionsDirectory = outputDirectory.resolve("definitions");
-        String[] definitions = definitionsDirectory.toFile().list();
-        assertThat(definitions).hasSize(5).containsAll(
-                asList("Category.adoc", "Order.adoc", "Pet.adoc", "Tag.adoc", "User.adoc"));
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionWithSeparatedOperations() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withSeparatedOperations()
-                .build();
-        Swagger2MarkupConverter.from(file).withConfig(config).build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        String[] files = outputDirectory.toFile().list();
-        expectedFiles.add("operations");
-        assertThat(files).hasSize(5).containsAll(expectedFiles);
-
-        Path pathsDirectory = outputDirectory.resolve("operations");
-        String[] paths = pathsDirectory.toFile().list();
-        assertThat(paths).hasSize(18);
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionWithRussianOutputLanguage() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withOutputLanguage(Language.RU)
-                .build();
-        Swagger2MarkupConverter.from(file)
-                .withConfig(config)
-                .build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.adoc")), Charset.forName("UTF-8")))
-                .contains("== Определения");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocConversionWithFrenchOutputLanguage() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withOutputLanguage(Language.FR)
-                .build();
-        Swagger2MarkupConverter.from(file)
-                .withConfig(config)
-                .build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        assertThat(new String(Files.readAllBytes(outputDirectory.resolve("overview.adoc")), Charset.forName("UTF-8")))
-                .contains("== Sch\u00E9ma d'URI");
-    }
-
-    @Test
-    public void testSwagger2AsciiDocExtensions() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .build();
-        Swagger2MarkupExtensionRegistry registry = Swagger2MarkupExtensionRegistry.ofEmpty()
-                .withExtension(new DynamicDefinitionsDocumentExtension(Paths.get("src/test/resources/docs/asciidoc/extensions")))
-                .withExtension(new DynamicPathsDocumentExtension(Paths.get("src/test/resources/docs/asciidoc/extensions")))
-                .build();
-        Swagger2MarkupConverter.from(file)
-                .withConfig(config)
-                .withExtensionRegistry(registry)
-                .build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        assertThat(new String(Files.readAllBytes(outputDirectory.resolve("paths.adoc")))).contains(
-                "Pet update request extension");
-        assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.adoc")))).contains(
-                "Pet extension");
-
-    }
-
-    @Test
-    public void testSwagger2AsciiDocSchemaExtension() throws IOException, URISyntaxException {
-        //Given
-        Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-        Path outputDirectory = Paths.get("build/docs/asciidoc/generated");
-        FileUtils.deleteQuietly(outputDirectory.toFile());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .build();
-        Swagger2MarkupExtensionRegistry registry = Swagger2MarkupExtensionRegistry.ofEmpty()
-                .withExtension(new SchemaExtension(Paths.get("src/test/resources/docs/asciidoc/extensions").toUri()))
-                .build();
-        Swagger2MarkupConverter.from(file)
-                .withConfig(config)
-                .withExtensionRegistry(registry)
-                .build()
-                .intoFolder(outputDirectory);
-
-        //Then
-        assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.adoc")))).contains(
-                "=== Pet");
-        assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.adoc")))).contains(
-                "==== XML Schema");
-    }
-}

src/test/java/io/github/robwin/swagger2markup/GeneralConverterTest.java

@@ -1,85 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup;
-
-import io.swagger.models.Swagger;
-import org.junit.Test;
-
-import java.net.MalformedURLException;
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.nio.file.Path;
-import java.nio.file.Paths;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
-public class GeneralConverterTest {
-
-    @Test
-    public void testConfigDefaultPaths() throws URISyntaxException {
-        //Given
-        Path file = Paths.get(GeneralConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withDefinitionDescriptions()
-                .withOperationDescriptions()
-                .build();
-
-        Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(file)
-                .withConfig(config)
-                .build();
-
-        //Then
-        URI baseUri = io.github.robwin.swagger2markup.internal.utils.IOUtils.uriParent(converter.getContext().getSwaggerLocation());
-        assertThat(converter.getContext().getConfig().getDefinitionDescriptionsUri()).isEqualTo(baseUri);
-        assertThat(converter.getContext().getConfig().getOperationDescriptionsUri()).isEqualTo(baseUri);
-    }
-
-    @Test
-    public void testConfigDefaultPathsWithUri() throws MalformedURLException {
-        //Given
-
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withDefinitionDescriptions()
-                .withOperationDescriptions()
-                .build();
-
-        Swagger2MarkupConverter converterBuilder = Swagger2MarkupConverter.from(URI.create("http://petstore.swagger.io/v2/swagger.json").toURL())
-                .withConfig(config)
-                .build();
-
-        //Then
-        assertThat(converterBuilder.getContext().getConfig().getDefinitionDescriptionsUri()).isNull();
-        assertThat(converterBuilder.getContext().getConfig().getOperationDescriptionsUri()).isNull();
-    }
-
-    @Test
-    public void testDefaultPathsWithoutFile() {
-        //Given
-        //When
-        Swagger2MarkupConfig config = Swagger2MarkupConfig.ofDefaults()
-                .withDefinitionDescriptions()
-                .build();
-
-        //Then
-        Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(new Swagger())
-                .withConfig(config)
-                .build();
-        assertThat(converter.getContext().getConfig().isDefinitionDescriptionsEnabled()).isFalse();
-    }
-}

src/test/java/io/github/robwin/swagger2markup/assertions/DiffAssert.java

@@ -1,88 +0,0 @@
-/*
- *
- *  Copyright 2016 Robert Winkler
- *
- *  Licensed under the Apache License, Version 2.0 (the "License");
- *  you may not use this file except in compliance with the License.
- *  You may obtain a copy of the License at
- *
- *         http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the License is distributed on an "AS IS" BASIS,
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  See the License for the specific language governing permissions and
- *  limitations under the License.
- *
- *
- */
-package io.github.robwin.swagger2markup.assertions;
-
-
-import com.sksamuel.diffpatch.DiffMatchPatch;
-import org.apache.commons.io.IOUtils;
-import org.assertj.core.api.AbstractAssert;
-
-import java.io.BufferedWriter;
-import java.io.IOException;
-import java.nio.charset.Charset;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.util.LinkedList;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
-public class DiffAssert extends AbstractAssert<DiffAssert, Path>{
-
-    public DiffAssert(Path actual) {
-        super(actual, DiffAssert.class);
-    }
-
-    /**
-     * Verifies that the content of the actual File is equal to the given one.
-     *
-     * @param expected the given value to compare the actual value to.
-     * @param reportPath the path to the report which should be generated if the files differ.
-     * @return {@code this} assertion object.
-     * @throws AssertionError if the actual value is not equal to the given one or if the actual value is {@code null}..
-     */
-    public DiffAssert isEqualTo(Path expected, Path reportPath) {
-        LinkedList<DiffMatchPatch.Diff> diffs = diff(actual, expected);
-        boolean allDiffsAreEqual = assertThatAllDiffsAreEqual(diffs);
-        if(!allDiffsAreEqual){
-            writeHtmlReport(reportPath, diffs);
-        }
-        assertThat(allDiffsAreEqual).as("The content of the following files differ. Actual: %s, Expected %s. Check the HTML report for more details: %s", actual.toAbsolutePath(), expected.toAbsolutePath(), reportPath.toAbsolutePath()).isTrue();
-        return myself;
-    }
-
-    public boolean assertThatAllDiffsAreEqual(LinkedList<DiffMatchPatch.Diff> diffs){
-        for(DiffMatchPatch.Diff diff : diffs){
-            if(diff.operation == DiffMatchPatch.Operation.DELETE || diff.operation == DiffMatchPatch.Operation.INSERT){
-                return false;
-            }
-        }
-        return true;
-    }
-
-    private static LinkedList<DiffMatchPatch.Diff> diff(Path actual, Path expected){
-        DiffMatchPatch differ = new DiffMatchPatch();
-        try {
-            return differ.diff_main(IOUtils.toString(expected.toUri()), IOUtils.toString(actual.toUri()), false);
-        } catch (IOException e) {
-            throw new RuntimeException("Failed to diff files.", e);
-        }
-    }
-
-    private static void writeHtmlReport(Path reportPath, LinkedList<DiffMatchPatch.Diff> diffs){
-        DiffMatchPatch differ = new DiffMatchPatch();
-        try {
-            Files.createDirectories(reportPath.getParent());
-            try (BufferedWriter writer = Files.newBufferedWriter(reportPath, Charset.forName("UTF-8"))) {
-                writer.write(differ.diff_prettyHtml(diffs));
-            }
-        } catch (IOException e) {
-            throw new RuntimeException(String.format("Failed to write report %s", reportPath.toAbsolutePath()), e);
-        }
-    }
-}

src/test/java/io/github/robwin/swagger2markup/spi/Swagger2MarkupExtensionRegistryTest.java

@@ -1,69 +0,0 @@
-/*
- * Copyright 2016 Robert Winkler
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package io.github.robwin.swagger2markup.spi;
-
-import io.github.robwin.swagger2markup.Swagger2MarkupExtensionRegistry;
-import io.github.robwin.swagger2markup.internal.extensions.DynamicDefinitionsDocumentExtension;
-import io.github.robwin.swagger2markup.internal.extensions.DynamicPathsDocumentExtension;
-import io.swagger.models.Swagger;
-import org.junit.Test;
-
-import java.nio.file.Paths;
-import java.util.Arrays;
-import java.util.List;
-
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.fail;
-
-public class Swagger2MarkupExtensionRegistryTest {
-
-    @Test
-    public void testRegistering() {
-        Swagger2MarkupExtensionRegistry.Builder registryBuilder = Swagger2MarkupExtensionRegistry.ofDefaults();
-
-        registryBuilder.withExtension(new MySwaggerModelExtension());
-        registryBuilder.withExtension(new DynamicDefinitionsDocumentExtension(Paths.get("src/test/resources/docs/asciidoc/extensions")));
-        registryBuilder.withExtension(new DynamicPathsDocumentExtension(Paths.get("src/test/resources/docs/asciidoc/extensions")));
-
-        try {
-            registryBuilder.withExtension(new AbstractExtension() {
-            });
-            fail("No IllegalArgumentException thrown");
-        } catch (IllegalArgumentException e) {
-            assertThat(e.getMessage()).isEqualTo("Provided extension class does not extend any of the supported extension points");
-        }
-    }
-
-    @Test
-    public void testListing() {
-        Extension ext1 = new MySwaggerModelExtension();
-        Extension ext2 = new MySwaggerModelExtension();
-        Extension ext3 = new SwaggerModelExtension() {
-            public void apply(Swagger swagger) {
-            }
-        };
-
-        Swagger2MarkupExtensionRegistry registry = Swagger2MarkupExtensionRegistry.ofDefaults()
-                .withExtension(ext2)
-                .withExtension(ext3)
-                .withExtension(ext1)
-                .build();
-        List<Extension> extensions = registry.getExtensions(Extension.class);
-        assertThat(extensions.size()).isEqualTo(7);
-        assertThat(extensions).contains(ext1, ext2, ext3);
-        assertThat(registry.getExtensions(SwaggerModelExtension.class)).isEqualTo(Arrays.asList(ext2, ext3, ext1));
-    }
-}

src/test/resources/docs/asciidoc/definitions/User/description.adoc

@@ -1,5 +0,0 @@
-This is a hand-written description.
-AsciiDoc is better suited for descriptions than:
-
-* JavaDoc
-* Annotations

src/test/resources/docs/asciidoc/definitions/User/id/description.adoc

@@ -1 +0,0 @@
-This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

src/test/resources/docs/asciidoc/definitions/User/username/description.adoc

@@ -1 +0,0 @@
-This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

src/test/resources/docs/asciidoc/extensions/Pet/definition-end-example.adoc

@@ -1,3 +0,0 @@
-== Pet extension
-
-This is an extension for this definition

src/test/resources/docs/asciidoc/extensions/Pet/schema.xsd

@@ -1,2 +0,0 @@
-<?xml version="1.0" encoding="" ?>
-<xsd>This is an XML Schema</xsd>

src/test/resources/docs/asciidoc/extensions/updatePet/operation-end-example.adoc

@@ -1,11 +0,0 @@
-== Pet update request extension
-
-----
-Request
-----
-
-== Pet update response extension
-
-----
-Response
-----

src/test/resources/docs/asciidoc/paths/updatePet/body/description.adoc

@@ -1,2 +0,0 @@
-This is a hand-written description.
-AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

src/test/resources/docs/asciidoc/paths/updatePet/description.adoc

@@ -1,5 +0,0 @@
-This is a hand-written description.
-AsciiDoc is better suited for descriptions than:
-
-* JavaDoc
-* Annotations

src/test/resources/docs/markdown/definitions/User/description.md

@@ -1,5 +0,0 @@
-This is a hand-written description.
-AsciiDoc is better suited for descriptions than:
-
-* JavaDoc
-* Annotations

src/test/resources/docs/markdown/definitions/User/id/description.md

@@ -1 +0,0 @@
-This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

src/test/resources/docs/markdown/definitions/User/username/description.md

@@ -1 +0,0 @@
-This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

src/test/resources/docs/markdown/extensions/Pet/definition-end-example.md

@@ -1,3 +0,0 @@
-## Pet extension
-
-This is an extension for this definition

src/test/resources/docs/markdown/extensions/updatePet/operation-end-example.md

@@ -1,11 +0,0 @@
-## Pet update request extension
-
-```
-Request
-```
-
-## Pet update response extension
-
-```
-Response
-```

src/test/resources/docs/markdown/paths/updatePet/body/description.md

@@ -1 +0,0 @@
-This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

src/test/resources/docs/markdown/paths/updatePet/description.md

@@ -1,5 +0,0 @@
-This is a hand-written description.
-It is better suited for adding descriptions than:
-
-* JavaDoc
-* Annotations

src/test/resources/expected_results/asciidoc/default/definitions.adoc

@@ -1,69 +0,0 @@
-
-[[_definitions]]
-== Definitions
-
-=== Category
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||
-|name||false|string||
-|===
-
-
-=== Order
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|complete||false|boolean||
-|id||false|integer(int64)||
-|petId||false|integer(int64)||
-|quantity||false|integer(int32)||
-|shipDate||false|string(date-time)||
-|status|Order Status|false|string||
-|===
-
-
-=== Pet
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|category||false|<<_category,Category>>||
-|id||false|integer(int64)||
-|name||true|string||"doggie"
-|photoUrls||true|string array||
-|status|pet status in the store|false|string||
-|tags||false|<<_tag,Tag>> array||
-|===
-
-
-=== Tag
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||
-|name||false|string||
-|===
-
-
-=== User
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|email||false|string||
-|firstName||false|string||
-|id||false|integer(int64)||
-|lastName||false|string||
-|password||false|string||
-|phone||false|string||
-|userStatus|User Status|false|integer(int32)||
-|username||false|string||
-|===
-
-
-

src/test/resources/expected_results/asciidoc/default/overview.adoc

@@ -1,36 +0,0 @@
-= Swagger Petstore
-
-
-[[_overview]]
-== Overview
-This is a sample server Petstore server.
-
-[Learn about Swagger](http://swagger.io) or join the IRC channel `#swagger` on irc.freenode.net.
-
-For this sample, you can use the api key `special-key` to test the authorization filters
-
-
-=== Version information
-Version : 1.0.0
-
-=== Contact information
-Contact : apiteam@swagger.io
-
-=== License information
-License : Apache 2.0
-License URL : http://www.apache.org/licenses/LICENSE-2.0.html
-Terms of service : http://helloreverb.com/terms/
-
-=== URI scheme
-Host : petstore.swagger.io
-BasePath : /v2
-Schemes : HTTP
-
-=== Tags
-
-* pet : Pet resource
-* store : Store resource
-* user : User resource
-
-
-

src/test/resources/expected_results/asciidoc/default/paths.adoc

@@ -1,993 +0,0 @@
-
-[[_paths]]
-== Paths
-
-=== Add a new pet to the store
-----
-POST /pets
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code 405
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|405|Invalid input|No Content
-|===
-
-
-==== Consumes
-
-* application/json
-* application/xml
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Update an existing pet
-----
-PUT /pets
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Pet not found|No Content
-|===
-
-
-===== HTTP Code 405
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|405|Validation exception|No Content
-|===
-
-
-==== Consumes
-
-* application/json
-* application/xml
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Finds Pets by status
-----
-GET /pets/findByStatus
-----
-
-
-==== Description
-[%hardbreaks]
-Multiple status values can be provided with comma seperated strings
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|status|Status values that need to be considered for filter|false|multi string array|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_pet,Pet>> array
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid status value|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Finds Pets by tags
-----
-GET /pets/findByTags
-----
-
-
-==== Description
-[%hardbreaks]
-Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|tags|Tags to filter by|false|multi string array|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_pet,Pet>> array
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid tag value|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Updates a pet in the store with form data
-----
-POST /pets/{petId}
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|petId|ID of pet that needs to be updated|true|string|
-|FormData|name|Updated name of the pet|true|string|
-|FormData|status|Updated status of the pet|true|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 405
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|405|Invalid input|No Content
-|===
-
-
-==== Consumes
-
-* application/x-www-form-urlencoded
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Find pet by ID
-----
-GET /pets/{petId}
-----
-
-
-==== Description
-[%hardbreaks]
-Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error conditions
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|petId|ID of pet that needs to be fetched|true|integer(int64)|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_pet,Pet>>
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Pet not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|apiKey|<<_api_key,api_key>>|
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Deletes a pet
-----
-DELETE /pets/{petId}
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Header|api_key||true|string|
-|Path|petId|Pet id to delete|true|integer(int64)|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid pet value|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Place an order for a pet
-----
-POST /stores/order
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|order placed for purchasing the pet|false|<<_order,Order>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_order,Order>>
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid Order|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* store
-
-
-=== Find purchase order by ID
-----
-GET /stores/order/{orderId}
-----
-
-
-==== Description
-[%hardbreaks]
-For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|orderId|ID of pet that needs to be fetched|true|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_order,Order>>
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Order not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* store
-
-
-=== Delete purchase order by ID
-----
-DELETE /stores/order/{orderId}
-----
-
-
-==== Description
-[%hardbreaks]
-For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|orderId|ID of the order that needs to be deleted|true|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Order not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* store
-
-
-=== Create user
-----
-POST /users
-----
-
-
-==== Description
-[%hardbreaks]
-This can only be done by the logged in user.
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|Created user object|false|<<_user,User>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Creates list of users with given input array
-----
-POST /users/createWithArray
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|List of user object|false|<<_user,User>> array|
-|===
-
-
-==== Responses
-
-===== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Creates list of users with given input array
-----
-POST /users/createWithList
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|List of user object|false|<<_user,User>> array|
-|===
-
-
-==== Responses
-
-===== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Logs user into the system
-----
-GET /users/login
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|password|The password for login in clear text|false|string|
-|Query|username|The user name for login|false|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|string
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid username/password supplied|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Logs out current logged in user session
-----
-GET /users/logout
-----
-
-
-==== Responses
-
-===== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Get user by user name
-----
-GET /users/{username}
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_user,User>>
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid username supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|User not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Updated user
-----
-PUT /users/{username}
-----
-
-
-==== Description
-[%hardbreaks]
-This can only be done by the logged in user.
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|username|name that need to be deleted|true|string|
-|Body|body|Updated user object|false|<<_user,User>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid user supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|User not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Delete user
-----
-DELETE /users/{username}
-----
-
-
-==== Description
-[%hardbreaks]
-This can only be done by the logged in user.
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|username|The name that needs to be deleted|true|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid username supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|User not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-

src/test/resources/expected_results/asciidoc/default/security.adoc

@@ -1,23 +0,0 @@
-
-[[_security]]
-== Security
-
-=== api_key
-Type : apiKey
-Name : api_key
-In : HEADER
-
-=== petstore_auth
-Type : oauth2
-Flow : implicit
-Token URL : http://petstore.swagger.io/api/oauth/dialog
-
-[options="header", cols="1,6"]
-|===
-|Name|Description
-|write_pets|modify pets in your account
-|read_pets|read your pets
-|===
-
-
-

src/test/resources/expected_results/asciidoc/examples/definitions.adoc

@@ -1,84 +0,0 @@
-
-[[_definitions]]
-== Definitions
-
-=== Category
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||123
-|name||false|string||"Canines"
-|===
-
-
-=== Identified
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||
-|===
-
-
-=== Order
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|complete||false|boolean||
-|id||false|integer(int64)||77
-|petId||false|integer(int64)||
-|quantity||false|integer(int32)||
-|shipDate||false|string(date-time)||
-|status|Order Status|false|string||"DONE"
-|===
-
-
-=== Pet
-[%hardbreaks]
-Test description
-
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|category||false|<<_category,Category>>||
-|id||false|integer(int64)||
-|name||true|string||"doggie"
-|nicknames||false|object||
-|photoUrls||true|string array||
-|status|pet status in the store|false|string||
-|tags||false|<<_tag,Tag>> array||
-|weight|the weight of the pet|false|number||
-|===
-
-
-=== Tag
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||
-|name||false|string||
-|===
-
-
-=== User
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|email||false|string||
-|firstName||false|string||
-|id||false|integer(int64)||
-|lastName||false|string||
-|password||false|string||
-|phone||false|string||
-|pictures||false|string(byte) array||
-|userStatus|User Status|false|integer(int32)||
-|username||false|string||
-|===
-
-
-

src/test/resources/expected_results/asciidoc/examples/overview.adoc

@@ -1,36 +0,0 @@
-= Swagger Petstore API
-
-
-[[_overview]]
-== Overview
-This is a sample server Petstore server.
-
-[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.
-
-For this sample, you can use the api key `special-key` to test the authorization filters
-
-
-=== Version information
-Version : 1.0.0
-
-=== Contact information
-Contact : apiteam@wordnik.com
-
-=== License information
-License : Apache 2.0
-License URL : http://www.apache.org/licenses/LICENSE-2.0.html
-Terms of service : http://helloreverb.com/terms/
-
-=== URI scheme
-Host : petstore.swagger.wordnik.com
-BasePath : /v2
-Schemes : HTTP
-
-=== Tags
-
-* pet : Pet resource
-* store : Store resource
-* user : User resource
-
-
-

src/test/resources/expected_results/asciidoc/examples/paths.adoc

@@ -1,984 +0,0 @@
-
-[[_paths]]
-== Paths
-
-=== Add a new pet to the store
-----
-POST /pets
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code 405
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|405|Invalid input|No Content
-|===
-
-
-==== Consumes
-
-* application/json
-* application/xml
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-==== Example HTTP response
-
-==== Response 405
-----
-{
-  "application/json" : {
-    "name" : "Puma",
-    "type" : 22,
-    "color" : "Black",
-    "gender" : "Female",
-    "breed" : "Mixed"
-  }
-}
-----
-
-
-=== Update an existing pet
-----
-PUT /pets
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Pet not found|No Content
-|===
-
-
-===== HTTP Code 405
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|405|Validation exception|No Content
-|===
-
-
-==== Consumes
-
-* application/json
-* application/xml
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Finds Pets by status
-----
-GET /pets/findByStatus
-----
-
-
-==== Description
-[%hardbreaks]
-Multiple status values can be provided with comma seperated strings
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|status|Status values that need to be considered for filter|false|multi string array|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_pet,Pet>> array
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid status value|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Finds Pets by tags
-----
-GET /pets/findByTags
-----
-
-
-==== Description
-[%hardbreaks]
-Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|tags|Tags to filter by|false|multi string array|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_pet,Pet>> array
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid tag value|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Updates a pet in the store with form data
-----
-POST /pets/{petId}
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|petId|ID of pet that needs to be updated|true|string|
-|FormData|name|Updated name of the pet|true|string|
-|FormData|status|Updated status of the pet|true|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 405
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|405|Invalid input|No Content
-|===
-
-
-==== Consumes
-
-* application/x-www-form-urlencoded
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Find pet by ID
-----
-GET /pets/{petId}
-----
-
-
-==== Description
-[%hardbreaks]
-Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error conditions
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|petId|ID of the pet|true|integer(int64)|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_pet,Pet>>
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Pet not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|apiKey|<<_api_key,api_key>>|
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Deletes a pet
-----
-DELETE /pets/{petId}
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Header|api_key||true|string|
-|Path|petId|Pet id to delete|true|integer(int64)|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid pet value|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* pet
-
-
-==== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Place an order for a pet
-----
-POST /stores/order
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|order placed for purchasing the pet|false|<<_order,Order>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_order,Order>>
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid Order|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* store
-
-
-==== Example HTTP request
-
-==== Request body
-----
-{
-  "id" : 99,
-  "petId" : 122,
-  "quantity" : 2,
-  "shipDate" : "2016-02-22T23:02:05Z",
-  "status" : "PENDING",
-  "complete" : true
-}
-----
-
-
-==== Example HTTP response
-
-==== Response 200
-----
-{
-  "id" : 99,
-  "petId" : 122,
-  "quantity" : 2,
-  "shipDate" : "2016-02-22T23:02:05Z",
-  "status" : "PENDING",
-  "complete" : true
-}
-----
-
-
-=== Find purchase order by ID
-----
-GET /stores/order/{orderId}
-----
-
-
-==== Description
-[%hardbreaks]
-For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|orderId|ID of pet that needs to be fetched|true|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_order,Order>>
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Order not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* store
-
-
-==== Example HTTP response
-
-==== Response 200
-----
-{
-  "id" : 99,
-  "petId" : 122,
-  "quantity" : 2,
-  "shipDate" : "2016-02-22T23:02:05Z",
-  "status" : "PENDING",
-  "complete" : true
-}
-----
-
-
-=== Delete purchase order by ID
-----
-DELETE /stores/order/{orderId}
-----
-
-
-==== Description
-[%hardbreaks]
-For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|orderId|ID of the order that needs to be deleted|true|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Order not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* store
-
-
-=== Create user
-----
-POST /users
-----
-
-
-==== Description
-[%hardbreaks]
-This can only be done by the logged in user.
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|Created user object|false|<<_user,User>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Creates list of users with given input array
-----
-POST /users/createWithArray
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|List of user object|false|<<_user,User>> array|
-|===
-
-
-==== Responses
-
-===== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Creates list of users with given input array
-----
-POST /users/createWithList
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|List of user object|false|<<_user,User>> array|
-|===
-
-
-==== Responses
-
-===== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Logs user into the system
-----
-GET /users/login
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|password|The password for login in clear text|false|string|testPassword
-|Query|username|The user name for login|false|string|testUser
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|string
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid username/password supplied|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Logs out current logged in user session
-----
-GET /users/logout
-----
-
-
-==== Responses
-
-===== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Get user by user name
-----
-GET /users/{username}
-----
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string|testUser
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_user,User>>
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid username supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|User not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Updated user
-----
-PUT /users/{username}
-----
-
-
-==== Description
-[%hardbreaks]
-This can only be done by the logged in user.
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|username|name that need to be deleted|true|string|
-|Body|body|Updated user object|false|<<_user,User>>|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid user supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|User not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-=== Delete user
-----
-DELETE /users/{username}
-----
-
-
-==== Description
-[%hardbreaks]
-This can only be done by the logged in user.
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|username|The name that needs to be deleted|true|string|
-|===
-
-
-==== Responses
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid username supplied|No Content
-|===
-
-
-===== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|User not found|No Content
-|===
-
-
-==== Produces
-
-* application/json
-* application/xml
-
-
-==== Tags
-
-* user
-
-
-

src/test/resources/expected_results/asciidoc/examples/security.adoc

@@ -1,23 +0,0 @@
-
-[[_security]]
-== Security
-
-=== api_key
-Type : apiKey
-Name : api_key
-In : HEADER
-
-=== petstore_auth
-Type : oauth2
-Flow : implicit
-Token URL : http://petstore.swagger.wordnik.com/api/oauth/dialog
-
-[options="header", cols="1,6"]
-|===
-|Name|Description
-|write_pets|modify pets in your account
-|read_pets|read your pets
-|===
-
-
-

src/test/resources/expected_results/asciidoc/generated_examples/definitions.adoc

@@ -1,86 +0,0 @@
-
-[[_definitions]]
-== Definitions
-
-=== Category
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||123
-|name||false|string||"Canines"
-|===
-
-
-=== Identified
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||0
-|===
-
-
-=== Order
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|complete||false|boolean||true
-|id||false|integer(int64)||77
-|petId||false|integer(int64)||0
-|quantity||false|integer(int32)||0
-|shipDate||false|string(date-time)||"string"
-|status|Order Status|false|string||"DONE"
-|===
-
-
-=== Pet
-[%hardbreaks]
-Test description
-
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|category||false|<<_category,Category>>||"<<_category>>"
-|id||false|integer(int64)||0
-|name||true|string||"doggie"
-|nicknames||false|object||{
-  "string" : "string"
-}
-|photoUrls||true|string array||[ "string" ]
-|status|pet status in the store|false|string||"string"
-|tags||false|<<_tag,Tag>> array||[ "<<_tag>>" ]
-|weight|the weight of the pet|false|number||0.0
-|===
-
-
-=== Tag
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||0
-|name||false|string||"string"
-|===
-
-
-=== User
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|email||false|string||"string"
-|firstName||false|string||"string"
-|id||false|integer(int64)||0
-|lastName||false|string||"string"
-|password||false|string||"string"
-|phone||false|string||"string"
-|pictures||false|string(byte) array||[ "string" ]
-|userStatus|User Status|false|integer(int32)||0
-|username||false|string||"string"
-|===
-
-
-

src/test/resources/expected_results/asciidoc/generated_examples/overview.adoc

@@ -1,36 +0,0 @@
-= Swagger Petstore API
-
-
-[[_overview]]
-== Overview
-This is a sample server Petstore server.
-
-[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.
-
-For this sample, you can use the api key `special-key` to test the authorization filters
-
-
-=== Version information
-Version : 1.0.0
-
-=== Contact information
-Contact : apiteam@wordnik.com
-
-=== License information
-License : Apache 2.0
-License URL : http://www.apache.org/licenses/LICENSE-2.0.html
-Terms of service : http://helloreverb.com/terms/
-
-=== URI scheme
-Host : petstore.swagger.wordnik.com
-BasePath : /v2
-Schemes : HTTP
-
-=== Tags
-
-* pet : Pet resource
-* store : Store resource
-* user : User resource
-
-
-

src/test/resources/expected_results/asciidoc/generated_examples/security.adoc

@@ -1,23 +0,0 @@
-
-[[_security]]
-== Security
-
-=== api_key
-Type : apiKey
-Name : api_key
-In : HEADER
-
-=== petstore_auth
-Type : oauth2
-Flow : implicit
-Token URL : http://petstore.swagger.wordnik.com/api/oauth/dialog
-
-[options="header", cols="1,6"]
-|===
-|Name|Description
-|write_pets|modify pets in your account
-|read_pets|read your pets
-|===
-
-
-

src/test/resources/expected_results/asciidoc/group_by_tags/definitions.adoc

@@ -1,69 +0,0 @@
-
-[[_definitions]]
-== Definitions
-
-=== Category
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||
-|name||false|string||
-|===
-
-
-=== Order
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|complete||false|boolean||
-|id||false|integer(int64)||
-|petId||false|integer(int64)||
-|quantity||false|integer(int32)||
-|shipDate||false|string(date-time)||
-|status|Order Status|false|string||
-|===
-
-
-=== Pet
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|category||false|<<_category,Category>>||
-|id||false|integer(int64)||
-|name||true|string||"doggie"
-|photoUrls||true|string array||
-|status|pet status in the store|false|string||
-|tags||false|<<_tag,Tag>> array||
-|===
-
-
-=== Tag
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||
-|name||false|string||
-|===
-
-
-=== User
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|email||false|string||
-|firstName||false|string||
-|id||false|integer(int64)||
-|lastName||false|string||
-|password||false|string||
-|phone||false|string||
-|userStatus|User Status|false|integer(int32)||
-|username||false|string||
-|===
-
-
-

src/test/resources/expected_results/asciidoc/group_by_tags/overview.adoc

@@ -1,36 +0,0 @@
-= Swagger Petstore
-
-
-[[_overview]]
-== Overview
-This is a sample server Petstore server.
-
-[Learn about Swagger](http://swagger.io) or join the IRC channel `#swagger` on irc.freenode.net.
-
-For this sample, you can use the api key `special-key` to test the authorization filters
-
-
-=== Version information
-Version : 1.0.0
-
-=== Contact information
-Contact : apiteam@swagger.io
-
-=== License information
-License : Apache 2.0
-License URL : http://www.apache.org/licenses/LICENSE-2.0.html
-Terms of service : http://helloreverb.com/terms/
-
-=== URI scheme
-Host : petstore.swagger.io
-BasePath : /v2
-Schemes : HTTP
-
-=== Tags
-
-* pet : Pet resource
-* store : Store resource
-* user : User resource
-
-
-

src/test/resources/expected_results/asciidoc/group_by_tags/paths.adoc

@@ -1,918 +0,0 @@
-
-[[_paths]]
-== Resources
-
-=== Pet
-[%hardbreaks]
-Pet resource
-
-
-==== Add a new pet to the store
-----
-POST /pets
-----
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>|
-|===
-
-
-===== Responses
-
-====== HTTP Code 405
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|405|Invalid input|No Content
-|===
-
-
-===== Consumes
-
-* application/json
-* application/xml
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-===== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-==== Update an existing pet
-----
-PUT /pets
-----
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>|
-|===
-
-
-===== Responses
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-====== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Pet not found|No Content
-|===
-
-
-====== HTTP Code 405
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|405|Validation exception|No Content
-|===
-
-
-===== Consumes
-
-* application/json
-* application/xml
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-===== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-==== Finds Pets by status
-----
-GET /pets/findByStatus
-----
-
-
-===== Description
-[%hardbreaks]
-Multiple status values can be provided with comma seperated strings
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|status|Status values that need to be considered for filter|false|multi string array|
-|===
-
-
-===== Responses
-
-====== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_pet,Pet>> array
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid status value|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-===== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-==== Finds Pets by tags
-----
-GET /pets/findByTags
-----
-
-
-===== Description
-[%hardbreaks]
-Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|tags|Tags to filter by|false|multi string array|
-|===
-
-
-===== Responses
-
-====== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_pet,Pet>> array
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid tag value|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-===== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-==== Updates a pet in the store with form data
-----
-POST /pets/{petId}
-----
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|petId|ID of pet that needs to be updated|true|string|
-|FormData|name|Updated name of the pet|true|string|
-|FormData|status|Updated status of the pet|true|string|
-|===
-
-
-===== Responses
-
-====== HTTP Code 405
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|405|Invalid input|No Content
-|===
-
-
-===== Consumes
-
-* application/x-www-form-urlencoded
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-===== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-==== Find pet by ID
-----
-GET /pets/{petId}
-----
-
-
-===== Description
-[%hardbreaks]
-Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error conditions
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|petId|ID of pet that needs to be fetched|true|integer(int64)|
-|===
-
-
-===== Responses
-
-====== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_pet,Pet>>
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-====== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Pet not found|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-===== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|apiKey|<<_api_key,api_key>>|
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-==== Deletes a pet
-----
-DELETE /pets/{petId}
-----
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Header|api_key||true|string|
-|Path|petId|Pet id to delete|true|integer(int64)|
-|===
-
-
-===== Responses
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid pet value|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-===== Security
-
-[options="header", cols=".^1,.^1h,.^6"]
-|===
-|Type|Name|Scopes
-|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets
-|===
-
-
-=== Store
-[%hardbreaks]
-Store resource
-
-
-==== Place an order for a pet
-----
-POST /stores/order
-----
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|order placed for purchasing the pet|false|<<_order,Order>>|
-|===
-
-
-===== Responses
-
-====== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_order,Order>>
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid Order|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-==== Find purchase order by ID
-----
-GET /stores/order/{orderId}
-----
-
-
-===== Description
-[%hardbreaks]
-For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|orderId|ID of pet that needs to be fetched|true|string|
-|===
-
-
-===== Responses
-
-====== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_order,Order>>
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-====== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Order not found|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-==== Delete purchase order by ID
-----
-DELETE /stores/order/{orderId}
-----
-
-
-===== Description
-[%hardbreaks]
-For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|orderId|ID of the order that needs to be deleted|true|string|
-|===
-
-
-===== Responses
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid ID supplied|No Content
-|===
-
-
-====== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|Order not found|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-=== User
-[%hardbreaks]
-User resource
-
-
-==== Create user
-----
-POST /users
-----
-
-
-===== Description
-[%hardbreaks]
-This can only be done by the logged in user.
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|Created user object|false|<<_user,User>>|
-|===
-
-
-===== Responses
-
-====== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-==== Creates list of users with given input array
-----
-POST /users/createWithArray
-----
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|List of user object|false|<<_user,User>> array|
-|===
-
-
-===== Responses
-
-====== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-==== Creates list of users with given input array
-----
-POST /users/createWithList
-----
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Body|body|List of user object|false|<<_user,User>> array|
-|===
-
-
-===== Responses
-
-====== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-==== Logs user into the system
-----
-GET /users/login
-----
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|password|The password for login in clear text|false|string|
-|Query|username|The user name for login|false|string|
-|===
-
-
-===== Responses
-
-====== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|string
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid username/password supplied|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-==== Logs out current logged in user session
-----
-GET /users/logout
-----
-
-
-===== Responses
-
-====== HTTP Code default
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|default|successful operation|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-==== Get user by user name
-----
-GET /users/{username}
-----
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string|
-|===
-
-
-===== Responses
-
-====== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|successful operation|<<_user,User>>
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|successful operation|integer|
-|X-Rate-Limit-Remaining|successful operation|integer|
-|X-Rate-Limit-Reset|successful operation|integer|
-|===
-
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid username supplied|No Content
-|===
-
-
-====== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|User not found|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-==== Updated user
-----
-PUT /users/{username}
-----
-
-
-===== Description
-[%hardbreaks]
-This can only be done by the logged in user.
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|username|name that need to be deleted|true|string|
-|Body|body|Updated user object|false|<<_user,User>>|
-|===
-
-
-===== Responses
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid user supplied|No Content
-|===
-
-
-====== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|User not found|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-==== Delete user
-----
-DELETE /users/{username}
-----
-
-
-===== Description
-[%hardbreaks]
-This can only be done by the logged in user.
-
-
-===== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Path|username|The name that needs to be deleted|true|string|
-|===
-
-
-===== Responses
-
-====== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Invalid username supplied|No Content
-|===
-
-
-====== HTTP Code 404
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|404|User not found|No Content
-|===
-
-
-===== Produces
-
-* application/json
-* application/xml
-
-
-

src/test/resources/expected_results/asciidoc/group_by_tags/security.adoc

@@ -1,23 +0,0 @@
-
-[[_security]]
-== Security
-
-=== api_key
-Type : apiKey
-Name : api_key
-In : HEADER
-
-=== petstore_auth
-Type : oauth2
-Flow : implicit
-Token URL : http://petstore.swagger.io/api/oauth/dialog
-
-[options="header", cols="1,6"]
-|===
-|Name|Description
-|write_pets|modify pets in your account
-|read_pets|read your pets
-|===
-
-
-

src/test/resources/expected_results/asciidoc/inline_schema/definitions.adoc

@@ -1,62 +0,0 @@
-
-[[_definitions]]
-== Definitions
-
-=== Error
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|error-code|Error code|false|integer||
-|message|Error message|false|string||
-|===
-
-
-=== ExternalLocation
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|Place|Place|false|string||
-|===
-
-
-=== InlineDepthSchema
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|Loop||false|<<_inlinedepthschema_loop,Loop>>||
-|===
-
-[[_inlinedepthschema_loop]]
-*Loop*
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|p1|Description p1|false|string||
-|p2|Description p2|false|<<_inlinedepthschema_p2,p2>>||
-|===
-
-[[_inlinedepthschema_p2]]
-*p2*
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|p2-1|Description p2-1|false|string||
-|p2-2|Description p2-2|false|object||
-|===
-
-
-=== Location
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|Place|Place|false|string||
-|===
-
-
-

src/test/resources/expected_results/asciidoc/inline_schema/overview.adoc

@@ -1,25 +0,0 @@
-= API
-
-
-[[_overview]]
-== Overview
-Service API
-
-=== Version information
-Version : 2.18
-
-=== URI scheme
-Host : service.host.com
-Schemes : HTTPS
-
-=== Consumes
-
-* application/json
-
-
-=== Produces
-
-* application/json
-
-
-

src/test/resources/expected_results/asciidoc/inline_schema/paths.adoc

@@ -1,93 +0,0 @@
-
-[[_paths]]
-== Paths
-
-=== LaunchCommand
-----
-POST /LaunchCommand
-----
-
-
-==== Description
-[%hardbreaks]
-Dummy description
-
-
-==== Parameters
-
-[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"]
-|===
-|Type|Name|Description|Required|Schema|Default
-|Query|Option|An optional option|false|string|
-|Query|Version|The API version|false|string|
-|Body|LaunchCommandRequest|Launch something new|false|<<_launchcommand_post_launchcommandrequest,LaunchCommandRequest>>|
-|===
-
-[[_launchcommand_post_launchcommandrequest]]
-*LaunchCommandRequest*
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|Command|Dummy description|true|<<_launchcommand_post_command,Command>>||
-|Location|Dummy description|false|<<_location,Location>>||
-|Options|Dummy description|false|string||
-|===
-
-[[_launchcommand_post_command]]
-*Command*
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|args|Command arguments|false|string||
-|path|Command path|false|string||
-|===
-
-
-==== Responses
-
-===== HTTP Code 200
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|200|Result|<<_launchcommand_post_response_200,Response 200>>
-|===
-
-*Headers*
-
-[options="header", cols=".^1h,.^3,.^1,.^1"]
-|===
-|Name|Description|Schema|Default
-|X-Rate-Limit-Limit|Result|integer|
-|X-Rate-Limit-Remaining|Result|integer|
-|X-Rate-Limit-Reset|Result|integer|
-|===
-
-
-===== HTTP Code 400
-
-[options="header", cols=".^1h,.^3,.^1"]
-|===
-|HTTP Code|Description|Schema
-|400|Error|<<_error,Error>>
-|===
-
-[[_launchcommand_post_response_200]]
-*Response 200*
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|Location|<description>|false|<<_location,Location>>||
-|ReservationId|<description>|false|string||
-|===
-
-
-==== Tags
-
-* All
-
-
-

src/test/resources/expected_results/asciidoc/spring_rest_docs/definitions.adoc

@@ -1,69 +0,0 @@
-
-[[_definitions]]
-== Definitions
-
-=== Category
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||
-|name||false|string||
-|===
-
-
-=== Order
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|complete||false|boolean||
-|id||false|integer(int64)||
-|petId||false|integer(int64)||
-|quantity||false|integer(int32)||
-|shipDate||false|string(date-time)||
-|status|Order Status|false|string||
-|===
-
-
-=== Pet
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|category||false|<<_category,Category>>||
-|id||false|integer(int64)||
-|name||true|string||"doggie"
-|photoUrls||true|string array||
-|status|pet status in the store|false|string||
-|tags||false|<<_tag,Tag>> array||
-|===
-
-
-=== Tag
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|id||false|integer(int64)||
-|name||false|string||
-|===
-
-
-=== User
-
-[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
-|===
-|Name|Description|Required|Schema|Default|Example
-|email||false|string||
-|firstName||false|string||
-|id||false|integer(int64)||
-|lastName||false|string||
-|password||false|string||
-|phone||false|string||
-|userStatus|User Status|false|integer(int32)||
-|username||false|string||
-|===
-
-
-

src/test/resources/expected_results/asciidoc/spring_rest_docs/overview.adoc

@@ -1,36 +0,0 @@
-= Swagger Petstore
-
-
-[[_overview]]
-== Overview
-This is a sample server Petstore server.
-
-[Learn about Swagger](http://swagger.io) or join the IRC channel `#swagger` on irc.freenode.net.
-
-For this sample, you can use the api key `special-key` to test the authorization filters
-
-
-=== Version information
-Version : 1.0.0
-
-=== Contact information
-Contact : apiteam@swagger.io
-
-=== License information
-License : Apache 2.0
-License URL : http://www.apache.org/licenses/LICENSE-2.0.html
-Terms of service : http://helloreverb.com/terms/
-
-=== URI scheme
-Host : petstore.swagger.io
-BasePath : /v2
-Schemes : HTTP
-
-=== Tags
-
-* pet : Pet resource
-* store : Store resource
-* user : User resource
-
-
-

src/test/resources/expected_results/asciidoc/spring_rest_docs/security.adoc

@@ -1,23 +0,0 @@
-
-[[_security]]
-== Security
-
-=== api_key
-Type : apiKey
-Name : api_key
-In : HEADER
-
-=== petstore_auth
-Type : oauth2
-Flow : implicit
-Token URL : http://petstore.swagger.io/api/oauth/dialog
-
-[options="header", cols="1,6"]
-|===
-|Name|Description
-|write_pets|modify pets in your account
-|read_pets|read your pets
-|===
-
-
-

src/test/resources/expected_results/markdown/default/definitions.md

@@ -1,59 +0,0 @@
-
-<a name="definitions"></a>
-## Definitions
-
-### Category
-
-|Name|Description|Required|Schema|Default|Example|
-|---|---|---|---|---|---|
-|id||false|integer(int64)|||
-|name||false|string|||
-
-
-### Order
-
-|Name|Description|Required|Schema|Default|Example|
-|---|---|---|---|---|---|
-|complete||false|boolean|||
-|id||false|integer(int64)|||
-|petId||false|integer(int64)|||
-|quantity||false|integer(int32)|||
-|shipDate||false|string(date-time)|||
-|status|Order Status|false|string|||
-
-
-### Pet
-
-|Name|Description|Required|Schema|Default|Example|
-|---|---|---|---|---|---|
-|category||false|[Category](#category)|||
-|id||false|integer(int64)|||
-|name||true|string||"doggie"|
-|photoUrls||true|string array|||
-|status|pet status in the store|false|string|||
-|tags||false|[Tag](#tag) array|||
-
-
-### Tag
-
-|Name|Description|Required|Schema|Default|Example|
-|---|---|---|---|---|---|
-|id||false|integer(int64)|||
-|name||false|string|||
-
-
-### User
-
-|Name|Description|Required|Schema|Default|Example|
-|---|---|---|---|---|---|
-|email||false|string|||
-|firstName||false|string|||
-|id||false|integer(int64)|||
-|lastName||false|string|||
-|password||false|string|||
-|phone||false|string|||
-|userStatus|User Status|false|integer(int32)|||
-|username||false|string|||
-
-
-

src/test/resources/expected_results/markdown/default/paths.md

@@ -1,857 +0,0 @@
-
-<a name="paths"></a>
-## Paths
-
-### Add a new pet to the store
-```
-POST /pets
-```
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Body|body|Pet object that needs to be added to the store|false|[Pet](#pet)||
-
-
-#### Responses
-
-##### HTTP Code 405
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|405|Invalid input|No Content|
-
-
-#### Consumes
-
-* application/json
-* application/xml
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* pet
-
-
-#### Security
-
-|Type|Name|Scopes|
-|---|---|---|
-|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets|
-
-
-### Update an existing pet
-```
-PUT /pets
-```
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Body|body|Pet object that needs to be added to the store|false|[Pet](#pet)||
-
-
-#### Responses
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid ID supplied|No Content|
-
-
-##### HTTP Code 404
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|404|Pet not found|No Content|
-
-
-##### HTTP Code 405
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|405|Validation exception|No Content|
-
-
-#### Consumes
-
-* application/json
-* application/xml
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* pet
-
-
-#### Security
-
-|Type|Name|Scopes|
-|---|---|---|
-|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets|
-
-
-### Finds Pets by status
-```
-GET /pets/findByStatus
-```
-
-
-#### Description
-Multiple status values can be provided with comma seperated strings
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Query|status|Status values that need to be considered for filter|false|multi string array||
-
-
-#### Responses
-
-##### HTTP Code 200
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|200|successful operation|[Pet](#pet) array|
-
-**Headers**
-
-|Name|Description|Schema|Default|
-|---|---|---|---|
-|X-Rate-Limit-Limit|successful operation|integer||
-|X-Rate-Limit-Remaining|successful operation|integer||
-|X-Rate-Limit-Reset|successful operation|integer||
-
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid status value|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* pet
-
-
-#### Security
-
-|Type|Name|Scopes|
-|---|---|---|
-|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets|
-
-
-### Finds Pets by tags
-```
-GET /pets/findByTags
-```
-
-
-#### Description
-Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Query|tags|Tags to filter by|false|multi string array||
-
-
-#### Responses
-
-##### HTTP Code 200
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|200|successful operation|[Pet](#pet) array|
-
-**Headers**
-
-|Name|Description|Schema|Default|
-|---|---|---|---|
-|X-Rate-Limit-Limit|successful operation|integer||
-|X-Rate-Limit-Remaining|successful operation|integer||
-|X-Rate-Limit-Reset|successful operation|integer||
-
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid tag value|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* pet
-
-
-#### Security
-
-|Type|Name|Scopes|
-|---|---|---|
-|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets|
-
-
-### Updates a pet in the store with form data
-```
-POST /pets/{petId}
-```
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Path|petId|ID of pet that needs to be updated|true|string||
-|FormData|name|Updated name of the pet|true|string||
-|FormData|status|Updated status of the pet|true|string||
-
-
-#### Responses
-
-##### HTTP Code 405
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|405|Invalid input|No Content|
-
-
-#### Consumes
-
-* application/x-www-form-urlencoded
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* pet
-
-
-#### Security
-
-|Type|Name|Scopes|
-|---|---|---|
-|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets|
-
-
-### Find pet by ID
-```
-GET /pets/{petId}
-```
-
-
-#### Description
-Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error conditions
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Path|petId|ID of pet that needs to be fetched|true|integer(int64)||
-
-
-#### Responses
-
-##### HTTP Code 200
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|200|successful operation|[Pet](#pet)|
-
-**Headers**
-
-|Name|Description|Schema|Default|
-|---|---|---|---|
-|X-Rate-Limit-Limit|successful operation|integer||
-|X-Rate-Limit-Remaining|successful operation|integer||
-|X-Rate-Limit-Reset|successful operation|integer||
-
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid ID supplied|No Content|
-
-
-##### HTTP Code 404
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|404|Pet not found|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* pet
-
-
-#### Security
-
-|Type|Name|Scopes|
-|---|---|---|
-|apiKey|[api_key](#api_key)||
-|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets|
-
-
-### Deletes a pet
-```
-DELETE /pets/{petId}
-```
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Header|api_key||true|string||
-|Path|petId|Pet id to delete|true|integer(int64)||
-
-
-#### Responses
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid pet value|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* pet
-
-
-#### Security
-
-|Type|Name|Scopes|
-|---|---|---|
-|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets|
-
-
-### Place an order for a pet
-```
-POST /stores/order
-```
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Body|body|order placed for purchasing the pet|false|[Order](#order)||
-
-
-#### Responses
-
-##### HTTP Code 200
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|200|successful operation|[Order](#order)|
-
-**Headers**
-
-|Name|Description|Schema|Default|
-|---|---|---|---|
-|X-Rate-Limit-Limit|successful operation|integer||
-|X-Rate-Limit-Remaining|successful operation|integer||
-|X-Rate-Limit-Reset|successful operation|integer||
-
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid Order|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* store
-
-
-### Find purchase order by ID
-```
-GET /stores/order/{orderId}
-```
-
-
-#### Description
-For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Path|orderId|ID of pet that needs to be fetched|true|string||
-
-
-#### Responses
-
-##### HTTP Code 200
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|200|successful operation|[Order](#order)|
-
-**Headers**
-
-|Name|Description|Schema|Default|
-|---|---|---|---|
-|X-Rate-Limit-Limit|successful operation|integer||
-|X-Rate-Limit-Remaining|successful operation|integer||
-|X-Rate-Limit-Reset|successful operation|integer||
-
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid ID supplied|No Content|
-
-
-##### HTTP Code 404
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|404|Order not found|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* store
-
-
-### Delete purchase order by ID
-```
-DELETE /stores/order/{orderId}
-```
-
-
-#### Description
-For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Path|orderId|ID of the order that needs to be deleted|true|string||
-
-
-#### Responses
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid ID supplied|No Content|
-
-
-##### HTTP Code 404
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|404|Order not found|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* store
-
-
-### Create user
-```
-POST /users
-```
-
-
-#### Description
-This can only be done by the logged in user.
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Body|body|Created user object|false|[User](#user)||
-
-
-#### Responses
-
-##### HTTP Code default
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|default|successful operation|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* user
-
-
-### Creates list of users with given input array
-```
-POST /users/createWithArray
-```
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Body|body|List of user object|false|[User](#user) array||
-
-
-#### Responses
-
-##### HTTP Code default
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|default|successful operation|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* user
-
-
-### Creates list of users with given input array
-```
-POST /users/createWithList
-```
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Body|body|List of user object|false|[User](#user) array||
-
-
-#### Responses
-
-##### HTTP Code default
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|default|successful operation|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* user
-
-
-### Logs user into the system
-```
-GET /users/login
-```
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Query|password|The password for login in clear text|false|string||
-|Query|username|The user name for login|false|string||
-
-
-#### Responses
-
-##### HTTP Code 200
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|200|successful operation|string|
-
-**Headers**
-
-|Name|Description|Schema|Default|
-|---|---|---|---|
-|X-Rate-Limit-Limit|successful operation|integer||
-|X-Rate-Limit-Remaining|successful operation|integer||
-|X-Rate-Limit-Reset|successful operation|integer||
-
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid username/password supplied|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* user
-
-
-### Logs out current logged in user session
-```
-GET /users/logout
-```
-
-
-#### Responses
-
-##### HTTP Code default
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|default|successful operation|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* user
-
-
-### Get user by user name
-```
-GET /users/{username}
-```
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string||
-
-
-#### Responses
-
-##### HTTP Code 200
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|200|successful operation|[User](#user)|
-
-**Headers**
-
-|Name|Description|Schema|Default|
-|---|---|---|---|
-|X-Rate-Limit-Limit|successful operation|integer||
-|X-Rate-Limit-Remaining|successful operation|integer||
-|X-Rate-Limit-Reset|successful operation|integer||
-
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid username supplied|No Content|
-
-
-##### HTTP Code 404
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|404|User not found|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* user
-
-
-### Updated user
-```
-PUT /users/{username}
-```
-
-
-#### Description
-This can only be done by the logged in user.
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Path|username|name that need to be deleted|true|string||
-|Body|body|Updated user object|false|[User](#user)||
-
-
-#### Responses
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid user supplied|No Content|
-
-
-##### HTTP Code 404
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|404|User not found|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* user
-
-
-### Delete user
-```
-DELETE /users/{username}
-```
-
-
-#### Description
-This can only be done by the logged in user.
-
-
-#### Parameters
-
-|Type|Name|Description|Required|Schema|Default|
-|---|---|---|---|---|---|
-|Path|username|The name that needs to be deleted|true|string||
-
-
-#### Responses
-
-##### HTTP Code 400
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|400|Invalid username supplied|No Content|
-
-
-##### HTTP Code 404
-
-|HTTP Code|Description|Schema|
-|---|---|---|
-|404|User not found|No Content|
-
-
-#### Produces
-
-* application/json
-* application/xml
-
-
-#### Tags
-
-* user
-
-
-

src/test/resources/expected_results/markdown/default/security.md

@@ -1,21 +0,0 @@
-
-<a name="security"></a>
-## Security
-
-### api_key
-Type : apiKey
-Name : api_key
-In : HEADER
-
-### petstore_auth
-Type : oauth2
-Flow : implicit
-Token URL : http://petstore.swagger.io/api/oauth/dialog
-
-|Name|Description|
-|---|---|
-|write_pets|modify pets in your account|
-|read_pets|read your pets|
-
-
-

src/test/resources/json/swagger_12.json

@@ -1,54 +0,0 @@
-{
-  "apiVersion" : "0.0.1-SNAPSHOT",
-  "swaggerVersion" : "1.2",
-  "basePath" : "",
-  "resourcePath" : "/resource/x/v2",
-  "apis" : [ {
-    "path" : "/resource/x/v2",
-    "operations" : [ {
-      "method" : "POST",
-      "nickname" : "createX",
-      "type" : "string",
-      "parameters" : [ {
-        "type": "string",
-        "description" : "The x in JSON format",
-        "paramType" : "body",
-        "name" : "body",
-        "required" : true
-      } ],
-      "summary" : "Creates a x x.",
-      "notes" : "If id already exists, the x is updated.",
-      "responseMessages" : [ {
-        "code" : 200,
-        "message" : "ok"
-      }, {
-        "code" : 500,
-        "message" : "error"
-      } ],
-      "consumes" : [ "application/json" ]
-    } ]
-  }, {
-    "path" : "/resource/x/v2/{id}",
-    "operations" : [ {
-      "method" : "GET",
-      "nickname" : "getX",
-      "type" : "string",
-      "parameters" : [ {
-        "type" : "integer",
-        "description" : "A valid x x UUID",
-        "paramType" : "path",
-        "name" : "id",
-        "required" : true
-      } ],
-      "summary" : "Gets the x x with the specified id.",
-      "responseMessages" : [ {
-        "code" : 200,
-        "message" : "ok"
-      }, {
-        "code" : 404,
-        "message" : "not found"
-      } ],
-      "produces" : [ "application/json" ]
-    } ]
-  } ]
-}

src/test/resources/json/swagger_missing_tag.json

@@ -1,883 +0,0 @@
-{
-    "swagger": "2.0",
-    "info": {
-        "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n",
-        "version": "1.0.0",
-        "title": "Swagger Petstore API",
-        "termsOfService": "http://helloreverb.com/terms/",
-        "contact": {
-            "name": "apiteam@wordnik.com"
-        },
-        "license": {
-            "name": "Apache 2.0",
-            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
-        }
-    },
-    "host": "petstore.swagger.wordnik.com",
-    "basePath": "/v2",
-    "schemes": [
-        "http"
-    ],
-    "tags": [
-        {
-            "name": "pet",
-            "description": "Pet resource"
-        },
-        {
-            "name": "store",
-            "description": "Store resource"
-        },
-        {
-            "name": "user",
-            "description": "User resource"
-        }
-    ],
-    "paths": {
-        "/pets": {
-            "post": {
-                "tags": [
-                    "pet"
-                ],
-                "summary": "Add a new pet to the store",
-                "description": "",
-                "operationId": "addPet",
-                "consumes": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "body",
-                        "name": "body",
-                        "description": "Pet object that needs to be added to the store",
-                        "required": false,
-                        "schema": {
-                            "$ref": "#/definitions/Pet"
-                        }
-                    }
-                ],
-                "responses": {
-                    "405": {
-                        "description": "Invalid input"
-                    }
-                },
-                "security": [
-                    {
-                        "petstore_auth": [
-                            "write_pets",
-                            "read_pets"
-                        ]
-                    }
-                ]
-            },
-            "put": {
-                "summary": "Update an existing pet",
-                "description": "",
-                "operationId": "updatePet",
-                "consumes": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "body",
-                        "name": "body",
-                        "description": "Pet object that needs to be added to the store",
-                        "required": false,
-                        "schema": {
-                            "$ref": "#/definitions/Pet"
-                        }
-                    }
-                ],
-                "responses": {
-                    "400": {
-                        "description": "Invalid ID supplied"
-                    },
-                    "404": {
-                        "description": "Pet not found"
-                    },
-                    "405": {
-                        "description": "Validation exception"
-                    }
-                },
-                "security": [
-                    {
-                        "petstore_auth": [
-                            "write_pets",
-                            "read_pets"
-                        ]
-                    }
-                ]
-            }
-        },
-        "/pets/findByStatus": {
-            "get": {
-                "tags": [
-                    "pet"
-                ],
-                "summary": "Finds Pets by status",
-                "description": "Multiple status values can be provided with comma seperated strings",
-                "operationId": "findPetsByStatus",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "query",
-                        "name": "status",
-                        "description": "Status values that need to be considered for filter",
-                        "required": false,
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        },
-                        "collectionFormat": "multi"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "$ref": "#/responses/FoundPets"
-                    },
-                    "400": {
-                        "description": "Invalid status value"
-                    }
-                },
-                "security": [
-                    {
-                        "petstore_auth": [
-                            "write_pets",
-                            "read_pets"
-                        ]
-                    }
-                ]
-            }
-        },
-        "/pets/findByTags": {
-            "get": {
-                "tags": [
-                    "pet"
-                ],
-                "summary": "Finds Pets by tags",
-                "description": "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
-                "operationId": "findPetsByTags",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "query",
-                        "name": "tags",
-                        "description": "Tags to filter by",
-                        "required": false,
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        },
-                        "collectionFormat": "multi"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "$ref": "#/responses/FoundPets"
-                    },
-                    "400": {
-                        "description": "Invalid tag value"
-                    }
-                },
-                "security": [
-                    {
-                        "petstore_auth": [
-                            "write_pets",
-                            "read_pets"
-                        ]
-                    }
-                ]
-            }
-        },
-        "/pets/{petId}": {
-            "get": {
-                "tags": [
-                    "pet"
-                ],
-                "summary": "Find pet by ID",
-                "description": "Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error conditions",
-                "operationId": "getPetById",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "$ref": "#/parameters/petId"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "successful operation",
-                        "schema": {
-                            "$ref": "#/definitions/Pet"
-                        }
-                    },
-                    "400": {
-                        "description": "Invalid ID supplied"
-                    },
-                    "404": {
-                        "description": "Pet not found"
-                    }
-                },
-                "security": [
-                    {
-                        "api_key": []
-                    },
-                    {
-                        "petstore_auth": [
-                            "write_pets",
-                            "read_pets"
-                        ]
-                    }
-                ]
-            },
-            "post": {
-                "tags": [
-                    "pet"
-                ],
-                "summary": "Updates a pet in the store with form data",
-                "description": "",
-                "operationId": "updatePetWithForm",
-                "consumes": [
-                    "application/x-www-form-urlencoded"
-                ],
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "path",
-                        "name": "petId",
-                        "description": "ID of pet that needs to be updated",
-                        "required": true,
-                        "type": "string"
-                    },
-                    {
-                        "in": "formData",
-                        "name": "name",
-                        "description": "Updated name of the pet",
-                        "required": true,
-                        "type": "string"
-                    },
-                    {
-                        "in": "formData",
-                        "name": "status",
-                        "description": "Updated status of the pet",
-                        "required": true,
-                        "type": "string"
-                    }
-                ],
-                "responses": {
-                    "405": {
-                        "description": "Invalid input"
-                    }
-                },
-                "security": [
-                    {
-                        "petstore_auth": [
-                            "write_pets",
-                            "read_pets"
-                        ]
-                    }
-                ]
-            },
-            "delete": {
-                "tags": [
-                    "pet"
-                ],
-                "summary": "Deletes a pet",
-                "description": "",
-                "operationId": "deletePet",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "header",
-                        "name": "api_key",
-                        "description": "",
-                        "required": true,
-                        "type": "string"
-                    },
-                    {
-                        "in": "path",
-                        "name": "petId",
-                        "description": "Pet id to delete",
-                        "required": true,
-                        "type": "integer",
-                        "format": "int64"
-                    }
-                ],
-                "responses": {
-                    "400": {
-                        "description": "Invalid pet value"
-                    }
-                },
-                "security": [
-                    {
-                        "petstore_auth": [
-                            "write_pets",
-                            "read_pets"
-                        ]
-                    }
-                ]
-            }
-        },
-        "/stores/order": {
-            "post": {
-                "tags": [
-                    "store"
-                ],
-                "summary": "Place an order for a pet",
-                "description": "",
-                "operationId": "placeOrder",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "body",
-                        "name": "body",
-                        "description": "order placed for purchasing the pet",
-                        "required": false,
-                        "schema": {
-                            "$ref": "#/definitions/Order"
-                        }
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "successful operation",
-                        "schema": {
-                            "$ref": "#/definitions/Order"
-                        }
-                    },
-                    "400": {
-                        "description": "Invalid Order"
-                    }
-                }
-            }
-        },
-        "/stores/order/{orderId}": {
-            "get": {
-                "tags": [
-                    "store"
-                ],
-                "summary": "Find purchase order by ID",
-                "description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
-                "operationId": "getOrderById",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "path",
-                        "name": "orderId",
-                        "description": "ID of pet that needs to be fetched",
-                        "required": true,
-                        "type": "string"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "successful operation",
-                        "schema": {
-                            "$ref": "#/definitions/Order"
-                        }
-                    },
-                    "400": {
-                        "description": "Invalid ID supplied"
-                    },
-                    "404": {
-                        "description": "Order not found"
-                    }
-                }
-            },
-            "delete": {
-                "tags": [
-                    "store"
-                ],
-                "summary": "Delete purchase order by ID",
-                "description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
-                "operationId": "deleteOrder",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "path",
-                        "name": "orderId",
-                        "description": "ID of the order that needs to be deleted",
-                        "required": true,
-                        "type": "string"
-                    }
-                ],
-                "responses": {
-                    "400": {
-                        "description": "Invalid ID supplied"
-                    },
-                    "404": {
-                        "description": "Order not found"
-                    }
-                }
-            }
-        },
-        "/users": {
-            "post": {
-                "tags": [
-                    "user"
-                ],
-                "summary": "Create user",
-                "description": "This can only be done by the logged in user.",
-                "operationId": "createUser",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "body",
-                        "name": "body",
-                        "description": "Created user object",
-                        "required": false,
-                        "schema": {
-                            "$ref": "#/definitions/User"
-                        }
-                    }
-                ],
-                "responses": {
-                    "default": {
-                        "description": "successful operation"
-                    }
-                }
-            }
-        },
-        "/users/createWithArray": {
-            "post": {
-                "tags": [
-                    "user"
-                ],
-                "summary": "Creates list of users with given input array",
-                "description": "",
-                "operationId": "createUsersWithArrayInput",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "body",
-                        "name": "body",
-                        "description": "List of user object",
-                        "required": false,
-                        "schema": {
-                            "type": "array",
-                            "items": {
-                                "$ref": "#/definitions/User"
-                            }
-                        }
-                    }
-                ],
-                "responses": {
-                    "default": {
-                        "description": "successful operation"
-                    }
-                }
-            }
-        },
-        "/users/createWithList": {
-            "post": {
-                "tags": [
-                    "user"
-                ],
-                "summary": "Creates list of users with given input array",
-                "description": "",
-                "operationId": "createUsersWithListInput",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "body",
-                        "name": "body",
-                        "description": "List of user object",
-                        "required": false,
-                        "schema": {
-                            "type": "array",
-                            "items": {
-                                "$ref": "#/definitions/User"
-                            }
-                        }
-                    }
-                ],
-                "responses": {
-                    "default": {
-                        "description": "successful operation"
-                    }
-                }
-            }
-        },
-        "/users/login": {
-            "get": {
-                "tags": [
-                    "user"
-                ],
-                "summary": "Logs user into the system",
-                "description": "",
-                "operationId": "loginUser",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "query",
-                        "name": "username",
-                        "description": "The user name for login",
-                        "required": false,
-                        "type": "string",
-                        "default": "testUser"
-                    },
-                    {
-                        "in": "query",
-                        "name": "password",
-                        "description": "The password for login in clear text",
-                        "required": false,
-                        "type": "string",
-                        "default": "testPassword"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "successful operation",
-                        "schema": {
-                            "type": "string"
-                        }
-                    },
-                    "400": {
-                        "description": "Invalid username/password supplied"
-                    }
-                }
-            }
-        },
-        "/users/logout": {
-            "get": {
-                "tags": [
-                    "user"
-                ],
-                "summary": "Logs out current logged in user session",
-                "description": "",
-                "operationId": "logoutUser",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "responses": {
-                    "default": {
-                        "description": "successful operation"
-                    }
-                }
-            }
-        },
-        "/users/{username}": {
-            "get": {
-                "tags": [
-                    "user"
-                ],
-                "summary": "Get user by user name",
-                "description": "",
-                "operationId": "getUserByName",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "path",
-                        "name": "username",
-                        "description": "The name that needs to be fetched. Use user1 for testing.",
-                        "required": true,
-                        "type": "string",
-                        "default": "testUser"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "successful operation",
-                        "schema": {
-                            "$ref": "#/definitions/User"
-                        }
-                    },
-                    "400": {
-                        "description": "Invalid username supplied"
-                    },
-                    "404": {
-                        "description": "User not found"
-                    }
-                }
-            },
-            "put": {
-                "tags": [
-                    "user"
-                ],
-                "summary": "Updated user",
-                "description": "This can only be done by the logged in user.",
-                "operationId": "updateUser",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "path",
-                        "name": "username",
-                        "description": "name that need to be deleted",
-                        "required": true,
-                        "type": "string"
-                    },
-                    {
-                        "in": "body",
-                        "name": "body",
-                        "description": "Updated user object",
-                        "required": false,
-                        "schema": {
-                            "$ref": "#/definitions/User"
-                        }
-                    }
-                ],
-                "responses": {
-                    "400": {
-                        "description": "Invalid user supplied"
-                    },
-                    "404": {
-                        "description": "User not found"
-                    }
-                }
-            },
-            "delete": {
-                "tags": [
-                    "user"
-                ],
-                "summary": "Delete user",
-                "description": "This can only be done by the logged in user.",
-                "operationId": "deleteUser",
-                "produces": [
-                    "application/json",
-                    "application/xml"
-                ],
-                "parameters": [
-                    {
-                        "in": "path",
-                        "name": "username",
-                        "description": "The name that needs to be deleted",
-                        "required": true,
-                        "type": "string"
-                    }
-                ],
-                "responses": {
-                    "400": {
-                        "description": "Invalid username supplied"
-                    },
-                    "404": {
-                        "description": "User not found"
-                    }
-                }
-            }
-        }
-    },
-    "securityDefinitions": {
-        "api_key": {
-            "type": "apiKey",
-            "name": "api_key",
-            "in": "header"
-        },
-        "petstore_auth": {
-            "type": "oauth2",
-            "authorizationUrl": "http://petstore.swagger.wordnik.com/api/oauth/dialog",
-            "flow": "implicit",
-            "scopes": {
-                "write_pets": "modify pets in your account",
-                "read_pets": "read your pets"
-            }
-        }
-    },
-    "responses":{
-        "FoundPets": {
-            "description": "successful operation",
-            "schema": {
-                "type": "array",
-                "items": {
-                    "$ref": "#/definitions/Pet"
-                }
-            }
-        }
-    },
-    "parameters":{
-        "petId": {
-            "in": "path",
-            "name": "petId",
-            "description": "ID of the pet",
-            "required": true,
-            "type": "integer",
-            "format": "int64"
-        }
-    },
-    "definitions": {
-        "Identified": {
-            "properties": {
-                "id": {
-                    "type": "integer",
-                    "format": "int64"
-                }
-            }
-        },
-        "User": {
-            "allOf": [
-                {
-                    "$ref": "#/definitions/Identified"
-                },
-                {
-                    "properties": {
-                        "username": {
-                            "type": "string"
-                        },
-                        "firstName": {
-                            "type": "string"
-                        },
-                        "lastName": {
-                            "type": "string"
-                        },
-                        "email": {
-                            "type": "string"
-                        },
-                        "password": {
-                            "type": "string"
-                        },
-                        "phone": {
-                            "type": "string"
-                        },
-                        "userStatus": {
-                            "type": "integer",
-                            "format": "int32",
-                            "description": "User Status"
-                        },
-                        "pictures": {
-                            "type": "array",
-                            "items": {
-                                "type": "string",
-                                "format": "byte"
-                            }
-                        }
-                    }
-                }
-            ]
-        },
-        "Category": {
-            "properties": {
-                "id": {
-                    "type": "integer",
-                    "format": "int64"
-                },
-                "name": {
-                    "type": "string"
-                }
-            }
-        },
-        "Pet": {
-            "description" : "Test description",
-            "required": [
-                "name",
-                "photoUrls"
-            ],
-            "properties": {
-                "id": {
-                    "type": "integer",
-                    "format": "int64"
-                },
-                "category": {
-                    "$ref": "#/definitions/Category"
-                },
-                "name": {
-                    "type": "string",
-                    "example": "doggie"
-                },
-                "photoUrls": {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                },
-                "tags": {
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/definitions/Tag"
-                    }
-                },
-                "status": {
-                    "type": "string",
-                    "description": "pet status in the store"
-                }
-            }
-        },
-        "Tag": {
-            "properties": {
-                "id": {
-                    "type": "integer",
-                    "format": "int64"
-                },
-                "name": {
-                    "type": "string"
-                }
-            }
-        },
-        "Order": {
-            "properties": {
-                "id": {
-                    "type": "integer",
-                    "format": "int64"
-                },
-                "petId": {
-                    "type": "integer",
-                    "format": "int64"
-                },
-                "quantity": {
-                    "type": "integer",
-                    "format": "int32"
-                },
-                "shipDate": {
-                    "type": "string",
-                    "format": "date-time"
-                },
-                "status": {
-                    "type": "string",
-                    "description": "Order Status"
-                },
-                "complete": {
-                    "type": "boolean"
-                }
-            }
-        }
-    }
-}

src/test/resources/yaml/swagger_inlineSchema.yaml

@@ -1,138 +0,0 @@
-swagger: "2.0"
-info:
-  title: API
-  description: Service API
-  version: "2.18"
-host: service.host.com
-schemes:
-  - https
-consumes:
-  - application/json
-produces:
-  - application/json
-paths:
-  /LaunchCommand:
-    post:
-      summary: LaunchCommand
-      description: Dummy description
-      tags:
-        - All
-      parameters:
-        - name: Version
-          description: The API version
-          type: string
-          in: query
-        - name: Option
-          description: An optional option
-          type: string
-          in: query
-        - name: LaunchCommandRequest
-          description: Launch something new
-          in: body
-          schema:
-            description: Inline schema
-            type: object
-            required:
-              - Command
-              - MinCount
-              - MaxCount
-            properties:
-              Command:
-                description: Dummy description
-                type: object
-                properties:
-                  path:
-                    description: Command path
-                    type: string
-                  args:
-                    description: Command arguments
-                    type: string
-              Options:
-                description: Dummy description
-                type: array
-                items:
-                  type: string
-                type: string
-              Location:
-                description: Dummy description
-                $ref: '#/definitions/Location'
-      responses:
-        200:
-          description: Result
-          schema:
-            type: object
-            properties:
-              ReservationId:
-                description: <description>
-                type: string
-              Location:
-                description: <description>
-                $ref: '#/definitions/Location'
-          headers:
-            X-Rate-Limit-Limit:
-              description: The number of allowed requests in the current period
-              type: integer
-            X-Rate-Limit-Remaining:
-              description: The number of remaining requests in the current period
-              type: integer
-            X-Rate-Limit-Reset:
-              description: The number of seconds left in the current period
-              type: integer
-        400:
-          description: Error
-          schema:
-            $ref: '#/definitions/Error'
-
-
-definitions:
-  ExternalLocation:
-    $ref: ./swagger_inlineSchema.yaml#/definitions/Location
-
-  Error:
-    type: object
-    properties:
-      error-code:
-        description: Error code
-        type: integer
-      message:
-        description: Error message
-        type: string
-
-  Location:
-    type: object
-    properties:
-      Loop:
-        description: Loop
-        type:
-          $ref: '#/definitions/Location'
-      Place:
-        description: Place
-        type: string
-
-  InlineDepthSchema:
-    type: object
-    properties:
-      Loop:
-        type: object
-        properties:
-          p1:
-            description: Description p1
-            type: string
-          p2:
-            description: Description p2
-            type: object
-            properties:
-              p2-1:
-                description: Description p2-1
-                type: string
-              p2-2:
-                description: Description p2-2
-                type: object
-                properties:
-                  p2-2-1:
-                    description: Description p2-2-1
-                    type: string
-                  p2-2-2:
-                    description: Description p2-2-2
-                    type: boolean
-

swagger2markup-asciidoc/build.gradle

@@ -0,0 +1,25 @@
+ext.moduleName="io.github.swagger2markup.asciidoc"
+
+dependencies {
+    configurations.all {
+//        resolutionStrategy.force dependencyOverrides.commonsCodec
+//        resolutionStrategy.force dependencyOverrides.commonsIO
+//        resolutionStrategy.force dependencyOverrides.commonsLang3
+        resolutionStrategy.force dependencyOverrides.jnrConstants
+        resolutionStrategy.force dependencyOverrides.jnrEnxio
+        resolutionStrategy.force dependencyOverrides.jnrPosix
+//        resolutionStrategy.force dependencyOverrides.jodaTime
+        resolutionStrategy.force dependencyOverrides.slf4j
+//        resolutionStrategy.force dependencyOverrides.jacksonDatabind
+//        resolutionStrategy.force dependencyOverrides.guava
+//        resolutionStrategy.force dependencyOverrides.findBugs
+//        resolutionStrategy.force dependencyOverrides.jaksonCore
+    }
+    implementation implLibraries.asciiDocJApi
+    implementation implLibraries.commonsText
+    implementation implLibraries.slf4j
+    testImplementation implLibraries.commonsIO
+    testImplementation testLibraries.asciiDocJ
+    testImplementation testLibraries.junit
+    testImplementation testLibraries.logback
+}

swagger2markup-asciidoc/src/main/java/io/github/swagger2markup/adoc/AsciidocConverter.java

@@ -0,0 +1,887 @@
+package io.github.swagger2markup.adoc;
+
+import io.github.swagger2markup.adoc.converter.internal.*;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.text.StringEscapeUtils;
+import org.asciidoctor.ast.List;
+import org.asciidoctor.ast.*;
+import org.asciidoctor.converter.ConverterFor;
+import org.asciidoctor.converter.StringConverter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.*;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+import java.util.stream.LongStream;
+import java.util.stream.Stream;
+
+import static io.github.swagger2markup.adoc.converter.internal.Delimiters.*;
+
+@ConverterFor(AsciidocConverter.NAME)
+public class AsciidocConverter extends StringConverter {
+
+    private Logger logger = LoggerFactory.getLogger(getClass());
+
+    public static final String NAME = "adoc";
+
+    private final Pattern emptyLineOrStartWith = Pattern.compile("(?m)^\\s*(?:\\r?\\n)|(?m)^\\s+");
+    private final Pattern coListItemIdPattern = Pattern.compile(".*-(\\d+)");
+    private final Pattern tableColumnsStylePattern = Pattern.compile("((\\d+)\\*)?([<^>])?(\\.[<^>])?(\\d+)?([adehlmsv])?");
+
+    private static final java.util.List<String> attributeToExclude = Arrays.asList(
+            "localtime",
+            "filetype",
+            "asciidoctor-version",
+            "doctime",
+            "localyear",
+            "docdate",
+            "localdate",
+            "localdatetime",
+            "docdatetime",
+            "backend",
+            "basebackend",
+            "doctitle",
+            "docyear"
+    );
+
+    private static final String[] supportedUrlSchemes = new String[]{
+            "http",
+            "https",
+            "ftp",
+            "irc",
+            "mailto"
+    };
+
+    public AsciidocConverter(String backend, Map<String, Object> opts) {
+        super(backend, opts);
+    }
+
+    /**
+     * Converts an {@link ContentNode} using the specified transform along
+     * with additional options. If a transform is not specified, implementations
+     * typically derive one from the {@link ContentNode#getNodeName()} property.
+     *
+     * <p>Implementations are free to decide how to carry out the conversion. In
+     * the case of the built-in converters, the tranform value is used to
+     * dispatch to a handler method. The TemplateConverter uses the value of
+     * the transform to select a template to render.
+     *
+     * @param node      The concrete instance of FlowNode to convert
+     * @param transform An optional String transform that hints at which transformation
+     *                  should be applied to this node. If a transform is not specified,
+     *                  the transform is typically derived from the value of the
+     *                  node's node_name property. (optional, default: null)
+     * @param opts      An optional map of options that provide additional hints about
+     *                  how to convert the node. (optional, default: empty map)
+     * @return the converted result
+     */
+    @Override
+    public String convert(ContentNode node, String transform, Map<Object, Object> opts) {
+        if (null == transform) {
+            transform = node.getNodeName();
+        }
+        switch (transform) {
+            case "inline_quoted":
+                return convertInlineQuoted((PhraseNode) node);
+            case "paragraph":
+                return convertParagraph((StructuralNode) node);
+            case "inline_anchor":
+                return convertInlineAnchor((PhraseNode) node);
+            case "section":
+                return convertSection((Section) node);
+            case "listing":
+                return convertListing((Block) node);
+            case "literal":
+                return convertLiteral((StructuralNode) node);
+            case "ulist":
+                return convertUList((List) node);
+            case "olist":
+                return convertOList((List) node);
+            case "dlist":
+                return convertDescriptionList((DescriptionList) node);
+            case "admonition":
+                return convertAdmonition((Block) node);
+            case "colist":
+                return convertCoList((List) node);
+            case "embedded":
+            case "document":
+                return convertEmbedded((Document) node);
+            case "example":
+                return convertExample((Block) node);
+            case "floating_title":
+                return convertFloatingTitle((StructuralNode) node);
+            case "image":
+                return convertImage((StructuralNode) node);
+            case "inline_break":
+                return convertInlineBreak(node);
+            case "inline_button":
+                return convertInlineButton(node);
+            case "inline_callout":
+                return convertInlineCallout(node);
+            case "inline_footnote":
+                return convertInlineFootnote(node);
+            case "inline_image":
+                return convertInlineImage((PhraseNode) node);
+            case "inline_indexterm":
+                return convertInlineIndexTerm(node);
+            case "inline_kbd":
+                return convertInlineKbd(node);
+            case "inline_menu":
+                return convertInlineMenu(node);
+            case "open":
+                return convertOpen((StructuralNode) node);
+            case "page_break":
+                return convertPageBreak(node);
+            case "preamble":
+                return convertPreamble((StructuralNode) node);
+            case "quote":
+                return convertQuote((StructuralNode) node);
+            case "sidebar":
+                return convertSidebar((StructuralNode) node);
+            case "stem":
+                return convertStem(node);
+            case "table":
+                return convertTable((Table) node);
+            case "thematic_break":
+                return convertThematicBreak(node);
+            case "verse":
+                return convertVerse((StructuralNode) node);
+            case "video":
+                return convertVideo(node);
+            case "toc":
+                return convertToc(node);
+            case "pass":
+                return convertPass(node);
+            case "audio":
+                return convertAudio(node);
+            // didn't exist on html converter
+            case "list":
+                return convertList((List) node);
+            case "list_item":
+                return convertListItem((ListItem) node);
+            default:
+                logger.debug("Don't know how to convert transform: [" + transform + "] Node: " + node);
+                return null;
+        }
+    }
+
+    String convertEmbedded(Document node) {
+        logger.debug("convertEmbedded");
+        StringBuilder sb = new StringBuilder();
+        appendId(node, sb);
+        if (StringUtils.isNotBlank(node.getDoctitle())) {
+            sb.append(repeat(node.getLevel() + 1,DOCUMENT_TITLE)).append(' ').append(StringEscapeUtils.unescapeHtml4(node.getDoctitle())).append(LINE_SEPARATOR);
+        }
+        Map<String, Object> attributes = node.getAttributes();
+        appendAuthors(sb, attributes);
+        appendRevisionDetails(sb, attributes);
+        appendDocumentAttributes(sb, attributes);
+        appendTrailingNewLine(sb);
+        appendChildBlocks(node, sb);
+        return sb.toString();
+    }
+
+    private void appendAuthors(StringBuilder sb, Map<String, Object> attributes) {
+        Long authorCount = (Long) attributes.getOrDefault("authorcount", 0L);
+        if (authorCount == 1) {
+            String author = getAuthorDetail(attributes, "author", "email");
+            if (StringUtils.isNotBlank(author)) {
+                sb.append(author).append(LINE_SEPARATOR);
+            }
+        } else if (authorCount > 1) {
+            String authors = LongStream.rangeClosed(1, authorCount)
+                    .mapToObj(i -> getAuthorDetail(attributes, "author_" + i, "email_" + i))
+                    .collect(Collectors.joining("; "));
+
+            if (StringUtils.isNotBlank(authors)) {
+                sb.append(authors).append(LINE_SEPARATOR);
+            }
+        }
+    }
+
+    private void appendDocumentAttributes(StringBuilder sb, Map<String, Object> attributes) {
+        attributes.forEach((k, v) -> {
+            if (!attributeToExclude.contains(k) && v != null && !v.toString().isEmpty())
+                sb.append(COLON).append(k).append(COLON).append(" ").append(v).append(LINE_SEPARATOR);
+        });
+    }
+
+    private void appendRevisionDetails(StringBuilder sb, Map<String, Object> attributes) {
+        String revDetails = Stream.of(attributes.get("revnumber"), attributes.get("revdate")).filter(Objects::nonNull)
+                .filter(o -> !o.toString().isEmpty()).map(Object::toString)
+                .collect(Collectors.joining(", "));
+
+        if (!revDetails.isEmpty()) {
+            sb.append("v").append(revDetails).append(LINE_SEPARATOR);
+        }
+    }
+
+    private String getAuthorDetail(Map<String, Object> attributes, String authorKey, String emailKey) {
+        String author = attributes.getOrDefault(authorKey, "").toString();
+        String email = attributes.getOrDefault(emailKey, "").toString();
+        if (StringUtils.isNotBlank(email)) {
+            email = " <" + email + ">";
+        }
+
+        return (author + email).trim();
+    }
+
+    private String convertInlineAnchor(PhraseNode node) {
+        logger.debug("convertInlineAnchor");
+        String type = node.getType();
+        switch (type) {
+            case "xref": {
+                String attrs;
+                String text;
+                String path = Optional.ofNullable(node.getAttributes().get("path")).orElse("").toString();
+                if (StringUtils.isNotBlank(path)) {
+                    ArrayList<String> list = new ArrayList<>();
+                    if (StringUtils.isNotBlank(node.getRole())) {
+                        list.add(" class=\"#{node.role}\"");
+                    }
+                    append_link_constraint_attrs(node, list);
+                    attrs = String.join(" ", list);
+                    text = StringUtils.isNotBlank(node.getText()) ? node.getText() : path;
+                } else {
+                    attrs = StringUtils.isNotBlank(node.getRole()) ? " class=\"" + node.getRole() + "\"" : "";
+                    text = node.getText();
+                    if (StringUtils.isNotBlank(text)) {
+                        text = node.getAttributes().get("refid").toString();
+                    }
+                }
+                return node.getTarget() + ATTRIBUTES_BEGIN + text + (StringUtils.isNotBlank(attrs) ? "," + attrs : "") + ATTRIBUTES_END;
+            }
+            case "ref":
+                return node.getId();
+            case "link": {
+                ArrayList<String> attrs = new ArrayList<>();
+                String target = node.getTarget();
+                String includePrefix = !StringUtils.startsWithAny(target, supportedUrlSchemes) ? "include::" : "";
+
+                String text = node.getText();
+                if (!target.equals(text)) {
+                    attrs.add(text);
+                }
+                if (StringUtils.isNotBlank(node.getId())) {
+                    attrs.add("id=\"" + node.getId() + "\"");
+                }
+                String role = node.getRole();
+                if (StringUtils.isNotBlank(role) && !role.equals("bare")) {
+                    attrs.add("role=\"" + role + "\"");
+                }
+                String title = node.getAttribute("title", "").toString();
+                if (StringUtils.isNotBlank(title)) {
+                    attrs.add("title=\"" + title + "\"");
+                }
+                return includePrefix + target + ATTRIBUTES_BEGIN + String.join(",", attrs) + ATTRIBUTES_END;
+            }
+            case "bibref":
+                return node.getId() + ATTRIBUTES_BEGIN + (StringUtils.isNotBlank(node.getReftext()) ? node.getReftext() : node.getId()) + ATTRIBUTES_END;
+            default:
+                logger.warn("unknown anchor type: " + node.getType());
+                return null;
+        }
+    }
+
+    private String convertAdmonition(Block node) {
+        logger.debug("convertAdmonition");
+        StringBuilder sb = new StringBuilder();
+
+        java.util.List<StructuralNode> blocks = node.getBlocks();
+        if (blocks.isEmpty()) {
+            sb.append(node.getStyle()).append(": ").append(node.getSource());
+        } else {
+            appendTitle(node, sb);
+            sb.append(ATTRIBUTES_BEGIN).append(node.getStyle()).append(ATTRIBUTES_END)
+                    .append(LINE_SEPARATOR).append(DELIMITER_EXAMPLE).append(LINE_SEPARATOR);
+            appendChildBlocks(node, sb);
+            sb.append(DELIMITER_EXAMPLE).append(LINE_SEPARATOR);
+        }
+        return sb.toString();
+    }
+
+    private String convertInlineQuoted(PhraseNode node) {
+        logger.debug("convertInlineQuoted");
+        StringBuilder sb = new StringBuilder();
+        String marker = "";
+        switch (node.getType()) {
+            case "monospaced":
+                marker = "`";
+                break;
+            case "emphasis":
+                marker = "_";
+                break;
+            case "strong":
+                marker = "*";
+                break;
+            case "superscript":
+                marker = "^";
+                break;
+            case "subscript":
+                marker = "~";
+                break;
+            case "double":
+            case "single":
+            case "mark":
+            case "asciimath":
+            case "latexmath":
+                marker = "";
+                break;
+        }
+        sb.append(marker).append(node.getText()).append(marker);
+        return sb.toString();
+    }
+
+    private String convertFloatingTitle(StructuralNode node) {
+        logger.debug("convertFloatingTitle");
+        return ATTRIBUTES_BEGIN + "discrete" + ATTRIBUTES_END + LINE_SEPARATOR +
+                repeat(node.getLevel() + 1, TITLE) + ' ' + node.getTitle() + LINE_SEPARATOR;
+    }
+
+    private String convertExample(Block node) {
+        logger.debug("convertExample");
+        StringBuilder sb = new StringBuilder();
+        appendTitle(node, sb);
+        sb.append(DELIMITER_EXAMPLE).append(LINE_SEPARATOR);
+        appendChildBlocks(node, sb);
+        sb.append(DELIMITER_EXAMPLE).append(LINE_SEPARATOR);
+        return sb.toString();
+    }
+
+    private String convertInlineButton(ContentNode node) {
+        logger.debug("convertInlineButton: name" + node.getNodeName());
+        return "convertInlineButton";
+    }
+
+    private String convertInlineCallout(ContentNode node) {
+        logger.debug("convertInlineCallout: name" + node.getNodeName());
+        return "convertInlineCallout";
+    }
+
+    private String convertInlineBreak(ContentNode node) {
+        logger.debug("convertInlineBreak: name" + node.getNodeName());
+        return "convertInlineBreak";
+    }
+
+    private String convertInlineFootnote(ContentNode node) {
+        logger.debug("convertInlineFootnote: name" + node.getNodeName());
+        return "convertInlineFootnote";
+    }
+
+    private String convertInlineImage(PhraseNode node) {
+        logger.debug("convertInlineImage");
+        if (node.getType().equals("icon")) {
+            return (new IconNode(node)).toAsciiDocContent();
+        } else {
+            return (new BlockImageNode(node)).toAsciiDocContent();
+        }
+    }
+
+    private String convertInlineIndexTerm(ContentNode node) {
+        logger.debug("convertInlineIndexTerm: name" + node.getNodeName());
+        return "convertInlineIndexTerm";
+    }
+
+    private String convertInlineKbd(ContentNode node) {
+        logger.debug("convertInlineKbd: name" + node.getNodeName());
+        return "convertInlineKbd";
+    }
+
+    private String convertInlineMenu(ContentNode node) {
+        logger.debug("convertInlineMenu: name" + node.getNodeName());
+        return "convertInlineMenu";
+    }
+
+    private String convertOpen(StructuralNode node) {
+        logger.debug("convertOpen");
+        StringBuilder sb = new StringBuilder();
+
+        switch (node.getStyle()) {
+            case "abstract":
+                sb.append(ATTRIBUTES_BEGIN).append("abstract").append(ATTRIBUTES_END).append(LINE_SEPARATOR);
+                break;
+            case "open":
+                sb.append(DELIMITER_OPEN_BLOCK).append(LINE_SEPARATOR);
+        }
+        sb.append(Optional.ofNullable(((Block) node).getSource()).orElse(""));
+        appendChildBlocks(node, sb);
+
+        if ("open".equals(node.getStyle())) {
+            sb.append(DELIMITER_OPEN_BLOCK).append(LINE_SEPARATOR);
+        }
+        return sb.toString();
+    }
+
+    private String convertPageBreak(ContentNode node) {
+        logger.debug("convertPageBreak: name" + node.getNodeName());
+        return DELIMITER_PAGE_BREAK + LINE_SEPARATOR;
+    }
+
+    private String convertQuote(StructuralNode node) {
+        logger.debug("convertQuote");
+        StringBuilder sb = new StringBuilder();
+        appendTitle(node, sb);
+        sb.append(ATTRIBUTES_BEGIN);
+        java.util.List<String> attrs = new ArrayList<>();
+        if (StringUtils.isNotBlank(node.getStyle())) {
+            attrs.add("quote");
+        }
+        appendAttributeTo(node, attrs, "attribution");
+        appendAttributeTo(node, attrs, "citetitle");
+        sb.append(String.join(",", attrs)).append(ATTRIBUTES_END).append(LINE_SEPARATOR);
+        java.util.List<StructuralNode> blocks = node.getBlocks();
+        if (!blocks.isEmpty()) {
+            sb.append("____").append(LINE_SEPARATOR);
+            appendChildBlocks(node, sb);
+            sb.append("____").append(LINE_SEPARATOR);
+        } else {
+            sb.append(((Block) node).getSource());
+        }
+
+        return sb.toString();
+    }
+
+    private String convertSidebar(StructuralNode node) {
+        logger.debug("convertSidebar");
+        StringBuilder sb = new StringBuilder();
+        appendTitle(node, sb);
+        appendChildBlocks(node, sb);
+        return sb.toString();
+    }
+
+    private String convertStem(ContentNode node) {
+        logger.debug("convertStem: name" + node.getNodeName());
+        return "convertStem";
+    }
+
+    private String convertThematicBreak(ContentNode node) {
+        logger.debug("convertThematicBreak: name" + node.getNodeName());
+        return DELIMITER_THEMATIC_BREAK + LINE_SEPARATOR;
+    }
+
+    private String convertVerse(StructuralNode node) {
+        logger.debug("convertVerse");
+        StringBuilder sb = new StringBuilder();
+        appendTitle(node, sb);
+        sb.append(ATTRIBUTES_BEGIN);
+        java.util.List<String> attrs = new ArrayList<>();
+        if (StringUtils.isNotBlank(node.getStyle())) {
+            attrs.add("verse");
+        }
+        appendAttributeTo(node, attrs, "attribution");
+        appendAttributeTo(node, attrs, "citetitle");
+        sb.append(String.join(",", attrs)).append(ATTRIBUTES_END).append(LINE_SEPARATOR);
+        String source = ((Block) node).getSource();
+        boolean matches = emptyLineOrStartWith.matcher(source).find();
+        if (matches) {
+            sb.append(DELIMITER_VERSE).append(LINE_SEPARATOR);
+        }
+        sb.append(source);
+        if (matches) {
+            sb.append(LINE_SEPARATOR).append(DELIMITER_VERSE);
+        }
+        appendTrailingNewLine(sb);
+        return sb.toString();
+    }
+
+    private String convertVideo(ContentNode node) {
+        logger.debug("convertVideo: name" + node.getNodeName());
+        return "convertVideo";
+    }
+
+    private String convertToc(ContentNode node) {
+        logger.debug("convertToc: name" + node.getNodeName());
+        return "convertToc";
+    }
+
+    private String convertPass(ContentNode node) {
+        logger.debug("convertPass: name" + node.getNodeName());
+        return "convertPass";
+    }
+
+    private String convertAudio(ContentNode node) {
+        logger.debug("convertAudio: name" + node.getNodeName());
+        return "convertAudio";
+    }
+
+    private String convertCell(Cell node) {
+        logger.debug("convertCell");
+        StringBuilder sb = new StringBuilder();
+        String source = node.getSource();
+        if (StringUtils.isNotBlank(source)) {
+            sb.append(source);
+        }
+        Document innerDocument = node.getInnerDocument();
+        if (null != innerDocument) {
+            appendChildBlocks(innerDocument, sb, false);
+        }
+        return sb.toString().replaceAll(LINE_SEPARATOR + LINE_SEPARATOR + "+", LINE_SEPARATOR + LINE_SEPARATOR);
+    }
+
+    private String convertRow(Row node, java.util.List<TableCellStyle> columnStyles, String delimiterTableCell) {
+        logger.debug("convertRow");
+        StringBuilder sb = new StringBuilder();
+        node.getCells().forEach(cell -> {
+            boolean addNewLine = false;
+            int colspan = cell.getColspan();
+            if (colspan != 0) {
+                addNewLine = true;
+                sb.append(colspan).append('+');
+            }
+            int rowspan = cell.getRowspan();
+            if (rowspan != 0) {
+                addNewLine = true;
+                sb.append('.').append(rowspan).append('+');
+            }
+            int index = cell.getColumn().getColumnNumber() - 1;
+            TableCellStyle tableCellStyle = (columnStyles.size() > index) ? columnStyles.get(index) : null;
+
+            boolean hAlignmentAdded = false;
+            TableCellHorizontalAlignment hAlignment = TableCellHorizontalAlignment.fromName(cell.getHorizontalAlignment().name());
+            if ((null != hAlignment) && (null == tableCellStyle || hAlignment != tableCellStyle.horizontalAlignment)) {
+                hAlignmentAdded = true;
+                addNewLine = true;
+                sb.append(hAlignment.getDelimiter());
+            }
+
+            TableCellVerticalAlignment vAlignment = TableCellVerticalAlignment.fromName(cell.getVerticalAlignment().name());
+            if ((null != vAlignment) && (null == tableCellStyle || hAlignmentAdded || vAlignment != tableCellStyle.verticalAlignment)) {
+                addNewLine = true;
+                sb.append(vAlignment.getDelimiter());
+            }
+
+            Style style = Style.fromName(cell.getAttribute("style", "").toString());
+            if (null != style && (null == tableCellStyle || style != tableCellStyle.style)) {
+                addNewLine = true;
+                sb.append(style.getShortHand());
+            }
+            sb.append(delimiterTableCell).append(convertCell(cell));
+            if (addNewLine) {
+                sb.append(LINE_SEPARATOR);
+            } else {
+                sb.append(' ');
+            }
+        });
+        return sb.toString();
+    }
+
+    private String convertTable(Table node) {
+        logger.debug("convertTable");
+        java.util.List<TableCellStyle> columnStyles = new ArrayList<>();
+        for (String col : node.getAttribute("cols", "").toString().split(",")) {
+            Matcher matcher = tableColumnsStylePattern.matcher(col);
+            if (matcher.find()) {
+                int multiplier = 1;
+                String multiplierGroup = matcher.group(2);
+                if (null != multiplierGroup) {
+                    try {
+                        multiplier = Integer.parseInt(multiplierGroup);
+                    } catch (NumberFormatException ignored) {
+                    }
+                }
+                int width = 0;
+                try {
+                    width = Integer.parseInt(matcher.group(5));
+                } catch (NumberFormatException ignored) {
+                }
+                TableCellStyle tableCellStyle = new TableCellStyle(
+                        TableCellHorizontalAlignment.fromString(matcher.group(3)),
+                        TableCellVerticalAlignment.fromString(matcher.group(4)),
+                        Style.fromString(matcher.group(6)),
+                        width
+                );
+                for (int i = 0; i < multiplier; i++) {
+                    columnStyles.add(tableCellStyle);
+                }
+            }
+        }
+
+        StringBuilder sb = new StringBuilder();
+        appendTitle(node, sb);
+        sb.append(new TableNode(node).toAsciiDocContent());
+        boolean innerTable = isInnerTable(node);
+        String tableDelimiter = innerTable ? DELIMITER_INNER_TABLE : DELIMITER_TABLE;
+        String cellDelimiter = innerTable ? DELIMITER_INNER_TABLE_CELL : DELIMITER_TABLE_CELL;
+        sb.append(tableDelimiter).append(LINE_SEPARATOR);
+        appendRows(node.getHeader(), sb, columnStyles, cellDelimiter);
+        appendRows(node.getBody(), sb, columnStyles, cellDelimiter);
+        appendRows(node.getFooter(), sb, columnStyles, cellDelimiter);
+        sb.append(tableDelimiter).append(LINE_SEPARATOR);
+        return sb.toString();
+    }
+
+    private boolean isInnerTable(ContentNode node) {
+        if(null != node) {
+            ContentNode parent = node.getParent();
+            if (null != parent) {
+                return parent instanceof Table || isInnerTable(parent);
+            }
+        }
+        return false;
+    }
+
+    private void appendRows(java.util.List<Row> rows, StringBuilder sb, java.util.List<TableCellStyle> columnStyles, String delimiterTableCell) {
+        rows.forEach(row -> sb.append(convertRow(row, columnStyles, delimiterTableCell)).append(LINE_SEPARATOR));
+    }
+
+    private String convertDescriptionList(DescriptionList node) {
+        logger.debug("convertDescriptionList");
+        StringBuilder sb = new StringBuilder();
+
+        appendTitle(node, sb);
+        String style = Optional.ofNullable(node.getStyle()).orElse("");
+        switch (style) {
+            case STYLE_HORIZONTAL:
+                sb.append(ATTRIBUTES_BEGIN).append(STYLE_HORIZONTAL).append(ATTRIBUTES_END).append(LINE_SEPARATOR);
+                node.getItems().forEach(item -> sb.append(convertDescriptionListEntry(item, node.getLevel(), false)));
+                break;
+            case STYLE_Q_AND_A:
+                sb.append(ATTRIBUTES_BEGIN).append(STYLE_Q_AND_A).append(ATTRIBUTES_END).append(LINE_SEPARATOR);
+            default:
+                node.getItems().forEach(item -> sb.append(convertDescriptionListEntry(item, node.getLevel(), true)));
+                break;
+        }
+        appendTrailingNewLine(sb);
+
+        return sb.toString();
+    }
+
+    private String convertDescriptionListEntry(DescriptionListEntry node, int level, Boolean descriptionOnNewLine) {
+        logger.debug("convertDescriptionListEntry");
+        StringBuilder sb = new StringBuilder();
+        String delimiter = repeat(level + 1, MARKER_D_LIST_ITEM);
+        String entryTerms = node.getTerms().stream()
+                .map(term -> Optional.ofNullable(term.getSource()).orElse(""))
+                .collect(Collectors.joining(delimiter + LINE_SEPARATOR, "", delimiter));
+        sb.append(entryTerms);
+        ListItem description = node.getDescription();
+        if (null != description) {
+            if (descriptionOnNewLine) {
+                sb.append(LINE_SEPARATOR);
+            }
+            String desc = Optional.ofNullable(description.getSource()).orElse("");
+            if (StringUtils.isNotBlank(desc)) {
+                sb.append(desc).append(LINE_SEPARATOR);
+            }
+            appendChildBlocks(description, sb);
+        }
+        return sb.toString();
+    }
+
+    private String convertListing(Block node) {
+        logger.debug("convertListing");
+        StringBuilder sb = new StringBuilder();
+        appendTitle(node, sb);
+        if (STYLE_SOURCE.equals(node.getStyle())) {
+            sb.append(new SourceNode(node).toAsciiDocContent());
+        } else {
+            sb.append(new BlockListingNode(node).toAsciiDocContent());
+        }
+        return sb.toString();
+    }
+
+    private String convertUList(List node) {
+        logger.debug("convertUList");
+        StringBuilder sb = new StringBuilder();
+        appendStyle(node, sb);
+        appendTitle(node, sb);
+        appendChildBlocks(node, sb);
+        appendTrailingNewLine(sb);
+        return sb.toString();
+    }
+
+    private String convertOList(List node) {
+        logger.debug("convertOList");
+        StringBuilder sb = new StringBuilder();
+        java.util.List<String> attrs = new ArrayList<>();
+        String start = node.getAttribute("start", "").toString();
+        if (StringUtils.isNotBlank(start)) {
+            attrs.add("start=" + start);
+        }
+        if (node.isOption("reversed")) {
+            attrs.add("%reversed");
+        }
+        if (!attrs.isEmpty()) {
+            sb.append(ATTRIBUTES_BEGIN).append(String.join(",", attrs)).append(ATTRIBUTES_END).append(LINE_SEPARATOR);
+        }
+        appendTitle(node, sb);
+        appendChildBlocks(node, sb);
+        appendTrailingNewLine(sb);
+        return sb.toString();
+    }
+
+    private String convertCoList(List node) {
+        logger.debug("convertCoList");
+        StringBuilder result = new StringBuilder();
+        appendChildBlocks(node, result);
+        return result.toString();
+    }
+
+    private String convertListItem(ListItem node) {
+        logger.debug("convertListItem");
+        StringBuilder sb = new StringBuilder();
+
+        String marker = Optional.ofNullable(node.getMarker()).orElse(repeat(node.getLevel(), MARKER_LIST_ITEM));
+
+        String coids = node.getAttribute("coids", "").toString();
+        Matcher matcher = coListItemIdPattern.matcher(coids);
+        if (matcher.find()) {
+            marker = marker.replaceAll("\\d+", matcher.group(1));
+        }
+
+        sb.append(marker).append(" ");
+
+        if (node.hasAttribute("checkbox")) {
+            sb.append('[');
+            if (node.hasAttribute("checked")) {
+                sb.append('x');
+            } else {
+                sb.append(' ');
+            }
+            sb.append(']').append(' ');
+        }
+
+        sb.append(Optional.ofNullable(node.getSource()).orElse(""));
+        appendTrailingNewLine(sb);
+        appendChildBlocks(node, sb);
+        return sb.toString();
+    }
+
+    private String convertList(List node) {
+        logger.debug("convertList");
+        return node.getContent().toString();
+    }
+
+    private String convertPreamble(StructuralNode node) {
+        logger.debug("convertPreamble");
+        return node.getContent().toString();
+    }
+
+    private String convertImage(StructuralNode node) {
+        logger.debug("convertImage");
+        StringBuilder sb = new StringBuilder();
+        appendTitle(node, sb);
+        appendRoles(node, sb);
+        sb.append(new BlockImageNode(node).toAsciiDocContent());
+        return sb.toString();
+    }
+
+    private String convertLiteral(StructuralNode node) {
+        logger.debug("convertLiteral");
+        return ATTRIBUTES_BEGIN + node.getContext() + ATTRIBUTES_END + LINE_SEPARATOR +
+                StringEscapeUtils.unescapeHtml4(node.getContent().toString()) + LINE_SEPARATOR;
+    }
+
+    private String convertParagraph(StructuralNode node) {
+        logger.debug("convertParagraph");
+        StringBuilder sb = new StringBuilder();
+        appendTitle(node, sb);
+        sb.append(new ParagraphAttributes(node).toAsciiDocContent());
+        appendSource((Block) node, sb);
+        appendTrailingNewLine(sb);
+        return sb.toString();
+    }
+
+    private String convertSection(Section node) {
+        logger.debug("convertSection");
+        StringBuilder sb = new StringBuilder();
+        appendId(node, sb);
+        sb.append(new DelimitedBlockNode(node).toAsciiDocContent()).append(StringUtils.repeat(TITLE, node.getLevel() + 1))
+                .append(" ").append(StringEscapeUtils.unescapeHtml4(node.getTitle())).append(LINE_SEPARATOR);
+        appendChildBlocks(node, sb);
+        appendTrailingNewLine(sb);
+        return sb.toString();
+    }
+
+    private void append_link_constraint_attrs(ContentNode node, java.util.List<String> attrs) {
+        String rel = node.getAttribute("nofollow-option").toString();
+        String window = node.getAttributes().get("window").toString();
+        if (StringUtils.isNotBlank(window)) {
+            attrs.add("target = \"#{window}\"");
+            if (window.equals("_blank") || (node.getAttributes().containsKey("option-noopener"))) {
+                if (StringUtils.isNotBlank(rel)) {
+                    attrs.add("rel = \"" + rel + "noopener\"");
+                } else {
+                    attrs.add(" rel=\"noopener\"");
+                }
+            }
+        } else if (StringUtils.isNotBlank(rel)) {
+            attrs.add("rel = " + rel + "\"");
+        }
+    }
+
+    private String repeat(int count, String with) {
+        return new String(new char[count]).replace("\0", with);
+    }
+
+    private void appendChildBlocks(StructuralNode parentNode, StringBuilder sb) {
+        appendChildBlocks(parentNode, sb, true);
+    }
+
+    private void appendChildBlocks(StructuralNode parentNode, StringBuilder sb, boolean addTrailingLineSeparator) {
+        final boolean isParentAListItem = parentNode instanceof ListItem || parentNode instanceof DescriptionListEntry;
+        parentNode.getBlocks().forEach(childNode -> {
+            String childNodeValue = childNode.convert();
+            if (StringUtils.isNotBlank(childNodeValue)) {
+                if (isParentAListItem && (sb.toString().contains("+" + LINE_SEPARATOR) || !(childNode instanceof List || childNode instanceof DescriptionList))) {
+                    sb.append('+').append(LINE_SEPARATOR);
+                }
+                sb.append(childNodeValue);
+                if (addTrailingLineSeparator && !StringUtils.endsWith(childNodeValue, LINE_SEPARATOR)) {
+                    sb.append(LINE_SEPARATOR);
+                }
+            }
+        });
+    }
+
+    private void appendTrailingNewLine(StringBuilder sb) {
+        if (!sb.toString().endsWith(LINE_SEPARATOR + LINE_SEPARATOR)) {
+            sb.append(LINE_SEPARATOR);
+        }
+    }
+
+    private void appendId(StructuralNode node, StringBuilder sb) {
+        String id = node.getId();
+        if (StringUtils.isNotBlank(id)) {
+            sb.append("[[").append(id).append("]]").append(LINE_SEPARATOR);
+        }
+    }
+
+    private void appendSource(Block node, StringBuilder sb) {
+        String source = node.getSource();
+        if (StringUtils.isNotBlank(source)) {
+            sb.append(source).append(LINE_SEPARATOR);
+        }
+    }
+
+    private void appendTitle(StructuralNode node, StringBuilder sb) {
+        String title = node.getTitle();
+        if (StringUtils.isNotBlank(title)) {
+            sb.append(".").append(StringEscapeUtils.unescapeHtml4(title)).append(LINE_SEPARATOR);
+        }
+    }
+
+    private void appendStyle(StructuralNode node, StringBuilder sb) {
+        String style = node.getStyle();
+        if (StringUtils.isNotBlank(style)) {
+            sb.append(ATTRIBUTES_BEGIN).append(style).append(ATTRIBUTES_END).append(LINE_SEPARATOR);
+        }
+    }
+
+    private void appendRoles(StructuralNode node, StringBuilder sb) {
+        java.util.List<String> roles = node.getRoles();
+        if (!roles.isEmpty()) {
+            sb.append(ATTRIBUTES_BEGIN).append(".").append(String.join(".", roles))
+                    .append(ATTRIBUTES_END).append(LINE_SEPARATOR);
+        }
+    }
+
+    private void appendAttributeTo(StructuralNode node, java.util.List<String> attrs, String name) {
+        String attribution = node.getAttribute(name, "").toString();
+        if (StringUtils.isNotBlank(attribution)) {
+            attrs.add(attribution);
+        }
+    }
+}

swagger2markup-asciidoc/src/main/java/io/github/swagger2markup/adoc/ast/impl/BlockImpl.java

@@ -0,0 +1,70 @@
+package io.github.swagger2markup.adoc.ast.impl;
+
+import org.asciidoctor.ast.Block;
+import org.asciidoctor.ast.StructuralNode;
+
+import java.util.*;
+
+public class BlockImpl extends StructuralNodeImpl implements Block {
+
+    private List<String> lines;
+
+    public BlockImpl(StructuralNode parent, String context) {
+        this(parent, context, "");
+    }
+
+    public BlockImpl(StructuralNode parent, String context, Object content) {
+        this(parent, context, new HashMap<>(), content);
+    }
+
+    public BlockImpl(StructuralNode parent, String context, Map<String, Object> attributes) {
+        this(parent, context, attributes, "");
+    }
+
+    public BlockImpl(StructuralNode parent, String context, Map<String, Object> attributes, Object content) {
+        this(parent, context, attributes, new ArrayList<>(), content, new ArrayList<>(), "", new ArrayList<>());
+    }
+
+    public BlockImpl(StructuralNode parent, String context, Map<String, Object> attributes, List<String> roles,
+                     Object content, List<StructuralNode> blocks, String contentModel, List<String> subs) {
+        this(parent, context, attributes, roles, content, blocks, calculateLevel(parent), contentModel, subs);
+    }
+
+    public BlockImpl(StructuralNode parent, String context, Map<String, Object> attributes, List<String> roles,
+                        Object content, List<StructuralNode> blocks, Integer level, String contentModel, List<String> subs) {
+        super(parent, context, attributes, roles, content, blocks, level, contentModel, subs);
+        this.lines = new ArrayList<>();
+    }
+
+    @Override
+    @Deprecated
+    public List<String> lines() {
+        return getLines();
+    }
+
+    @Override
+    public List<String> getLines() {
+        return lines;
+    }
+
+    @Override
+    public void setLines(List<String> lines) {
+        this.lines = lines;
+    }
+
+    @Override
+    @Deprecated
+    public String source() {
+        return getSource();
+    }
+
+    @Override
+    public String getSource() {
+        return String.join("\n", lines);
+    }
+
+    @Override
+    public void setSource(String source) {
+        setLines(Arrays.asList(source.split("\n")));
+    }
+}

swagger2markup-asciidoc/src/main/java/io/github/swagger2markup/adoc/ast/impl/CellImpl.java

@@ -0,0 +1,112 @@
+package io.github.swagger2markup.adoc.ast.impl;
+
+import org.asciidoctor.ast.Cell;
+import org.asciidoctor.ast.Column;
+import org.asciidoctor.ast.Document;
+import org.asciidoctor.ast.Table;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class CellImpl extends ContentNodeImpl implements Cell {
+
+    private final int colspan;
+    private final int rowspan;
+    private String text;
+    private String style;
+    private Document innerDocument;
+
+    public CellImpl(Column parent, String text) {
+        this(parent, "table_cell", new HashMap<>(), new ArrayList<>(), 0, 0);
+        this.text = text;
+    }
+
+    public CellImpl(Column parent, Document innerDocument) {
+        this(parent, "table_cell", new HashMap<>(), new ArrayList<>(), 0, 0);
+        this.innerDocument = innerDocument;
+    }
+
+    public CellImpl(Column parent, String context, Map<String, Object> attributes, List<String> roles, int colspan, int rowspan) {
+        super(parent, context, attributes, roles);
+        this.colspan = colspan;
+        this.rowspan = rowspan;
+    }
+
+    @Override
+    public Column getColumn() {
+        return (Column) getParent();
+    }
+
+    @Override
+    public int getColspan() {
+        return colspan;
+    }
+
+    @Override
+    public int getRowspan() {
+        return rowspan;
+    }
+
+    @Override
+    public String getText() {
+        return text;
+    }
+
+    @Override
+    public String getSource() {
+        return text;
+    }
+
+    @Override
+    public void setSource(String source) {
+        this.text = source;
+    }
+
+    @Override
+    public Object getContent() {
+        return text;
+    }
+
+    @Override
+    public String getStyle() {
+        return style;
+    }
+
+    @Override
+    public void setStyle(String style) {
+        this.style = style;
+    }
+
+    @Override
+    public Table.HorizontalAlignment getHorizontalAlignment() {
+        return Table.HorizontalAlignment.valueOf(((String) getAttribute("halign", "left")).toUpperCase());
+    }
+
+    @Override
+    public void setHorizontalAlignment(Table.HorizontalAlignment halign) {
+        setAttribute("halign", halign.name().toLowerCase(), true);
+    }
+
+    @Override
+    public Table.VerticalAlignment getVerticalAlignment() {
+        return Table.VerticalAlignment.valueOf(((String) getAttribute("valign", "top")).toUpperCase());
+    }
+
+    @Override
+    public void setVerticalAlignment(Table.VerticalAlignment valign) {
+        setAttribute("valign", valign.name().toLowerCase(), true);
+    }
+
+    @Override
+    public Document getInnerDocument() {
+        return innerDocument;
+    }
+
+    @Override
+    public void setInnerDocument(Document document) {
+        this.innerDocument = document;
+    }
+
+}

swagger2markup-asciidoc/src/main/java/io/github/swagger2markup/adoc/ast/impl/ColumnImpl.java

@@ -0,0 +1,81 @@
+package io.github.swagger2markup.adoc.ast.impl;
+
+import org.asciidoctor.ast.Column;
+import org.asciidoctor.ast.Table;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class ColumnImpl extends ContentNodeImpl implements Column {
+
+    private String style;
+    private Number columnNumber = -1;
+    private Number width = 0;
+
+    public ColumnImpl(Table parent) {
+        this(parent, "table_column", new HashMap<>(), new ArrayList<>());
+    }
+
+    public ColumnImpl(Table parent, String context, Map<String, Object> attributes, List<String> roles) {
+        super(parent, context, attributes, roles);
+    }
+
+    @Override
+    public String getStyle() {
+        return style;
+    }
+
+    @Override
+    public void setStyle(String style) {
+        this.style = style;
+    }
+
+    @Override
+    public Table getTable() {
+        return (Table) getParent();
+    }
+
+    @Override
+    public int getColumnNumber() {
+        return columnNumber.intValue();
+    }
+
+    public void setColumnNumber(Integer columnNumber) {
+        setAttribute("colnumber", columnNumber, true);
+        this.columnNumber = columnNumber;
+    }
+
+    @Override
+    public int getWidth() {
+        return width.intValue();
+    }
+
+    @Override
+    public void setWidth(int width) {
+        setAttribute("width", width, true);
+        this.width = width;
+    }
+
+    @Override
+    public Table.HorizontalAlignment getHorizontalAlignment() {
+        return Table.HorizontalAlignment.valueOf(((String) getAttribute("halign", "left")).toUpperCase());
+    }
+
+    @Override
+    public void setHorizontalAlignment(Table.HorizontalAlignment halign) {
+        setAttribute("halign", halign.name().toLowerCase(), true);
+    }
+
+    @Override
+    public Table.VerticalAlignment getVerticalAlignment() {
+        return Table.VerticalAlignment.valueOf(((String) getAttribute("valign", "top")).toUpperCase());
+    }
+
+    @Override
+    public void setVerticalAlignment(Table.VerticalAlignment valign) {
+        setAttribute("valign", valign.name().toLowerCase(), true);
+    }
+
+}