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

refactored responses header display

Browse Source 
fixed tests after column width update
fixed defaultString in swaggerMarkupDescription
This commit is contained in:
Hugo de Paix de Coeur
2016-04-12 18:49:57 +02:00
parent dce6b4183a
commit 6e4c0c1498
49 changed files with 1511 additions and 2622 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -238,11 +238,11 @@ public abstract class MarkupDocumentBuilder {
/**
* Returns converted markup text from Swagger.
*
* @param markupText text to convert
* @return converted markup text
* @param markupText text to convert, or null
* @return converted markup text, or empty string
*/
protected String swaggerMarkupDescription(String markupText) {
return markupDocBuilder.copy(false).importMarkup(new StringReader(markupText), globalContext.getConfig().getSwaggerMarkupLanguage()).toString().trim();
return markupDocBuilder.copy(false).importMarkup(new StringReader(defaultString(markupText)), globalContext.getConfig().getSwaggerMarkupLanguage()).toString().trim();
}
protected void buildDescriptionParagraph(String description, MarkupDocBuilder docBuilder) {

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

@@ -372,20 +372,6 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
}
}
/**
* Adds a response section title to the document.
*
* @param title the response title
* @param docBuilder the MarkupDocBuilder to use
*/
private void buildResponseTitle(String title, MarkupDocBuilder docBuilder) {
if (config.getPathsGroupedBy() == GroupBy.AS_IS) {
docBuilder.sectionTitleLevel4(title);
} else {
docBuilder.sectionTitleLevel5(title);
}
}
/**
* Adds a operation description to the document.
* If hand-written descriptions exist, it tries to load the description from a file.
@@ -640,18 +626,14 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
new MarkupTableColumn(HTTP_CODE_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(15).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^15"),
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"));
List<MarkupTableColumn> responseHeaderCols = Arrays.asList(
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(11).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^11"),
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"),
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2"));
List<List<String>> cells = new ArrayList<>();
Set<String> responseNames = toKeySet(responses, config.getResponseOrdering());
for (String responseName : responseNames) {
List<List<String>> cells = new ArrayList<>();
List<List<String>> responseHeaderCells = new ArrayList<>();
Response response = responses.get(responseName);
String schemaContent = NO_CONTENT;
if (response.getSchema() != null) {
Property property = response.getSchema();
Type type = PropertyUtils.getType(property, new DefinitionDocumentResolverFromOperation());
@@ -659,37 +641,49 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
if (config.getInlineSchemaDepthLevel() > 0) {
type = createInlineType(type, RESPONSE + " " + responseName, operation.getId() + " " + RESPONSE + " " + responseName, inlineDefinitions);
}
cells.add(Arrays.asList(boldText(responseName), swaggerMarkupDescription(response.getDescription()), type.displaySchema(markupDocBuilder)));
} else {
cells.add(Arrays.asList(boldText(responseName), swaggerMarkupDescription(response.getDescription()), NO_CONTENT));
schemaContent = type.displaySchema(markupDocBuilder);
}
buildResponseTitle(HTTP_CODE_COLUMN + " " + responseName, docBuilder);
docBuilder.tableWithColumnSpecs(responseCols, cells);
MarkupDocBuilder descriptionBuilder = docBuilder.copy(false);
descriptionBuilder.text(swaggerMarkupDescription(response.getDescription()));
Map<String, Property> headers = response.getHeaders();
if(MapUtils.isNotEmpty(headers)) {
docBuilder.boldTextLine(HEADERS_COLUMN);
for(Map.Entry<String, Property> header : headers.entrySet()){
Property property = header.getValue();
Type propertyType = PropertyUtils.getType(property, null);
responseHeaderCells.add(Arrays.asList(boldText(header.getKey()),
swaggerMarkupDescription(defaultString(property.getDescription())),
propertyType.displaySchema(markupDocBuilder),
PropertyUtils.getDefaultValue(property)));
if (MapUtils.isNotEmpty(headers)) {
descriptionBuilder.newLine(true).boldText(HEADERS_COLUMN).text(COLON);
for (Map.Entry<String, Property> header : headers.entrySet()) {
descriptionBuilder.newLine(true);
Property headerProperty = header.getValue();
Type propertyType = PropertyUtils.getType(headerProperty, null);
String headerDescription = swaggerMarkupDescription(headerProperty.getDescription());
String defaultValue = PropertyUtils.getDefaultValue(headerProperty);
descriptionBuilder
.literalText(header.getKey())
.text(String.format(" (%s)", propertyType.displaySchema(markupDocBuilder)));
if (isNotBlank(headerDescription) || isNotBlank(defaultValue))
descriptionBuilder.text(COLON);
if (isNotBlank(headerDescription) && !headerDescription.endsWith("."))
headerDescription += ".";
descriptionBuilder.text(headerDescription);
if (isNotBlank(defaultValue)) {
descriptionBuilder.text(" ").boldText(DEFAULT_COLUMN).text(COLON).text(defaultValue);
}
}
docBuilder.tableWithColumnSpecs(responseHeaderCols, responseHeaderCells);
}
cells.add(Arrays.asList(boldText(responseName), descriptionBuilder.toString(), schemaContent));
}
docBuilder.tableWithColumnSpecs(responseCols, cells);
}
return inlineDefinitions;
}
/**
* Builds the title of an inline schema.
* Inline definitions should never been referenced in TOC because they have no real existence, so they are just text.

1
src/main/java/io/github/swagger2markup/internal/utils/PropertyUtils.java
View File

@@ -79,6 +79,7 @@ public final class PropertyUtils {
* @param property the property
* @return the default value of the property, or otherwise an empty String
*/
// FIXME : getDefaultValue should return Object, then should be Json.prettyfied and literalized at display, like examples
public static String getDefaultValue(Property property) {
Validate.notNull(property, "property must not be null");
String defaultValue = "";

25
src/test/java/io/github/swagger2markup/AsciidocConverterTest.java
View File

@@ -458,6 +458,27 @@ public class AsciidocConverterTest {
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/polymorphism").toURI());
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithPolymorphism.html");
}
@Test
public void testSwagger2AsciiDocConversionWithResponseHeaders() throws IOException, URISyntaxException {
//Given
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_response_headers.yaml").toURI());
Path outputDirectory = Paths.get("build/test/asciidoc/response_headers");
FileUtils.deleteQuietly(outputDirectory.toFile());
//When
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.build();
Swagger2MarkupConverter.from(file)
.withConfig(config)
.build()
.toFolder(outputDirectory);
//Then
String[] files = outputDirectory.toFile().list();
assertThat(files).hasSize(4).containsAll(expectedFiles);
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/response_headers").toURI());
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithResponseHeaders.html");
}
}

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

@@ -130,6 +130,30 @@ public class MarkdownConverterTest {
asList("Category.md", "Order.md", "Pet.md", "Tag.md", "User.md"));
}
@Test
public void testSwagger2MarkdownConversionWithResponseHeaders() throws IOException, URISyntaxException {
//Given
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_response_headers.yaml").toURI());
Path outputDirectory = Paths.get("build/test/markdown/response_headers");
FileUtils.deleteQuietly(outputDirectory.toFile());
//When
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withMarkupLanguage(MarkupLanguage.MARKDOWN)
.build();
Swagger2MarkupConverter.from(file)
.withConfig(config)
.build()
.toFolder(outputDirectory);
//Then
String[] files = outputDirectory.toFile().list();
assertThat(files).hasSize(4).containsAll(expectedFiles);
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/markdown/response_headers").toURI());
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2MarkdownConversionWithResponseHeaders.html");
}
@Test
public void testSwagger2MarkdownConversionHandlesComposition() throws IOException, URISyntaxException {
//Given

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

@@ -5,7 +5,7 @@
[[_category]]
=== Category
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -18,7 +18,7 @@ _optional_||string|
[[_order]]
=== Order
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*complete* +
@@ -39,7 +39,7 @@ _optional_|Order Status|enum (Ordered, Cancelled)|
[[_pet]]
=== Pet
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -60,7 +60,7 @@ _optional_||< <<_tag,Tag>>> array|
[[_tag]]
=== Tag
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -73,7 +73,7 @@ _optional_||string|
[[_user]]
=== User
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*email* +

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

@@ -11,7 +11,7 @@ POST /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -21,9 +21,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -49,7 +47,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -65,7 +63,7 @@ PUT /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -75,29 +73,11 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*405*|Validation exception|No Content
|===
@@ -121,7 +101,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -141,7 +121,7 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*status* +
@@ -151,30 +131,14 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<_pet,Pet>>> array
|*400*|Invalid status value|No Content
|===
@@ -192,7 +156,7 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -212,7 +176,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
@@ -222,30 +186,14 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<_pet,Pet>>> array
|*400*|Invalid tag value|No Content
|===
@@ -263,7 +211,7 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -279,7 +227,7 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -293,9 +241,7 @@ _required_|Updated status of the pet|string|
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -320,7 +266,7 @@ _required_|Updated status of the pet|string|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -340,7 +286,7 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -350,39 +296,15 @@ _required_|ID of pet that needs to be fetched|integer(int64)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_pet,Pet>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_pet,Pet>>
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
@@ -400,7 +322,7 @@ _required_|ID of pet that needs to be fetched|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*apiKey*|*<<_api_key,api_key>>*|
@@ -417,7 +339,7 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
@@ -429,9 +351,7 @@ _required_|Pet id to delete|integer(int64)|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -451,7 +371,7 @@ _required_|Pet id to delete|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -467,7 +387,7 @@ POST /stores/order
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -477,30 +397,14 @@ _optional_|order placed for purchasing the pet|<<_order,Order>>|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_order,Order>>
|*400*|Invalid Order|No Content
|===
@@ -529,7 +433,7 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -539,39 +443,15 @@ _required_|ID of pet that needs to be fetched|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_order,Order>>
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -600,7 +480,7 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -610,20 +490,10 @@ _required_|ID of the order that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -652,7 +522,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -662,9 +532,7 @@ _optional_|Created user object|<<_user,User>>|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -691,7 +559,7 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -701,9 +569,7 @@ _optional_|List of user object|< <<_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -730,7 +596,7 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -740,9 +606,7 @@ _optional_|List of user object|< <<_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -769,7 +633,7 @@ GET /users/login
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*password* +
@@ -781,30 +645,14 @@ _optional_|The user name for login|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|string
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|string
|*400*|Invalid username/password supplied|No Content
|===
@@ -829,9 +677,7 @@ GET /users/logout
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -858,7 +704,7 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -868,39 +714,15 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_user,User>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_user,User>>
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -929,7 +751,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -941,20 +763,10 @@ _optional_|Updated user object|<<_user,User>>|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -983,7 +795,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -993,20 +805,10 @@ _required_|The name that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===

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

@@ -18,7 +18,7 @@ _Flow_ : implicit
_Token URL_ : http://petstore.swagger.io/api/oauth/dialog
[options="header", cols="1,6"]
[options="header", cols=".^3,.^17"]
|===
|Name|Description
|write_pets|modify pets in your account

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

@@ -15,7 +15,7 @@ Return state
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*oldState* +
@@ -27,7 +27,7 @@ _optional_|State as enum in object|<<_createstate_statemodel,StateModel>>|
[[_createstate_statemodel]]
*StateModel*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*value* +
@@ -37,9 +37,7 @@ _optional_|State value|enum (ADDED, REMOVED, CHANGED)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|enum (ADDED, REMOVED, CHANGED)

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

@@ -5,7 +5,7 @@
[[_category]]
=== Category
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -18,7 +18,7 @@ _optional_|*Example* : `"Canines"`|string|
[[_complexobject]]
=== ComplexObject
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*subObject* +
@@ -29,7 +29,7 @@ _optional_||object|
[[_identified]]
=== Identified
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -40,7 +40,7 @@ _optional_||integer(int64)|
[[_order]]
=== Order
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*complete* +
@@ -64,7 +64,7 @@ _optional_|Order Status +
Test description
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -89,7 +89,7 @@ _optional_|the weight of the pet|number|
[[_tag]]
=== Tag
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -105,7 +105,7 @@ _optional_||string|
_Polymorphism_ : Composition
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*email* +

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

@@ -11,7 +11,7 @@ POST /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -21,9 +21,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -49,7 +47,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -82,7 +80,7 @@ PUT /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -92,29 +90,11 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*405*|Validation exception|No Content
|===
@@ -138,7 +118,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -158,7 +138,7 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*status* +
@@ -168,20 +148,10 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid status value|No Content
|===
@@ -199,7 +169,7 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -219,7 +189,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
@@ -229,20 +199,10 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid tag value|No Content
|===
@@ -260,7 +220,7 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -276,7 +236,7 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -290,9 +250,7 @@ _required_|Updated status of the pet|string|
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -317,7 +275,7 @@ _required_|Updated status of the pet|string|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -337,7 +295,7 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -347,29 +305,11 @@ _required_|ID of the pet|integer(int64)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_pet,Pet>>
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
@@ -387,7 +327,7 @@ _required_|ID of the pet|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*apiKey*|*<<_api_key,api_key>>*|
@@ -404,7 +344,7 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
@@ -416,9 +356,7 @@ _required_|Pet id to delete|integer(int64)|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -438,7 +376,7 @@ _required_|Pet id to delete|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -454,7 +392,7 @@ POST /stores/order
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -464,20 +402,10 @@ _optional_|order placed for purchasing the pet|<<_order,Order>>|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid Order|No Content
|===
@@ -538,7 +466,7 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -548,29 +476,11 @@ _required_|ID of pet that needs to be fetched|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -615,7 +525,7 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -625,20 +535,10 @@ _required_|ID of the order that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -667,7 +567,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -677,9 +577,7 @@ _optional_|Created user object|<<_user,User>>|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -706,7 +604,7 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -716,9 +614,7 @@ _optional_|List of user object|< <<_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -745,7 +641,7 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -755,9 +651,7 @@ _optional_|List of user object|< <<_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -784,7 +678,7 @@ GET /users/login
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*password* +
@@ -796,20 +690,10 @@ _optional_|The user name for login|string|testUser
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|string
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username/password supplied|No Content
|===
@@ -834,9 +718,7 @@ GET /users/logout
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -863,7 +745,7 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -873,29 +755,11 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|test
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_user,User>>
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -924,7 +788,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -936,20 +800,10 @@ _optional_|Updated user object|<<_user,User>>|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -978,7 +832,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -988,20 +842,10 @@ _required_|The name that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===

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

@@ -18,7 +18,7 @@ _Flow_ : implicit
_Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog
[options="header", cols="1,6"]
[options="header", cols=".^3,.^17"]
|===
|Name|Description
|write_pets|modify pets in your account

10
src/test/resources/expected/asciidoc/generated/definitions/Category.adoc
View File

@@ -2,11 +2,13 @@
[[_category]]
=== Category
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Required|Schema|Default|Example
|id||false|integer(int64)||
|name||false|string||
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)|
|*name* +
_optional_||string|
|===

22
src/test/resources/expected/asciidoc/generated/definitions/Order.adoc
View File

@@ -2,15 +2,21 @@
[[_order]]
=== Order
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Required|Schema|Default|Example
|complete||false|boolean||
|id||false|integer(int64)||
|petId||false|integer(int64)||
|quantity||false|integer(int32)||
|shipDate||false|string(date-time)||
|status|Order Status|false|enum (Ordered, Cancelled)||
|Name|Description|Schema|Default
|*complete* +
_optional_||boolean|
|*id* +
_optional_||integer(int64)|
|*petId* +
_optional_||integer(int64)|
|*quantity* +
_optional_||integer(int32)|
|*shipDate* +
_optional_||string(date-time)|
|*status* +
_optional_|Order Status|enum (Ordered, Cancelled)|
|===

22
src/test/resources/expected/asciidoc/generated/definitions/Pet.adoc
View File

@@ -2,15 +2,21 @@
[[_pet]]
=== Pet
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Required|Schema|Default|Example
|category||false|<<_category,Category>>||
|id||false|integer(int64)||
|name||true|string||"doggie"
|photoUrls||true|string array||
|status|pet status in the store,|false|enum (Dead, Alive)||
|tags||false|<<_tag,Tag>> array||
|Name|Description|Schema|Default
|*category* +
_optional_||<<_category,Category>>|
|*id* +
_optional_||integer(int64)|
|*name* +
_required_|*Example* : `"doggie"`|string|
|*photoUrls* +
_required_||<string> array|
|*status* +
_optional_|pet status in the store,|enum (Dead, Alive)|
|*tags* +
_optional_||< <<_tag,Tag>>> array|
|===

10
src/test/resources/expected/asciidoc/generated/definitions/Tag.adoc
View File

@@ -2,11 +2,13 @@
[[_tag]]
=== Tag
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Required|Schema|Default|Example
|id||false|integer(int64)||
|name||false|string||
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)|
|*name* +
_optional_||string|
|===

28
src/test/resources/expected/asciidoc/generated/definitions/User.adoc
View File

@@ -2,17 +2,25 @@
[[_user]]
=== User
[options="header", cols=".^1h,.^6,.^1,.^1,.^1,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Required|Schema|Default|Example
|email||false|string||
|firstName||false|string||
|id||false|integer(int64)||
|lastName||false|string||
|password||false|string||
|phone||false|string||
|userStatus|User Status|false|integer(int32)||
|username||false|string||
|Name|Description|Schema|Default
|*email* +
_optional_||string|
|*firstName* +
_optional_||string|
|*id* +
_optional_||integer(int64)|
|*lastName* +
_optional_||string|
|*password* +
_optional_||string|
|*phone* +
_optional_||string|
|*userStatus* +
_optional_|User Status|integer(int32)|
|*username* +
_optional_||string|
|===

24
src/test/resources/expected/asciidoc/generated/overview.adoc
View File

@@ -11,20 +11,28 @@ For this sample, you can use the api key `special-key` to test the authorization
=== Version information
Version : 1.0.0 +
[%hardbreaks]
_Version_ : 1.0.0
=== Contact information
Contact : apiteam@swagger.io +
[%hardbreaks]
_Contact_ : apiteam@swagger.io
=== License information
License : Apache 2.0 +
License URL : http://www.apache.org/licenses/LICENSE-2.0.html +
Terms of service : http://helloreverb.com/terms/ +
[%hardbreaks]
_License_ : Apache 2.0
_License URL_ : http://www.apache.org/licenses/LICENSE-2.0.html
_Terms of service_ : http://helloreverb.com/terms/
=== URI scheme
Host : petstore.swagger.io +
BasePath : /v2 +
Schemes : HTTP +
[%hardbreaks]
_Host_ : petstore.swagger.io
_BasePath_ : /v2
_Schemes_ : HTTP
=== Tags

674
src/test/resources/expected/asciidoc/generated/paths.adoc
View File

File diff suppressed because it is too large Load Diff

20
src/test/resources/expected/asciidoc/generated/security.adoc
View File

@@ -2,17 +2,23 @@
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
Type : apiKey
Name : api_key
In : HEADER
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
Type : oauth2
Flow : implicit
Token URL : http://petstore.swagger.io/api/oauth/dialog
[%hardbreaks]
_Type_ : oauth2
_Flow_ : implicit
_Token URL_ : http://petstore.swagger.io/api/oauth/dialog
[options="header", cols="1,6"]
[options="header", cols=".^3,.^17"]
|===
|Name|Description
|write_pets|modify pets in your account

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

@@ -5,7 +5,7 @@
[[_category]]
=== Category
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -18,7 +18,7 @@ _optional_|*Example* : `"Canines"`|string|
[[_complexobject]]
=== ComplexObject
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*subObject* +
@@ -29,7 +29,7 @@ _optional_|*Example* : `"object"`|object|
[[_identified]]
=== Identified
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -40,7 +40,7 @@ _optional_|*Example* : `0`|integer(int64)|
[[_order]]
=== Order
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*complete* +
@@ -64,7 +64,7 @@ _optional_|Order Status +
Test description
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -93,7 +93,7 @@ _optional_|the weight of the pet +
[[_tag]]
=== Tag
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -109,7 +109,7 @@ _optional_|*Example* : `"string"`|string|
_Polymorphism_ : Composition
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*email* +

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

@@ -11,7 +11,7 @@ POST /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -21,9 +21,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -49,7 +47,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -115,7 +113,7 @@ PUT /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -125,29 +123,11 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*405*|Validation exception|No Content
|===
@@ -171,7 +151,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -224,7 +204,7 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*status* +
@@ -234,20 +214,10 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid status value|No Content
|===
@@ -265,7 +235,7 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -312,7 +282,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
@@ -322,20 +292,10 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid tag value|No Content
|===
@@ -353,7 +313,7 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -396,7 +356,7 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -410,9 +370,7 @@ _required_|Updated status of the pet|string|
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -437,7 +395,7 @@ _required_|Updated status of the pet|string|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -473,7 +431,7 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -483,29 +441,11 @@ _required_|ID of the pet|integer(int64)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_pet,Pet>>
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
@@ -523,7 +463,7 @@ _required_|ID of the pet|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*apiKey*|*<<_api_key,api_key>>*|
@@ -575,7 +515,7 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
@@ -587,9 +527,7 @@ _required_|Pet id to delete|integer(int64)|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -609,7 +547,7 @@ _required_|Pet id to delete|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -641,7 +579,7 @@ POST /stores/order
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -651,20 +589,10 @@ _optional_|order placed for purchasing the pet|<<_order,Order>>|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid Order|No Content
|===
@@ -732,7 +660,7 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -742,29 +670,11 @@ _required_|ID of pet that needs to be fetched|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -818,7 +728,7 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -828,20 +738,10 @@ _required_|ID of the order that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -879,7 +779,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -889,9 +789,7 @@ _optional_|Created user object|<<_user,User>>|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -944,7 +842,7 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -954,9 +852,7 @@ _optional_|List of user object|< <<_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1009,7 +905,7 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -1019,9 +915,7 @@ _optional_|List of user object|< <<_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1074,7 +968,7 @@ GET /users/login
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*password* +
@@ -1086,20 +980,10 @@ _optional_|The user name for login|string|testUser
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|string
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username/password supplied|No Content
|===
@@ -1152,9 +1036,7 @@ GET /users/logout
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1190,7 +1072,7 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -1200,29 +1082,11 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|test
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_user,User>>
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -1279,7 +1143,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -1291,20 +1155,10 @@ _optional_|Updated user object|<<_user,User>>|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -1359,7 +1213,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -1369,20 +1223,10 @@ _required_|The name that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===

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

@@ -18,7 +18,7 @@ _Flow_ : implicit
_Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog
[options="header", cols="1,6"]
[options="header", cols=".^3,.^17"]
|===
|Name|Description
|write_pets|modify pets in your account

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

@@ -5,7 +5,7 @@
[[_category]]
=== Category
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -18,7 +18,7 @@ _optional_||string|
[[_order]]
=== Order
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*complete* +
@@ -39,7 +39,7 @@ _optional_|Order Status|enum (Ordered, Cancelled)|
[[_pet]]
=== Pet
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -60,7 +60,7 @@ _optional_||< <<_tag,Tag>>> array|
[[_tag]]
=== Tag
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -73,7 +73,7 @@ _optional_||string|
[[_user]]
=== User
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*email* +

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

@@ -15,7 +15,7 @@ POST /pets
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -25,9 +25,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
===== Responses
====== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -48,7 +46,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
===== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -64,7 +62,7 @@ PUT /pets
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -74,29 +72,11 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
===== Responses
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
====== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
====== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*405*|Validation exception|No Content
|===
@@ -115,7 +95,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
===== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -135,7 +115,7 @@ Multiple status values can be provided with comma seperated strings
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*status* +
@@ -145,30 +125,14 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
===== Responses
====== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<_pet,Pet>>> array
|*400*|Invalid status value|No Content
|===
@@ -181,7 +145,7 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
===== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -201,7 +165,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
@@ -211,30 +175,14 @@ _optional_|Tags to filter by|<string> array(multi)|
===== Responses
====== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<_pet,Pet>>> array
|*400*|Invalid tag value|No Content
|===
@@ -247,7 +195,7 @@ _optional_|Tags to filter by|<string> array(multi)|
===== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -263,7 +211,7 @@ POST /pets/{petId}
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -277,9 +225,7 @@ _required_|Updated status of the pet|string|
===== Responses
====== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -299,7 +245,7 @@ _required_|Updated status of the pet|string|
===== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -319,7 +265,7 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -329,39 +275,15 @@ _required_|ID of pet that needs to be fetched|integer(int64)|
===== Responses
====== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_pet,Pet>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_pet,Pet>>
|*400*|Invalid ID supplied|No Content
|===
====== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
@@ -374,7 +296,7 @@ _required_|ID of pet that needs to be fetched|integer(int64)|
===== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*apiKey*|*<<_api_key,api_key>>*|
@@ -391,7 +313,7 @@ DELETE /pets/{petId}
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
@@ -403,9 +325,7 @@ _required_|Pet id to delete|integer(int64)|
===== Responses
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -420,7 +340,7 @@ _required_|Pet id to delete|integer(int64)|
===== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -440,7 +360,7 @@ POST /stores/order
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -450,30 +370,14 @@ _optional_|order placed for purchasing the pet|<<_order,Order>>|
===== Responses
====== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_order,Order>>
|*400*|Invalid Order|No Content
|===
@@ -497,7 +401,7 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -507,39 +411,15 @@ _required_|ID of pet that needs to be fetched|string|
===== Responses
====== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_order,Order>>
|*400*|Invalid ID supplied|No Content
|===
====== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -563,7 +443,7 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -573,20 +453,10 @@ _required_|ID of the order that needs to be deleted|string|
===== Responses
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
====== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -614,7 +484,7 @@ This can only be done by the logged in user.
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -624,9 +494,7 @@ _optional_|Created user object|<<_user,User>>|
===== Responses
====== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -648,7 +516,7 @@ POST /users/createWithArray
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -658,9 +526,7 @@ _optional_|List of user object|< <<_user,User>>> array|
===== Responses
====== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -682,7 +548,7 @@ POST /users/createWithList
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -692,9 +558,7 @@ _optional_|List of user object|< <<_user,User>>> array|
===== Responses
====== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -716,7 +580,7 @@ GET /users/login
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*password* +
@@ -728,30 +592,14 @@ _optional_|The user name for login|string|
===== Responses
====== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|string
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|string
|*400*|Invalid username/password supplied|No Content
|===
@@ -771,9 +619,7 @@ GET /users/logout
===== Responses
====== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -795,7 +641,7 @@ GET /users/{username}
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -805,39 +651,15 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|
===== Responses
====== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_user,User>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_user,User>>
|*400*|Invalid username supplied|No Content
|===
====== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -861,7 +683,7 @@ This can only be done by the logged in user.
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -873,20 +695,10 @@ _optional_|Updated user object|<<_user,User>>|
===== Responses
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
|===
====== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -910,7 +722,7 @@ This can only be done by the logged in user.
===== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -920,20 +732,10 @@ _required_|The name that needs to be deleted|string|
===== Responses
====== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content
|===
====== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===

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

@@ -18,7 +18,7 @@ _Flow_ : implicit
_Token URL_ : http://petstore.swagger.io/api/oauth/dialog
[options="header", cols="1,6"]
[options="header", cols=".^3,.^17"]
|===
|Name|Description
|write_pets|modify pets in your account

10
src/test/resources/expected/asciidoc/idxref/definitions.adoc
View File

@@ -5,7 +5,7 @@
[[_category]]
=== Category
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -18,7 +18,7 @@ _optional_||string|
[[_order]]
=== Order
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*complete* +
@@ -39,7 +39,7 @@ _optional_|Order Status|enum (Ordered, Cancelled)|
[[_pet]]
=== Pet
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -60,7 +60,7 @@ _optional_||< <<definitions.adoc#_tag,Tag>>> array|
[[_tag]]
=== Tag
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -73,7 +73,7 @@ _optional_||string|
[[_user]]
=== User
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*email* +

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

@@ -11,7 +11,7 @@ POST /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -21,9 +21,7 @@ _optional_|Pet object that needs to be added to the store|<<definitions.adoc#_pe
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -49,7 +47,7 @@ _optional_|Pet object that needs to be added to the store|<<definitions.adoc#_pe
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<security.adoc#_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -65,7 +63,7 @@ PUT /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -75,29 +73,11 @@ _optional_|Pet object that needs to be added to the store|<<definitions.adoc#_pe
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*405*|Validation exception|No Content
|===
@@ -121,7 +101,7 @@ _optional_|Pet object that needs to be added to the store|<<definitions.adoc#_pe
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<security.adoc#_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -141,7 +121,7 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*status* +
@@ -151,30 +131,14 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<definitions.adoc#_pet,Pet>>> array
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<definitions.adoc#_pet,Pet>>> array
|*400*|Invalid status value|No Content
|===
@@ -192,7 +156,7 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<security.adoc#_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -212,7 +176,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
@@ -222,30 +186,14 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<definitions.adoc#_pet,Pet>>> array
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<definitions.adoc#_pet,Pet>>> array
|*400*|Invalid tag value|No Content
|===
@@ -263,7 +211,7 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<security.adoc#_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -279,7 +227,7 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -293,9 +241,7 @@ _required_|Updated status of the pet|string|
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -320,7 +266,7 @@ _required_|Updated status of the pet|string|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<security.adoc#_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -340,7 +286,7 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -350,39 +296,15 @@ _required_|ID of pet that needs to be fetched|integer(int64)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<definitions.adoc#_pet,Pet>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<definitions.adoc#_pet,Pet>>
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
@@ -400,7 +322,7 @@ _required_|ID of pet that needs to be fetched|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*apiKey*|*<<security.adoc#_api_key,api_key>>*|
@@ -417,7 +339,7 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
@@ -429,9 +351,7 @@ _required_|Pet id to delete|integer(int64)|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -451,7 +371,7 @@ _required_|Pet id to delete|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<security.adoc#_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -467,7 +387,7 @@ POST /stores/order
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -477,30 +397,14 @@ _optional_|order placed for purchasing the pet|<<definitions.adoc#_order,Order>>
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<definitions.adoc#_order,Order>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<definitions.adoc#_order,Order>>
|*400*|Invalid Order|No Content
|===
@@ -529,7 +433,7 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -539,39 +443,15 @@ _required_|ID of pet that needs to be fetched|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<definitions.adoc#_order,Order>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<definitions.adoc#_order,Order>>
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -600,7 +480,7 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -610,20 +490,10 @@ _required_|ID of the order that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -652,7 +522,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -662,9 +532,7 @@ _optional_|Created user object|<<definitions.adoc#_user,User>>|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -691,7 +559,7 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -701,9 +569,7 @@ _optional_|List of user object|< <<definitions.adoc#_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -730,7 +596,7 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -740,9 +606,7 @@ _optional_|List of user object|< <<definitions.adoc#_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -769,7 +633,7 @@ GET /users/login
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*password* +
@@ -781,30 +645,14 @@ _optional_|The user name for login|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|string
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|string
|*400*|Invalid username/password supplied|No Content
|===
@@ -829,9 +677,7 @@ GET /users/logout
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -858,7 +704,7 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -868,39 +714,15 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<definitions.adoc#_user,User>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<definitions.adoc#_user,User>>
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -929,7 +751,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -941,20 +763,10 @@ _optional_|Updated user object|<<definitions.adoc#_user,User>>|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -983,7 +795,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -993,20 +805,10 @@ _required_|The name that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===

2
src/test/resources/expected/asciidoc/idxref/security.adoc
View File

@@ -18,7 +18,7 @@ _Flow_ : implicit
_Token URL_ : http://petstore.swagger.io/api/oauth/dialog
[options="header", cols="1,6"]
[options="header", cols=".^3,.^17"]
|===
|Name|Description
|write_pets|modify pets in your account

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

@@ -5,7 +5,7 @@
[[_error]]
=== Error
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*error-code* +
@@ -18,7 +18,7 @@ _optional_|Error message|string|
[[_externallocation]]
=== ExternalLocation
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Place* +
@@ -29,7 +29,7 @@ _optional_|Place|string|
[[_inlinedepthschema]]
=== InlineDepthSchema
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Loop* +
@@ -39,7 +39,7 @@ _optional_||<<_inlinedepthschema_loop,Loop>>|
[[_inlinedepthschema_loop]]
*Loop*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p1* +
@@ -51,7 +51,7 @@ _optional_|Description p2|<<_inlinedepthschema_p2,p2>>|
[[_inlinedepthschema_p2]]
*p2*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p2-1* +
@@ -63,7 +63,7 @@ _optional_|Description p2-2|<<_inlinedepthschema_p2_p2-2,p2-2>>|
[[_inlinedepthschema_p2_p2-2]]
*p2-2*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p2-2-1* +
@@ -75,7 +75,7 @@ _optional_|Description p2-2-2|<<_inlinedepthschema_p2_p2-2_p2-2-2,p2-2-2>>|
[[_inlinedepthschema_p2_p2-2_p2-2-1]]
*p2-2-1*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p2-2-1-1* +
@@ -87,7 +87,7 @@ _optional_|Description p2-2-1-2|boolean|
[[_inlinedepthschema_p2_p2-2_p2-2-2]]
*p2-2-2*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p2-2-2-1* +
@@ -100,7 +100,7 @@ _optional_|Description p2-2-2-2|boolean|
[[_inlinepet]]
=== InlinePet
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -114,7 +114,7 @@ _optional_||< <<_inlinepet_tags,tags>>> array|
[[_inlinepet_category]]
*category*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -126,7 +126,7 @@ _optional_||string|
[[_inlinepet_tags]]
*tags*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -139,7 +139,7 @@ _optional_||string|
[[_inlinetitlepet]]
=== InlineTitlePet
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -153,7 +153,7 @@ _optional_||< <<_tagmodel,TagModel>>> array|
[[_categorymodel]]
*CategoryModel*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -165,7 +165,7 @@ _optional_||string|
[[_tagmodel]]
*TagModel*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -178,7 +178,7 @@ _optional_||string|
[[_location]]
=== Location
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Place* +
@@ -191,7 +191,7 @@ _optional_|Place|string|
mixed collections and objects
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -201,7 +201,7 @@ _optional_||< <<_mixedschema_mytable,myTable>>> array|
[[_mixedschema_mytable]]
*myTable*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -211,7 +211,7 @@ _optional_||<string,<<_mixedschema_mydict,myDict>>> map|
[[_mixedschema_mydict]]
*myDict*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +
@@ -230,7 +230,7 @@ _Type_ : < <string,<<_recursivecollectionschema_inline,RecursiveCollectionSchema
[[_recursivecollectionschema_inline]]
*RecursiveCollectionSchema*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -245,7 +245,7 @@ _optional_|option value|string|
mixed collections and objects
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -255,7 +255,7 @@ _optional_||< <<_tablecontent,TableContent>>> array|
[[_tablecontent]]
*TableContent*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*emptyObject* +
@@ -267,7 +267,7 @@ _optional_||<string,<<_kvpair,KVPair>>> map|
[[_kvpair]]
*KVPair*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +

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

@@ -15,7 +15,7 @@ Dummy description
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*Version* +
@@ -25,7 +25,7 @@ _optional_|The API version|< <string,<<_collectionparameters_post_version,Versio
[[_collectionparameters_post_version]]
*Version*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -37,9 +37,7 @@ _optional_|option value|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|< <string,<<_collectionparameters_post_response_200,Response 200>>> map> array
@@ -48,7 +46,7 @@ _optional_|option value|string|
[[_collectionparameters_post_response_200]]
*Response 200*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -76,7 +74,7 @@ Dummy description
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*Option* +
@@ -90,7 +88,7 @@ _optional_|Launch something new|<<_launchcommand_post_launchcommandrequest,Launc
[[_launchcommand_post_launchcommandrequest]]
*LaunchCommandRequest*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Command* +
@@ -104,7 +102,7 @@ _optional_|Options k/v pairs|< <<_launchcommand_post_options,Options>>> array|
[[_launchcommand_post_command]]
*Command*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*args* +
@@ -116,7 +114,7 @@ _optional_|Command path|string|
[[_launchcommand_post_options]]
*Options*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -128,37 +126,21 @@ _optional_|option value|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_launchcommand_post_response_200,Response 200>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_launchcommand_post_response_200,Response 200>>
|*400*|Error|<<_error,Error>>
|===
[[_launchcommand_post_response_200]]
*Response 200*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Location* +
@@ -172,7 +154,7 @@ _optional_|<description>|string|
[[_launchcommand_post_options]]
*Options*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -200,7 +182,7 @@ Dummy description
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*Version* +
@@ -210,7 +192,7 @@ _optional_|The API version|<<_mixedparameters_post_version,Version>>|
[[_mixedparameters_post_version]]
*Version*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -220,7 +202,7 @@ _optional_||< <<_mixedparameters_post_mytable,myTable>>> array|
[[_mixedparameters_post_mytable]]
*myTable*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -230,7 +212,7 @@ _optional_||<string,<<_mixedparameters_post_mytable_mydict,myDict>>> map|
[[_mixedparameters_post_mytable_mydict]]
*myDict*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +
@@ -242,9 +224,7 @@ _optional_||string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_mixedparameters_post_response_200,Response 200>>
@@ -253,7 +233,7 @@ _optional_||string|
[[_mixedparameters_post_response_200]]
*Response 200*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -263,7 +243,7 @@ _optional_||< <<_mixedparameters_post_mytable,myTable>>> array|
[[_mixedparameters_post_mytable]]
*myTable*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -273,7 +253,7 @@ _optional_||<string,<<_mixedparameters_post_mytable_mydict,myDict>>> map|
[[_mixedparameters_post_mytable_mydict]]
*myDict*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +
@@ -301,7 +281,7 @@ Dummy description
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*Version* +
@@ -311,7 +291,7 @@ _optional_|The API version|<<_request,Request>>|
[[_request]]
*Request*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -321,7 +301,7 @@ _optional_||< <<_tablecontent,TableContent>>> array|
[[_tablecontent]]
*TableContent*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -331,7 +311,7 @@ _optional_||<string,<<_kvpair,KVPair>>> map|
[[_kvpair]]
*KVPair*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +
@@ -343,9 +323,7 @@ _optional_||string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_result,Result>>
@@ -354,7 +332,7 @@ _optional_||string|
[[_result]]
*Result*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -364,7 +342,7 @@ _optional_||< <<_tablecontent,TableContent>>> array|
[[_tablecontent]]
*TableContent*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -374,7 +352,7 @@ _optional_||<string,<<_kvpair,KVPair>>> map|
[[_kvpair]]
*KVPair*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +

44
src/test/resources/expected/asciidoc/inline_schema_flat_body/definitions.adoc
View File

@@ -5,7 +5,7 @@
[[_error]]
=== Error
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*error-code* +
@@ -18,7 +18,7 @@ _optional_|Error message|string|
[[_externallocation]]
=== ExternalLocation
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Place* +
@@ -29,7 +29,7 @@ _optional_|Place|string|
[[_inlinedepthschema]]
=== InlineDepthSchema
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Loop* +
@@ -39,7 +39,7 @@ _optional_||<<_inlinedepthschema_loop,Loop>>|
[[_inlinedepthschema_loop]]
*Loop*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p1* +
@@ -51,7 +51,7 @@ _optional_|Description p2|<<_inlinedepthschema_p2,p2>>|
[[_inlinedepthschema_p2]]
*p2*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p2-1* +
@@ -63,7 +63,7 @@ _optional_|Description p2-2|<<_inlinedepthschema_p2_p2-2,p2-2>>|
[[_inlinedepthschema_p2_p2-2]]
*p2-2*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p2-2-1* +
@@ -75,7 +75,7 @@ _optional_|Description p2-2-2|<<_inlinedepthschema_p2_p2-2_p2-2-2,p2-2-2>>|
[[_inlinedepthschema_p2_p2-2_p2-2-1]]
*p2-2-1*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p2-2-1-1* +
@@ -87,7 +87,7 @@ _optional_|Description p2-2-1-2|boolean|
[[_inlinedepthschema_p2_p2-2_p2-2-2]]
*p2-2-2*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p2-2-2-1* +
@@ -100,7 +100,7 @@ _optional_|Description p2-2-2-2|boolean|
[[_inlinepet]]
=== InlinePet
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -114,7 +114,7 @@ _optional_||< <<_inlinepet_tags,tags>>> array|
[[_inlinepet_category]]
*category*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -126,7 +126,7 @@ _optional_||string|
[[_inlinepet_tags]]
*tags*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -139,7 +139,7 @@ _optional_||string|
[[_inlinetitlepet]]
=== InlineTitlePet
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -153,7 +153,7 @@ _optional_||< <<_tagmodel,TagModel>>> array|
[[_categorymodel]]
*CategoryModel*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -165,7 +165,7 @@ _optional_||string|
[[_tagmodel]]
*TagModel*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -178,7 +178,7 @@ _optional_||string|
[[_location]]
=== Location
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Place* +
@@ -191,7 +191,7 @@ _optional_|Place|string|
mixed collections and objects
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -201,7 +201,7 @@ _optional_||< <<_mixedschema_mytable,myTable>>> array|
[[_mixedschema_mytable]]
*myTable*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -211,7 +211,7 @@ _optional_||<string,<<_mixedschema_mydict,myDict>>> map|
[[_mixedschema_mydict]]
*myDict*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +
@@ -230,7 +230,7 @@ _Type_ : < <string,<<_recursivecollectionschema_inline,RecursiveCollectionSchema
[[_recursivecollectionschema_inline]]
*RecursiveCollectionSchema*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -245,7 +245,7 @@ _optional_|option value|string|
mixed collections and objects
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -255,7 +255,7 @@ _optional_||< <<_tablecontent,TableContent>>> array|
[[_tablecontent]]
*TableContent*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*emptyObject* +
@@ -267,7 +267,7 @@ _optional_||<string,<<_kvpair,KVPair>>> map|
[[_kvpair]]
*KVPair*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +

80
src/test/resources/expected/asciidoc/inline_schema_flat_body/paths.adoc
View File

@@ -24,7 +24,7 @@ _Type_ : < <string,<<_collectionparameters_post_version,Version>>> map> array
[[_collectionparameters_post_version]]
*Version*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -36,9 +36,7 @@ _optional_|option value|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|< <string,<<_collectionparameters_post_response_200,Response 200>>> map> array
@@ -47,7 +45,7 @@ _optional_|option value|string|
[[_collectionparameters_post_response_200]]
*Response 200*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -75,7 +73,7 @@ Dummy description
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*Option* +
@@ -93,7 +91,7 @@ _Name_ : LaunchCommandRequest
_Flags_ : optional
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Command* +
@@ -107,7 +105,7 @@ _optional_|Options k/v pairs|< <<_launchcommand_post_options,Options>>> array|
[[_launchcommand_post_command]]
*Command*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*args* +
@@ -119,7 +117,7 @@ _optional_|Command path|string|
[[_launchcommand_post_options]]
*Options*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -131,37 +129,21 @@ _optional_|option value|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_launchcommand_post_response_200,Response 200>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_launchcommand_post_response_200,Response 200>>
|*400*|Error|<<_error,Error>>
|===
[[_launchcommand_post_response_200]]
*Response 200*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*Location* +
@@ -175,7 +157,7 @@ _optional_|<description>|string|
[[_launchcommand_post_options]]
*Options*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*key* +
@@ -209,7 +191,7 @@ _Name_ : Version
_Flags_ : optional
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -219,7 +201,7 @@ _optional_||< <<_mixedparameters_post_mytable,myTable>>> array|
[[_mixedparameters_post_mytable]]
*myTable*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -229,7 +211,7 @@ _optional_||<string,<<_mixedparameters_post_mydict,myDict>>> map|
[[_mixedparameters_post_mydict]]
*myDict*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +
@@ -241,9 +223,7 @@ _optional_||string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_mixedparameters_post_response_200,Response 200>>
@@ -252,7 +232,7 @@ _optional_||string|
[[_mixedparameters_post_response_200]]
*Response 200*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -262,7 +242,7 @@ _optional_||< <<_mixedparameters_post_mytable,myTable>>> array|
[[_mixedparameters_post_mytable]]
*myTable*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -272,7 +252,7 @@ _optional_||<string,<<_mixedparameters_post_mytable_mydict,myDict>>> map|
[[_mixedparameters_post_mytable_mydict]]
*myDict*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +
@@ -306,7 +286,7 @@ _Name_ : Version
_Flags_ : optional
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -316,7 +296,7 @@ _optional_||< <<_tablecontent,TableContent>>> array|
[[_tablecontent]]
*TableContent*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -326,7 +306,7 @@ _optional_||<string,<<_kvpair,KVPair>>> map|
[[_kvpair]]
*KVPair*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +
@@ -338,9 +318,7 @@ _optional_||string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_result,Result>>
@@ -349,7 +327,7 @@ _optional_||string|
[[_result]]
*Result*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myTable* +
@@ -359,7 +337,7 @@ _optional_||< <<_tablecontent,TableContent>>> array|
[[_tablecontent]]
*TableContent*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*myDict* +
@@ -369,7 +347,7 @@ _optional_||<string,<<_kvpair,KVPair>>> map|
[[_kvpair]]
*KVPair*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*k* +

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

@@ -7,7 +7,7 @@
Information about a given HTTP mapping.
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*bean* +

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

@@ -15,7 +15,7 @@ Returns integer metrics information for the application.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -25,9 +25,7 @@ _optional_|String metrics|<string,integer(int32)> map|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|<string,string> map
@@ -62,7 +60,7 @@ Returns a collated list of all `@RequestMapping` paths.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -72,9 +70,7 @@ _optional_|Mappings|<string,<<_mappinginfo,MappingInfo>>> map|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|<string,<<_mappinginfo,MappingInfo>>> map
@@ -109,7 +105,7 @@ Returns metrics information for the application.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -119,7 +115,7 @@ _optional_|Metrics|<string,<<_createmetrics_body,body>>> map|
[[_createmetrics_body]]
*body*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p1* +
@@ -131,9 +127,7 @@ _optional_||string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|<string,<<_createmetrics_response_200,Response 200>>> map
@@ -142,7 +136,7 @@ _optional_||string|
[[_createmetrics_response_200]]
*Response 200*
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*p1* +
@@ -180,7 +174,7 @@ Returns string metrics information for the application.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -190,9 +184,7 @@ _optional_|String metrics|<string,string> map|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|<string,string> map

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

@@ -11,7 +11,7 @@ _Polymorphism_ : Inheritance
_Discriminator_ : collType
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*collType* +
@@ -30,7 +30,7 @@ _Polymorphism_ : Inheritance
_Discriminator_ : petType
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*huntingSkill* +
@@ -47,7 +47,7 @@ _required_||string|
Collection parent type without discriminator
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*name* +
@@ -64,7 +64,7 @@ _Polymorphism_ : Inheritance
_Discriminator_ : dogType
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*dogType* +
@@ -86,7 +86,7 @@ A map without discriminator
_Polymorphism_ : Composition
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*collType* +
@@ -101,7 +101,7 @@ _optional_||string|
Pet parent type with discriminator
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*name* +

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

@@ -15,9 +15,7 @@ Get collections
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|<<_collection,Collection>>
@@ -47,9 +45,7 @@ Get pets
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|<<_pet,Pet>>

52
src/test/resources/expected/asciidoc/response_headers/definitions.adoc Normal file
View File

@@ -0,0 +1,52 @@
[[_definitions]]
== Definitions
[[_category]]
=== Category
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)|
|*name* +
_optional_||string|
|===
[[_pet]]
=== Pet
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
_optional_||<<_category,Category>>|
|*id* +
_optional_||integer(int64)|
|*name* +
_required_|*Example* : `"doggie"`|string|
|*photoUrls* +
_required_||<string> array|
|*status* +
_optional_|pet status in the store,|enum (Dead, Alive)|
|*tags* +
_optional_||< <<_tag,Tag>>> array|
|===
[[_tag]]
=== Tag
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
_optional_||integer(int64)|
|*name* +
_optional_||string|
|===

44
src/test/resources/expected/asciidoc/response_headers/overview.adoc Normal file
View File

@@ -0,0 +1,44 @@
= Swagger Petstore
[[_overview]]
== Overview
This is a sample server Petstore server.
http://swagger.io[Learn about Swagger] or join the IRC channel `#swagger` on irc.freenode.net.
For this sample, you can use the api key `special-key` to test the authorization filters
=== Version information
[%hardbreaks]
_Version_ : 1.0.0
=== Contact information
[%hardbreaks]
_Contact_ : apiteam@swagger.io
=== License information
[%hardbreaks]
_License_ : Apache 2.0
_License URL_ : http://www.apache.org/licenses/LICENSE-2.0.html
_Terms of service_ : http://helloreverb.com/terms/
=== URI scheme
[%hardbreaks]
_Host_ : petstore.swagger.io
_BasePath_ : /v2
_Schemes_ : HTTP
=== Tags
* pet : Pet resource
* store : Store resource
* user : User resource

70
src/test/resources/expected/asciidoc/response_headers/paths.adoc Normal file
View File

@@ -0,0 +1,70 @@
[[_paths]]
== Paths
[[_getpetbyid]]
=== Find pet by ID
....
GET /pets/{petId}
....
==== Description
Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
==== Parameters
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)|
|===
==== Responses
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (string) : The number of allowed requests in the current period. *Default* : 20 +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
This is an important value !. +
`X-Rate-Limit-Reset` (boolean) : *Default* : false|<<_pet,Pet>>
|*400*|Invalid ID supplied|No Content
|*404*|Page not found (override) +
*Headers* : +
`X-Rate-Limit-Limit` (string) : The number of allowed requests in the current period. *Default* : 20 +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
This is an important value !. +
`X-Rate-Limit-Reset` (boolean) : *Default* : false +
`Nothing` (integer) +
`DottedDescription` (string) : This description is terminated with a dot. *Default* : 20|No Content
|===
==== Produces
* `application/json`
* `application/xml`
==== Tags
* pet
==== Security
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*apiKey*|*<<_api_key,api_key>>*|
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
|===

29
src/test/resources/expected/asciidoc/response_headers/security.adoc Normal file
View File

@@ -0,0 +1,29 @@
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
[%hardbreaks]
_Type_ : oauth2
_Flow_ : implicit
_Token URL_ : http://petstore.swagger.io/api/oauth/dialog
[options="header", cols=".^3,.^17"]
|===
|Name|Description
|write_pets|modify pets in your account
|read_pets|read your pets
|===

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

@@ -55,7 +55,7 @@ POST /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -65,9 +65,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -93,7 +91,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -138,7 +136,7 @@ PUT /pets
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -148,29 +146,11 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*405*|Validation exception|No Content
|===
@@ -194,7 +174,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -243,7 +223,7 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*status* +
@@ -253,30 +233,14 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<_pet,Pet>>> array
|*400*|Invalid status value|No Content
|===
@@ -294,7 +258,7 @@ _optional_|Status values that need to be considered for filter|<string> array(mu
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -341,7 +305,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
@@ -351,30 +315,14 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>>> array
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<_pet,Pet>>> array
|*400*|Invalid tag value|No Content
|===
@@ -392,7 +340,7 @@ _optional_|Tags to filter by|<string> array(multi)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -435,7 +383,7 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -449,9 +397,7 @@ _required_|Updated status of the pet|string|
==== Responses
===== HTTP Code 405
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -476,7 +422,7 @@ _required_|Updated status of the pet|string|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -512,7 +458,7 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
@@ -522,39 +468,15 @@ _required_|ID of pet that needs to be fetched|integer(int64)|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_pet,Pet>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_pet,Pet>>
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Pet not found|No Content
|===
@@ -572,7 +494,7 @@ _required_|ID of pet that needs to be fetched|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*apiKey*|*<<_api_key,api_key>>*|
@@ -620,7 +542,7 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
@@ -632,9 +554,7 @@ _required_|Pet id to delete|integer(int64)|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -654,7 +574,7 @@ _required_|Pet id to delete|integer(int64)|
==== Security
[options="header", cols=".^1,.^1,.^3"]
[options="header", cols=".^3,.^4,.^13"]
|===
|Type|Name|Scopes
|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets
@@ -686,7 +606,7 @@ POST /stores/order
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -696,30 +616,14 @@ _optional_|order placed for purchasing the pet|<<_order,Order>>|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_order,Order>>
|*400*|Invalid Order|No Content
|===
@@ -787,7 +691,7 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -797,39 +701,15 @@ _required_|ID of pet that needs to be fetched|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_order,Order>>
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -883,7 +763,7 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
@@ -893,20 +773,10 @@ _required_|ID of the order that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|Order not found|No Content
|===
@@ -944,7 +814,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -954,9 +824,7 @@ _optional_|Created user object|<<_user,User>>|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1008,7 +876,7 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -1018,9 +886,7 @@ _optional_|List of user object|< <<_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1072,7 +938,7 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
@@ -1082,9 +948,7 @@ _optional_|List of user object|< <<_user,User>>> array|
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1136,7 +1000,7 @@ GET /users/login
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*password* +
@@ -1148,30 +1012,14 @@ _optional_|The user name for login|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|string
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|string
|*400*|Invalid username/password supplied|No Content
|===
@@ -1224,9 +1072,7 @@ GET /users/logout
==== Responses
===== HTTP Code default
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1262,7 +1108,7 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -1272,39 +1118,15 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|
==== Responses
===== HTTP Code 200
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_user,User>>
|===
*Headers*
[options="header", cols=".^1,.^4,.^2,.^1"]
|===
|Name|Description|Schema|Default
|*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-Reset*|The number of seconds left in the current period|integer|
|===
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
*Headers* : +
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_user,User>>
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -1360,7 +1182,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -1372,20 +1194,10 @@ _optional_|Updated user object|<<_user,User>>|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -1439,7 +1251,7 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^1,.^1,.^4,.^2,.^1"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -1449,20 +1261,10 @@ _required_|The name that needs to be deleted|string|
==== Responses
===== HTTP Code 400
[options="header", cols=".^1,.^4,.^2"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content
|===
===== HTTP Code 404
[options="header", cols=".^1,.^4,.^2"]
|===
|HTTP Code|Description|Schema
|*404*|User not found|No Content
|===
@@ -1495,7 +1297,7 @@ _required_|The name that needs to be deleted|string|
[[_category]]
=== Category
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -1508,7 +1310,7 @@ _optional_|*Example* : `"string"`|string|
[[_order]]
=== Order
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*complete* +
@@ -1530,7 +1332,7 @@ _optional_|Order Status +
[[_pet]]
=== Pet
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*category* +
@@ -1552,7 +1354,7 @@ _optional_|*Example* : `[ "<<_tag>>" ]`|< <<_tag,Tag>>> array|
[[_tag]]
=== Tag
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*id* +
@@ -1565,7 +1367,7 @@ _optional_|*Example* : `"string"`|string|
[[_user]]
=== User
[options="header", cols=".^1,.^4,.^2,.^1"]
[options="header", cols=".^3,.^11,.^4,.^2"]
|===
|Name|Description|Schema|Default
|*email* +
@@ -1609,7 +1411,7 @@ _Flow_ : implicit
_Token URL_ : http://petstore.swagger.io/api/oauth/dialog
[options="header", cols="1,6"]
[options="header", cols=".^3,.^17"]
|===
|Name|Description
|write_pets|modify pets in your account

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

@@ -18,8 +18,6 @@ POST /pets
#### Responses
##### HTTP Code 405
|HTTP Code|Description|Schema|
|---|---|---|
|**405**|Invalid input|No Content|
@@ -65,24 +63,10 @@ PUT /pets
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid ID supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|Pet not found|No Content|
##### HTTP Code 405
|HTTP Code|Description|Schema|
|---|---|---|
|**405**|Validation exception|No Content|
@@ -130,25 +114,9 @@ Multiple status values can be provided with comma seperated strings
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|<[Pet](#pet)> array|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<[Pet](#pet)> array|
|**400**|Invalid status value|No Content|
@@ -190,25 +158,9 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|<[Pet](#pet)> array|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<[Pet](#pet)> array|
|**400**|Invalid tag value|No Content|
@@ -248,8 +200,6 @@ POST /pets/{petId}
#### Responses
##### HTTP Code 405
|HTTP Code|Description|Schema|
|---|---|---|
|**405**|Invalid input|No Content|
@@ -298,32 +248,10 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error cond
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|[Pet](#pet)|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|[Pet](#pet)|
|**400**|Invalid ID supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|Pet not found|No Content|
@@ -363,8 +291,6 @@ DELETE /pets/{petId}
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid pet value|No Content|
@@ -404,25 +330,9 @@ POST /stores/order
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|[Order](#order)|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|[Order](#order)|
|**400**|Invalid Order|No Content|
@@ -457,32 +367,10 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|[Order](#order)|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|[Order](#order)|
|**400**|Invalid ID supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|Order not found|No Content|
@@ -517,17 +405,9 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid ID supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|Order not found|No Content|
@@ -562,8 +442,6 @@ This can only be done by the logged in user.
#### Responses
##### HTTP Code default
|HTTP Code|Description|Schema|
|---|---|---|
|**default**|successful operation|No Content|
@@ -596,8 +474,6 @@ POST /users/createWithArray
#### Responses
##### HTTP Code default
|HTTP Code|Description|Schema|
|---|---|---|
|**default**|successful operation|No Content|
@@ -630,8 +506,6 @@ POST /users/createWithList
#### Responses
##### HTTP Code default
|HTTP Code|Description|Schema|
|---|---|---|
|**default**|successful operation|No Content|
@@ -665,25 +539,9 @@ GET /users/login
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|string|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|string|
|**400**|Invalid username/password supplied|No Content|
@@ -707,8 +565,6 @@ GET /users/logout
#### Responses
##### HTTP Code default
|HTTP Code|Description|Schema|
|---|---|---|
|**default**|successful operation|No Content|
@@ -741,32 +597,10 @@ GET /users/{username}
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|[User](#user)|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|[User](#user)|
|**400**|Invalid username supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|User not found|No Content|
@@ -802,17 +636,9 @@ This can only be done by the logged in user.
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid user supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|User not found|No Content|
@@ -847,17 +673,9 @@ This can only be done by the logged in user.
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid username supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|User not found|No Content|

196
src/test/resources/expected/markdown/idxref/paths.md
View File

@@ -18,8 +18,6 @@ POST /pets
#### Responses
##### HTTP Code 405
|HTTP Code|Description|Schema|
|---|---|---|
|**405**|Invalid input|No Content|
@@ -65,24 +63,10 @@ PUT /pets
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid ID supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|Pet not found|No Content|
##### HTTP Code 405
|HTTP Code|Description|Schema|
|---|---|---|
|**405**|Validation exception|No Content|
@@ -130,25 +114,9 @@ Multiple status values can be provided with comma seperated strings
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|<[Pet](definitions.md#pet)> array|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<[Pet](definitions.md#pet)> array|
|**400**|Invalid status value|No Content|
@@ -190,25 +158,9 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|<[Pet](definitions.md#pet)> array|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<[Pet](definitions.md#pet)> array|
|**400**|Invalid tag value|No Content|
@@ -248,8 +200,6 @@ POST /pets/{petId}
#### Responses
##### HTTP Code 405
|HTTP Code|Description|Schema|
|---|---|---|
|**405**|Invalid input|No Content|
@@ -298,32 +248,10 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error cond
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|[Pet](definitions.md#pet)|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|[Pet](definitions.md#pet)|
|**400**|Invalid ID supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|Pet not found|No Content|
@@ -363,8 +291,6 @@ DELETE /pets/{petId}
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid pet value|No Content|
@@ -404,25 +330,9 @@ POST /stores/order
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|[Order](definitions.md#order)|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|[Order](definitions.md#order)|
|**400**|Invalid Order|No Content|
@@ -457,32 +367,10 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|[Order](definitions.md#order)|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|[Order](definitions.md#order)|
|**400**|Invalid ID supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|Order not found|No Content|
@@ -517,17 +405,9 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid ID supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|Order not found|No Content|
@@ -562,8 +442,6 @@ This can only be done by the logged in user.
#### Responses
##### HTTP Code default
|HTTP Code|Description|Schema|
|---|---|---|
|**default**|successful operation|No Content|
@@ -596,8 +474,6 @@ POST /users/createWithArray
#### Responses
##### HTTP Code default
|HTTP Code|Description|Schema|
|---|---|---|
|**default**|successful operation|No Content|
@@ -630,8 +506,6 @@ POST /users/createWithList
#### Responses
##### HTTP Code default
|HTTP Code|Description|Schema|
|---|---|---|
|**default**|successful operation|No Content|
@@ -665,25 +539,9 @@ GET /users/login
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|string|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|string|
|**400**|Invalid username/password supplied|No Content|
@@ -707,8 +565,6 @@ GET /users/logout
#### Responses
##### HTTP Code default
|HTTP Code|Description|Schema|
|---|---|---|
|**default**|successful operation|No Content|
@@ -741,32 +597,10 @@ GET /users/{username}
#### Responses
##### HTTP Code 200
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation|[User](definitions.md#user)|
**Headers**
|Name|Description|Schema|Default|
|---|---|---|---|
|**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-Reset**|The number of seconds left in the current period|integer||
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. <br>`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|[User](definitions.md#user)|
|**400**|Invalid username supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|User not found|No Content|
@@ -802,17 +636,9 @@ This can only be done by the logged in user.
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid user supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|User not found|No Content|
@@ -847,17 +673,9 @@ This can only be done by the logged in user.
#### Responses
##### HTTP Code 400
|HTTP Code|Description|Schema|
|---|---|---|
|**400**|Invalid username supplied|No Content|
##### HTTP Code 404
|HTTP Code|Description|Schema|
|---|---|---|
|**404**|User not found|No Content|

36
src/test/resources/expected/markdown/response_headers/definitions.md Normal file
View File

@@ -0,0 +1,36 @@
<a name="definitions"></a>
## Definitions
<a name="category"></a>
### Category
|Name|Description|Schema|Default|
|---|---|---|---|
|**id** <br>*optional*||integer(int64)||
|**name** <br>*optional*||string||
<a name="pet"></a>
### Pet
|Name|Description|Schema|Default|
|---|---|---|---|
|**category** <br>*optional*||[Category](#category)||
|**id** <br>*optional*||integer(int64)||
|**name** <br>*required*|**Example** : `"doggie"`|string||
|**photoUrls** <br>*required*||<string> array||
|**status** <br>*optional*|pet status in the store,|enum (Dead, Alive)||
|**tags** <br>*optional*||<[Tag](#tag)> array||
<a name="tag"></a>
### Tag
|Name|Description|Schema|Default|
|---|---|---|---|
|**id** <br>*optional*||integer(int64)||
|**name** <br>*optional*||string||

40
src/test/resources/expected/markdown/response_headers/overview.md Normal file
View File

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

51
src/test/resources/expected/markdown/response_headers/paths.md Normal file
View File

@@ -0,0 +1,51 @@
<a name="paths"></a>
## Paths
<a name="getpetbyid"></a>
### Find pet by ID
```
GET /pets/{petId}
```
#### Description
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
#### Parameters
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)||
#### Responses
|HTTP Code|Description|Schema|
|---|---|---|
|**200**|successful operation <br>**Headers** : <br>`X-Rate-Limit-Limit` (string) : The number of allowed requests in the current period. **Default** : 20 <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +<br>This is an important value !. <br>`X-Rate-Limit-Reset` (boolean) : **Default** : false|[Pet](#pet)|
|**400**|Invalid ID supplied|No Content|
|**404**|Page not found (override) <br>**Headers** : <br>`X-Rate-Limit-Limit` (string) : The number of allowed requests in the current period. **Default** : 20 <br>`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +<br>This is an important value !. <br>`X-Rate-Limit-Reset` (boolean) : **Default** : false <br>`Nothing` (integer) <br>`DottedDescription` (string) : This description is terminated with a dot. **Default** : 20|No Content|
#### Produces
* `application/json`
* `application/xml`
#### Tags
* pet
#### Security
|Type|Name|Scopes|
|---|---|---|
|**apiKey**|**[api_key](#api_key)**||
|**oauth2**|**[petstore_auth](#petstore_auth)**|write_pets,read_pets|

25
src/test/resources/expected/markdown/response_headers/security.md Normal file
View File

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

166
src/test/resources/yaml/swagger_response_headers.yaml Normal file
View File

@@ -0,0 +1,166 @@
swagger: "2.0"
info:
description: |
This is a sample server Petstore server.
[Learn about Swagger](http://swagger.io) or join the IRC channel `#swagger` on irc.freenode.net.
For this sample, you can use the api key `special-key` to test the authorization filters
version: "1.0.0"
title: Swagger Petstore
termsOfService: http://helloreverb.com/terms/
contact:
name: apiteam@swagger.io
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
host: petstore.swagger.io
basePath: /v2
schemes:
- http
tags:
- name: pet
description: Pet resource
- name: store
description: Store resource
- name: user
description: User resource
paths:
/pets/{petId}:
get:
tags:
- pet
summary: Find pet by ID
description: Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
operationId: getPetById
produces:
- application/json
- application/xml
parameters:
- in: path
name: petId
description: ID of pet that needs to be fetched
required: true
type: integer
format: int64
responses:
"404":
description: Pet not found
$ref: "#/responses/NotFound"
"200":
description: successful operation
schema:
$ref: "#/definitions/Pet"
headers:
X-Rate-Limit-Limit:
description: The number of allowed requests in the current period
type: string
default: "20"
X-Rate-Limit-Remaining:
description: |
The number of remaining requests in the current period. +
This is an important value !
type: integer
X-Rate-Limit-Reset:
type: boolean
default: false
"400":
$ref: "#/responses/InvalidId"
security:
- api_key: []
- petstore_auth:
- write_pets
- read_pets
parameters:
PetBody:
in: body
name: body
description: Pet object that needs to be added to the store
required: false
schema:
$ref: "#/definitions/Pet"
responses:
InvalidId:
description: Invalid ID supplied
NotFound:
description: Page not found (override)
headers:
X-Rate-Limit-Limit:
description: The number of allowed requests in the current period
type: string
default: "20"
X-Rate-Limit-Remaining:
description: |
The number of remaining requests in the current period. +
This is an important value !
type: integer
X-Rate-Limit-Reset:
type: boolean
default: false
Nothing:
type: integer
DottedDescription:
description: This description is terminated with a dot.
type: string
default: "20"
securityDefinitions:
api_key:
type: apiKey
name: api_key
in: header
petstore_auth:
type: oauth2
authorizationUrl: http://petstore.swagger.io/api/oauth/dialog
flow: implicit
scopes:
write_pets: modify pets in your account
read_pets: read your pets
definitions:
Category:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
Pet:
type: object
required:
- name
- photoUrls
properties:
id:
type: integer
format: int64
category:
$ref: "#/definitions/Category"
name:
type: string
example: doggie
photoUrls:
type: array
items:
type: string
tags:
type: array
items:
$ref: "#/definitions/Tag"
status:
type: string
description: pet status in the store,
enum:
- Dead
- Alive
Tag:
type: object
properties:
id:
type: integer
format: int64
name:
type: string