mindol1004/swagger2markup
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Removed Required column and render required flag in NAME_COLUMN.

Browse Source 
Removed header style on columns in tables.
Support for read-only property flags.
This commit is contained in:
Hugo de Paix de Coeur
2016-04-06 18:15:09 +02:00
parent 3e9fca8a0d
commit ae3f9aa353
33 changed files with 1652 additions and 1300 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
src/main/java/io/github/swagger2markup/internal/document/builder/MarkupDocumentBuilder.java
View File

@@ -32,6 +32,7 @@ import io.github.swagger2markup.utils.IOUtils;
import io.swagger.models.properties.Property; import io.swagger.models.properties.Property;
import io.swagger.util.Json; import io.swagger.util.Json;
import org.apache.commons.collections4.MapUtils; import org.apache.commons.collections4.MapUtils;
import org.apache.commons.lang3.BooleanUtils;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
@@ -50,9 +51,10 @@ import static org.apache.commons.lang3.StringUtils.isNotBlank;
*/ */
public abstract class MarkupDocumentBuilder { public abstract class MarkupDocumentBuilder {
protected static final String COLON = " : ";
protected final String DEFAULT_COLUMN; protected final String DEFAULT_COLUMN;
protected final String EXAMPLE_COLUMN; protected final String EXAMPLE_COLUMN;
protected final String REQUIRED_COLUMN;
protected final String SCHEMA_COLUMN; protected final String SCHEMA_COLUMN;
protected final String NAME_COLUMN; protected final String NAME_COLUMN;
protected final String DESCRIPTION_COLUMN; protected final String DESCRIPTION_COLUMN;
@@ -62,6 +64,11 @@ public abstract class MarkupDocumentBuilder {
protected final String CONSUMES; protected final String CONSUMES;
protected final String TAGS; protected final String TAGS;
protected final String NO_CONTENT; protected final String NO_CONTENT;
protected final String FLAGS_COLUMN;
protected final String FLAGS_REQUIRED;
protected final String FLAGS_OPTIONAL;
protected final String FLAGS_READ_ONLY;
protected Logger logger = LoggerFactory.getLogger(getClass()); protected Logger logger = LoggerFactory.getLogger(getClass());
@@ -82,7 +89,10 @@ public abstract class MarkupDocumentBuilder {
ResourceBundle labels = ResourceBundle.getBundle("io/github/swagger2markup/lang/labels", config.getOutputLanguage().toLocale()); ResourceBundle labels = ResourceBundle.getBundle("io/github/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
DEFAULT_COLUMN = labels.getString("default_column"); DEFAULT_COLUMN = labels.getString("default_column");
EXAMPLE_COLUMN = labels.getString("example_column"); EXAMPLE_COLUMN = labels.getString("example_column");
REQUIRED_COLUMN = labels.getString("required_column"); FLAGS_COLUMN = labels.getString("flags.column");
FLAGS_REQUIRED = labels.getString("flags.required");
FLAGS_OPTIONAL = labels.getString("flags.optional");
FLAGS_READ_ONLY = labels.getString("flags.read_only");
SCHEMA_COLUMN = labels.getString("schema_column"); SCHEMA_COLUMN = labels.getString("schema_column");
NAME_COLUMN = labels.getString("name_column"); NAME_COLUMN = labels.getString("name_column");
DESCRIPTION_COLUMN = labels.getString("description_column"); DESCRIPTION_COLUMN = labels.getString("description_column");
@@ -116,9 +126,8 @@ public abstract class MarkupDocumentBuilder {
List<ObjectType> localDefinitions = new ArrayList<>(); List<ObjectType> localDefinitions = new ArrayList<>();
List<List<String>> cells = new ArrayList<>(); List<List<String>> cells = new ArrayList<>();
List<MarkupTableColumn> cols = Arrays.asList( List<MarkupTableColumn> cols = Arrays.asList(
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(true).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"), new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6"), new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6"),
new MarkupTableColumn(REQUIRED_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(EXAMPLE_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1")); new MarkupTableColumn(EXAMPLE_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
@@ -139,10 +148,20 @@ public abstract class MarkupDocumentBuilder {
Object example = PropertyUtils.getExample(config.isGeneratedExamplesEnabled(), property, markupDocBuilder); Object example = PropertyUtils.getExample(config.isGeneratedExamplesEnabled(), property, markupDocBuilder);
MarkupDocBuilder propertyNameContent = markupDocBuilder.copy(false);
propertyNameContent.boldTextLine(propertyName, true);
if (BooleanUtils.isTrue(property.getRequired()))
propertyNameContent.italicText(FLAGS_REQUIRED.toLowerCase());
else
propertyNameContent.italicText(FLAGS_OPTIONAL.toLowerCase());
if (BooleanUtils.isTrue(property.getReadOnly())) {
propertyNameContent.newLine(true);
propertyNameContent.italicText(FLAGS_READ_ONLY.toLowerCase());
}
List<String> content = Arrays.asList( List<String> content = Arrays.asList(
propertyName, propertyNameContent.toString(),
swaggerMarkupDescription(defaultString(property.getDescription())), swaggerMarkupDescription(defaultString(property.getDescription())),
Boolean.toString(property.getRequired()),
propertyType.displaySchema(docBuilder), propertyType.displaySchema(docBuilder),
PropertyUtils.getDefaultValue(property), PropertyUtils.getDefaultValue(property),
example != null ? Json.pretty(example) : "" example != null ? Json.pretty(example) : ""
@@ -157,6 +176,18 @@ public abstract class MarkupDocumentBuilder {
return localDefinitions; return localDefinitions;
} }
protected String boldText(String text) {
return this.markupDocBuilder.copy(false).boldText(text).toString();
}
protected String italicText(String text) {
return this.markupDocBuilder.copy(false).italicText(text).toString();
}
protected String literalText(String text) {
return this.markupDocBuilder.copy(false).literalText(text).toString();
}
/** /**
* Returns converted markup text from Swagger. * Returns converted markup text from Swagger.
* *

11
src/main/java/io/github/swagger2markup/internal/document/builder/OverviewDocumentBuilder.java
View File

@@ -35,7 +35,6 @@ import static org.apache.commons.lang3.StringUtils.*;
public class OverviewDocumentBuilder extends MarkupDocumentBuilder { public class OverviewDocumentBuilder extends MarkupDocumentBuilder {
private static final String OVERVIEW_ANCHOR = "overview"; private static final String OVERVIEW_ANCHOR = "overview";
private static final String COLON = " : ";
private final String OVERVIEW; private final String OVERVIEW;
private final String CURRENT_VERSION; private final String CURRENT_VERSION;
private final String VERSION; private final String VERSION;
@@ -194,9 +193,7 @@ public class OverviewDocumentBuilder extends MarkupDocumentBuilder {
this.markupDocBuilder.sectionTitleLevel2(CONSUMES); this.markupDocBuilder.sectionTitleLevel2(CONSUMES);
this.markupDocBuilder.newLine(); this.markupDocBuilder.newLine();
for (String consume : consumes) { for (String consume : consumes) {
MarkupDocBuilder contentType = this.markupDocBuilder.copy(false); this.markupDocBuilder.unorderedListItem(literalText(consume));
contentType.literalText(consume);
this.markupDocBuilder.unorderedListItem(contentType.toString());
} }
this.markupDocBuilder.newLine(); this.markupDocBuilder.newLine();
} }
@@ -206,10 +203,8 @@ public class OverviewDocumentBuilder extends MarkupDocumentBuilder {
if (isNotEmpty(produces)) { if (isNotEmpty(produces)) {
this.markupDocBuilder.sectionTitleLevel2(PRODUCES); this.markupDocBuilder.sectionTitleLevel2(PRODUCES);
this.markupDocBuilder.newLine(); this.markupDocBuilder.newLine();
for (String consume : produces) { for (String produce : produces) {
MarkupDocBuilder contentType = this.markupDocBuilder.copy(false); this.markupDocBuilder.unorderedListItem(literalText(produce));
contentType.literalText(consume);
this.markupDocBuilder.unorderedListItem(contentType.toString());
} }
this.markupDocBuilder.newLine(); this.markupDocBuilder.newLine();
} }

51
src/main/java/io/github/swagger2markup/internal/document/builder/PathsDocumentBuilder.java
View File

@@ -39,6 +39,7 @@ import io.swagger.models.properties.Property;
import io.swagger.util.Json; import io.swagger.util.Json;
import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.collections4.MapUtils; import org.apache.commons.collections4.MapUtils;
import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate; import org.apache.commons.lang3.Validate;
import org.apache.commons.lang3.text.WordUtils; import org.apache.commons.lang3.text.WordUtils;
@@ -438,10 +439,9 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
if (displayParameters) { if (displayParameters) {
List<List<String>> cells = new ArrayList<>(); List<List<String>> cells = new ArrayList<>();
List<MarkupTableColumn> cols = Arrays.asList( List<MarkupTableColumn> cols = Arrays.asList(
new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(1).withHeaderColumn(true).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"), new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(true).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"), new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6"), new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6"),
new MarkupTableColumn(REQUIRED_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1")); new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
for (Parameter parameter : parameters) { for (Parameter parameter : parameters) {
@@ -460,11 +460,17 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
} }
String parameterType = WordUtils.capitalize(parameter.getIn()); String parameterType = WordUtils.capitalize(parameter.getIn());
MarkupDocBuilder parameterNameContent = markupDocBuilder.copy(false);
parameterNameContent.boldTextLine(parameter.getName(), true);
if (parameter.getRequired())
parameterNameContent.italicText(FLAGS_REQUIRED.toLowerCase());
else
parameterNameContent.italicText(FLAGS_OPTIONAL.toLowerCase());
List<String> content = Arrays.asList( List<String> content = Arrays.asList(
parameterType, boldText(parameterType),
parameter.getName(), parameterNameContent.toString(),
swaggerMarkupDescription(defaultString(parameter.getDescription())), swaggerMarkupDescription(defaultString(parameter.getDescription())),
Boolean.toString(parameter.getRequired()),
type.displaySchema(markupDocBuilder), type.displaySchema(markupDocBuilder),
ParameterUtils.getDefaultValue(parameter)); ParameterUtils.getDefaultValue(parameter));
cells.add(content); cells.add(content);
@@ -500,10 +506,10 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
} }
MarkupDocBuilder typeInfos = docBuilder.copy(false); MarkupDocBuilder typeInfos = docBuilder.copy(false);
typeInfos.italicText(REQUIRED_COLUMN).textLine(" : " + parameter.getRequired()); typeInfos.italicText(NAME_COLUMN).textLine(COLON + parameter.getName());
typeInfos.italicText(NAME_COLUMN).textLine(" : " + parameter.getName()); typeInfos.italicText(FLAGS_COLUMN).textLine(COLON + (BooleanUtils.isTrue(parameter.getRequired()) ? FLAGS_REQUIRED.toLowerCase() : FLAGS_OPTIONAL.toLowerCase()));
if (!(type instanceof ObjectType)) { if (!(type instanceof ObjectType)) {
typeInfos.italicText(TYPE_COLUMN).textLine(" : " + type.displaySchema(docBuilder)); typeInfos.italicText(TYPE_COLUMN).textLine(COLON + type.displaySchema(docBuilder));
} }
docBuilder.paragraph(typeInfos.toString(), true); docBuilder.paragraph(typeInfos.toString(), true);
@@ -525,9 +531,7 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
buildSectionTitle(CONSUMES, docBuilder); buildSectionTitle(CONSUMES, docBuilder);
docBuilder.newLine(); docBuilder.newLine();
for (String consume : consumes) { for (String consume : consumes) {
MarkupDocBuilder contentType = docBuilder.copy(false); docBuilder.unorderedListItem(literalText(consume));
contentType.literalText(consume);
docBuilder.unorderedListItem(contentType.toString());
} }
docBuilder.newLine(); docBuilder.newLine();
} }
@@ -540,9 +544,7 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
buildSectionTitle(PRODUCES, docBuilder); buildSectionTitle(PRODUCES, docBuilder);
docBuilder.newLine(); docBuilder.newLine();
for (String produce : produces) { for (String produce : produces) {
MarkupDocBuilder contentType = docBuilder.copy(false); docBuilder.unorderedListItem(literalText(produce));
contentType.literalText(produce);
docBuilder.unorderedListItem(contentType.toString());
} }
docBuilder.newLine(); docBuilder.newLine();
} }
@@ -583,7 +585,7 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
} }
} }
} }
/** /**
* Builds the security section of a Swagger Operation. * Builds the security section of a Swagger Operation.
* *
@@ -597,8 +599,8 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
Map<String, SecuritySchemeDefinition> securityDefinitions = globalContext.getSwagger().getSecurityDefinitions(); Map<String, SecuritySchemeDefinition> securityDefinitions = globalContext.getSwagger().getSecurityDefinitions();
List<List<String>> cells = new ArrayList<>(); List<List<String>> cells = new ArrayList<>();
List<MarkupTableColumn> cols = Arrays.asList( List<MarkupTableColumn> cols = Arrays.asList(
new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(1).withHeaderColumn(true).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"), new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(true).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"), new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(SCOPES_COLUMN).withWidthRatio(6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6")); new MarkupTableColumn(SCOPES_COLUMN).withWidthRatio(6).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^6"));
for (Map<String, List<String>> securityScheme : securitySchemes) { for (Map<String, List<String>> securityScheme : securitySchemes) {
for (Map.Entry<String, List<String>> securityEntry : securityScheme.entrySet()) { for (Map.Entry<String, List<String>> securityEntry : securityScheme.entrySet()) {
@@ -607,7 +609,8 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
if (securityDefinitions != null && securityDefinitions.containsKey(securityKey)) { if (securityDefinitions != null && securityDefinitions.containsKey(securityKey)) {
type = securityDefinitions.get(securityKey).getType(); type = securityDefinitions.get(securityKey).getType();
} }
List<String> content = Arrays.asList(type, docBuilder.copy(false).crossReference(securityKey, securityKey).toString(),
List<String> content = Arrays.asList(boldText(type), boldText(docBuilder.copy(false).crossReference(securityKey, securityKey).toString()),
Joiner.on(",").join(securityEntry.getValue())); Joiner.on(",").join(securityEntry.getValue()));
cells.add(content); cells.add(content);
} }
@@ -624,12 +627,12 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
buildSectionTitle(RESPONSES, docBuilder); buildSectionTitle(RESPONSES, docBuilder);
List<MarkupTableColumn> responseCols = Arrays.asList( List<MarkupTableColumn> responseCols = Arrays.asList(
new MarkupTableColumn(HTTP_CODE_COLUMN).withWidthRatio(1).withHeaderColumn(true).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"), new MarkupTableColumn(HTTP_CODE_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(3).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"), new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(3).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1")); new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
List<MarkupTableColumn> responseHeaderCols = Arrays.asList( List<MarkupTableColumn> responseHeaderCols = Arrays.asList(
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(true).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1h"), new MarkupTableColumn(NAME_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(3).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"), new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(3).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"), new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1")); new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(1).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"));
@@ -652,9 +655,9 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
type = new RefType(type); type = new RefType(type);
} }
} }
cells.add(Arrays.asList(responseName, swaggerMarkupDescription(response.getDescription()), type.displaySchema(markupDocBuilder))); cells.add(Arrays.asList(boldText(responseName), swaggerMarkupDescription(response.getDescription()), type.displaySchema(markupDocBuilder)));
} else { } else {
cells.add(Arrays.asList(responseName, swaggerMarkupDescription(response.getDescription()), NO_CONTENT)); cells.add(Arrays.asList(boldText(responseName), swaggerMarkupDescription(response.getDescription()), NO_CONTENT));
} }
buildResponseTitle(HTTP_CODE_COLUMN + " " + responseName, docBuilder); buildResponseTitle(HTTP_CODE_COLUMN + " " + responseName, docBuilder);
@@ -666,7 +669,7 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
for(Map.Entry<String, Property> header : headers.entrySet()){ for(Map.Entry<String, Property> header : headers.entrySet()){
Property property = header.getValue(); Property property = header.getValue();
Type propertyType = PropertyUtils.getType(property, null); Type propertyType = PropertyUtils.getType(property, null);
responseHeaderCells.add(Arrays.asList(header.getKey(), responseHeaderCells.add(Arrays.asList(boldText(header.getKey()),
swaggerMarkupDescription(defaultString(property.getDescription())), swaggerMarkupDescription(defaultString(property.getDescription())),
propertyType.displaySchema(markupDocBuilder), propertyType.displaySchema(markupDocBuilder),
PropertyUtils.getDefaultValue(property))); PropertyUtils.getDefaultValue(property)));

1
src/main/java/io/github/swagger2markup/internal/document/builder/SecurityDocumentBuilder.java
View File

@@ -40,7 +40,6 @@ import static org.apache.commons.lang3.StringUtils.isNotBlank;
public class SecurityDocumentBuilder extends MarkupDocumentBuilder { public class SecurityDocumentBuilder extends MarkupDocumentBuilder {
private static final String SECURITY_ANCHOR = "securityScheme"; private static final String SECURITY_ANCHOR = "securityScheme";
private static final String COLON = " : ";
private final String SECURITY; private final String SECURITY;
private final String TYPE; private final String TYPE;
private final String NAME; private final String NAME;

6
src/main/resources/io/github/swagger2markup/lang/labels_de.properties
View File

@@ -1,7 +1,11 @@
definitions=Definitionen definitions=Definitionen
default_column=Standard default_column=Standard
example_column=Beispiel example_column=Beispiel
required_column=Pflichtfeld flags.column=Flags
flags.required=Required
flags.optional=Optional
flags.read_only=Read-only
flags.read_write=Read-write
schema_column=Schema schema_column=Schema
name_column=Name name_column=Name
description_column=Beschreibung description_column=Beschreibung

6
src/main/resources/io/github/swagger2markup/lang/labels_en.properties
View File

@@ -2,7 +2,11 @@ definitions=Definitions
default_column=Default default_column=Default
example_column=Example example_column=Example
required_column=Required flags.column=Flags
flags.required=Required
flags.optional=Optional
flags.read_only=Read-only
flags.read_write=Read-write
schema_column=Schema schema_column=Schema
name_column=Name name_column=Name
description_column=Description description_column=Description

6
src/main/resources/io/github/swagger2markup/lang/labels_fr.properties
View File

@@ -2,7 +2,11 @@ definitions=D\u00E9finitions
default_column=D\u00E9faut default_column=D\u00E9faut
example_column=Exemple example_column=Exemple
required_column=Requis flags.column=Modificateurs
flags.required=Requis
flags.optional=Optionnel
flags.read_only=Lecture seule
flags.read_write=Lecture/\u00E9criture
schema_column=Sch\u00E9ma schema_column=Sch\u00E9ma
name_column=Nom name_column=Nom
description_column=Description description_column=Description

6
src/main/resources/io/github/swagger2markup/lang/labels_ru.properties
View File

@@ -1,7 +1,11 @@
definitions=\u041E\u043F\u0440\u0435\u0434\u0435\u043B\u0435\u043D\u0438\u044F definitions=\u041E\u043F\u0440\u0435\u0434\u0435\u043B\u0435\u043D\u0438\u044F
default_column=\u041F\u043E \u0443\u043C\u043E\u043B\u0447\u0430\u043D\u0438\u044E 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 flags.column=Flags
flags.required=\u041E\u0431\u044F\u0437\u0430\u0442\u0435\u043B\u044C\u043D\u043E
flags.optional=Optional
flags.read_only=Read-only
flags.read_write=Read-write
example_column=\u041F\u0440\u0438\u043C\u0435\u0440 example_column=\u041F\u0440\u0438\u043C\u0435\u0440
schema_column=\u0421\u0445\u0435\u043C\u0430 schema_column=\u0421\u0445\u0435\u043C\u0430
name_column=\u0418\u043C\u044F name_column=\u0418\u043C\u044F

2
src/test/java/io/github/swagger2markup/GeneralConverterTest.java
View File

@@ -48,7 +48,7 @@ public class GeneralConverterTest {
public void testToFileWithoutExtension() throws IOException, URISyntaxException { public void testToFileWithoutExtension() throws IOException, URISyntaxException {
//Given //Given
String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/yaml/swagger_petstore.yaml")); String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/yaml/swagger_petstore.yaml"));
Path outputFile = Paths.get("build/test/asciidoc/outputFile.adoc"); Path outputFile = Paths.get("build/test/asciidoc/toFile/outputFile.adoc");
//When //When
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder() Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()

14
src/test/java/io/github/swagger2markup/MarkdownConverterTest.java
View File

@@ -35,10 +35,7 @@ import java.nio.charset.Charset;
import java.nio.file.Files; import java.nio.file.Files;
import java.nio.file.Path; import java.nio.file.Path;
import java.nio.file.Paths; import java.nio.file.Paths;
import java.util.ArrayList; import java.util.*;
import java.util.List;
import java.util.Map;
import java.util.Set;
import static java.util.Arrays.asList; import static java.util.Arrays.asList;
import static org.assertj.core.api.Assertions.fail; import static org.assertj.core.api.Assertions.fail;
@@ -144,6 +141,7 @@ public class MarkdownConverterTest {
/** /**
* Given a markdown document to search, this checks to see if the specified tables * Given a markdown document to search, this checks to see if the specified tables
* have all of the expected fields listed. * have all of the expected fields listed.
* Match is a "search", and not an "equals" match.
* *
* @param doc markdown document file to inspect * @param doc markdown document file to inspect
* @param fieldsByTable map of table name (header) to field names expected * @param fieldsByTable map of table name (header) to field names expected
@@ -179,7 +177,13 @@ public class MarkdownConverterTest {
final Set<String> fieldsLeft = fieldsLeftByTable.get(inTable); final Set<String> fieldsLeft = fieldsLeftByTable.get(inTable);
// Mark the field as found and if this table has no more fields to find, // Mark the field as found and if this table has no more fields to find,
// remove it from the "fieldsLeftByTable" map to mark the table as done // remove it from the "fieldsLeftByTable" map to mark the table as done
if (fieldsLeft.remove(fieldName) && fieldsLeft.isEmpty()) { Iterator<String> fieldIt = fieldsLeft.iterator();
while (fieldIt.hasNext()) {
String fieldLeft = fieldIt.next();
if (fieldName.contains(fieldLeft))
fieldIt.remove();
}
if (fieldsLeft.isEmpty()) {
fieldsLeftByTable.remove(inTable); fieldsLeftByTable.remove(inTable);
} }
} }

92
src/test/resources/expected/asciidoc/default/definitions.adoc
View File

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

352
src/test/resources/expected/asciidoc/default/paths.adoc
View File

@@ -11,10 +11,11 @@ POST /pets
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -22,10 +23,10 @@ POST /pets
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -48,10 +49,10 @@ POST /pets
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -64,10 +65,11 @@ PUT /pets
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -75,28 +77,28 @@ PUT /pets
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Validation exception|No Content |*405*|Validation exception|No Content
|=== |===
@@ -119,10 +121,10 @@ PUT /pets
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -139,10 +141,11 @@ Multiple status values can be provided with comma seperated strings
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|status|Status values that need to be considered for filter|false|multi string array| |*Query*|*status* +
_optional_|Status values that need to be considered for filter|multi string array|
|=== |===
@@ -150,29 +153,29 @@ Multiple status values can be provided with comma seperated strings
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid status value|No Content |*400*|Invalid status value|No Content
|=== |===
@@ -189,10 +192,10 @@ Multiple status values can be provided with comma seperated strings
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -209,10 +212,11 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|tags|Tags to filter by|false|multi string array| |*Query*|*tags* +
_optional_|Tags to filter by|multi string array|
|=== |===
@@ -220,29 +224,29 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid tag value|No Content |*400*|Invalid tag value|No Content
|=== |===
@@ -259,10 +263,10 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -275,12 +279,15 @@ POST /pets/{petId}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of pet that needs to be updated|true|string| |*Path*|*petId* +
|FormData|name|Updated name of the pet|true|string| _required_|ID of pet that needs to be updated|string|
|FormData|status|Updated status of the pet|true|string| |*FormData*|*name* +
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string|
|=== |===
@@ -288,10 +295,10 @@ POST /pets/{petId}
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -313,10 +320,10 @@ POST /pets/{petId}
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -333,10 +340,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of pet that needs to be fetched|true|integer(int64)| |*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)|
|=== |===
@@ -344,38 +352,38 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> |*200*|successful operation|<<_pet,Pet>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
@@ -392,11 +400,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|apiKey|<<_api_key,api_key>>| |*apiKey*|*<<_api_key,api_key>>*|
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -409,11 +417,13 @@ DELETE /pets/{petId}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Header|api_key||true|string| |*Header*|*api_key* +
|Path|petId|Pet id to delete|true|integer(int64)| _required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)|
|=== |===
@@ -421,10 +431,10 @@ DELETE /pets/{petId}
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid pet value|No Content |*400*|Invalid pet value|No Content
|=== |===
@@ -441,10 +451,10 @@ DELETE /pets/{petId}
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -457,10 +467,11 @@ POST /stores/order
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|order placed for purchasing the pet|false|<<_order,Order>>| |*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|=== |===
@@ -468,29 +479,29 @@ POST /stores/order
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid Order|No Content |*400*|Invalid Order|No Content
|=== |===
@@ -518,10 +529,11 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of pet that needs to be fetched|true|string| |*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string|
|=== |===
@@ -529,38 +541,38 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -588,10 +600,11 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of the order that needs to be deleted|true|string| |*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string|
|=== |===
@@ -599,19 +612,19 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -639,10 +652,11 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Created user object|false|<<_user,User>>| |*Body*|*body* +
_optional_|Created user object|<<_user,User>>|
|=== |===
@@ -650,10 +664,10 @@ This can only be done by the logged in user.
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -677,10 +691,11 @@ POST /users/createWithArray
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -688,10 +703,10 @@ POST /users/createWithArray
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -715,10 +730,11 @@ POST /users/createWithList
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -726,10 +742,10 @@ POST /users/createWithList
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -753,11 +769,13 @@ GET /users/login
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|password|The password for login in clear text|false|string| |*Query*|*password* +
|Query|username|The user name for login|false|string| _optional_|The password for login in clear text|string|
|*Query*|*username* +
_optional_|The user name for login|string|
|=== |===
@@ -765,29 +783,29 @@ GET /users/login
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|string |*200*|successful operation|string
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username/password supplied|No Content |*400*|Invalid username/password supplied|No Content
|=== |===
@@ -813,10 +831,10 @@ GET /users/logout
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -840,10 +858,11 @@ GET /users/{username}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string| |*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string|
|=== |===
@@ -851,38 +870,38 @@ GET /users/{username}
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_user,User>> |*200*|successful operation|<<_user,User>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -910,11 +929,13 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|name that need to be deleted|true|string| |*Path*|*username* +
|Body|body|Updated user object|false|<<_user,User>>| _required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>|
|=== |===
@@ -922,19 +943,19 @@ This can only be done by the logged in user.
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid user supplied|No Content |*400*|Invalid user supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -962,10 +983,11 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be deleted|true|string| |*Path*|*username* +
_required_|The name that needs to be deleted|string|
|=== |===
@@ -973,19 +995,19 @@ This can only be done by the logged in user.
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===

16
src/test/resources/expected/asciidoc/default/security.adoc
View File

@@ -3,14 +3,18 @@
== Security == Security
=== api_key === api_key
Type : apiKey [%hardbreaks]
Name : api_key _Type_ : apiKey
In : HEADER _Name_ : api_key
_In_ : HEADER
=== petstore_auth === petstore_auth
Type : oauth2 [%hardbreaks]
Flow : implicit _Type_ : oauth2
Token URL : http://petstore.swagger.io/api/oauth/dialog _Flow_ : implicit
_Token URL_ : http://petstore.swagger.io/api/oauth/dialog
[options="header", cols="1,6"] [options="header", cols="1,6"]
|=== |===

21
src/test/resources/expected/asciidoc/enums/paths.adoc
View File

@@ -15,20 +15,23 @@ Return state
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|oldState|Old State as raw string|true|enum (ADDED, REMOVED, CHANGED)| |*Path*|*oldState* +
|Body|StateModel|State as enum in object|false|<<_createstate_statemodel,StateModel>>| _required_|Old State as raw string|enum (ADDED, REMOVED, CHANGED)|
|*Body*|*StateModel* +
_optional_|State as enum in object|<<_createstate_statemodel,StateModel>>|
|=== |===
[[_createstate_statemodel]] [[_createstate_statemodel]]
*StateModel* *StateModel*
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|value|State value|false|enum (ADDED, REMOVED, CHANGED)|| |*value* +
_optional_|State value|enum (ADDED, REMOVED, CHANGED)||
|=== |===
@@ -36,10 +39,10 @@ Return state
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|OK|enum (ADDED, REMOVED, CHANGED) |*200*|OK|enum (ADDED, REMOVED, CHANGED)
|=== |===

108
src/test/resources/expected/asciidoc/examples/definitions.adoc
View File

@@ -5,36 +5,45 @@
[[_category]] [[_category]]
=== Category === Category
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|id||false|integer(int64)||123 |*id* +
|name||false|string||"Canines" _optional_||integer(int64)||123
|*name* +
_optional_||string||"Canines"
|=== |===
[[_identified]] [[_identified]]
=== Identified === Identified
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|id||false|integer(int64)|| |*id* +
_optional_||integer(int64)||
|=== |===
[[_order]] [[_order]]
=== Order === Order
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|complete||false|boolean|| |*complete* +
|id||false|integer(int64)||77 _optional_||boolean||
|petId||false|integer(int64)|| |*id* +
|quantity||false|integer(int32)|| _optional_||integer(int64)||77
|shipDate||false|string(date-time)|| |*petId* +
|status|Order Status|false|string||"DONE" _optional_||integer(int64)||
|*quantity* +
_optional_||integer(int32)||
|*shipDate* +
_optional_||string(date-time)||
|*status* +
_optional_|Order Status|string||"DONE"
|=== |===
@@ -43,28 +52,38 @@
Test description Test description
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|category||false|<<_category,Category>>|| |*category* +
|id||false|integer(int64)|| _optional_||<<_category,Category>>||
|name||true|string||"doggie" |*id* +
|nicknames||false|<string,string> map|| _optional_||integer(int64)||
|photoUrls||true|string array|| |*name* +
|status|pet status in the store|false|string|| _required_||string||"doggie"
|tags||false|<<_tag,Tag>> array|| |*nicknames* +
|weight|the weight of the pet|false|number|| _optional_||<string,string> map||
|*photoUrls* +
_required_||string array||
|*status* +
_optional_|pet status in the store|string||
|*tags* +
_optional_||<<_tag,Tag>> array||
|*weight* +
_optional_|the weight of the pet|number||
|=== |===
[[_tag]] [[_tag]]
=== Tag === Tag
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|id||false|integer(int64)|| |*id* +
|name||false|string|| _optional_||integer(int64)||
|*name* +
_optional_||string||
|=== |===
@@ -74,18 +93,27 @@ Test description
_Polymorphism_ : Composition _Polymorphism_ : Composition
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|email||false|string|| |*email* +
|firstName||false|string|| _optional_||string||
|id||false|integer(int64)|| |*firstName* +
|lastName||false|string|| _optional_||string||
|password||false|string|| |*id* +
|phone||false|string|| _optional_||integer(int64)||
|pictures||false|string(byte) array|| |*lastName* +
|userStatus|User Status|false|integer(int32)|| _optional_||string||
|username||false|string|| |*password* +
_optional_||string||
|*phone* +
_optional_||string||
|*pictures* +
_optional_||string(byte) array||
|*userStatus* +
_optional_|User Status|integer(int32)||
|*username* +
_optional_||string||
|=== |===

296
src/test/resources/expected/asciidoc/examples/paths.adoc
View File

@@ -11,10 +11,11 @@ POST /pets
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -22,10 +23,10 @@ POST /pets
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -48,10 +49,10 @@ POST /pets
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -81,10 +82,11 @@ PUT /pets
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -92,28 +94,28 @@ PUT /pets
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Validation exception|No Content |*405*|Validation exception|No Content
|=== |===
@@ -136,10 +138,10 @@ PUT /pets
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -156,10 +158,11 @@ Multiple status values can be provided with comma seperated strings
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|status|Status values that need to be considered for filter|false|multi string array| |*Query*|*status* +
_optional_|Status values that need to be considered for filter|multi string array|
|=== |===
@@ -167,19 +170,19 @@ Multiple status values can be provided with comma seperated strings
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid status value|No Content |*400*|Invalid status value|No Content
|=== |===
@@ -196,10 +199,10 @@ Multiple status values can be provided with comma seperated strings
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -216,10 +219,11 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|tags|Tags to filter by|false|multi string array| |*Query*|*tags* +
_optional_|Tags to filter by|multi string array|
|=== |===
@@ -227,19 +231,19 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid tag value|No Content |*400*|Invalid tag value|No Content
|=== |===
@@ -256,10 +260,10 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -272,12 +276,15 @@ POST /pets/{petId}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of pet that needs to be updated|true|string| |*Path*|*petId* +
|FormData|name|Updated name of the pet|true|string| _required_|ID of pet that needs to be updated|string|
|FormData|status|Updated status of the pet|true|string| |*FormData*|*name* +
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string|
|=== |===
@@ -285,10 +292,10 @@ POST /pets/{petId}
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -310,10 +317,10 @@ POST /pets/{petId}
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -330,10 +337,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of the pet|true|integer(int64)| |*Path*|*petId* +
_required_|ID of the pet|integer(int64)|
|=== |===
@@ -341,28 +349,28 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> |*200*|successful operation|<<_pet,Pet>>
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
@@ -379,11 +387,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|apiKey|<<_api_key,api_key>>| |*apiKey*|*<<_api_key,api_key>>*|
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -396,11 +404,13 @@ DELETE /pets/{petId}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Header|api_key||true|string| |*Header*|*api_key* +
|Path|petId|Pet id to delete|true|integer(int64)| _required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)|
|=== |===
@@ -408,10 +418,10 @@ DELETE /pets/{petId}
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid pet value|No Content |*400*|Invalid pet value|No Content
|=== |===
@@ -428,10 +438,10 @@ DELETE /pets/{petId}
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -444,10 +454,11 @@ POST /stores/order
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|order placed for purchasing the pet|false|<<_order,Order>>| |*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|=== |===
@@ -455,19 +466,19 @@ POST /stores/order
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid Order|No Content |*400*|Invalid Order|No Content
|=== |===
@@ -527,10 +538,11 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of pet that needs to be fetched|true|string| |*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string|
|=== |===
@@ -538,28 +550,28 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -603,10 +615,11 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of the order that needs to be deleted|true|string| |*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string|
|=== |===
@@ -614,19 +627,19 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -654,10 +667,11 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Created user object|false|<<_user,User>>| |*Body*|*body* +
_optional_|Created user object|<<_user,User>>|
|=== |===
@@ -665,10 +679,10 @@ This can only be done by the logged in user.
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -692,10 +706,11 @@ POST /users/createWithArray
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -703,10 +718,10 @@ POST /users/createWithArray
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -730,10 +745,11 @@ POST /users/createWithList
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -741,10 +757,10 @@ POST /users/createWithList
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -768,11 +784,13 @@ GET /users/login
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|password|The password for login in clear text|false|string|testPassword |*Query*|*password* +
|Query|username|The user name for login|false|string|testUser _optional_|The password for login in clear text|string|testPassword
|*Query*|*username* +
_optional_|The user name for login|string|testUser
|=== |===
@@ -780,19 +798,19 @@ GET /users/login
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|string |*200*|successful operation|string
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username/password supplied|No Content |*400*|Invalid username/password supplied|No Content
|=== |===
@@ -818,10 +836,10 @@ GET /users/logout
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -845,10 +863,11 @@ GET /users/{username}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string|testUser |*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string|testUser
|=== |===
@@ -856,28 +875,28 @@ GET /users/{username}
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_user,User>> |*200*|successful operation|<<_user,User>>
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -905,11 +924,13 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|name that need to be deleted|true|string| |*Path*|*username* +
|Body|body|Updated user object|false|<<_user,User>>| _required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>|
|=== |===
@@ -917,19 +938,19 @@ This can only be done by the logged in user.
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid user supplied|No Content |*400*|Invalid user supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -957,10 +978,11 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be deleted|true|string| |*Path*|*username* +
_required_|The name that needs to be deleted|string|
|=== |===
@@ -968,19 +990,19 @@ This can only be done by the logged in user.
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===

16
src/test/resources/expected/asciidoc/examples/security.adoc
View File

@@ -3,14 +3,18 @@
== Security == Security
=== api_key === api_key
Type : apiKey [%hardbreaks]
Name : api_key _Type_ : apiKey
In : HEADER _Name_ : api_key
_In_ : HEADER
=== petstore_auth === petstore_auth
Type : oauth2 [%hardbreaks]
Flow : implicit _Type_ : oauth2
Token URL : http://petstore.swagger.wordnik.com/api/oauth/dialog _Flow_ : implicit
_Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog
[options="header", cols="1,6"] [options="header", cols="1,6"]
|=== |===

108
src/test/resources/expected/asciidoc/generated_examples/definitions.adoc
View File

@@ -5,36 +5,45 @@
[[_category]] [[_category]]
=== Category === Category
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|id||false|integer(int64)||123 |*id* +
|name||false|string||"Canines" _optional_||integer(int64)||123
|*name* +
_optional_||string||"Canines"
|=== |===
[[_identified]] [[_identified]]
=== Identified === Identified
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|id||false|integer(int64)||0 |*id* +
_optional_||integer(int64)||0
|=== |===
[[_order]] [[_order]]
=== Order === Order
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|complete||false|boolean||true |*complete* +
|id||false|integer(int64)||77 _optional_||boolean||true
|petId||false|integer(int64)||0 |*id* +
|quantity||false|integer(int32)||0 _optional_||integer(int64)||77
|shipDate||false|string(date-time)||"string" |*petId* +
|status|Order Status|false|string||"DONE" _optional_||integer(int64)||0
|*quantity* +
_optional_||integer(int32)||0
|*shipDate* +
_optional_||string(date-time)||"string"
|*status* +
_optional_|Order Status|string||"DONE"
|=== |===
@@ -43,30 +52,40 @@
Test description Test description
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|category||false|<<_category,Category>>||"<<_category>>" |*category* +
|id||false|integer(int64)||0 _optional_||<<_category,Category>>||"<<_category>>"
|name||true|string||"doggie" |*id* +
|nicknames||false|<string,string> map||{ _optional_||integer(int64)||0
|*name* +
_required_||string||"doggie"
|*nicknames* +
_optional_||<string,string> map||{
"string" : "string" "string" : "string"
} }
|photoUrls||true|string array||[ "string" ] |*photoUrls* +
|status|pet status in the store|false|string||"string" _required_||string array||[ "string" ]
|tags||false|<<_tag,Tag>> array||[ "<<_tag>>" ] |*status* +
|weight|the weight of the pet|false|number||0.0 _optional_|pet status in the store|string||"string"
|*tags* +
_optional_||<<_tag,Tag>> array||[ "<<_tag>>" ]
|*weight* +
_optional_|the weight of the pet|number||0.0
|=== |===
[[_tag]] [[_tag]]
=== Tag === Tag
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|id||false|integer(int64)||0 |*id* +
|name||false|string||"string" _optional_||integer(int64)||0
|*name* +
_optional_||string||"string"
|=== |===
@@ -76,18 +95,27 @@ Test description
_Polymorphism_ : Composition _Polymorphism_ : Composition
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|email||false|string||"string" |*email* +
|firstName||false|string||"string" _optional_||string||"string"
|id||false|integer(int64)||0 |*firstName* +
|lastName||false|string||"string" _optional_||string||"string"
|password||false|string||"string" |*id* +
|phone||false|string||"string" _optional_||integer(int64)||0
|pictures||false|string(byte) array||[ "string" ] |*lastName* +
|userStatus|User Status|false|integer(int32)||0 _optional_||string||"string"
|username||false|string||"string" |*password* +
_optional_||string||"string"
|*phone* +
_optional_||string||"string"
|*pictures* +
_optional_||string(byte) array||[ "string" ]
|*userStatus* +
_optional_|User Status|integer(int32)||0
|*username* +
_optional_||string||"string"
|=== |===

296
src/test/resources/expected/asciidoc/generated_examples/paths.adoc
View File

@@ -11,10 +11,11 @@ POST /pets
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -22,10 +23,10 @@ POST /pets
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -48,10 +49,10 @@ POST /pets
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -114,10 +115,11 @@ PUT /pets
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -125,28 +127,28 @@ PUT /pets
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Validation exception|No Content |*405*|Validation exception|No Content
|=== |===
@@ -169,10 +171,10 @@ PUT /pets
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -222,10 +224,11 @@ Multiple status values can be provided with comma seperated strings
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|status|Status values that need to be considered for filter|false|multi string array| |*Query*|*status* +
_optional_|Status values that need to be considered for filter|multi string array|
|=== |===
@@ -233,19 +236,19 @@ Multiple status values can be provided with comma seperated strings
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid status value|No Content |*400*|Invalid status value|No Content
|=== |===
@@ -262,10 +265,10 @@ Multiple status values can be provided with comma seperated strings
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -309,10 +312,11 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|tags|Tags to filter by|false|multi string array| |*Query*|*tags* +
_optional_|Tags to filter by|multi string array|
|=== |===
@@ -320,19 +324,19 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid tag value|No Content |*400*|Invalid tag value|No Content
|=== |===
@@ -349,10 +353,10 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -392,12 +396,15 @@ POST /pets/{petId}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of pet that needs to be updated|true|string| |*Path*|*petId* +
|FormData|name|Updated name of the pet|true|string| _required_|ID of pet that needs to be updated|string|
|FormData|status|Updated status of the pet|true|string| |*FormData*|*name* +
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string|
|=== |===
@@ -405,10 +412,10 @@ POST /pets/{petId}
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -430,10 +437,10 @@ POST /pets/{petId}
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -466,10 +473,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of the pet|true|integer(int64)| |*Path*|*petId* +
_required_|ID of the pet|integer(int64)|
|=== |===
@@ -477,28 +485,28 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> |*200*|successful operation|<<_pet,Pet>>
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
@@ -515,11 +523,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|apiKey|<<_api_key,api_key>>| |*apiKey*|*<<_api_key,api_key>>*|
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -567,11 +575,13 @@ DELETE /pets/{petId}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Header|api_key||true|string| |*Header*|*api_key* +
|Path|petId|Pet id to delete|true|integer(int64)| _required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)|
|=== |===
@@ -579,10 +589,10 @@ DELETE /pets/{petId}
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid pet value|No Content |*400*|Invalid pet value|No Content
|=== |===
@@ -599,10 +609,10 @@ DELETE /pets/{petId}
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -631,10 +641,11 @@ POST /stores/order
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|order placed for purchasing the pet|false|<<_order,Order>>| |*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|=== |===
@@ -642,19 +653,19 @@ POST /stores/order
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid Order|No Content |*400*|Invalid Order|No Content
|=== |===
@@ -721,10 +732,11 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of pet that needs to be fetched|true|string| |*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string|
|=== |===
@@ -732,28 +744,28 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -806,10 +818,11 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of the order that needs to be deleted|true|string| |*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string|
|=== |===
@@ -817,19 +830,19 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -866,10 +879,11 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Created user object|false|<<_user,User>>| |*Body*|*body* +
_optional_|Created user object|<<_user,User>>|
|=== |===
@@ -877,10 +891,10 @@ This can only be done by the logged in user.
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -930,10 +944,11 @@ POST /users/createWithArray
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -941,10 +956,10 @@ POST /users/createWithArray
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -994,10 +1009,11 @@ POST /users/createWithList
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -1005,10 +1021,10 @@ POST /users/createWithList
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -1058,11 +1074,13 @@ GET /users/login
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|password|The password for login in clear text|false|string|testPassword |*Query*|*password* +
|Query|username|The user name for login|false|string|testUser _optional_|The password for login in clear text|string|testPassword
|*Query*|*username* +
_optional_|The user name for login|string|testUser
|=== |===
@@ -1070,19 +1088,19 @@ GET /users/login
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|string |*200*|successful operation|string
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username/password supplied|No Content |*400*|Invalid username/password supplied|No Content
|=== |===
@@ -1136,10 +1154,10 @@ GET /users/logout
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -1172,10 +1190,11 @@ GET /users/{username}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string|testUser |*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string|testUser
|=== |===
@@ -1183,28 +1202,28 @@ GET /users/{username}
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_user,User>> |*200*|successful operation|<<_user,User>>
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -1260,11 +1279,13 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|name that need to be deleted|true|string| |*Path*|*username* +
|Body|body|Updated user object|false|<<_user,User>>| _required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>|
|=== |===
@@ -1272,19 +1293,19 @@ This can only be done by the logged in user.
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid user supplied|No Content |*400*|Invalid user supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -1338,10 +1359,11 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be deleted|true|string| |*Path*|*username* +
_required_|The name that needs to be deleted|string|
|=== |===
@@ -1349,19 +1371,19 @@ This can only be done by the logged in user.
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===

16
src/test/resources/expected/asciidoc/generated_examples/security.adoc
View File

@@ -3,14 +3,18 @@
== Security == Security
=== api_key === api_key
Type : apiKey [%hardbreaks]
Name : api_key _Type_ : apiKey
In : HEADER _Name_ : api_key
_In_ : HEADER
=== petstore_auth === petstore_auth
Type : oauth2 [%hardbreaks]
Flow : implicit _Type_ : oauth2
Token URL : http://petstore.swagger.wordnik.com/api/oauth/dialog _Flow_ : implicit
_Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog
[options="header", cols="1,6"] [options="header", cols="1,6"]
|=== |===

92
src/test/resources/expected/asciidoc/group_by_tags/definitions.adoc
View File

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

352
src/test/resources/expected/asciidoc/group_by_tags/paths.adoc
View File

@@ -15,10 +15,11 @@ POST /pets
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -26,10 +27,10 @@ POST /pets
====== HTTP Code 405 ====== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -47,10 +48,10 @@ POST /pets
===== Security ===== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -63,10 +64,11 @@ PUT /pets
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -74,28 +76,28 @@ PUT /pets
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
====== HTTP Code 404 ====== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
====== HTTP Code 405 ====== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Validation exception|No Content |*405*|Validation exception|No Content
|=== |===
@@ -113,10 +115,10 @@ PUT /pets
===== Security ===== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -133,10 +135,11 @@ Multiple status values can be provided with comma seperated strings
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|status|Status values that need to be considered for filter|false|multi string array| |*Query*|*status* +
_optional_|Status values that need to be considered for filter|multi string array|
|=== |===
@@ -144,29 +147,29 @@ Multiple status values can be provided with comma seperated strings
====== HTTP Code 200 ====== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid status value|No Content |*400*|Invalid status value|No Content
|=== |===
@@ -178,10 +181,10 @@ Multiple status values can be provided with comma seperated strings
===== Security ===== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -198,10 +201,11 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|tags|Tags to filter by|false|multi string array| |*Query*|*tags* +
_optional_|Tags to filter by|multi string array|
|=== |===
@@ -209,29 +213,29 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
====== HTTP Code 200 ====== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid tag value|No Content |*400*|Invalid tag value|No Content
|=== |===
@@ -243,10 +247,10 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
===== Security ===== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -259,12 +263,15 @@ POST /pets/{petId}
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of pet that needs to be updated|true|string| |*Path*|*petId* +
|FormData|name|Updated name of the pet|true|string| _required_|ID of pet that needs to be updated|string|
|FormData|status|Updated status of the pet|true|string| |*FormData*|*name* +
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string|
|=== |===
@@ -272,10 +279,10 @@ POST /pets/{petId}
====== HTTP Code 405 ====== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -292,10 +299,10 @@ POST /pets/{petId}
===== Security ===== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -312,10 +319,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of pet that needs to be fetched|true|integer(int64)| |*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)|
|=== |===
@@ -323,38 +331,38 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
====== HTTP Code 200 ====== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> |*200*|successful operation|<<_pet,Pet>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
====== HTTP Code 404 ====== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
@@ -366,11 +374,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
===== Security ===== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|apiKey|<<_api_key,api_key>>| |*apiKey*|*<<_api_key,api_key>>*|
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -383,11 +391,13 @@ DELETE /pets/{petId}
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Header|api_key||true|string| |*Header*|*api_key* +
|Path|petId|Pet id to delete|true|integer(int64)| _required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)|
|=== |===
@@ -395,10 +405,10 @@ DELETE /pets/{petId}
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid pet value|No Content |*400*|Invalid pet value|No Content
|=== |===
@@ -410,10 +420,10 @@ DELETE /pets/{petId}
===== Security ===== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -430,10 +440,11 @@ POST /stores/order
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|order placed for purchasing the pet|false|<<_order,Order>>| |*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|=== |===
@@ -441,29 +452,29 @@ POST /stores/order
====== HTTP Code 200 ====== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid Order|No Content |*400*|Invalid Order|No Content
|=== |===
@@ -486,10 +497,11 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of pet that needs to be fetched|true|string| |*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string|
|=== |===
@@ -497,38 +509,38 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
====== HTTP Code 200 ====== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
====== HTTP Code 404 ====== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -551,10 +563,11 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of the order that needs to be deleted|true|string| |*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string|
|=== |===
@@ -562,19 +575,19 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
====== HTTP Code 404 ====== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -601,10 +614,11 @@ This can only be done by the logged in user.
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Created user object|false|<<_user,User>>| |*Body*|*body* +
_optional_|Created user object|<<_user,User>>|
|=== |===
@@ -612,10 +626,10 @@ This can only be done by the logged in user.
====== HTTP Code default ====== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -634,10 +648,11 @@ POST /users/createWithArray
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -645,10 +660,10 @@ POST /users/createWithArray
====== HTTP Code default ====== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -667,10 +682,11 @@ POST /users/createWithList
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -678,10 +694,10 @@ POST /users/createWithList
====== HTTP Code default ====== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -700,11 +716,13 @@ GET /users/login
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|password|The password for login in clear text|false|string| |*Query*|*password* +
|Query|username|The user name for login|false|string| _optional_|The password for login in clear text|string|
|*Query*|*username* +
_optional_|The user name for login|string|
|=== |===
@@ -712,29 +730,29 @@ GET /users/login
====== HTTP Code 200 ====== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|string |*200*|successful operation|string
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username/password supplied|No Content |*400*|Invalid username/password supplied|No Content
|=== |===
@@ -755,10 +773,10 @@ GET /users/logout
====== HTTP Code default ====== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -777,10 +795,11 @@ GET /users/{username}
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string| |*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string|
|=== |===
@@ -788,38 +807,38 @@ GET /users/{username}
====== HTTP Code 200 ====== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_user,User>> |*200*|successful operation|<<_user,User>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
====== HTTP Code 404 ====== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -842,11 +861,13 @@ This can only be done by the logged in user.
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|name that need to be deleted|true|string| |*Path*|*username* +
|Body|body|Updated user object|false|<<_user,User>>| _required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>|
|=== |===
@@ -854,19 +875,19 @@ This can only be done by the logged in user.
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid user supplied|No Content |*400*|Invalid user supplied|No Content
|=== |===
====== HTTP Code 404 ====== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -889,10 +910,11 @@ This can only be done by the logged in user.
===== Parameters ===== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be deleted|true|string| |*Path*|*username* +
_required_|The name that needs to be deleted|string|
|=== |===
@@ -900,19 +922,19 @@ This can only be done by the logged in user.
====== HTTP Code 400 ====== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
====== HTTP Code 404 ====== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===

16
src/test/resources/expected/asciidoc/group_by_tags/security.adoc
View File

@@ -3,14 +3,18 @@
== Security == Security
=== api_key === api_key
Type : apiKey [%hardbreaks]
Name : api_key _Type_ : apiKey
In : HEADER _Name_ : api_key
_In_ : HEADER
=== petstore_auth === petstore_auth
Type : oauth2 [%hardbreaks]
Flow : implicit _Type_ : oauth2
Token URL : http://petstore.swagger.io/api/oauth/dialog _Flow_ : implicit
_Token URL_ : http://petstore.swagger.io/api/oauth/dialog
[options="header", cols="1,6"] [options="header", cols="1,6"]
|=== |===

51
src/test/resources/expected/asciidoc/inline_schema/definitions.adoc
View File

@@ -5,61 +5,70 @@
[[_error]] [[_error]]
=== Error === Error
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|error-code|Error code|false|integer|| |*error-code* +
|message|Error message|false|string|| _optional_|Error code|integer||
|*message* +
_optional_|Error message|string||
|=== |===
[[_externallocation]] [[_externallocation]]
=== ExternalLocation === ExternalLocation
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|Place|Place|false|string|| |*Place* +
_optional_|Place|string||
|=== |===
[[_inlinedepthschema]] [[_inlinedepthschema]]
=== InlineDepthSchema === InlineDepthSchema
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|Loop||false|<<_inlinedepthschema_loop,Loop>>|| |*Loop* +
_optional_||<<_inlinedepthschema_loop,Loop>>||
|=== |===
[[_inlinedepthschema_loop]] [[_inlinedepthschema_loop]]
*Loop* *Loop*
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|p1|Description p1|false|string|| |*p1* +
|p2|Description p2|false|<<_inlinedepthschema_p2,p2>>|| _optional_|Description p1|string||
|*p2* +
_optional_|Description p2|<<_inlinedepthschema_p2,p2>>||
|=== |===
[[_inlinedepthschema_p2]] [[_inlinedepthschema_p2]]
*p2* *p2*
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|p2-1|Description p2-1|false|string|| |*p2-1* +
|p2-2|Description p2-2|false|object|| _optional_|Description p2-1|string||
|*p2-2* +
_optional_|Description p2-2|object||
|=== |===
[[_location]] [[_location]]
=== Location === Location
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|Place|Place|false|string|| |*Place* +
_optional_|Place|string||
|=== |===

62
src/test/resources/expected/asciidoc/inline_schema/paths.adoc
View File

@@ -15,33 +15,41 @@ Dummy description
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|Option|An optional option|false|string| |*Query*|*Option* +
|Query|Version|The API version|false|string| _optional_|An optional option|string|
|Body|LaunchCommandRequest|Launch something new|false|<<_launchcommand_post_launchcommandrequest,LaunchCommandRequest>>| |*Query*|*Version* +
_optional_|The API version|string|
|*Body*|*LaunchCommandRequest* +
_optional_|Launch something new|<<_launchcommand_post_launchcommandrequest,LaunchCommandRequest>>|
|=== |===
[[_launchcommand_post_launchcommandrequest]] [[_launchcommand_post_launchcommandrequest]]
*LaunchCommandRequest* *LaunchCommandRequest*
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|Command|Dummy description|true|<<_launchcommand_post_command,Command>>|| |*Command* +
|Location|Dummy description|false|<<_location,Location>>|| _required_|Dummy description|<<_launchcommand_post_command,Command>>||
|Options|Dummy description|false|string|| |*Location* +
_optional_|Dummy description|<<_location,Location>>||
|*Options* +
_optional_|Dummy description|string||
|=== |===
[[_launchcommand_post_command]] [[_launchcommand_post_command]]
*Command* *Command*
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|args|Command arguments|false|string|| |*args* +
|path|Command path|false|string|| _optional_|Command arguments|string||
|*path* +
_optional_|Command path|string||
|=== |===
@@ -49,39 +57,41 @@ Dummy description
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|Result|<<_launchcommand_post_response_200,Response 200>> |*200*|Result|<<_launchcommand_post_response_200,Response 200>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Error|<<_error,Error>> |*400*|Error|<<_error,Error>>
|=== |===
[[_launchcommand_post_response_200]] [[_launchcommand_post_response_200]]
*Response 200* *Response 200*
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|Location|<description>|false|<<_location,Location>>|| |*Location* +
|ReservationId|<description>|false|string|| _optional_|<description>|<<_location,Location>>||
|*ReservationId* +
_optional_|<description>|string||
|=== |===

16
src/test/resources/expected/asciidoc/maps/definitions.adoc
View File

@@ -7,13 +7,17 @@
Information about a given HTTP mapping. Information about a given HTTP mapping.
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|bean|Unique name of the bean which handles the given mapping.|false|string|| |*bean* +
|method|The signature of the method which processes requests to the given mapping.|false|string|| _optional_|Unique name of the bean which handles the given mapping.|string||
|tags||false|<string,string> map|| |*method* +
|type|The class which processes requests to the given mapping.|false|string|| _optional_|The signature of the method which processes requests to the given mapping.|string||
|*tags* +
_optional_||<string,string> map||
|*type* +
_optional_|The class which processes requests to the given mapping.|string||
|=== |===

44
src/test/resources/expected/asciidoc/maps/paths.adoc
View File

@@ -15,10 +15,11 @@ Returns integer metrics information for the application.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|String metrics|false|<string,integer(int32)> map| |*Body*|*body* +
_optional_|String metrics|<string,integer(int32)> map|
|=== |===
@@ -26,10 +27,10 @@ Returns integer metrics information for the application.
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|OK|<string,string> map |*200*|OK|<string,string> map
|=== |===
@@ -61,10 +62,11 @@ Returns a collated list of all `@RequestMapping` paths.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Mappings|false|<string,<<_mappinginfo,MappingInfo>>> map| |*Body*|*body* +
_optional_|Mappings|<string,<<_mappinginfo,MappingInfo>>> map|
|=== |===
@@ -72,10 +74,10 @@ Returns a collated list of all `@RequestMapping` paths.
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|OK|<string,<<_mappinginfo,MappingInfo>>> map |*200*|OK|<string,<<_mappinginfo,MappingInfo>>> map
|=== |===
@@ -107,10 +109,11 @@ Returns metrics information for the application.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Metrics|false|<string,object> map| |*Body*|*body* +
_optional_|Metrics|<string,object> map|
|=== |===
@@ -118,10 +121,10 @@ Returns metrics information for the application.
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|OK|<string,object> map |*200*|OK|<string,object> map
|=== |===
@@ -153,10 +156,11 @@ Returns string metrics information for the application.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|String metrics|false|<string,string> map| |*Body*|*body* +
_optional_|String metrics|<string,string> map|
|=== |===
@@ -164,10 +168,10 @@ Returns string metrics information for the application.
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|OK|<string,string> map |*200*|OK|<string,string> map
|=== |===

66
src/test/resources/expected/asciidoc/polymorphism/definitions.adoc
View File

@@ -11,11 +11,13 @@ _Polymorphism_ : Inheritance
_Discriminator_ : collType _Discriminator_ : collType
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|collType|collection type discriminator|true|string|| |*collType* +
|name||false|string|| _required_|collection type discriminator|string||
|*name* +
_optional_||string||
|=== |===
@@ -28,12 +30,15 @@ _Polymorphism_ : Inheritance
_Discriminator_ : petType _Discriminator_ : petType
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|huntingSkill|The measured skill for hunting|true|enum (clueless, lazy, adventurous, aggressive)|lazy| |*huntingSkill* +
|name|conflicting property with inheriting model (issue #44)|false|string|| _required_|The measured skill for hunting|enum (clueless, lazy, adventurous, aggressive)|lazy|
|petType||true|string|| |*name* +
_optional_|conflicting property with inheriting model (issue #44)|string||
|*petType* +
_required_||string||
|=== |===
@@ -42,10 +47,11 @@ _Discriminator_ : petType
Collection parent type without discriminator Collection parent type without discriminator
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|name||false|string|| |*name* +
_optional_||string||
|=== |===
@@ -58,13 +64,17 @@ _Polymorphism_ : Inheritance
_Discriminator_ : dogType _Discriminator_ : dogType
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|dogType||true|string|| |*dogType* +
|name||true|string|| _required_||string||
|packSize|the size of the pack the dog is from|true|integer(int32)|0| |*name* +
|petType||true|string|| _required_||string||
|*packSize* +
_required_|the size of the pack the dog is from|integer(int32)|0|
|*petType* +
_required_||string||
|=== |===
@@ -76,11 +86,13 @@ A map without discriminator
_Polymorphism_ : Composition _Polymorphism_ : Composition
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|collType|collection type discriminator|true|string|| |*collType* +
|name||false|string|| _required_|collection type discriminator|string||
|*name* +
_optional_||string||
|=== |===
@@ -89,11 +101,13 @@ _Polymorphism_ : Composition
Pet parent type with discriminator Pet parent type with discriminator
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|name||true|string|| |*name* +
|petType||true|string|| _required_||string||
|*petType* +
_required_||string||
|=== |===

8
src/test/resources/expected/asciidoc/polymorphism/paths.adoc
View File

@@ -17,10 +17,10 @@ Get collections
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|OK|<<_collection,Collection>> |*200*|OK|<<_collection,Collection>>
|=== |===
@@ -49,10 +49,10 @@ Get pets
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|OK|<<_pet,Pet>> |*200*|OK|<<_pet,Pet>>
|=== |===

460
src/test/resources/expected/asciidoc/toFile/outputFile.adoc
View File

@@ -55,10 +55,11 @@ POST /pets
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -66,10 +67,10 @@ POST /pets
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -92,10 +93,10 @@ POST /pets
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -137,10 +138,11 @@ PUT /pets
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| |*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|=== |===
@@ -148,28 +150,28 @@ PUT /pets
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Validation exception|No Content |*405*|Validation exception|No Content
|=== |===
@@ -192,10 +194,10 @@ PUT /pets
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -241,10 +243,11 @@ Multiple status values can be provided with comma seperated strings
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|status|Status values that need to be considered for filter|false|multi string array| |*Query*|*status* +
_optional_|Status values that need to be considered for filter|multi string array|
|=== |===
@@ -252,29 +255,29 @@ Multiple status values can be provided with comma seperated strings
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid status value|No Content |*400*|Invalid status value|No Content
|=== |===
@@ -291,10 +294,10 @@ Multiple status values can be provided with comma seperated strings
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -338,10 +341,11 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|tags|Tags to filter by|false|multi string array| |*Query*|*tags* +
_optional_|Tags to filter by|multi string array|
|=== |===
@@ -349,29 +353,29 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> array |*200*|successful operation|<<_pet,Pet>> array
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid tag value|No Content |*400*|Invalid tag value|No Content
|=== |===
@@ -388,10 +392,10 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -431,12 +435,15 @@ POST /pets/{petId}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of pet that needs to be updated|true|string| |*Path*|*petId* +
|FormData|name|Updated name of the pet|true|string| _required_|ID of pet that needs to be updated|string|
|FormData|status|Updated status of the pet|true|string| |*FormData*|*name* +
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string|
|=== |===
@@ -444,10 +451,10 @@ POST /pets/{petId}
===== HTTP Code 405 ===== HTTP Code 405
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|405|Invalid input|No Content |*405*|Invalid input|No Content
|=== |===
@@ -469,10 +476,10 @@ POST /pets/{petId}
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -505,10 +512,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|petId|ID of pet that needs to be fetched|true|integer(int64)| |*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)|
|=== |===
@@ -516,38 +524,38 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_pet,Pet>> |*200*|successful operation|<<_pet,Pet>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Pet not found|No Content |*404*|Pet not found|No Content
|=== |===
@@ -564,11 +572,11 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|apiKey|<<_api_key,api_key>>| |*apiKey*|*<<_api_key,api_key>>*|
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -612,11 +620,13 @@ DELETE /pets/{petId}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Header|api_key||true|string| |*Header*|*api_key* +
|Path|petId|Pet id to delete|true|integer(int64)| _required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)|
|=== |===
@@ -624,10 +634,10 @@ DELETE /pets/{petId}
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid pet value|No Content |*400*|Invalid pet value|No Content
|=== |===
@@ -644,10 +654,10 @@ DELETE /pets/{petId}
==== Security ==== Security
[options="header", cols=".^1h,.^1h,.^6"] [options="header", cols=".^1,.^1,.^6"]
|=== |===
|Type|Name|Scopes |Type|Name|Scopes
|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets |*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|=== |===
@@ -676,10 +686,11 @@ POST /stores/order
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|order placed for purchasing the pet|false|<<_order,Order>>| |*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|=== |===
@@ -687,29 +698,29 @@ POST /stores/order
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid Order|No Content |*400*|Invalid Order|No Content
|=== |===
@@ -776,10 +787,11 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of pet that needs to be fetched|true|string| |*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string|
|=== |===
@@ -787,38 +799,38 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_order,Order>> |*200*|successful operation|<<_order,Order>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -871,10 +883,11 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|orderId|ID of the order that needs to be deleted|true|string| |*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string|
|=== |===
@@ -882,19 +895,19 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content |*400*|Invalid ID supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|Order not found|No Content |*404*|Order not found|No Content
|=== |===
@@ -931,10 +944,11 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|Created user object|false|<<_user,User>>| |*Body*|*body* +
_optional_|Created user object|<<_user,User>>|
|=== |===
@@ -942,10 +956,10 @@ This can only be done by the logged in user.
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -994,10 +1008,11 @@ POST /users/createWithArray
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -1005,10 +1020,10 @@ POST /users/createWithArray
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -1057,10 +1072,11 @@ POST /users/createWithList
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Body|body|List of user object|false|<<_user,User>> array| |*Body*|*body* +
_optional_|List of user object|<<_user,User>> array|
|=== |===
@@ -1068,10 +1084,10 @@ POST /users/createWithList
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -1120,11 +1136,13 @@ GET /users/login
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Query|password|The password for login in clear text|false|string| |*Query*|*password* +
|Query|username|The user name for login|false|string| _optional_|The password for login in clear text|string|
|*Query*|*username* +
_optional_|The user name for login|string|
|=== |===
@@ -1132,29 +1150,29 @@ GET /users/login
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|string |*200*|successful operation|string
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username/password supplied|No Content |*400*|Invalid username/password supplied|No Content
|=== |===
@@ -1208,10 +1226,10 @@ GET /users/logout
===== HTTP Code default ===== HTTP Code default
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|default|successful operation|No Content |*default*|successful operation|No Content
|=== |===
@@ -1244,10 +1262,11 @@ GET /users/{username}
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string| |*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string|
|=== |===
@@ -1255,38 +1274,38 @@ GET /users/{username}
===== HTTP Code 200 ===== HTTP Code 200
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|200|successful operation|<<_user,User>> |*200*|successful operation|<<_user,User>>
|=== |===
*Headers* *Headers*
[options="header", cols=".^1h,.^3,.^1,.^1"] [options="header", cols=".^1,.^3,.^1,.^1"]
|=== |===
|Name|Description|Schema|Default |Name|Description|Schema|Default
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| |*X-Rate-Limit-Limit*|The number of allowed requests in the current period|integer|
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| |*X-Rate-Limit-Remaining*|The number of remaining requests in the current period|integer|
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| |*X-Rate-Limit-Reset*|The number of seconds left in the current period|integer|
|=== |===
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -1341,11 +1360,13 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|name that need to be deleted|true|string| |*Path*|*username* +
|Body|body|Updated user object|false|<<_user,User>>| _required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>|
|=== |===
@@ -1353,19 +1374,19 @@ This can only be done by the logged in user.
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid user supplied|No Content |*400*|Invalid user supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -1418,10 +1439,11 @@ This can only be done by the logged in user.
==== Parameters ==== Parameters
[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] [options="header", cols=".^1,.^1,.^6,.^1,.^1"]
|=== |===
|Type|Name|Description|Required|Schema|Default |Type|Name|Description|Schema|Default
|Path|username|The name that needs to be deleted|true|string| |*Path*|*username* +
_required_|The name that needs to be deleted|string|
|=== |===
@@ -1429,19 +1451,19 @@ This can only be done by the logged in user.
===== HTTP Code 400 ===== HTTP Code 400
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|400|Invalid username supplied|No Content |*400*|Invalid username supplied|No Content
|=== |===
===== HTTP Code 404 ===== HTTP Code 404
[options="header", cols=".^1h,.^3,.^1"] [options="header", cols=".^1,.^3,.^1"]
|=== |===
|HTTP Code|Description|Schema |HTTP Code|Description|Schema
|404|User not found|No Content |*404*|User not found|No Content
|=== |===
@@ -1473,69 +1495,93 @@ This can only be done by the logged in user.
[[_category]] [[_category]]
=== Category === Category
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|id||false|integer(int64)||0 |*id* +
|name||false|string||"string" _optional_||integer(int64)||0
|*name* +
_optional_||string||"string"
|=== |===
[[_order]] [[_order]]
=== Order === Order
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|complete||false|boolean||true |*complete* +
|id||false|integer(int64)||0 _optional_||boolean||true
|petId||false|integer(int64)||0 |*id* +
|quantity||false|integer(int32)||0 _optional_||integer(int64)||0
|shipDate||false|string(date-time)||"string" |*petId* +
|status|Order Status|false|enum (Ordered, Cancelled)||"string" _optional_||integer(int64)||0
|*quantity* +
_optional_||integer(int32)||0
|*shipDate* +
_optional_||string(date-time)||"string"
|*status* +
_optional_|Order Status|enum (Ordered, Cancelled)||"string"
|=== |===
[[_pet]] [[_pet]]
=== Pet === Pet
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|category||false|<<_category,Category>>||"<<_category>>" |*category* +
|id||false|integer(int64)||0 _optional_||<<_category,Category>>||"<<_category>>"
|name||true|string||"doggie" |*id* +
|photoUrls||true|string array||[ "string" ] _optional_||integer(int64)||0
|status|pet status in the store,|false|enum (Dead, Alive)||"string" |*name* +
|tags||false|<<_tag,Tag>> array||[ "<<_tag>>" ] _required_||string||"doggie"
|*photoUrls* +
_required_||string array||[ "string" ]
|*status* +
_optional_|pet status in the store,|enum (Dead, Alive)||"string"
|*tags* +
_optional_||<<_tag,Tag>> array||[ "<<_tag>>" ]
|=== |===
[[_tag]] [[_tag]]
=== Tag === Tag
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|id||false|integer(int64)||0 |*id* +
|name||false|string||"string" _optional_||integer(int64)||0
|*name* +
_optional_||string||"string"
|=== |===
[[_user]] [[_user]]
=== User === User
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"] [options="header", cols=".^1,.^6,.^1,.^1,.^1"]
|=== |===
|Name|Description|Required|Schema|Default|Example |Name|Description|Schema|Default|Example
|email||false|string||"string" |*email* +
|firstName||false|string||"string" _optional_||string||"string"
|id||false|integer(int64)||0 |*firstName* +
|lastName||false|string||"string" _optional_||string||"string"
|password||false|string||"string" |*id* +
|phone||false|string||"string" _optional_||integer(int64)||0
|userStatus|User Status|false|integer(int32)||0 |*lastName* +
|username||false|string||"string" _optional_||string||"string"
|*password* +
_optional_||string||"string"
|*phone* +
_optional_||string||"string"
|*userStatus* +
_optional_|User Status|integer(int32)||0
|*username* +
_optional_||string||"string"
|=== |===
@@ -1545,14 +1591,18 @@ This can only be done by the logged in user.
== Security == Security
=== api_key === api_key
Type : apiKey [%hardbreaks]
Name : api_key _Type_ : apiKey
In : HEADER _Name_ : api_key
_In_ : HEADER
=== petstore_auth === petstore_auth
Type : oauth2 [%hardbreaks]
Flow : implicit _Type_ : oauth2
Token URL : http://petstore.swagger.io/api/oauth/dialog _Flow_ : implicit
_Token URL_ : http://petstore.swagger.io/api/oauth/dialog
[options="header", cols="1,6"] [options="header", cols="1,6"]
|=== |===

68
src/test/resources/expected/markdown/default/definitions.md
View File

@@ -5,60 +5,60 @@
<a name="category"></a> <a name="category"></a>
### Category ### Category
|Name|Description|Required|Schema|Default|Example| |Name|Description|Schema|Default|Example|
|---|---|---|---|---|---| |---|---|---|---|---|
|id||false|integer(int64)||| |**id** <br>*optional*||integer(int64)|||
|name||false|string||| |**name** <br>*optional*||string|||
<a name="order"></a> <a name="order"></a>
### Order ### Order
|Name|Description|Required|Schema|Default|Example| |Name|Description|Schema|Default|Example|
|---|---|---|---|---|---| |---|---|---|---|---|
|complete||false|boolean||| |**complete** <br>*optional*||boolean|||
|id||false|integer(int64)||| |**id** <br>*optional*||integer(int64)|||
|petId||false|integer(int64)||| |**petId** <br>*optional*||integer(int64)|||
|quantity||false|integer(int32)||| |**quantity** <br>*optional*||integer(int32)|||
|shipDate||false|string(date-time)||| |**shipDate** <br>*optional*||string(date-time)|||
|status|Order Status|false|enum (Ordered, Cancelled)||| |**status** <br>*optional*|Order Status|enum (Ordered, Cancelled)|||
<a name="pet"></a> <a name="pet"></a>
### Pet ### Pet
|Name|Description|Required|Schema|Default|Example| |Name|Description|Schema|Default|Example|
|---|---|---|---|---|---| |---|---|---|---|---|
|category||false|[Category](#category)||| |**category** <br>*optional*||[Category](#category)|||
|id||false|integer(int64)||| |**id** <br>*optional*||integer(int64)|||
|name||true|string||"doggie"| |**name** <br>*required*||string||"doggie"|
|photoUrls||true|string array||| |**photoUrls** <br>*required*||string array|||
|status|pet status in the store,|false|enum (Dead, Alive)||| |**status** <br>*optional*|pet status in the store,|enum (Dead, Alive)|||
|tags||false|[Tag](#tag) array||| |**tags** <br>*optional*||[Tag](#tag) array|||
<a name="tag"></a> <a name="tag"></a>
### Tag ### Tag
|Name|Description|Required|Schema|Default|Example| |Name|Description|Schema|Default|Example|
|---|---|---|---|---|---| |---|---|---|---|---|
|id||false|integer(int64)||| |**id** <br>*optional*||integer(int64)|||
|name||false|string||| |**name** <br>*optional*||string|||
<a name="user"></a> <a name="user"></a>
### User ### User
|Name|Description|Required|Schema|Default|Example| |Name|Description|Schema|Default|Example|
|---|---|---|---|---|---| |---|---|---|---|---|
|email||false|string||| |**email** <br>*optional*||string|||
|firstName||false|string||| |**firstName** <br>*optional*||string|||
|id||false|integer(int64)||| |**id** <br>*optional*||integer(int64)|||
|lastName||false|string||| |**lastName** <br>*optional*||string|||
|password||false|string||| |**password** <br>*optional*||string|||
|phone||false|string||| |**phone** <br>*optional*||string|||
|userStatus|User Status|false|integer(int32)||| |**userStatus** <br>*optional*|User Status|integer(int32)|||
|username||false|string||| |**username** <br>*optional*||string|||

236
src/test/resources/expected/markdown/default/paths.md
View File

@@ -11,9 +11,9 @@ POST /pets
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Body|body|Pet object that needs to be added to the store|false|[Pet](#pet)|| |**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](#pet)||
#### Responses #### Responses
@@ -22,7 +22,7 @@ POST /pets
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|405|Invalid input|No Content| |**405**|Invalid input|No Content|
#### Consumes #### Consumes
@@ -46,7 +46,7 @@ POST /pets
|Type|Name|Scopes| |Type|Name|Scopes|
|---|---|---| |---|---|---|
|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets| |**oauth2**|**[petstore_auth](#petstore_auth)**|write_pets,read_pets|
<a name="updatepet"></a> <a name="updatepet"></a>
@@ -58,9 +58,9 @@ PUT /pets
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Body|body|Pet object that needs to be added to the store|false|[Pet](#pet)|| |**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](#pet)||
#### Responses #### Responses
@@ -69,21 +69,21 @@ PUT /pets
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid ID supplied|No Content| |**400**|Invalid ID supplied|No Content|
##### HTTP Code 404 ##### HTTP Code 404
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|404|Pet not found|No Content| |**404**|Pet not found|No Content|
##### HTTP Code 405 ##### HTTP Code 405
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|405|Validation exception|No Content| |**405**|Validation exception|No Content|
#### Consumes #### Consumes
@@ -107,7 +107,7 @@ PUT /pets
|Type|Name|Scopes| |Type|Name|Scopes|
|---|---|---| |---|---|---|
|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets| |**oauth2**|**[petstore_auth](#petstore_auth)**|write_pets,read_pets|
<a name="findpetsbystatus"></a> <a name="findpetsbystatus"></a>
@@ -123,9 +123,9 @@ Multiple status values can be provided with comma seperated strings
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Query|status|Status values that need to be considered for filter|false|multi string array|| |**Query**|**status** <br>*optional*|Status values that need to be considered for filter|multi string array||
#### Responses #### Responses
@@ -134,22 +134,22 @@ Multiple status values can be provided with comma seperated strings
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|200|successful operation|[Pet](#pet) array| |**200**|successful operation|[Pet](#pet) array|
**Headers** **Headers**
|Name|Description|Schema|Default| |Name|Description|Schema|Default|
|---|---|---|---| |---|---|---|---|
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer|| |**X-Rate-Limit-Limit**|The number of allowed requests in the current period|integer||
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer|| |**X-Rate-Limit-Remaining**|The number of remaining requests in the current period|integer||
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer|| |**X-Rate-Limit-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400 ##### HTTP Code 400
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid status value|No Content| |**400**|Invalid status value|No Content|
#### Produces #### Produces
@@ -167,7 +167,7 @@ Multiple status values can be provided with comma seperated strings
|Type|Name|Scopes| |Type|Name|Scopes|
|---|---|---| |---|---|---|
|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets| |**oauth2**|**[petstore_auth](#petstore_auth)**|write_pets,read_pets|
<a name="findpetsbytags"></a> <a name="findpetsbytags"></a>
@@ -183,9 +183,9 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Query|tags|Tags to filter by|false|multi string array|| |**Query**|**tags** <br>*optional*|Tags to filter by|multi string array||
#### Responses #### Responses
@@ -194,22 +194,22 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|200|successful operation|[Pet](#pet) array| |**200**|successful operation|[Pet](#pet) array|
**Headers** **Headers**
|Name|Description|Schema|Default| |Name|Description|Schema|Default|
|---|---|---|---| |---|---|---|---|
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer|| |**X-Rate-Limit-Limit**|The number of allowed requests in the current period|integer||
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer|| |**X-Rate-Limit-Remaining**|The number of remaining requests in the current period|integer||
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer|| |**X-Rate-Limit-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400 ##### HTTP Code 400
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid tag value|No Content| |**400**|Invalid tag value|No Content|
#### Produces #### Produces
@@ -227,7 +227,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|Type|Name|Scopes| |Type|Name|Scopes|
|---|---|---| |---|---|---|
|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets| |**oauth2**|**[petstore_auth](#petstore_auth)**|write_pets,read_pets|
<a name="updatepetwithform"></a> <a name="updatepetwithform"></a>
@@ -239,11 +239,11 @@ POST /pets/{petId}
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Path|petId|ID of pet that needs to be updated|true|string|| |**Path**|**petId** <br>*required*|ID of pet that needs to be updated|string||
|FormData|name|Updated name of the pet|true|string|| |**FormData**|**name** <br>*required*|Updated name of the pet|string||
|FormData|status|Updated status of the pet|true|string|| |**FormData**|**status** <br>*required*|Updated status of the pet|string||
#### Responses #### Responses
@@ -252,7 +252,7 @@ POST /pets/{petId}
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|405|Invalid input|No Content| |**405**|Invalid input|No Content|
#### Consumes #### Consumes
@@ -275,7 +275,7 @@ POST /pets/{petId}
|Type|Name|Scopes| |Type|Name|Scopes|
|---|---|---| |---|---|---|
|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets| |**oauth2**|**[petstore_auth](#petstore_auth)**|write_pets,read_pets|
<a name="getpetbyid"></a> <a name="getpetbyid"></a>
@@ -291,9 +291,9 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error cond
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Path|petId|ID of pet that needs to be fetched|true|integer(int64)|| |**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)||
#### Responses #### Responses
@@ -302,29 +302,29 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error cond
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|200|successful operation|[Pet](#pet)| |**200**|successful operation|[Pet](#pet)|
**Headers** **Headers**
|Name|Description|Schema|Default| |Name|Description|Schema|Default|
|---|---|---|---| |---|---|---|---|
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer|| |**X-Rate-Limit-Limit**|The number of allowed requests in the current period|integer||
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer|| |**X-Rate-Limit-Remaining**|The number of remaining requests in the current period|integer||
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer|| |**X-Rate-Limit-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400 ##### HTTP Code 400
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid ID supplied|No Content| |**400**|Invalid ID supplied|No Content|
##### HTTP Code 404 ##### HTTP Code 404
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|404|Pet not found|No Content| |**404**|Pet not found|No Content|
#### Produces #### Produces
@@ -342,8 +342,8 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error cond
|Type|Name|Scopes| |Type|Name|Scopes|
|---|---|---| |---|---|---|
|apiKey|[api_key](#api_key)|| |**apiKey**|**[api_key](#api_key)**||
|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets| |**oauth2**|**[petstore_auth](#petstore_auth)**|write_pets,read_pets|
<a name="deletepet"></a> <a name="deletepet"></a>
@@ -355,10 +355,10 @@ DELETE /pets/{petId}
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Header|api_key||true|string|| |**Header**|**api_key** <br>*required*||string||
|Path|petId|Pet id to delete|true|integer(int64)|| |**Path**|**petId** <br>*required*|Pet id to delete|integer(int64)||
#### Responses #### Responses
@@ -367,7 +367,7 @@ DELETE /pets/{petId}
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid pet value|No Content| |**400**|Invalid pet value|No Content|
#### Produces #### Produces
@@ -385,7 +385,7 @@ DELETE /pets/{petId}
|Type|Name|Scopes| |Type|Name|Scopes|
|---|---|---| |---|---|---|
|oauth2|[petstore_auth](#petstore_auth)|write_pets,read_pets| |**oauth2**|**[petstore_auth](#petstore_auth)**|write_pets,read_pets|
<a name="placeorder"></a> <a name="placeorder"></a>
@@ -397,9 +397,9 @@ POST /stores/order
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Body|body|order placed for purchasing the pet|false|[Order](#order)|| |**Body**|**body** <br>*optional*|order placed for purchasing the pet|[Order](#order)||
#### Responses #### Responses
@@ -408,22 +408,22 @@ POST /stores/order
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|200|successful operation|[Order](#order)| |**200**|successful operation|[Order](#order)|
**Headers** **Headers**
|Name|Description|Schema|Default| |Name|Description|Schema|Default|
|---|---|---|---| |---|---|---|---|
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer|| |**X-Rate-Limit-Limit**|The number of allowed requests in the current period|integer||
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer|| |**X-Rate-Limit-Remaining**|The number of remaining requests in the current period|integer||
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer|| |**X-Rate-Limit-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400 ##### HTTP Code 400
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid Order|No Content| |**400**|Invalid Order|No Content|
#### Produces #### Produces
@@ -450,9 +450,9 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Path|orderId|ID of pet that needs to be fetched|true|string|| |**Path**|**orderId** <br>*required*|ID of pet that needs to be fetched|string||
#### Responses #### Responses
@@ -461,29 +461,29 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|200|successful operation|[Order](#order)| |**200**|successful operation|[Order](#order)|
**Headers** **Headers**
|Name|Description|Schema|Default| |Name|Description|Schema|Default|
|---|---|---|---| |---|---|---|---|
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer|| |**X-Rate-Limit-Limit**|The number of allowed requests in the current period|integer||
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer|| |**X-Rate-Limit-Remaining**|The number of remaining requests in the current period|integer||
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer|| |**X-Rate-Limit-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400 ##### HTTP Code 400
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid ID supplied|No Content| |**400**|Invalid ID supplied|No Content|
##### HTTP Code 404 ##### HTTP Code 404
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|404|Order not found|No Content| |**404**|Order not found|No Content|
#### Produces #### Produces
@@ -510,9 +510,9 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Path|orderId|ID of the order that needs to be deleted|true|string|| |**Path**|**orderId** <br>*required*|ID of the order that needs to be deleted|string||
#### Responses #### Responses
@@ -521,14 +521,14 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid ID supplied|No Content| |**400**|Invalid ID supplied|No Content|
##### HTTP Code 404 ##### HTTP Code 404
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|404|Order not found|No Content| |**404**|Order not found|No Content|
#### Produces #### Produces
@@ -555,9 +555,9 @@ This can only be done by the logged in user.
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Body|body|Created user object|false|[User](#user)|| |**Body**|**body** <br>*optional*|Created user object|[User](#user)||
#### Responses #### Responses
@@ -566,7 +566,7 @@ This can only be done by the logged in user.
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|default|successful operation|No Content| |**default**|successful operation|No Content|
#### Produces #### Produces
@@ -589,9 +589,9 @@ POST /users/createWithArray
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Body|body|List of user object|false|[User](#user) array|| |**Body**|**body** <br>*optional*|List of user object|[User](#user) array||
#### Responses #### Responses
@@ -600,7 +600,7 @@ POST /users/createWithArray
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|default|successful operation|No Content| |**default**|successful operation|No Content|
#### Produces #### Produces
@@ -623,9 +623,9 @@ POST /users/createWithList
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Body|body|List of user object|false|[User](#user) array|| |**Body**|**body** <br>*optional*|List of user object|[User](#user) array||
#### Responses #### Responses
@@ -634,7 +634,7 @@ POST /users/createWithList
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|default|successful operation|No Content| |**default**|successful operation|No Content|
#### Produces #### Produces
@@ -657,10 +657,10 @@ GET /users/login
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Query|password|The password for login in clear text|false|string|| |**Query**|**password** <br>*optional*|The password for login in clear text|string||
|Query|username|The user name for login|false|string|| |**Query**|**username** <br>*optional*|The user name for login|string||
#### Responses #### Responses
@@ -669,22 +669,22 @@ GET /users/login
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|200|successful operation|string| |**200**|successful operation|string|
**Headers** **Headers**
|Name|Description|Schema|Default| |Name|Description|Schema|Default|
|---|---|---|---| |---|---|---|---|
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer|| |**X-Rate-Limit-Limit**|The number of allowed requests in the current period|integer||
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer|| |**X-Rate-Limit-Remaining**|The number of remaining requests in the current period|integer||
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer|| |**X-Rate-Limit-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400 ##### HTTP Code 400
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid username/password supplied|No Content| |**400**|Invalid username/password supplied|No Content|
#### Produces #### Produces
@@ -711,7 +711,7 @@ GET /users/logout
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|default|successful operation|No Content| |**default**|successful operation|No Content|
#### Produces #### Produces
@@ -734,9 +734,9 @@ GET /users/{username}
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string|| |**Path**|**username** <br>*required*|The name that needs to be fetched. Use user1 for testing.|string||
#### Responses #### Responses
@@ -745,29 +745,29 @@ GET /users/{username}
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|200|successful operation|[User](#user)| |**200**|successful operation|[User](#user)|
**Headers** **Headers**
|Name|Description|Schema|Default| |Name|Description|Schema|Default|
|---|---|---|---| |---|---|---|---|
|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer|| |**X-Rate-Limit-Limit**|The number of allowed requests in the current period|integer||
|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer|| |**X-Rate-Limit-Remaining**|The number of remaining requests in the current period|integer||
|X-Rate-Limit-Reset|The number of seconds left in the current period|integer|| |**X-Rate-Limit-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400 ##### HTTP Code 400
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid username supplied|No Content| |**400**|Invalid username supplied|No Content|
##### HTTP Code 404 ##### HTTP Code 404
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|404|User not found|No Content| |**404**|User not found|No Content|
#### Produces #### Produces
@@ -794,10 +794,10 @@ This can only be done by the logged in user.
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Path|username|name that need to be deleted|true|string|| |**Path**|**username** <br>*required*|name that need to be deleted|string||
|Body|body|Updated user object|false|[User](#user)|| |**Body**|**body** <br>*optional*|Updated user object|[User](#user)||
#### Responses #### Responses
@@ -806,14 +806,14 @@ This can only be done by the logged in user.
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid user supplied|No Content| |**400**|Invalid user supplied|No Content|
##### HTTP Code 404 ##### HTTP Code 404
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|404|User not found|No Content| |**404**|User not found|No Content|
#### Produces #### Produces
@@ -840,9 +840,9 @@ This can only be done by the logged in user.
#### Parameters #### Parameters
|Type|Name|Description|Required|Schema|Default| |Type|Name|Description|Schema|Default|
|---|---|---|---|---|---| |---|---|---|---|---|
|Path|username|The name that needs to be deleted|true|string|| |**Path**|**username** <br>*required*|The name that needs to be deleted|string||
#### Responses #### Responses
@@ -851,14 +851,14 @@ This can only be done by the logged in user.
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|400|Invalid username supplied|No Content| |**400**|Invalid username supplied|No Content|
##### HTTP Code 404 ##### HTTP Code 404
|HTTP Code|Description|Schema| |HTTP Code|Description|Schema|
|---|---|---| |---|---|---|
|404|User not found|No Content| |**404**|User not found|No Content|
#### Produces #### Produces

14
src/test/resources/expected/markdown/default/security.md
View File

@@ -3,14 +3,16 @@
## Security ## Security
### api_key ### api_key
Type : apiKey *Type* : apiKey
Name : api_key *Name* : api_key
In : HEADER *In* : HEADER
### petstore_auth ### petstore_auth
Type : oauth2 *Type* : oauth2
Flow : implicit *Flow* : implicit
Token URL : http://petstore.swagger.io/api/oauth/dialog *Token URL* : http://petstore.swagger.io/api/oauth/dialog
|Name|Description| |Name|Description|
|---|---| |---|---|