Compare commits

..

2 Commits

Author SHA1 Message Date
Hugo de Paix de Coeur
85c5b7aa97 switched swagger-parser to 1.0.21-SNAPSHOT
Added a use case in tests : object array with examples
Added a workaround for object array examples because swagger-parser returns a string and not an ArrayNode as expected
2016-06-10 11:45:19 +02:00
Hugo de Paix de Coeur
662cc3f40f Added inline schemas in generatedExample test
Ignore inline schema tests because of a bug in swagger-parser-1.0.21
2016-06-10 11:42:05 +02:00
98 changed files with 1551 additions and 3253 deletions

3
.gitignore vendored
View File

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

View File

@@ -27,7 +27,7 @@ image::src/docs/asciidoc/images/Swagger2Markup.PNG[]
image::src/docs/asciidoc/images/Swagger2Markup_definitions.PNG[]
== Reference documentation
- http://swagger2markup.github.io/swagger2markup/1.1.0/[Reference Documentation]
- http://swagger2markup.github.io/swagger2markup/1.0.0/[Reference Documentation]
- https://github.com/Swagger2Markup/swagger2markup/blob/master/RELEASENOTES.adoc[Release notes]
- https://github.com/Swagger2Markup/spring-swagger2markup-demo[Demo using Swagger2Markup, Spring Boot, Springfox and spring-restdocs]

View File

@@ -78,9 +78,9 @@
=== Version 0.9.3
* Updated swagger-parser from v1.0.13 to v1.0.16
* Enhancement #61: Refactor separated documents logic to support inter-document cross-references
* Enhancement #53: Support for tags, paths and methods ordering
* Enhancement #51: Support for separated operations files
* Enhancement #61 Refactor separated documents logic to support inter-document cross-references
* Enhancement #53 : support for tags, paths and methods ordering
* Enhancement #51 : Support for separated operations files
* Enhancement #52: Markdown generation for inline schemas
== Version 1.0.0
@@ -91,15 +91,3 @@
* Inline schema support
* New configuration options
* Support of deprecated path operations
=== Version 1.0.1
* Enhancement: Support to render validation constraints of properties
* Enhancement: Possibility to disable rendering of the security chapter below operations
== Version 1.1.0
* PR #177: Fixed rendering of recursive examples
* PR #186: Add support for Chinese language
* PR #190: Add support for Spanish language
* PR #192: Updated min/max value to format correctly based on the data type
* PR #193: Added support for exclusiveMin and exclusiveMax

View File

@@ -13,12 +13,10 @@ buildscript {
}
}
description = 'swagger2markup Build'
version = '1.1.0'
ext.releaseVersion = '1.1.0'
version = '1.0.1-SNAPSHOT'
group = 'io.github.swagger2markup'
apply plugin: 'java'
apply plugin: 'eclipse'
apply from: 'gradle/publishing.gradle'
apply from: 'gradle/coverage.gradle'
apply from: 'gradle/documentation.gradle'
@@ -37,12 +35,12 @@ repositories {
}
jcenter()
mavenCentral()
//mavenLocal()
mavenLocal()
}
dependencies {
compile 'io.github.swagger2markup:markup-document-builder:1.0.0'
compile 'io.swagger:swagger-compat-spec-parser:1.0.18'
compile 'io.swagger:swagger-compat-spec-parser:1.0.21-SNAPSHOT'
compile 'org.apache.commons:commons-configuration2:2.0'
compile 'commons-beanutils:commons-beanutils:1.9.2'
compile 'org.apache.commons:commons-collections4:4.1'
@@ -60,6 +58,7 @@ test {
systemProperty 'http.nonProxyHosts', System.properties['http.nonProxyHosts']
}
systemProperty 'file.encoding', 'UTF-8'
ignoreFailures = true
}

View File

@@ -14,7 +14,6 @@ asciidoctor {
sectlinks: '',
sectanchors: '',
hardbreaks: '',
'release-version': project.releaseVersion
]
}
@@ -30,6 +29,6 @@ githubPages {
pages {
from file(asciidoctor.outputDir.path + '/html5')
into project.releaseVersion
into project.version
}
}

View File

@@ -16,7 +16,7 @@ You can show the help:
[source, subs="attributes"]
----
java -jar swagger2markup-cli-{release-version}.jar help convert
java -jar swagger2markup-cli-{project-version}.jar help convert
----
Output:
@@ -57,7 +57,7 @@ You can convert a Swagger file into a folder as follows:
[source, subs="attributes"]
----
java -jar swagger2markup-cli-{release-version}.jar convert -i /path/to/swagger_petstore.yaml -d /tmp/asiidoc
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -d /tmp/asiidoc
----
It generates the Markup documents into the `/tmp/asiidoc` folder.
@@ -68,7 +68,7 @@ You can convert a local Swagger file into a file as follows:
[source, subs="attributes"]
----
java -jar swagger2markup-cli-{release-version}.jar convert -i /path/to/swagger_petstore.yaml -f /tmp/asiidoc/swagger
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -f /tmp/asiidoc/swagger
----
NOTE: The input file must not have a file extension
@@ -81,7 +81,7 @@ You can convert a remote Swagger specification which must be accessible via HTTP
[source, subs="attributes"]
----
java -jar swagger2markup-cli-{release-version}.jar convert -i "http://petstore.swagger.io/v2/swagger.json" -d /tmp
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i "http://petstore.swagger.io/v2/swagger.json" -d /tmp
----
=== Configuration
@@ -98,6 +98,6 @@ Invoke the CLI as follows:
[source, subs="attributes"]
----
java -jar swagger2markup-cli-{release-version}.jar convert -i /path/to/swagger_petstore.yaml -o /tmp -c /path/to/config.properties
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -o /tmp -c /path/to/config.properties
----

View File

@@ -1,13 +0,0 @@
== Docker image
The Swagger2Markup-CLI has been published as a Docker image on DockerHub.
=== Usage guide
You can pull the Swagger2Markup image as follows:
`docker pull swagger2markup/swagger2markup`
You can convert a Swagger Spec by running a Docker container as follows:
`docker run --rm -v $(pwd):/opt swagger2markup/swagger2markup convert -i /opt/swagger.yaml -f /opt/swagger -c /opt/config.properties`

View File

@@ -19,7 +19,7 @@ repositories {
jCenter()
}
compile "io.github.swagger2markup:swagger2markup:{release-version}"
compile "io.github.swagger2markup:swagger2markup:{project-version}"
----
==== Snapshot
@@ -50,7 +50,7 @@ repositories {
<dependency>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup</artifactId>
<version>{release-version}</version>
<version>{project-version}</version>
</dependency>
----

View File

@@ -18,7 +18,7 @@ buildscript {
}
dependencies {
classpath 'io.github.swagger2markup:swagger2markup-gradle-plugin:{release-version}'
classpath 'io.github.swagger2markup:swagger2markup-gradle-plugin:{project-version}'
}
}

View File

@@ -5,7 +5,7 @@ Robert Winkler
:source-highlighter: coderay
:numbered:
:hardbreaks:
:revnumber: {release-version}
:revnumber: {project-version}
:revdate: {localdate}
:icons: font
:pagenums:
@@ -26,8 +26,6 @@ include::maven_plugin.adoc[]
include::command_line_interface.adoc[]
include::docker.adoc[]
include::demo.adoc[]
include::contributing.adoc[]

View File

@@ -31,7 +31,7 @@ Add the following snippet to your Maven POM file:
<plugin>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup-maven-plugin</artifactId>
<version>{release-version}</version>
<version>{project-version}</version>
</plugin>
</plugins>
</build>
@@ -45,14 +45,14 @@ The plugin adds a new task goal `swagger2markup:convertSwagger2markup`. You can
You can customize the task by configuring a Map of <<Swagger2Markup properties>>.
[source,xml, subs="specialcharacters,attributes"]
[source,xml]
----
<build>
<plugins>
<plugin>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup-maven-plugin</artifactId>
<version>{release-version}</version>
<version>{project-version}</version>
<configuration>
<swaggerInput>${project.basedir}/src/docs/swagger/swagger_petstore.yaml</swaggerInput>
<outputDir>${project.build.directory}/asciidoc</outputDir>

View File

@@ -141,7 +141,6 @@ The following tables list all available properties of Swagger2Markup:
|swagger2markup.lineSeparator| Specifies the line separator which should be used | UNIX, WINDOWS, MAC | <System-dependent>
|swagger2markup.generatedExamplesEnabled| Specifies if HTTP request and response examples should be generated | true, false | false
|swagger2markup.flatBodyEnabled| Optionally isolate the body parameter, if any, from other parameters | true, false | false
|swagger2markup.pathSecuritySectionEnabled| Optionally disable the security section for path sections | true, false | true
|swagger2markup.anchorPrefix| Optionally prefix all anchors for uniqueness if you want to include generated documents into a global documentation | Any String |
|===

View File

@@ -22,13 +22,11 @@ import java.util.Locale;
* @author Maksim Myshkin
*/
public enum Language {
EN(Locale.ENGLISH),
EN(new Locale("en")),
RU(new Locale("ru")),
FR(Locale.FRENCH),
DE(Locale.GERMAN),
TR(new Locale("tr")),
ZH(Locale.CHINESE),
ES(new Locale("es"));
FR(new Locale("fr")),
DE(new Locale("de")),
TR(new Locale("tr"));
private final Locale lang;

View File

@@ -143,11 +143,6 @@ public interface Swagger2MarkupConfig {
*/
boolean isFlatBodyEnabled();
/**
* Optionally disable the security section for path sections
*/
boolean isPathSecuritySectionEnabled();
/**
* Optionally prefix all anchors for uniqueness.
*/

View File

@@ -48,7 +48,6 @@ public class Swagger2MarkupProperties {
public static final String INTER_DOCUMENT_CROSS_REFERENCES_ENABLED = PROPERTIES_PREFIX + ".interDocumentCrossReferencesEnabled";
public static final String INTER_DOCUMENT_CROSS_REFERENCES_PREFIX = PROPERTIES_PREFIX + ".interDocumentCrossReferencesPrefix";
public static final String FLAT_BODY_ENABLED = PROPERTIES_PREFIX + ".flatBodyEnabled";
public static final String PATH_SECURITY_SECTION_ENABLED = PROPERTIES_PREFIX + ".pathSecuritySectionEnabled";
public static final String ANCHOR_PREFIX = PROPERTIES_PREFIX + ".anchorPrefix";
public static final String OVERVIEW_DOCUMENT = PROPERTIES_PREFIX + ".overviewDocument";
public static final String PATHS_DOCUMENT = PROPERTIES_PREFIX + ".pathsDocument";

View File

@@ -109,7 +109,6 @@ public class Swagger2MarkupConfigBuilder {
config.interDocumentCrossReferencesEnabled = swagger2MarkupProperties.getRequiredBoolean(INTER_DOCUMENT_CROSS_REFERENCES_ENABLED);
config.interDocumentCrossReferencesPrefix = swagger2MarkupProperties.getString(INTER_DOCUMENT_CROSS_REFERENCES_PREFIX, null);
config.flatBodyEnabled = swagger2MarkupProperties.getRequiredBoolean(FLAT_BODY_ENABLED);
config.pathSecuritySectionEnabled = swagger2MarkupProperties.getRequiredBoolean(PATH_SECURITY_SECTION_ENABLED);
config.anchorPrefix = swagger2MarkupProperties.getString(ANCHOR_PREFIX, null);
config.overviewDocument = swagger2MarkupProperties.getRequiredString(OVERVIEW_DOCUMENT);
config.pathsDocument = swagger2MarkupProperties.getRequiredString(PATHS_DOCUMENT);
@@ -467,16 +466,6 @@ public class Swagger2MarkupConfigBuilder {
return this;
}
/**
* Optionally disable the security section for path sections
*
* @return this builder
*/
public Swagger2MarkupConfigBuilder withoutPathSecuritySection() {
config.pathSecuritySectionEnabled = false;
return this;
}
/**
* Optionally prefix all anchors for uniqueness.
*
@@ -526,7 +515,6 @@ public class Swagger2MarkupConfigBuilder {
private boolean interDocumentCrossReferencesEnabled;
private String interDocumentCrossReferencesPrefix;
private boolean flatBodyEnabled;
private boolean pathSecuritySectionEnabled;
private String anchorPrefix;
private LineSeparator lineSeparator;
@@ -654,11 +642,6 @@ public class Swagger2MarkupConfigBuilder {
return flatBodyEnabled;
}
@Override
public boolean isPathSecuritySectionEnabled() {
return pathSecuritySectionEnabled;
}
@Override
public String getAnchorPrefix() {
return anchorPrefix;

View File

@@ -61,7 +61,7 @@ public class DefinitionsDocumentBuilder extends MarkupDocumentBuilder {
public DefinitionsDocumentBuilder(Swagger2MarkupConverter.Context context, Swagger2MarkupExtensionRegistry extensionRegistry, Path outputPath) {
super(context, extensionRegistry, outputPath);
final ResourceBundle labels = ResourceBundle.getBundle("io/github/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
ResourceBundle labels = ResourceBundle.getBundle("io/github/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
DEFINITIONS = labels.getString("definitions");
POLYMORPHISM_COLUMN = labels.getString("polymorphism.column");
DISCRIMINATOR_COLUMN = labels.getString("polymorphism.discriminator");

View File

@@ -40,7 +40,6 @@ import java.nio.file.Path;
import java.util.*;
import static io.github.swagger2markup.internal.utils.MapUtils.toKeySet;
import static org.apache.commons.lang3.BooleanUtils.isTrue;
import static org.apache.commons.lang3.StringUtils.defaultString;
import static org.apache.commons.lang3.StringUtils.isNotBlank;
@@ -52,18 +51,6 @@ public abstract class MarkupDocumentBuilder {
protected static final String COLON = " : ";
protected final String DEFAULT_COLUMN;
protected final String MAXLENGTH_COLUMN;
protected final String MINLENGTH_COLUMN;
protected final String LENGTH_COLUMN;
protected final String PATTERN_COLUMN;
protected final String MINVALUE_COLUMN;
protected final String MINVALUE_EXCLUSIVE_COLUMN;
protected final String MAXVALUE_COLUMN;
protected final String MAXVALUE_EXCLUSIVE_COLUMN;
protected final String EXAMPLE_COLUMN;
protected final String SCHEMA_COLUMN;
protected final String NAME_COLUMN;
@@ -98,17 +85,6 @@ public abstract class MarkupDocumentBuilder {
ResourceBundle labels = ResourceBundle.getBundle("io/github/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
DEFAULT_COLUMN = labels.getString("default_column");
MINLENGTH_COLUMN = labels.getString("minlength_column");
MAXLENGTH_COLUMN = labels.getString("maxlength_column");
LENGTH_COLUMN = labels.getString("length_column");
PATTERN_COLUMN = labels.getString("pattern_column");
MINVALUE_COLUMN = labels.getString("minvalue_column");
MAXVALUE_COLUMN = labels.getString("maxvalue_column");
MINVALUE_EXCLUSIVE_COLUMN = labels.getString("minvalue_exclusive_column");
MAXVALUE_EXCLUSIVE_COLUMN = labels.getString("maxvalue_exclusive_column");
EXAMPLE_COLUMN = labels.getString("example_column");
FLAGS_COLUMN = labels.getString("flags.column");
FLAGS_REQUIRED = labels.getString("flags.required");
@@ -195,11 +171,10 @@ public abstract class MarkupDocumentBuilder {
protected List<ObjectType> buildPropertiesTable(Map<String, Property> properties, String uniquePrefix, DefinitionDocumentResolver definitionDocumentResolver, MarkupDocBuilder docBuilder) {
List<ObjectType> inlineDefinitions = new ArrayList<>();
List<List<String>> cells = new ArrayList<>();
ArrayList<MarkupTableColumn> cols = new ArrayList<>(Arrays.asList(
List<MarkupTableColumn> cols = 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")));
ArrayList<Integer> unusedCols = new ArrayList<>(Arrays.asList(2, 1, 0));
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"));
if (MapUtils.isNotEmpty(properties)) {
Set<String> propertyNames = toKeySet(properties, config.getPropertyOrdering());
for (String propertyName : propertyNames) {
@@ -211,114 +186,40 @@ public abstract class MarkupDocumentBuilder {
Object example = PropertyUtils.getExample(config.isGeneratedExamplesEnabled(), property, markupDocBuilder);
Object defaultValue = PropertyUtils.getDefaultValue(property);
Integer maxlength = PropertyUtils.getMaxlength(property);
Integer minlength = PropertyUtils.getMinlength(property);
String pattern = PropertyUtils.getPattern(property);
Number minValue = PropertyUtils.getMin(property);
Boolean exclusiveMin = PropertyUtils.getExclusiveMin(property);
Number maxValue = PropertyUtils.getMax(property);
Boolean exclusiveMax = PropertyUtils.getExclusiveMax(property);
MarkupDocBuilder propertyNameContent = copyMarkupDocBuilder();
propertyNameContent.boldTextLine(propertyName, true);
if (isTrue(property.getRequired()))
if (BooleanUtils.isTrue(property.getRequired()))
propertyNameContent.italicText(FLAGS_REQUIRED.toLowerCase());
else
propertyNameContent.italicText(FLAGS_OPTIONAL.toLowerCase());
if (isTrue(property.getReadOnly())) {
if (BooleanUtils.isTrue(property.getReadOnly())) {
propertyNameContent.newLine(true);
propertyNameContent.italicText(FLAGS_READ_ONLY.toLowerCase());
}
MarkupDocBuilder descriptionContent = copyMarkupDocBuilder();
String description = defaultString(swaggerMarkupDescription(property.getDescription()));
if (isNotBlank(description.toString()))
if (isNotBlank(description))
descriptionContent.text(description);
if(defaultValue != null){
if (isNotBlank(descriptionContent.toString()))
if (isNotBlank(description))
descriptionContent.newLine(true);
descriptionContent.boldText(DEFAULT_COLUMN).text(COLON).literalText(Json.pretty(defaultValue));
}
if (minlength != null && maxlength != null) {
// combination of minlength/maxlength
if (isNotBlank(descriptionContent.toString()))
descriptionContent.newLine(true);
String lengthRange = minlength + " - " + maxlength;
if (minlength.equals(maxlength)) {
lengthRange = minlength.toString();
}
descriptionContent.boldText(LENGTH_COLUMN).text(COLON).literalText(lengthRange);
} else {
if(minlength != null){
if (isNotBlank(descriptionContent.toString()))
descriptionContent.newLine(true);
descriptionContent.boldText(MINLENGTH_COLUMN).text(COLON).literalText(minlength.toString());
}
if(maxlength != null){
if (isNotBlank(descriptionContent.toString()))
descriptionContent.newLine(true);
descriptionContent.boldText(MAXLENGTH_COLUMN).text(COLON).literalText(maxlength.toString());
}
}
if(pattern != null){
if (isNotBlank(descriptionContent.toString()))
descriptionContent.newLine(true);
descriptionContent.boldText(PATTERN_COLUMN).text(COLON).literalText(Json.pretty(pattern));
}
if(minValue != null){
if (isNotBlank(descriptionContent.toString()))
descriptionContent.newLine(true);
String minValueColumn = isTrue(exclusiveMin) ? MINVALUE_EXCLUSIVE_COLUMN : MINVALUE_COLUMN;
descriptionContent.boldText(minValueColumn).text(COLON).literalText(minValue.toString());
}
if(maxValue != null){
if (isNotBlank(descriptionContent.toString()))
descriptionContent.newLine(true);
String maxValueColumn = isTrue(exclusiveMax) ? MAXVALUE_EXCLUSIVE_COLUMN : MAXVALUE_COLUMN;
descriptionContent.boldText(maxValueColumn).text(COLON).literalText(maxValue.toString());
}
if (example != null) {
if (isNotBlank(description) || defaultValue != null)
descriptionContent.newLine(true);
descriptionContent.boldText(EXAMPLE_COLUMN).text(COLON).literalText(Json.pretty(example));
}
ArrayList<String> content = new ArrayList<>(Arrays.asList(
List<String> content = Arrays.asList(
propertyNameContent.toString(),
descriptionContent.toString(),
propertyType.displaySchema(docBuilder)
));
unusedCols.removeIf(index -> !(content.get(index).equals("")));
);
cells.add(content);
}
for (int index : unusedCols) {
cols.remove(index);
for (List cell : cells) {
cell.remove(index);
}
}
docBuilder.tableWithColumnSpecs(cols, cells);
} else {
docBuilder.textLine(NO_CONTENT);

View File

@@ -115,7 +115,7 @@ public class OverviewDocumentBuilder extends MarkupDocumentBuilder {
}
private void buildContactInfoSection(Contact contact) {
if(contact != null && (isNotBlank(contact.getName()) || isNotBlank(contact.getEmail()))){
if(contact != null){
this.markupDocBuilder.sectionTitleLevel2(CONTACT_INFORMATION);
MarkupDocBuilder paragraph = copyMarkupDocBuilder();
if(isNotBlank(contact.getName())){

View File

@@ -82,6 +82,7 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
private static final String PATHS_ANCHOR = "paths";
public PathsDocumentBuilder(Swagger2MarkupConverter.Context globalContext, Swagger2MarkupExtensionRegistry extensionRegistry, java.nio.file.Path outputPath) {
super(globalContext, extensionRegistry, outputPath);
@@ -277,9 +278,7 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
buildConsumesSection(operation, docBuilder);
buildProducesSection(operation, docBuilder);
buildTagsSection(operation, docBuilder);
if (config.isPathSecuritySectionEnabled()) {
buildSecuritySchemeSection(operation, docBuilder);
}
buildSecuritySchemeSection(operation, docBuilder);
buildExamplesSection(operation, docBuilder);
applyPathsDocumentExtension(new Context(Position.OPERATION_END, docBuilder, operation));
applyPathsDocumentExtension(new Context(Position.OPERATION_AFTER, docBuilder, operation));
@@ -425,13 +424,12 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
applyPathsDocumentExtension(new Context(Position.OPERATION_DESCRIPTION_BEGIN, parametersBuilder, operation));
if (hasParameters) {
List<List<String>> cells = new ArrayList<>();
ArrayList<MarkupTableColumn> cols = new ArrayList<>(Arrays.asList(
new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(2).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2"),
List<MarkupTableColumn> cols = Arrays.asList(
new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(9).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^9"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(10).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^10"),
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"),
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2")));
ArrayList<Integer> unusedCols = new ArrayList<>(Arrays.asList(4, 3, 2, 1, 0));
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2"));
for (Parameter parameter : parameters) {
if (filterParameter(parameter)) {
Type type = ParameterUtils.getType(parameter, globalContext.getSwagger().getDefinitions(), new DefinitionDocumentResolverFromOperation());
@@ -449,27 +447,15 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
Object defaultValue = ParameterUtils.getDefaultValue(parameter);
ArrayList<String> content = new ArrayList<>(Arrays.asList(
List<String> content = Arrays.asList(
boldText(parameterType),
parameterNameContent.toString(),
defaultString(swaggerMarkupDescription(parameter.getDescription())),
type.displaySchema(markupDocBuilder),
defaultValue != null ? literalText(Json.pretty(defaultValue)) : ""));
unusedCols.removeIf(index -> !(content.get(index).equals("")));
defaultValue != null ? literalText(Json.pretty(defaultValue)) : "");
cells.add(content);
}
}
for (int index : unusedCols) {
cols.remove(index);
for (List cell : cells) {
cell.remove(index);
}
}
parametersBuilder.tableWithColumnSpecs(cols, cells);
}
applyPathsDocumentExtension(new Context(Position.OPERATION_DESCRIPTION_END, parametersBuilder, operation));
@@ -608,11 +594,10 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
Map<String, SecuritySchemeDefinition> securityDefinitions = globalContext.getSwagger().getSecurityDefinitions();
List<List<String>> cells = new ArrayList<>();
ArrayList<MarkupTableColumn> cols = new ArrayList<>(Arrays.asList(
List<MarkupTableColumn> cols = Arrays.asList(
new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(4).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"),
new MarkupTableColumn(SCOPES_COLUMN).withWidthRatio(13).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^13")));
ArrayList<Integer> unusedCols = new ArrayList<>(Arrays.asList(2, 1, 0));
new MarkupTableColumn(SCOPES_COLUMN).withWidthRatio(13).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^13"));
for (Map<String, List<String>> securityScheme : securitySchemes) {
for (Map.Entry<String, List<String>> securityEntry : securityScheme.entrySet()) {
String securityKey = securityEntry.getKey();
@@ -621,21 +606,11 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
type = securityDefinitions.get(securityKey).getType();
}
ArrayList<String> content = new ArrayList<>(Arrays.asList(boldText(type), boldText(copyMarkupDocBuilder().crossReference(securityDocumentResolver(), securityKey, securityKey).toString()),
Joiner.on(",").join(securityEntry.getValue())));
unusedCols.removeIf(index -> !(content.get(index).equals("")));
List<String> content = Arrays.asList(boldText(type), boldText(copyMarkupDocBuilder().crossReference(securityDocumentResolver(), securityKey, securityKey).toString()),
Joiner.on(",").join(securityEntry.getValue()));
cells.add(content);
}
}
for (int index : unusedCols) {
cols.remove(index);
for (List cell : cells) {
cell.remove(index);
}
}
securityBuilder.tableWithColumnSpecs(cols, cells);
}
applyPathsDocumentExtension(new Context(Position.OPERATION_SECURITY_END, securityBuilder, operation));
@@ -668,11 +643,11 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
MarkupDocBuilder responsesBuilder = copyMarkupDocBuilder();
applyPathsDocumentExtension(new Context(Position.OPERATION_RESPONSES_BEGIN, responsesBuilder, operation));
if (MapUtils.isNotEmpty(responses)) {
ArrayList<MarkupTableColumn> responseCols = new ArrayList<>(Arrays.asList(
new MarkupTableColumn(HTTP_CODE_COLUMN).withWidthRatio(2).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2"),
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(14).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^14"),
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4")));
ArrayList<Integer> unusedCols = new ArrayList<>(Arrays.asList(2, 1, 0));
List<MarkupTableColumn> responseCols = Arrays.asList(
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<List<String>> cells = new ArrayList<>();
Set<String> responseNames = toKeySet(responses, config.getResponseOrdering());
@@ -722,23 +697,7 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
}
}
ArrayList<String> content = new ArrayList<>(Arrays.asList(
boldText(responseName),
descriptionBuilder.toString(),
schemaContent
));
unusedCols.removeIf(index -> !(content.get(index).equals("")));
cells.add(content);
}
for (int index : unusedCols) {
responseCols.remove(index);
for (List cell : cells) {
cell.remove(index);
}
cells.add(Arrays.asList(boldText(responseName), descriptionBuilder.toString(), schemaContent));
}
responsesBuilder.tableWithColumnSpecs(responseCols, cells);

View File

@@ -87,7 +87,7 @@ public class SecurityDocumentBuilder extends MarkupDocumentBuilder {
}
private void buildSecuritySchemeDefinitionsSection(Map<String, SecuritySchemeDefinition> securitySchemes) {
Set<String> securitySchemeNames = toKeySet(securitySchemes, null); // TODO : provide a dedicated ordering configuration for security schemes
Set<String> securitySchemeNames = toKeySet(securitySchemes, Ordering.natural()); // TODO : provide a dedicated ordering configuration for security schemes
for (String securitySchemeName : securitySchemeNames) {
SecuritySchemeDefinition securityScheme = securitySchemes.get(securitySchemeName);
applySecurityDocumentExtension(new Context(Position.SECURITY_SCHEME_BEFORE, markupDocBuilder, securitySchemeName, securityScheme));

View File

@@ -16,6 +16,10 @@
package io.github.swagger2markup.internal.utils;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
import io.github.swagger2markup.model.PathOperation;
import io.swagger.models.*;
@@ -27,7 +31,7 @@ import io.swagger.models.properties.RefProperty;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.HashMap;
import java.io.IOException;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
@@ -35,15 +39,13 @@ import java.util.Map;
public class ExamplesUtil {
private static Logger logger = LoggerFactory.getLogger(ExamplesUtil.class);
private static final Integer MAX_RECURSION_TO_DISPLAY = 2;
/**
* Generates a Map of response examples
* Generates a map of response examples from the given {@code operation}
*
* @param generateMissingExamples specifies the missing examples should be generated
* @param operation the Swagger Operation
* @param definitions the map of definitions
* @param definitions the map of all available definitions
* @param markupDocBuilder the markup builder
* @return map containing response examples.
*/
@@ -61,7 +63,7 @@ public class ExamplesUtil {
if (example == null && schema instanceof RefProperty) {
String simpleRef = ((RefProperty) schema).getSimpleRef();
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder, new HashMap< String, Integer >());
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder);
}
if (example == null && generateMissingExamples) {
example = PropertyUtils.generateExample(schema, markupDocBuilder);
@@ -78,13 +80,13 @@ public class ExamplesUtil {
}
/**
* Generates examples for request
* Generates a map of request examples from the given {@code operation}
*
* @param generateMissingExamples specifies the missing examples should be generated
* @param pathOperation the Swagger Operation
* @param definitions the map of definitions
* @param definitions the map of all available definitions
* @param markupDocBuilder the markup builder
* @return an Optional with the example content
* @return map containing request examples
*/
public static Map<String, Object> generateRequestExampleMap(boolean generateMissingExamples, PathOperation pathOperation, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
Operation operation = pathOperation.getOperation();
@@ -102,17 +104,17 @@ public class ExamplesUtil {
Model schema = ((BodyParameter) parameter).getSchema();
if (schema instanceof RefModel) {
String simpleRef = ((RefModel) schema).getSimpleRef();
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder, new HashMap< String, Integer >());
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder);
} else if (generateMissingExamples) {
if (schema instanceof ComposedModel) {
example = exampleMapForProperties(getPropertiesForComposedModel(
(ComposedModel) schema, definitions), definitions, markupDocBuilder, new HashMap< String, Integer >());
(ComposedModel) schema, definitions), definitions, markupDocBuilder);
} else if (schema instanceof ArrayModel) {
example = generateExampleForArrayModel((ArrayModel) schema, definitions, markupDocBuilder, new HashMap< String, Integer >());
example = generateExampleForArrayModel((ArrayModel) schema, definitions, markupDocBuilder);
} else {
example = schema.getExample();
if (example == null) {
example = exampleMapForProperties(schema.getProperties(), definitions, markupDocBuilder, new HashMap< String, Integer >());
example = exampleMapForProperties(schema.getProperties(), definitions, markupDocBuilder);
}
}
}
@@ -153,7 +155,7 @@ public class ExamplesUtil {
}
} else if (parameter instanceof RefParameter) {
String simpleRef = ((RefParameter) parameter).getSimpleRef();
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder, new HashMap< String, Integer >());
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder);
}
if (example != null)
@@ -170,30 +172,28 @@ public class ExamplesUtil {
* @param simpleRef the simple reference string
* @param definitions the map of definitions
* @param markupDocBuilder the markup builder
* @param refStack map to detect cyclic references
* @return returns an Object or Map of examples
*/
public static Object generateExampleForRefModel(boolean generateMissingExamples, String simpleRef, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder, Map< String, Integer > refStack) {
public static Object generateExampleForRefModel(boolean generateMissingExamples, String simpleRef, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
Model model = definitions.get(simpleRef);
Object example = null;
if (model != null) {
example = model.getExample();
if (example == null && generateMissingExamples) {
if (!refStack.containsKey(simpleRef)) {
refStack.put(simpleRef, 1);
} else {
refStack.put(simpleRef, refStack.get(simpleRef) + 1);
// Workaround for https://github.com/swagger-api/swagger-parser/issues/255 returning a string
if (model instanceof ArrayModel && example instanceof String) {
ObjectMapper mapper = new ObjectMapper();
try {
example = mapper.readTree((String) example);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
if (example == null && generateMissingExamples) {
if (model instanceof ComposedModel) {
example = exampleMapForProperties(getPropertiesForComposedModel((ComposedModel) model, definitions), definitions, markupDocBuilder);
} else {
example = exampleMapForProperties(model.getProperties(), definitions, markupDocBuilder);
}
if (refStack.get(simpleRef) <= MAX_RECURSION_TO_DISPLAY) {
if (model instanceof ComposedModel) {
example = exampleMapForProperties(getPropertiesForComposedModel((ComposedModel) model, definitions), definitions, markupDocBuilder, refStack);
} else {
example = exampleMapForProperties(model.getProperties(), definitions, markupDocBuilder, refStack);
}
}else{
return "...";
}
refStack.put(simpleRef, refStack.get(simpleRef) - 1);
}
}
return example;
@@ -231,20 +231,19 @@ public class ExamplesUtil {
* @param properties the map of properties
* @param definitions the map of definitions
* @param markupDocBuilder the markup builder
* @param refStack map to detect cyclic references
*
* @return a Map of examples
*/
public static Map<String, Object> exampleMapForProperties(Map<String, Property> properties, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder, Map< String, Integer > refStack) {
public static Map<String, Object> exampleMapForProperties(Map<String, Property> properties, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
Map<String, Object> exampleMap = new LinkedHashMap<>();
if (properties != null) {
for (Map.Entry<String, Property> property : properties.entrySet()) {
Object exampleObject = property.getValue().getExample();
if (exampleObject == null) {
if (property.getValue() instanceof RefProperty) {
exampleObject = generateExampleForRefModel(true, ((RefProperty) property.getValue()).getSimpleRef(), definitions, markupDocBuilder, refStack);
exampleObject = generateExampleForRefModel(true, ((RefProperty) property.getValue()).getSimpleRef(), definitions, markupDocBuilder);
} else if (property.getValue() instanceof ArrayProperty) {
exampleObject = generateExampleForArrayProperty((ArrayProperty) property.getValue(), definitions, markupDocBuilder, refStack);
exampleObject = generateExampleForArrayProperty((ArrayProperty) property.getValue(), definitions, markupDocBuilder);
} else if (property.getValue() instanceof MapProperty) {
exampleObject = generateExampleForMapProperty((MapProperty) property.getValue(), markupDocBuilder);
}
@@ -272,19 +271,19 @@ public class ExamplesUtil {
return exampleMap;
}
public static Object generateExampleForArrayModel(ArrayModel model, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder, Map< String, Integer > refStack) {
public static Object generateExampleForArrayModel(ArrayModel model, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
if (model.getExample() != null) {
return model.getExample();
} else if (model.getProperties() != null) {
return new Object[]{exampleMapForProperties(model.getProperties(), definitions, markupDocBuilder, refStack)};
return new Object[]{exampleMapForProperties(model.getProperties(), definitions, markupDocBuilder)};
} else {
Property itemProperty = model.getItems();
if (itemProperty.getExample() != null) {
return new Object[]{itemProperty.getExample()};
} else if (itemProperty instanceof ArrayProperty) {
return new Object[]{generateExampleForArrayProperty((ArrayProperty) itemProperty, definitions, markupDocBuilder, refStack)};
return new Object[]{generateExampleForArrayProperty((ArrayProperty) itemProperty, definitions, markupDocBuilder)};
} else if (itemProperty instanceof RefProperty) {
return new Object[]{generateExampleForRefModel(true, ((RefProperty) itemProperty).getSimpleRef(), definitions, markupDocBuilder, refStack)};
return new Object[]{generateExampleForRefModel(true, ((RefProperty) itemProperty).getSimpleRef(), definitions, markupDocBuilder)};
} else {
return new Object[]{PropertyUtils.generateExample(itemProperty, markupDocBuilder)};
}
@@ -299,14 +298,14 @@ public class ExamplesUtil {
* @param markupDocBuilder the markup builder
* @return array of Object
*/
public static Object[] generateExampleForArrayProperty(ArrayProperty value, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder, Map< String, Integer > refStack) {
public static Object[] generateExampleForArrayProperty(ArrayProperty value, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
Property property = value.getItems();
if (property.getExample() != null) {
return new Object[]{property.getExample()};
} else if (property instanceof ArrayProperty) {
return new Object[]{generateExampleForArrayProperty((ArrayProperty) property, definitions, markupDocBuilder, refStack)};
return new Object[]{generateExampleForArrayProperty((ArrayProperty) property, definitions, markupDocBuilder)};
} else if (property instanceof RefProperty) {
return new Object[]{generateExampleForRefModel(true, ((RefProperty) property).getSimpleRef(), definitions, markupDocBuilder, refStack)};
return new Object[]{generateExampleForRefModel(true, ((RefProperty) property).getSimpleRef(), definitions, markupDocBuilder)};
} else {
return new Object[]{PropertyUtils.generateExample(property, markupDocBuilder)};
}

View File

@@ -91,7 +91,6 @@ public final class PropertyUtils {
public static Object getDefaultValue(Property property) {
Validate.notNull(property, "property must not be null");
Object defaultValue = null;
if (property instanceof BooleanProperty) {
BooleanProperty booleanProperty = (BooleanProperty) property;
defaultValue = booleanProperty.getDefault();
@@ -116,143 +115,7 @@ public final class PropertyUtils {
}
return defaultValue;
}
/**
* Retrieves the minLength of a property, or otherwise returns null.
*
* @param property the property
* @return the minLength of the property, or otherwise null
*/
public static Integer getMinlength(Property property) {
Validate.notNull(property, "property must not be null");
Integer minLength = null;
if (property instanceof StringProperty) {
StringProperty stringProperty = (StringProperty) property;
minLength = stringProperty.getMinLength();
} else if (property instanceof UUIDProperty) {
UUIDProperty uuidProperty = (UUIDProperty) property;
minLength = uuidProperty.getMinLength();
}
return minLength;
}
/**
* Retrieves the maxLength of a property, or otherwise returns null.
*
* @param property the property
* @return the maxLength of the property, or otherwise null
*/
public static Integer getMaxlength(Property property) {
Validate.notNull(property, "property must not be null");
Integer maxLength = null;
if (property instanceof StringProperty) {
StringProperty stringProperty = (StringProperty) property;
maxLength = stringProperty.getMaxLength();
} else if (property instanceof UUIDProperty) {
UUIDProperty uuidProperty = (UUIDProperty) property;
maxLength = uuidProperty.getMaxLength();
}
return maxLength;
}
/**
* Retrieves the pattern of a property, or otherwise returns null.
*
* @param property the property
* @return the pattern of the property, or otherwise null
*/
public static String getPattern(Property property) {
Validate.notNull(property, "property must not be null");
String pattern = null;
if (property instanceof StringProperty) {
StringProperty stringProperty = (StringProperty) property;
pattern = stringProperty.getPattern();
} else if (property instanceof UUIDProperty) {
UUIDProperty uuidProperty = (UUIDProperty) property;
pattern = uuidProperty.getPattern();
}
return pattern;
}
/**
* Retrieves the minimum value of a property, or otherwise returns null.
*
* @param property the property
* @return the minimum value of the property, or otherwise null
*/
public static Number getMin(Property property) {
Validate.notNull(property, "property must not be null");
Number min = null;
if (property instanceof BaseIntegerProperty){
BaseIntegerProperty integerProperty = (BaseIntegerProperty) property;
min = integerProperty.getMinimum() != null ? integerProperty.getMinimum().longValue() : null;
} else if (property instanceof AbstractNumericProperty){
AbstractNumericProperty numericProperty = (AbstractNumericProperty) property;
min = numericProperty.getMinimum();
}
return min;
}
/**
* Retrieves the exclusiveMinimum value of a property, or otherwise returns null.
*
* @param property the property
* @return the exclusiveMinimum value of the property, or otherwise null
*/
public static Boolean getExclusiveMin(Property property) {
Validate.notNull(property, "property must not be null");
Boolean exclusiveMin = null;
if (property instanceof AbstractNumericProperty){
AbstractNumericProperty numericProperty = (AbstractNumericProperty) property;
exclusiveMin = numericProperty.getExclusiveMinimum();
}
return exclusiveMin;
}
/**
* Retrieves the minimum value of a property, or otherwise returns null.
*
* @param property the property
* @return the minimum value of the property, or otherwise null
*/
public static Number getMax(Property property) {
Validate.notNull(property, "property must not be null");
Number max = null;
if (property instanceof BaseIntegerProperty){
BaseIntegerProperty integerProperty = (BaseIntegerProperty) property;
max = integerProperty.getMaximum() != null ? integerProperty.getMaximum().longValue() : null;
} else if (property instanceof AbstractNumericProperty){
AbstractNumericProperty numericProperty = (AbstractNumericProperty) property;
max = numericProperty.getMaximum();
}
return max;
}
/**
* Retrieves the exclusiveMaximum value of a property, or otherwise returns null.
*
* @param property the property
* @return the exclusiveMaximum value of the property, or otherwise null
*/
public static Boolean getExclusiveMax(Property property) {
Validate.notNull(property, "property must not be null");
Boolean exclusiveMax = null;
if (property instanceof AbstractNumericProperty){
AbstractNumericProperty numericProperty = (AbstractNumericProperty) property;
exclusiveMax = numericProperty.getExclusiveMaximum();
}
return exclusiveMax;
}
/**
* Return example display string for the given {@code property}.
*

View File

@@ -10,7 +10,6 @@ swagger2markup.outputLanguage=EN
swagger2markup.inlineSchemaEnabled=true
swagger2markup.interDocumentCrossReferencesEnabled=false
swagger2markup.flatBodyEnabled=false
swagger2markup.pathSecuritySectionEnabled=true
swagger2markup.overviewDocument=overview
swagger2markup.pathsDocument=paths
swagger2markup.definitionsDocument=definitions

View File

@@ -1,24 +1,12 @@
definitions=Definitionen
default_column=Standard
# validators
minlength_column=Mindestl<EFBFBD>nge
maxlength_column=Maximale L<>nge
length_column=L<EFBFBD>nge
pattern_column=Pattern
minvalue_column=Mindestwert
minvalue_exclusive_column=Mindestwert (exklusiv)
maxvalue_column=Maximalwert
maxvalue_exclusive_column=Maximalwert (exklusiv)
example_column=Beispiel
flags.column=Flags
flags.required=verpflichtend
flags.optional=optional
flags.read_only=Nur lesen
flags.read_write=Lesen+Schreiben
schema_column=Typ
flags.required=Required
flags.optional=Optional
flags.read_only=Read-only
flags.read_write=Read-write
schema_column=Schema
name_column=Name
description_column=Beschreibung
headers_column=Headers
@@ -26,7 +14,7 @@ scopes_column=Scopes
produces=Erzeugt
consumes=Verarbeitet
tags=Tags
overview=<EFBFBD>bersicht
overview=<EFBFBD>bersicht
current_version=Aktuelle Version
version=Version
contact_information=Kontaktinformationen
@@ -40,7 +28,7 @@ uri_scheme=URI Schema
host=Host
base_path=Basis-Pfad
schemes=Schemata
security_name=Name
security_name=
security_type=Typ
security_in=In
security_flow=Flow

View File

@@ -1,17 +1,6 @@
definitions=Definitions
default_column=Default
# validators
minlength_column=Minimum length
maxlength_column=Maximal length
length_column=Length
pattern_column=Pattern
minvalue_column=Minimum value
minvalue_exclusive_column=Minimum value (exclusive)
maxvalue_column=Maximum value
maxvalue_exclusive_column=Maximum value (exclusive)
example_column=Example
flags.column=Flags
flags.required=Required

View File

@@ -1,71 +0,0 @@
definitions=Definiciones
default_column=Valor por defecto
# validators
minlength_column=Longitud m<>nima
maxlength_column=Longitud m<>xima
length_column=Longitud
pattern_column=Patr<EFBFBD>n
minvalue_column=Valor m<>nimo
minvalue_exclusive_column=Valor m<>nimo (exclusivo)
maxvalue_column=Valor m<>ximo
maxvalue_exclusive_column=Valor m<>ximo (exclusivo)
example_column=Ejemplo
flags.column=Flags
flags.required=Obligatorio
flags.optional=Opcional
flags.read_only=S<EFBFBD>lo lectura
flags.read_write=Lectura-escritura
schema_column=Esquema
name_column=Nombre
description_column=Descripci<EFBFBD>n
headers_column=Cabeceras
scopes_column=Scopes
produces=Produce
consumes=Consume
tags=Etiquetas
overview=Resumen
current_version=Informaci<EFBFBD>n de versi<73>n
version=Versi<EFBFBD>n
contact_information=Informaci<EFBFBD>n de contacto
contact_name=Contacto
contact_email=Email de contacto
license_information=Informaci<EFBFBD>n de licencia
license=Licencia
license_url=URL de licencia
terms_of_service=T<EFBFBD>rminos de servicio
uri_scheme=Esquema URI
host=Servidor
base_path=Ruta base
schemes=Esquemas
security_type=Tipo
security_name=Nombre
security_in=En
security_flow=Flujo
security_authorizationUrl=URL de autorizaci<63>n
security_tokenUrl=URL del token
paths=Rutas
resources=Recursos
security=Seguridad
parameters=Par<EFBFBD>metros
body_parameter=Par<EFBFBD>metro de cuerpo
responses=Respuestas
response=Respuesta
request=Solicitud
example_request=Ejemplo de solicitud HTTP
example_response=Ejemplo de respuesta HTTP
type_column=Tipo
http_code_column=C<EFBFBD>digo HTTP
parameter=Par<EFBFBD>metro
unknown=Desconocido
no_content=Sin contenido
operation.deprecated=Operaci<EFBFBD>n obsoleta
polymorphism.column=Polimorfismo
polymorphism.discriminator=Discriminador
polymorphism.nature.INHERITANCE=Herencia
polymorphism.nature.COMPOSITION=Composici<EFBFBD>n

View File

@@ -1,17 +1,6 @@
definitions=D\u00E9finitions
default_column=D\u00E9faut
# validators
minlength_column=Longueur minimale
maxlength_column=Longueur maximale
length_column=Longueur
pattern_column=Mod\u00E8le
minvalue_column=Valeur minimale
minvalue_exclusive_column=Valeur minimale (exclusif)
maxvalue_column=Valeur maximale
maxvalue_exclusive_column=Valeur maximale (exclusif)
example_column=Exemple
flags.column=Modificateurs
flags.required=Requis
@@ -62,7 +51,7 @@ type_column=Type
http_code_column=Code HTTP
parameter=Param\u00E8tre
unknown=Inconnu
unknown=Unknown
no_content=Pas de contenu
operation.deprecated=Cette op\u00E9ration est obsol\u00E8te.
polymorphism.column=Polymorphisme

View File

@@ -1,17 +1,6 @@
definitions=\u041E\u043F\u0440\u0435\u0434\u0435\u043B\u0435\u043D\u0438\u044F
default_column=\u041F\u043E \u0443\u043C\u043E\u043B\u0447\u0430\u043D\u0438\u044E
# validators
minlength_column=Minimum length
maxlength_column=Maximal length
length_column=Length
pattern_column=Pattern
minvalue_column=Minimum value
minvalue_exclusive_column=Minimum value (exclusive)
maxvalue_column=Maximum value
maxvalue_exclusive_column=Maximum value (exclusive)
flags.column=Flags
flags.required=\u041E\u0431\u044F\u0437\u0430\u0442\u0435\u043B\u044C\u043D\u043E
flags.optional=Optional
@@ -49,7 +38,7 @@ security_authorizationUrl=URL \u0430\u0432\u0442\u043E\u0440\u0438\u0437\u0430\u
security_tokenUrl=URL \u0442\u043E\u043A\u0435\u043D\u0430
paths=\u041F\u0443\u0442\u0438
resources=\u0420\u0435\u0441\u0443\u0440\u0441\u044B
resources=\u041E\u0442\u0432\u0435\u0442\u044B
security=\u0411\u0435\u0437\u043E\u043F\u0430\u0441\u043D\u043E\u0441\u0442\u044C
response=\u041E\u0442\u0432\u0435\u0442
request=\u0417\u0430\u043F\u0440\u043E\u0441
@@ -68,4 +57,4 @@ operation.deprecated=\u042D\u0442\u0430 \u043E\u043F\u0435\u0440\u0430\u0446\u04
polymorphism.column=Polymorphism
polymorphism.discriminator=Discriminator
polymorphism.nature.INHERITANCE=Inheritance
polymorphism.nature.COMPOSITION=Composition
polymorphism.nature.COMPOSITION=Composition

View File

@@ -1,17 +1,6 @@
definitions=Tan\u0131mlar
default_column=Varsay\u0131lan
# validators
minlength_column=Minimum length
maxlength_column=Maximal length
length_column=Length
pattern_column=Pattern
minvalue_column=Minimum value
minvalue_exclusive_column=Minimum value (exclusive)
maxvalue_column=Maximum value
maxvalue_exclusive_column=Maximum value (exclusive)
example_column=\u00D6rnek
flags.column=Bayraklar
flags.required=Gerekli

View File

@@ -1,71 +0,0 @@
definitions=定义
default_column=默认列
# validators
minlength_column=最小长度
maxlength_column=最大长度
length_column=长度
pattern_column=模式
minvalue_column=最小值
minvalue_exclusive_column=最小值(不包括)
maxvalue_column=最大值
maxvalue_exclusive_column=最大值(不包括)
example_column=例子
flags.column=标志
flags.required=必填
flags.optional=可选
flags.read_only=只读
flags.read_write=读写
schema_column=架构
name_column=名称
description_column=说明
headers_column=
scopes_column=作用域
produces=生成
consumes=消耗
tags=标签
overview=概观
current_version=版本信息
version=版本
contact_information=联系方式
contact_name=名字
contact_email=邮箱
license_information=许可信息
license=许可证
license_url=许可网址
terms_of_service=服务条款
uri_scheme=URI scheme
host=域名
base_path=基础路径
schemes=方案
security_type=类型
security_name=名称
security_in=
security_flow=
security_authorizationUrl=授权网址
security_tokenUrl=令牌网址
paths=路径
resources=资源
security=安全
parameters=参数
body_parameter=Body参数
responses=响应
response=响应
request=请求
example_request=HTTP请求示例
example_response=HTTP响应示例
type_column=类型
http_code_column=HTTP代码
parameter=参数
unknown=未知
no_content=无内容
operation.deprecated=该操作已弃用
polymorphism.column=多态性
polymorphism.discriminator=鉴别
polymorphism.nature.INHERITANCE=继承
polymorphism.nature.COMPOSITION=成分

View File

@@ -20,6 +20,7 @@ import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -174,7 +175,6 @@ public class AsciidocConverterTest {
//When
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withoutInlineSchema()
.withGeneratedExamples()
.build();
@@ -189,26 +189,8 @@ public class AsciidocConverterTest {
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/generated_examples").toURI());
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithGeneratedExamples.html");
}
@Test
public void testSwagger2AsciiDocConversionWithGeneratedRecursiveExamples() throws IOException, URISyntaxException {
// Given
String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/json/swagger_recursion.json"));
Path outputDirectory = Paths.get("build/test/asciidoc/generated_recursion_examples");
FileUtils.deleteQuietly(outputDirectory.toFile());
// When
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder().withoutInlineSchema().withGeneratedExamples().build();
Swagger2MarkupConverter.from(swaggerJsonString).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/generated_recursion_examples").toURI());
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithGeneratedRecursiveExamples.html");
}
@Ignore("swagger-parser-1.0.21 ignore Location def because it's referenced from an external ref (ExternalLocation)")
@Test
public void testSwagger2AsciiDocWithInlineSchema() throws IOException, URISyntaxException {
//Given
@@ -231,6 +213,7 @@ public class AsciidocConverterTest {
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocWithInlineSchema.html");
}
@Ignore("swagger-parser-1.0.21 ignore Location def because it's referenced from an external ref (ExternalLocation)")
@Test
public void testSwagger2AsciiDocWithInlineSchemaAndFlatBody() throws IOException, URISyntaxException {
//Given
@@ -389,25 +372,6 @@ public class AsciidocConverterTest {
@Test
public void testSwagger2AsciiDocConversionWithRussianOutputLanguage() throws IOException, URISyntaxException {
testSwagger2AsciiDocConversionWithOutputLanguage(Language.RU, "definitions.adoc", "== Определения");
}
@Test
public void testSwagger2AsciiDocConversionWithFrenchOutputLanguage() throws IOException, URISyntaxException {
testSwagger2AsciiDocConversionWithOutputLanguage(Language.FR, "overview.adoc", "== Sch\u00E9ma d'URI");
}
@Test
public void testSwagger2AsciiDocConversionWithGermanOutputLanguage() throws IOException, URISyntaxException {
testSwagger2AsciiDocConversionWithOutputLanguage(Language.DE, "definitions.adoc", "Beschreibung");
}
@Test
public void testSwagger2AsciiDocConversionWithSpanishOutputLanguage() throws IOException, URISyntaxException {
testSwagger2AsciiDocConversionWithOutputLanguage(Language.ES, "definitions.adoc", "Descripción");
}
private void testSwagger2AsciiDocConversionWithOutputLanguage(Language language, String outputFilename, String expected) throws IOException, URISyntaxException {
//Given
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
Path outputDirectory = Paths.get("build/test/asciidoc/generated");
@@ -415,7 +379,7 @@ public class AsciidocConverterTest {
//When
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withOutputLanguage(language)
.withOutputLanguage(Language.RU)
.build();
Swagger2MarkupConverter.from(file)
.withConfig(config)
@@ -423,8 +387,29 @@ public class AsciidocConverterTest {
.toFolder(outputDirectory);
//Then
assertThat(new String(Files.readAllBytes(outputDirectory.resolve(outputFilename)), Charset.forName("UTF-8")))
.contains(expected);
assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.adoc")), Charset.forName("UTF-8")))
.contains("== Определения");
}
@Test
public void testSwagger2AsciiDocConversionWithFrenchOutputLanguage() throws IOException, URISyntaxException {
//Given
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
Path outputDirectory = Paths.get("build/test/asciidoc/generated");
FileUtils.deleteQuietly(outputDirectory.toFile());
//When
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withOutputLanguage(Language.FR)
.build();
Swagger2MarkupConverter.from(file)
.withConfig(config)
.build()
.toFolder(outputDirectory);
//Then
assertThat(new String(Files.readAllBytes(outputDirectory.resolve("overview.adoc")), Charset.forName("UTF-8")))
.contains("== Sch\u00E9ma d'URI");
}
@Test
@@ -472,30 +457,6 @@ public class AsciidocConverterTest {
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/enums").toURI());
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithEnums.html");
}
@Test
public void testSwagger2AsciiDocConversionWithValidators() throws IOException, URISyntaxException {
//Given
Path file = Paths.get(AsciidocConverterTest.class.getResource("/json/swagger_validators.json").toURI());
Path outputDirectory = Paths.get("build/test/asciidoc/validators");
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/validators").toURI());
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithValidators.html");
}
@Test
public void testSwagger2AsciiDocConversionWithPolymorphism() throws IOException, URISyntaxException {
@@ -566,27 +527,4 @@ public class AsciidocConverterTest {
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/response_headers").toURI());
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithResponseHeaders.html");
}
@Test
public void testSwagger2AsciiDocConversionWithEmptyContactUsingJSON() throws IOException, URISyntaxException {
//Given
Path file = Paths.get(AsciidocConverterTest.class.getResource("/json/swagger_emptycontact.json").toURI());
Path outputDirectory = Paths.get("build/test/asciidoc/emptycontact");
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/emptycontact").toURI());
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithEmptyContactUsingJSON.html");
}
}

View File

@@ -67,7 +67,6 @@ public class Swagger2MarkupConfigBuilderTest {
assertThat(config.getTagOrderBy()).isEqualTo(OrderBy.NATURAL);
assertThat(config.getTagOrdering()).isEqualTo(Ordering.natural());
assertThat(config.isFlatBodyEnabled()).isFalse();
assertThat(config.isPathSecuritySectionEnabled()).isTrue();
assertThat(config.isInterDocumentCrossReferencesEnabled()).isFalse();
assertThat(config.isSeparatedDefinitionsEnabled()).isFalse();
assertThat(config.isSeparatedOperationsEnabled()).isFalse();
@@ -112,7 +111,6 @@ public class Swagger2MarkupConfigBuilderTest {
assertThat(config.getTagOrderBy()).isEqualTo(OrderBy.AS_IS);
assertThat(config.getTagOrdering()).isNull();
assertThat(config.isFlatBodyEnabled()).isTrue();
assertThat(config.isPathSecuritySectionEnabled()).isFalse();
assertThat(config.isInterDocumentCrossReferencesEnabled()).isTrue();
assertThat(config.isSeparatedDefinitionsEnabled()).isTrue();
assertThat(config.isSeparatedOperationsEnabled()).isTrue();

View File

@@ -8,7 +8,6 @@ swagger2markup.inlineSchemaEnabled=false
swagger2markup.interDocumentCrossReferencesEnabled=true
swagger2markup.interDocumentCrossReferencesPrefix=xrefPrefix
swagger2markup.flatBodyEnabled=true
swagger2markup.pathSecuritySectionEnabled=false
swagger2markup.anchorPrefix=anchorPrefix
swagger2markup.overviewDocument=overviewTest
swagger2markup.pathsDocument=pathsTest

View File

@@ -13,8 +13,6 @@ _optional_||integer(int64)
|*name* +
_optional_|The name of the category +
*Default* : `"DefaultCategory"` +
*Length* : `0 - 255` +
*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` +
*Example* : `"FoobarCategory"`|string
|===
@@ -33,8 +31,6 @@ _optional_||integer(int64)
_optional_||integer(int64)
|*quantity* +
_optional_|*Default* : `0` +
*Minimum value* : `0` +
*Maximum value* : `10000` +
*Example* : `10`|integer(int32)
|*shipDate* +
_optional_||string(date-time)
@@ -67,13 +63,13 @@ _optional_||< <<_tag,Tag>> > array
[[_tag]]
=== Tag
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===

View File

@@ -11,17 +11,17 @@ POST /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -63,17 +63,17 @@ PUT /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -121,17 +121,17 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*status* +
_optional_|Status values that need to be considered for filter|< string > array(multi)
_optional_|Status values that need to be considered for filter|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -176,17 +176,17 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
_optional_|Tags to filter by|< string > array(multi)
_optional_|Tags to filter by|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -227,21 +227,21 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be updated|string
_required_|ID of pet that needs to be updated|string|
|*FormData*|*name* +
_required_|Updated name of the pet|string
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string
_required_|Updated status of the pet|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -286,17 +286,17 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)
_required_|ID of pet that needs to be fetched|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -339,19 +339,19 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
_required_||string
_required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)
_required_|Pet id to delete|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -387,17 +387,17 @@ POST /stores/order
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -433,17 +433,17 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string
_required_|ID of pet that needs to be fetched|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -480,17 +480,17 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string
_required_|ID of the order that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -522,17 +522,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Created user object|<<_user,User>>
_optional_|Created user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -559,17 +559,17 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -596,17 +596,17 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -633,19 +633,19 @@ GET /users/login
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*password* +
_optional_|The password for login in clear text|string
_optional_|The password for login in clear text|string|
|*Query*|*username* +
_optional_|The user name for login|string
_optional_|The user name for login|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -677,7 +677,7 @@ GET /users/logout
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -704,17 +704,17 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string
_required_|The name that needs to be fetched. Use user1 for testing.|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -751,19 +751,19 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|name that need to be deleted|string
_required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>
_optional_|Updated user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
@@ -795,17 +795,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be deleted|string
_required_|The name that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content

View File

@@ -2,6 +2,14 @@
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
[%hardbreaks]
@@ -18,12 +26,4 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|===
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER

View File

@@ -1,12 +0,0 @@
= Empty Contact
[[_overview]]
== Overview
=== Version information
[%hardbreaks]
_Version_ : 1.0

View File

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

View File

@@ -18,25 +18,30 @@ _optional_|*Example* : `"Canines"`|string
[[_complexobject]]
=== ComplexObject
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*subObject* +
_optional_|object
_optional_||object
|===
[[_identified]]
=== Identified
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|===
[[_objectarray]]
=== ObjectArray
_Type_ : < object > array
[[_order]]
=== Order
@@ -89,13 +94,13 @@ _optional_|the weight of the pet|number
[[_tag]]
=== Tag
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===

View File

@@ -2,6 +2,32 @@
[[_paths]]
== Paths
[[_objectarray_patch]]
=== PATCH /objectArray
==== Parameters
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_required_||<<_objectarray,ObjectArray>>|
|===
==== Example HTTP request
===== Request body
[source,json]
----
[ {
"op" : "replace",
"path" : "/s",
"v" : "w"
} ]
----
[[_addpet]]
=== Add a new pet to the store
....
@@ -11,17 +37,17 @@ POST /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -80,17 +106,17 @@ PUT /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -138,17 +164,17 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*status* +
_optional_|Status values that need to be considered for filter|< string > array(multi)
_optional_|Status values that need to be considered for filter|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>> > array
@@ -189,17 +215,17 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
_optional_|Tags to filter by|< string > array(multi)
_optional_|Tags to filter by|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>> > array
@@ -236,21 +262,21 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be updated|string
_required_|ID of pet that needs to be updated|string|
|*FormData*|*name* +
_required_|Updated name of the pet|string
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string
_required_|Updated status of the pet|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -295,17 +321,17 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of the pet|integer(int64)
_required_|ID of the pet|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_pet,Pet>>
@@ -344,19 +370,19 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
_required_||string
_required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)
_required_|Pet id to delete|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -392,17 +418,17 @@ POST /stores/order
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
@@ -466,17 +492,17 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string
_required_|ID of pet that needs to be fetched|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
@@ -525,17 +551,17 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string
_required_|ID of the order that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -567,17 +593,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Created user object|<<_user,User>>
_optional_|Created user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -604,17 +630,17 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -641,17 +667,17 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -678,7 +704,7 @@ GET /users/login
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*password* +
@@ -690,7 +716,7 @@ _optional_|The user name for login|string|`"testUser"`
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|string
@@ -718,7 +744,7 @@ GET /users/logout
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -745,7 +771,7 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -755,7 +781,7 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|`"te
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_user,User>>
@@ -788,19 +814,19 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|name that need to be deleted|string
_required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>
_optional_|Updated user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
@@ -832,17 +858,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be deleted|string
_required_|The name that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content

View File

@@ -2,6 +2,14 @@
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
[%hardbreaks]
@@ -18,12 +26,4 @@ _Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|===
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER

View File

@@ -10,8 +10,6 @@ _optional_||integer(int64)
|*name* +
_optional_|The name of the category +
*Default* : `"DefaultCategory"` +
*Length* : `0 - 255` +
*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` +
*Example* : `"FoobarCategory"`|string
|===

View File

@@ -13,8 +13,6 @@ _optional_||integer(int64)
_optional_||integer(int64)
|*quantity* +
_optional_|*Default* : `0` +
*Minimum value* : `0.0` +
*Maximum value* : `10000.0` +
*Example* : `10`|integer(int32)
|*shipDate* +
_optional_||string(date-time)

View File

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

View File

@@ -11,17 +11,17 @@ POST /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -63,17 +63,17 @@ PUT /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -121,17 +121,17 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*status* +
_optional_|Status values that need to be considered for filter|< string > array(multi)
_optional_|Status values that need to be considered for filter|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -176,17 +176,17 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
_optional_|Tags to filter by|< string > array(multi)
_optional_|Tags to filter by|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -227,21 +227,21 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be updated|string
_required_|ID of pet that needs to be updated|string|
|*FormData*|*name* +
_required_|Updated name of the pet|string
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string
_required_|Updated status of the pet|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -286,17 +286,17 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)
_required_|ID of pet that needs to be fetched|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -339,19 +339,19 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
_required_||string
_required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)
_required_|Pet id to delete|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -387,17 +387,17 @@ POST /stores/order
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -433,17 +433,17 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string
_required_|ID of pet that needs to be fetched|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -480,17 +480,17 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string
_required_|ID of the order that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -522,17 +522,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Created user object|<<_user,User>>
_optional_|Created user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -559,17 +559,17 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -596,17 +596,17 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -633,19 +633,19 @@ GET /users/login
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*password* +
_optional_|The password for login in clear text|string
_optional_|The password for login in clear text|string|
|*Query*|*username* +
_optional_|The user name for login|string
_optional_|The user name for login|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -677,7 +677,7 @@ GET /users/logout
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -704,17 +704,17 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string
_required_|The name that needs to be fetched. Use user1 for testing.|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -751,19 +751,19 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|name that need to be deleted|string
_required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>
_optional_|Updated user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
@@ -795,17 +795,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be deleted|string
_required_|The name that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content

View File

@@ -2,6 +2,14 @@
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
[%hardbreaks]
@@ -18,12 +26,4 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|===
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER

View File

@@ -22,7 +22,19 @@ _optional_|*Example* : `"Canines"`|string
|===
|Name|Description|Schema
|*subObject* +
_optional_|*Example* : `"object"`|object
_optional_|*Example* : `"object"`|<<_complexobject_subobject,subObject>>
|===
[[_complexobject_subobject]]
*subObject*
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|*id* +
_optional_|*Example* : `88`|integer(int64)
|*value* +
_optional_|*Example* : `"a value !"`|string
|===
@@ -37,6 +49,11 @@ _optional_|*Example* : `0`|integer(int64)
|===
[[_objectarray]]
=== ObjectArray
_Type_ : < object > array
[[_order]]
=== Order

View File

@@ -2,6 +2,39 @@
[[_paths]]
== Paths
[[_objectarray_patch]]
=== PATCH /objectArray
==== Parameters
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_required_||<<_objectarray,ObjectArray>>|
|===
==== Example HTTP request
===== Request path
[source,json]
----
"/objectArray"
----
===== Request body
[source,json]
----
[ {
"op" : "replace",
"path" : "/s",
"v" : "w"
} ]
----
[[_addpet]]
=== Add a new pet to the store
....
@@ -11,17 +44,17 @@ POST /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -113,17 +146,17 @@ PUT /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -204,17 +237,17 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*status* +
_optional_|Status values that need to be considered for filter|< string > array(multi)
_optional_|Status values that need to be considered for filter|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>> > array
@@ -282,17 +315,17 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
_optional_|Tags to filter by|< string > array(multi)
_optional_|Tags to filter by|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|< <<_pet,Pet>> > array
@@ -356,21 +389,21 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be updated|string
_required_|ID of pet that needs to be updated|string|
|*FormData*|*name* +
_required_|Updated name of the pet|string
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string
_required_|Updated status of the pet|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -431,17 +464,17 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of the pet|integer(int64)
_required_|ID of the pet|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_pet,Pet>>
@@ -515,19 +548,19 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
_required_||string
_required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)
_required_|Pet id to delete|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -579,17 +612,17 @@ POST /stores/order
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
@@ -660,17 +693,17 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string
_required_|ID of pet that needs to be fetched|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_order,Order>>
@@ -728,17 +761,17 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string
_required_|ID of the order that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -779,17 +812,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Created user object|<<_user,User>>
_optional_|Created user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -842,17 +875,17 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -905,17 +938,17 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -968,7 +1001,7 @@ GET /users/login
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*password* +
@@ -980,7 +1013,7 @@ _optional_|The user name for login|string|`"testUser"`
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|string
@@ -1036,7 +1069,7 @@ GET /users/logout
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1072,7 +1105,7 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Path*|*username* +
@@ -1082,7 +1115,7 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|`"te
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation|<<_user,User>>
@@ -1143,19 +1176,19 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|name that need to be deleted|string
_required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>
_optional_|Updated user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
@@ -1213,17 +1246,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be deleted|string
_required_|The name that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content

View File

@@ -2,6 +2,14 @@
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
[%hardbreaks]
@@ -18,12 +26,4 @@ _Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|===
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER

View File

@@ -1,19 +0,0 @@
[[_definitions]]
== Definitions
[[_navigationentry]]
=== NavigationEntry
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|*childs* +
_optional_|*Example* : `[ "<<_navigationentry>>" ]`|< <<_navigationentry,NavigationEntry>> > array
|*id* +
_optional_|Primary key of this entry +
*Example* : `0.0`|number(int64)
|===

View File

@@ -1,28 +0,0 @@
= API
[[_overview]]
== Overview
=== Version information
[%hardbreaks]
_Version_ : 2.0.0
=== URI scheme
[%hardbreaks]
_BasePath_ : /navigation
_Schemes_ : HTTPS
=== Consumes
* `application/json`
=== Produces
* `application/json`

View File

@@ -1,126 +0,0 @@
[[_paths]]
== Paths
[[_usernavigation]]
=== Get navigation
....
GET /
....
==== Description
Returns the navigation as a tree
==== Responses
[options="header", cols=".^2,.^14,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Successful response|<<_navigationentry,NavigationEntry>>
|===
==== Tags
* Navigation
==== Example HTTP request
===== Request path
[source,json]
----
"/"
----
==== Example HTTP response
===== Response 200
[source,json]
----
{
"id" : 0.0,
"childs" : [ {
"id" : 0.0,
"childs" : [ "..." ]
} ]
}
----
[[_updatenavigation]]
=== update entry
....
PUT /
....
==== Description
Updates the navigation tree
==== Parameters
[options="header", cols=".^2,.^3,.^4"]
|===
|Type|Name|Schema
|*Body*|*entry* +
_optional_|<<_navigationentry,NavigationEntry>>
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Successful response|<<_navigationentry,NavigationEntry>>
|===
==== Tags
* Navigation
==== Example HTTP request
===== Request path
[source,json]
----
"/"
----
===== Request body
[source,json]
----
{
"id" : 0.0,
"childs" : [ {
"id" : 0.0,
"childs" : [ "..." ]
} ]
}
----
==== Example HTTP response
===== Response 200
[source,json]
----
{
"id" : 0.0,
"childs" : [ {
"id" : 0.0,
"childs" : [ "..." ]
} ]
}
----

View File

@@ -13,8 +13,6 @@ _optional_||integer(int64)
|*name* +
_optional_|The name of the category +
*Default* : `"DefaultCategory"` +
*Length* : `0 - 255` +
*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` +
*Example* : `"FoobarCategory"`|string
|===
@@ -33,8 +31,6 @@ _optional_||integer(int64)
_optional_||integer(int64)
|*quantity* +
_optional_|*Default* : `0` +
*Minimum value* : `0` +
*Maximum value* : `10000` +
*Example* : `10`|integer(int32)
|*shipDate* +
_optional_||string(date-time)
@@ -67,13 +63,13 @@ _optional_||< <<_tag,Tag>> > array
[[_tag]]
=== Tag
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===

View File

@@ -16,17 +16,17 @@ POST /pets
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -63,17 +63,17 @@ PUT /pets
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -116,17 +116,17 @@ Multiple status values can be provided with comma seperated strings
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*status* +
_optional_|Status values that need to be considered for filter|< string > array(multi)
_optional_|Status values that need to be considered for filter|< string > array(multi)|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -166,17 +166,17 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
_optional_|Tags to filter by|< string > array(multi)
_optional_|Tags to filter by|< string > array(multi)|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -212,21 +212,21 @@ POST /pets/{petId}
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be updated|string
_required_|ID of pet that needs to be updated|string|
|*FormData*|*name* +
_required_|Updated name of the pet|string
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string
_required_|Updated status of the pet|string|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -266,17 +266,17 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)
_required_|ID of pet that needs to be fetched|integer(int64)|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -314,19 +314,19 @@ DELETE /pets/{petId}
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
_required_||string
_required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)
_required_|Pet id to delete|integer(int64)|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -362,17 +362,17 @@ POST /stores/order
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -403,17 +403,17 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string
_required_|ID of pet that needs to be fetched|string|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -445,17 +445,17 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string
_required_|ID of the order that needs to be deleted|string|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -487,17 +487,17 @@ This can only be done by the logged in user.
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Created user object|<<_user,User>>
_optional_|Created user object|<<_user,User>>|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -519,17 +519,17 @@ POST /users/createWithArray
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -551,17 +551,17 @@ POST /users/createWithList
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -583,19 +583,19 @@ GET /users/login
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*password* +
_optional_|The password for login in clear text|string
_optional_|The password for login in clear text|string|
|*Query*|*username* +
_optional_|The user name for login|string
_optional_|The user name for login|string|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -622,7 +622,7 @@ GET /users/logout
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -644,17 +644,17 @@ GET /users/{username}
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string
_required_|The name that needs to be fetched. Use user1 for testing.|string|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -686,19 +686,19 @@ This can only be done by the logged in user.
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|name that need to be deleted|string
_required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>
_optional_|Updated user object|<<_user,User>>|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
@@ -725,17 +725,17 @@ This can only be done by the logged in user.
===== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be deleted|string
_required_|The name that needs to be deleted|string|
|===
===== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content

View File

@@ -2,6 +2,14 @@
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
[%hardbreaks]
@@ -18,12 +26,4 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|===
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER

View File

@@ -13,8 +13,6 @@ _optional_||integer(int64)
|*name* +
_optional_|The name of the category +
*Default* : `"DefaultCategory"` +
*Length* : `0 - 255` +
*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` +
*Example* : `"FoobarCategory"`|string
|===
@@ -33,8 +31,6 @@ _optional_||integer(int64)
_optional_||integer(int64)
|*quantity* +
_optional_|*Default* : `0` +
*Minimum value* : `0` +
*Maximum value* : `10000` +
*Example* : `10`|integer(int32)
|*shipDate* +
_optional_||string(date-time)
@@ -67,13 +63,13 @@ _optional_||< <<definitions.adoc#_tag,Tag>> > array
[[_tag]]
=== Tag
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===

View File

@@ -11,17 +11,17 @@ POST /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<definitions.adoc#_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<definitions.adoc#_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -63,17 +63,17 @@ PUT /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<definitions.adoc#_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<definitions.adoc#_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -121,17 +121,17 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*status* +
_optional_|Status values that need to be considered for filter|< string > array(multi)
_optional_|Status values that need to be considered for filter|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -176,17 +176,17 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
_optional_|Tags to filter by|< string > array(multi)
_optional_|Tags to filter by|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -227,21 +227,21 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be updated|string
_required_|ID of pet that needs to be updated|string|
|*FormData*|*name* +
_required_|Updated name of the pet|string
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string
_required_|Updated status of the pet|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -286,17 +286,17 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)
_required_|ID of pet that needs to be fetched|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -339,19 +339,19 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
_required_||string
_required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)
_required_|Pet id to delete|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -387,17 +387,17 @@ POST /stores/order
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|order placed for purchasing the pet|<<definitions.adoc#_order,Order>>
_optional_|order placed for purchasing the pet|<<definitions.adoc#_order,Order>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -433,17 +433,17 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string
_required_|ID of pet that needs to be fetched|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -480,17 +480,17 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string
_required_|ID of the order that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -522,17 +522,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Created user object|<<definitions.adoc#_user,User>>
_optional_|Created user object|<<definitions.adoc#_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -559,17 +559,17 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<definitions.adoc#_user,User>> > array
_optional_|List of user object|< <<definitions.adoc#_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -596,17 +596,17 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<definitions.adoc#_user,User>> > array
_optional_|List of user object|< <<definitions.adoc#_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -633,19 +633,19 @@ GET /users/login
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*password* +
_optional_|The password for login in clear text|string
_optional_|The password for login in clear text|string|
|*Query*|*username* +
_optional_|The user name for login|string
_optional_|The user name for login|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -677,7 +677,7 @@ GET /users/logout
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -704,17 +704,17 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string
_required_|The name that needs to be fetched. Use user1 for testing.|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -751,19 +751,19 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|name that need to be deleted|string
_required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<definitions.adoc#_user,User>>
_optional_|Updated user object|<<definitions.adoc#_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
@@ -795,17 +795,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be deleted|string
_required_|The name that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content

View File

@@ -2,6 +2,14 @@
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
[%hardbreaks]
@@ -18,12 +26,4 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|===
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER

View File

@@ -29,11 +29,11 @@ _optional_|Place|string
[[_inlinedepthschema]]
=== InlineDepthSchema
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*Loop* +
_optional_|<<_inlinedepthschema_loop,Loop>>
_optional_||<<_inlinedepthschema_loop,Loop>>
|===
[[_inlinedepthschema_loop]]
@@ -100,78 +100,78 @@ _optional_|Description p2-2-2-2|boolean
[[_inlinepet]]
=== InlinePet
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*category* +
_optional_|<<_inlinepet_category,category>>
_optional_||<<_inlinepet_category,category>>
|*id* +
_required_|integer(int64)
_required_||integer(int64)
|*tags* +
_optional_|< <<_inlinepet_tags,tags>> > array
_optional_||< <<_inlinepet_tags,tags>> > array
|===
[[_inlinepet_category]]
*category*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===
[[_inlinepet_tags]]
*tags*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===
[[_inlinetitlepet]]
=== InlineTitlePet
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*category* +
_optional_|<<_categorymodel,CategoryModel>>
_optional_||<<_categorymodel,CategoryModel>>
|*id* +
_required_|integer(int64)
_required_||integer(int64)
|*tags* +
_optional_|< <<_tagmodel,TagModel>> > array
_optional_||< <<_tagmodel,TagModel>> > array
|===
[[_categorymodel]]
*CategoryModel*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===
[[_tagmodel]]
*TagModel*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===
@@ -191,33 +191,33 @@ _optional_|Place|string
mixed collections and objects
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_mixedschema_mytable,myTable>> > array
_optional_||< <<_mixedschema_mytable,myTable>> > array
|===
[[_mixedschema_mytable]]
*myTable*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_mixedschema_mydict,myDict>> > map
_optional_||< string, <<_mixedschema_mydict,myDict>> > map
|===
[[_mixedschema_mydict]]
*myDict*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===
@@ -245,35 +245,35 @@ _optional_|option value|string
mixed collections and objects
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_tablecontent,TableContent>> > array
_optional_||< <<_tablecontent,TableContent>> > array
|===
[[_tablecontent]]
*TableContent*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*emptyObject* +
_optional_|object
_optional_||object
|*myDict* +
_optional_|< string, <<_kvpair,KVPair>> > map
_optional_||< string, <<_kvpair,KVPair>> > map
|===
[[_kvpair]]
*KVPair*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===

View File

@@ -15,11 +15,11 @@ Dummy description
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*Version* +
_optional_|The API version|< < string, <<_collectionparameters_post_version,Version>> > map > array
_optional_|The API version|< < string, <<_collectionparameters_post_version,Version>> > map > array|
|===
[[_collectionparameters_post_version]]
@@ -37,7 +37,7 @@ _optional_|option value|string
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|< < string, <<_collectionparameters_post_response_200,Response 200>> > map > array
@@ -74,15 +74,15 @@ Dummy description
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*Option* +
_optional_|An optional option|string
_optional_|An optional option|string|
|*Query*|*Version* +
_optional_|The API version|string
_optional_|The API version|string|
|*Body*|*LaunchCommandRequest* +
_optional_|Launch something new|<<_launchcommand_post_launchcommandrequest,LaunchCommandRequest>>
_optional_|Launch something new|<<_launchcommand_post_launchcommandrequest,LaunchCommandRequest>>|
|===
[[_launchcommand_post_launchcommandrequest]]
@@ -126,7 +126,7 @@ _optional_|option value|string
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result +
@@ -182,49 +182,49 @@ Dummy description
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*Version* +
_optional_|The API version|<<_mixedparameters_post_version,Version>>
_optional_|The API version|<<_mixedparameters_post_version,Version>>|
|===
[[_mixedparameters_post_version]]
*Version*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_mixedparameters_post_mytable,myTable>> > array
_optional_||< <<_mixedparameters_post_mytable,myTable>> > array
|===
[[_mixedparameters_post_mytable]]
*myTable*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
_optional_||< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
|===
[[_mixedparameters_post_mytable_mydict]]
*myDict*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_mixedparameters_post_response_200,Response 200>>
@@ -233,33 +233,33 @@ _optional_|string
[[_mixedparameters_post_response_200]]
*Response 200*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_mixedparameters_post_mytable,myTable>> > array
_optional_||< <<_mixedparameters_post_mytable,myTable>> > array
|===
[[_mixedparameters_post_mytable]]
*myTable*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
_optional_||< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
|===
[[_mixedparameters_post_mytable_mydict]]
*myDict*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===
@@ -281,49 +281,49 @@ Dummy description
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*Version* +
_optional_|The API version|<<_request,Request>>
_optional_|The API version|<<_request,Request>>|
|===
[[_request]]
*Request*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_tablecontent,TableContent>> > array
_optional_||< <<_tablecontent,TableContent>> > array
|===
[[_tablecontent]]
*TableContent*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_kvpair,KVPair>> > map
_optional_||< string, <<_kvpair,KVPair>> > map
|===
[[_kvpair]]
*KVPair*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_result,Result>>
@@ -332,33 +332,33 @@ _optional_|string
[[_result]]
*Result*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_tablecontent,TableContent>> > array
_optional_||< <<_tablecontent,TableContent>> > array
|===
[[_tablecontent]]
*TableContent*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_kvpair,KVPair>> > map
_optional_||< string, <<_kvpair,KVPair>> > map
|===
[[_kvpair]]
*KVPair*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===

View File

@@ -29,11 +29,11 @@ _optional_|Place|string
[[_inlinedepthschema]]
=== InlineDepthSchema
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*Loop* +
_optional_|<<_inlinedepthschema_loop,Loop>>
_optional_||<<_inlinedepthschema_loop,Loop>>
|===
[[_inlinedepthschema_loop]]
@@ -100,78 +100,78 @@ _optional_|Description p2-2-2-2|boolean
[[_inlinepet]]
=== InlinePet
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*category* +
_optional_|<<_inlinepet_category,category>>
_optional_||<<_inlinepet_category,category>>
|*id* +
_required_|integer(int64)
_required_||integer(int64)
|*tags* +
_optional_|< <<_inlinepet_tags,tags>> > array
_optional_||< <<_inlinepet_tags,tags>> > array
|===
[[_inlinepet_category]]
*category*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===
[[_inlinepet_tags]]
*tags*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===
[[_inlinetitlepet]]
=== InlineTitlePet
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*category* +
_optional_|<<_categorymodel,CategoryModel>>
_optional_||<<_categorymodel,CategoryModel>>
|*id* +
_required_|integer(int64)
_required_||integer(int64)
|*tags* +
_optional_|< <<_tagmodel,TagModel>> > array
_optional_||< <<_tagmodel,TagModel>> > array
|===
[[_categorymodel]]
*CategoryModel*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===
[[_tagmodel]]
*TagModel*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===
@@ -191,33 +191,33 @@ _optional_|Place|string
mixed collections and objects
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_mixedschema_mytable,myTable>> > array
_optional_||< <<_mixedschema_mytable,myTable>> > array
|===
[[_mixedschema_mytable]]
*myTable*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_mixedschema_mydict,myDict>> > map
_optional_||< string, <<_mixedschema_mydict,myDict>> > map
|===
[[_mixedschema_mydict]]
*myDict*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===
@@ -245,35 +245,35 @@ _optional_|option value|string
mixed collections and objects
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_tablecontent,TableContent>> > array
_optional_||< <<_tablecontent,TableContent>> > array
|===
[[_tablecontent]]
*TableContent*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*emptyObject* +
_optional_|object
_optional_||object
|*myDict* +
_optional_|< string, <<_kvpair,KVPair>> > map
_optional_||< string, <<_kvpair,KVPair>> > map
|===
[[_kvpair]]
*KVPair*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===

View File

@@ -36,7 +36,7 @@ _optional_|option value|string
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|< < string, <<_collectionparameters_post_response_200,Response 200>> > map > array
@@ -73,13 +73,13 @@ Dummy description
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*Option* +
_optional_|An optional option|string
_optional_|An optional option|string|
|*Query*|*Version* +
_optional_|The API version|string
_optional_|The API version|string|
|===
@@ -129,7 +129,7 @@ _optional_|option value|string
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result +
@@ -191,39 +191,39 @@ _Name_ : Version
_Flags_ : optional
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_mixedparameters_post_mytable,myTable>> > array
_optional_||< <<_mixedparameters_post_mytable,myTable>> > array
|===
[[_mixedparameters_post_mytable]]
*myTable*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_mixedparameters_post_mydict,myDict>> > map
_optional_||< string, <<_mixedparameters_post_mydict,myDict>> > map
|===
[[_mixedparameters_post_mydict]]
*myDict*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_mixedparameters_post_response_200,Response 200>>
@@ -232,33 +232,33 @@ _optional_|string
[[_mixedparameters_post_response_200]]
*Response 200*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_mixedparameters_post_mytable,myTable>> > array
_optional_||< <<_mixedparameters_post_mytable,myTable>> > array
|===
[[_mixedparameters_post_mytable]]
*myTable*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
_optional_||< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
|===
[[_mixedparameters_post_mytable_mydict]]
*myDict*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===
@@ -286,39 +286,39 @@ _Name_ : Version
_Flags_ : optional
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_tablecontent,TableContent>> > array
_optional_||< <<_tablecontent,TableContent>> > array
|===
[[_tablecontent]]
*TableContent*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_kvpair,KVPair>> > map
_optional_||< string, <<_kvpair,KVPair>> > map
|===
[[_kvpair]]
*KVPair*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|Result|<<_result,Result>>
@@ -327,33 +327,33 @@ _optional_|string
[[_result]]
*Result*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myTable* +
_optional_|< <<_tablecontent,TableContent>> > array
_optional_||< <<_tablecontent,TableContent>> > array
|===
[[_tablecontent]]
*TableContent*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*myDict* +
_optional_|< string, <<_kvpair,KVPair>> > map
_optional_||< string, <<_kvpair,KVPair>> > map
|===
[[_kvpair]]
*KVPair*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*k* +
_optional_|string
_optional_||string
|*v* +
_optional_|string
_optional_||string
|===

View File

@@ -5,68 +5,68 @@
[[_comment]]
=== Comment
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*created_time* +
_optional_|string
_optional_||string
|*from* +
_optional_|<<_miniprofile,MiniProfile>>
_optional_||<<_miniprofile,MiniProfile>>
|*id* +
_optional_|string
_optional_||string
|*text* +
_optional_|string
_optional_||string
|===
[[_image]]
=== Image
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*height* +
_optional_|integer
_optional_||integer
|*url* +
_optional_|string
_optional_||string
|*width* +
_optional_|integer
_optional_||integer
|===
[[_like]]
=== Like
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*first_name* +
_optional_|string
_optional_||string
|*id* +
_optional_|string
_optional_||string
|*last_name* +
_optional_|string
_optional_||string
|*type* +
_optional_|string
_optional_||string
|*user_name* +
_optional_|string
_optional_||string
|===
[[_location]]
=== Location
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|string
_optional_||string
|*latitude* +
_optional_|number
_optional_||number
|*longitude* +
_optional_|number
_optional_||number
|*name* +
_optional_|string
_optional_||string
|===
@@ -105,51 +105,51 @@ _optional_||<<_media_videos,videos>>
[[_media_comments]]
*comments:*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*count* +
_optional_|integer
_optional_||integer
|*data* +
_optional_|< <<_comment,Comment>> > array
_optional_||< <<_comment,Comment>> > array
|===
[[_media_images]]
*images*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*low_resolution* +
_optional_|<<_image,Image>>
_optional_||<<_image,Image>>
|*standard_resolution* +
_optional_|<<_image,Image>>
_optional_||<<_image,Image>>
|*thumbnail* +
_optional_|<<_image,Image>>
_optional_||<<_image,Image>>
|===
[[_media_likes]]
*likes*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*count* +
_optional_|integer
_optional_||integer
|*data* +
_optional_|< <<_miniprofile,MiniProfile>> > array
_optional_||< <<_miniprofile,MiniProfile>> > array
|===
[[_media_videos]]
*videos*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*low_resolution* +
_optional_|<<_image,Image>>
_optional_||<<_image,Image>>
|*standard_resolution* +
_optional_|<<_image,Image>>
_optional_||<<_image,Image>>
|===
@@ -158,67 +158,67 @@ _optional_|<<_image,Image>>
A shorter version of User for likes array
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*full_name* +
_optional_|string
_optional_||string
|*id* +
_optional_|integer
_optional_||integer
|*profile_picture* +
_optional_|string
_optional_||string
|*user_name* +
_optional_|string
_optional_||string
|===
[[_tag]]
=== Tag
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*media_count* +
_optional_|integer
_optional_||integer
|*name* +
_optional_|string
_optional_||string
|===
[[_user]]
=== User
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*bio* +
_optional_|string
_optional_||string
|*counts* +
_optional_|<<_user_counts,counts>>
_optional_||<<_user_counts,counts>>
|*full_name* +
_optional_|string
_optional_||string
|*id* +
_optional_|integer
_optional_||integer
|*profile_picture* +
_optional_|string
_optional_||string
|*username* +
_optional_|string
_optional_||string
|*website* +
_optional_|string
_optional_||string
|===
[[_user_counts]]
*counts*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*follows* +
_optional_|integer
_optional_||integer
|*follwed_by* +
_optional_|integer
_optional_||integer
|*media* +
_optional_|integer
_optional_||integer
|===

File diff suppressed because it is too large Load Diff

View File

@@ -2,6 +2,14 @@
[[_securityscheme]]
== Security
[[_key]]
=== key
[%hardbreaks]
_Type_ : apiKey
_Name_ : access_token
_In_ : QUERY
[[_oauth]]
=== oauth
[%hardbreaks]
@@ -21,12 +29,4 @@ _Token URL_ : https://instagram.com/oauth/authorize/?client_id=CLIENT-ID&redirec
|===
[[_key]]
=== key
[%hardbreaks]
_Type_ : apiKey
_Name_ : access_token
_In_ : QUERY

View File

@@ -15,17 +15,17 @@ Returns integer metrics information for the application.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|String metrics|< string, integer(int32) > map
_optional_|String metrics|< string, integer(int32) > map|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|< string, string > map
@@ -60,17 +60,17 @@ Returns a collated list of all `@RequestMapping` paths.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Mappings|< string, <<_mappinginfo,MappingInfo>> > map
_optional_|Mappings|< string, <<_mappinginfo,MappingInfo>> > map|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|< string, <<_mappinginfo,MappingInfo>> > map
@@ -105,29 +105,29 @@ Returns metrics information for the application.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Metrics|< string, <<_createmetrics_body,body>> > map
_optional_|Metrics|< string, <<_createmetrics_body,body>> > map|
|===
[[_createmetrics_body]]
*body*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*p1* +
_optional_|string
_optional_||string
|*p2* +
_optional_|string
_optional_||string
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|< string, <<_createmetrics_response_200,Response 200>> > map
@@ -136,13 +136,13 @@ _optional_|string
[[_createmetrics_response_200]]
*Response 200*
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*p1* +
_optional_|string
_optional_||string
|*p2* +
_optional_|string
_optional_||string
|===
@@ -174,17 +174,17 @@ Returns string metrics information for the application.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|String metrics|< string, string > map
_optional_|String metrics|< string, string > map|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|OK|< string, string > map

View File

@@ -48,11 +48,11 @@ _required_||string
Collection parent type without discriminator
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*name* +
_optional_|string
_optional_||string
|===
@@ -74,8 +74,7 @@ _required_||string
_required_||string
|*packSize* +
_required_|the size of the pack the dog is from +
*Default* : `0` +
*Minimum value* : `0`|integer(int32)
*Default* : `0`|integer(int32)
|*petType* +
_required_||string
|===
@@ -104,13 +103,13 @@ _optional_||string
Pet parent type with discriminator
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*name* +
_required_|string
_required_||string
|*petType* +
_required_|string
_required_||string
|===

View File

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

View File

@@ -48,11 +48,11 @@ _required_|The measured skill for hunting +
Collection parent type without discriminator
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*name* +
_optional_|string
_optional_||string
|===
@@ -76,8 +76,7 @@ _required_||string
_required_||string
|*packSize* +
_required_|the size of the pack the dog is from +
*Default* : `0` +
*Minimum value* : `0`|integer(int32)
*Default* : `0`|integer(int32)
|===
@@ -104,13 +103,13 @@ _required_|collection type discriminator|string
Pet parent type with discriminator
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*name* +
_required_|string
_required_||string
|*petType* +
_required_|string
_required_||string
|===

View File

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

View File

@@ -5,13 +5,13 @@
[[_category]]
=== Category
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===
@@ -39,13 +39,13 @@ _optional_||< <<_tag,Tag>> > array
[[_tag]]
=== Tag
[options="header", cols=".^3,.^4"]
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Schema
|Name|Description|Schema
|*id* +
_optional_|integer(int64)
_optional_||integer(int64)
|*name* +
_optional_|string
_optional_||string
|===

View File

@@ -15,17 +15,17 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)
_required_|ID of pet that needs to be fetched|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +

View File

@@ -2,6 +2,14 @@
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
[%hardbreaks]
@@ -18,12 +26,4 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|===
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER

View File

@@ -55,17 +55,17 @@ POST /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -136,17 +136,17 @@ PUT /pets
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>
_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -223,17 +223,17 @@ Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*status* +
_optional_|Status values that need to be considered for filter|< string > array(multi)
_optional_|Status values that need to be considered for filter|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -305,17 +305,17 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*tags* +
_optional_|Tags to filter by|< string > array(multi)
_optional_|Tags to filter by|< string > array(multi)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -383,21 +383,21 @@ POST /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be updated|string
_required_|ID of pet that needs to be updated|string|
|*FormData*|*name* +
_required_|Updated name of the pet|string
_required_|Updated name of the pet|string|
|*FormData*|*status* +
_required_|Updated status of the pet|string
_required_|Updated status of the pet|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*405*|Invalid input|No Content
@@ -458,17 +458,17 @@ Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*petId* +
_required_|ID of pet that needs to be fetched|integer(int64)
_required_|ID of pet that needs to be fetched|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -542,19 +542,19 @@ DELETE /pets/{petId}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Header*|*api_key* +
_required_||string
_required_||string|
|*Path*|*petId* +
_required_|Pet id to delete|integer(int64)
_required_|Pet id to delete|integer(int64)|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid pet value|No Content
@@ -606,17 +606,17 @@ POST /stores/order
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|order placed for purchasing the pet|<<_order,Order>>
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -691,17 +691,17 @@ For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values w
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of pet that needs to be fetched|string
_required_|ID of pet that needs to be fetched|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -763,17 +763,17 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*orderId* +
_required_|ID of the order that needs to be deleted|string
_required_|ID of the order that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid ID supplied|No Content
@@ -814,17 +814,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|Created user object|<<_user,User>>
_optional_|Created user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -876,17 +876,17 @@ POST /users/createWithArray
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -938,17 +938,17 @@ POST /users/createWithList
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Body*|*body* +
_optional_|List of user object|< <<_user,User>> > array
_optional_|List of user object|< <<_user,User>> > array|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1000,19 +1000,19 @@ GET /users/login
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Query*|*password* +
_optional_|The password for login in clear text|string
_optional_|The password for login in clear text|string|
|*Query*|*username* +
_optional_|The user name for login|string
_optional_|The user name for login|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -1072,7 +1072,7 @@ GET /users/logout
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*default*|successful operation|No Content
@@ -1108,17 +1108,17 @@ GET /users/{username}
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be fetched. Use user1 for testing.|string
_required_|The name that needs to be fetched. Use user1 for testing.|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*200*|successful operation +
@@ -1182,19 +1182,19 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|name that need to be deleted|string
_required_|name that need to be deleted|string|
|*Body*|*body* +
_optional_|Updated user object|<<_user,User>>
_optional_|Updated user object|<<_user,User>>|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid user supplied|No Content
@@ -1251,17 +1251,17 @@ This can only be done by the logged in user.
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|===
|Type|Name|Description|Schema
|Type|Name|Description|Schema|Default
|*Path*|*username* +
_required_|The name that needs to be deleted|string
_required_|The name that needs to be deleted|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^1,.^15,.^4"]
|===
|HTTP Code|Description|Schema
|*400*|Invalid username supplied|No Content
@@ -1305,8 +1305,6 @@ _optional_|*Example* : `0`|integer(int64)
|*name* +
_optional_|The name of the category +
*Default* : `"DefaultCategory"` +
*Length* : `0 - 255` +
*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` +
*Example* : `"FoobarCategory"`|string
|===
@@ -1325,8 +1323,6 @@ _optional_|*Example* : `0`|integer(int64)
_optional_|*Example* : `0`|integer(int64)
|*quantity* +
_optional_|*Default* : `0` +
*Minimum value* : `0` +
*Maximum value* : `10000` +
*Example* : `10`|integer(int32)
|*shipDate* +
_optional_|*Example* : `"string"`|string(date-time)
@@ -1402,6 +1398,14 @@ _optional_|*Example* : `"string"`|string
[[_securityscheme]]
== Security
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER
[[_petstore_auth]]
=== petstore_auth
[%hardbreaks]
@@ -1418,12 +1422,4 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|===
[[_api_key]]
=== api_key
[%hardbreaks]
_Type_ : apiKey
_Name_ : api_key
_In_ : HEADER

View File

@@ -1,63 +0,0 @@
[[_definitions]]
== Definitions
[[_samplerequest]]
=== SampleRequest
[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|*sampleDoubleComplete* +
_optional_|sample double with range 0.0-10.0 +
*Minimum value* : `0.0` +
*Maximum value* : `10.0`|number(double)
|*sampleDoubleExclusiveBoth* +
_optional_|sample double with range 0.0-10.0 (both exclusive) +
*Minimum value (exclusive)* : `0.0` +
*Maximum value (exclusive)* : `10.0`|number(double)
|*sampleDoubleExclusiveMaximum* +
_optional_|sample double with range to 10.0 (exclusive) +
*Maximum value (exclusive)* : `10.0`|number(double)
|*sampleDoubleExclusiveMinimum* +
_optional_|sample double with range from 0.0 (exclusive) +
*Minimum value (exclusive)* : `0.0`|number(double)
|*sampleDoubleNoDescription* +
_optional_|*Minimum value* : `0.0` +
*Maximum value* : `10.0`|number(double)
|*sampleDoubleOnlyMaximum* +
_optional_|sample double with range to 10.0 +
*Maximum value* : `10.0`|number(double)
|*sampleDoubleOnlyMinimum* +
_optional_|sample double with range from 0.0 +
*Minimum value* : `0.0`|number(double)
|*sampleNumberComplete* +
_optional_|sample int with range 0-10 +
*Minimum value* : `0` +
*Maximum value* : `10`|integer(int32)
|*sampleNumberNoDescription* +
_optional_|*Minimum value* : `0` +
*Maximum value* : `10`|integer(int32)
|*sampleNumberOnlyMaximum* +
_optional_|sample int with range to 10 +
*Maximum value* : `10`|integer(int32)
|*sampleNumberOnlyMinimum* +
_optional_|sample int with range from 0 +
*Minimum value* : `0`|integer(int32)
|*sampleStringComplete* +
_optional_|Sample string with range 0-2 and a pattern +
*Length* : `0 - 2` +
*Pattern* : `"[A-Z0-9]{0,2}"`|string
|*sampleStringOnlyMaxLength* +
_optional_|*Maximal length* : `2`|string
|*sampleStringOnlyMinLength* +
_optional_|*Minimum length* : `0`|string
|*sampleStringOnlyPattern* +
_optional_|*Pattern* : `"[A-Z0-9]{0,2}"`|string
|*sampleStringWithNoDescription* +
_optional_|*Length* : `0 - 2` +
*Pattern* : `"[A-Z0-9]{0,2}"`|string
|===

View File

@@ -1,14 +0,0 @@
= Title
[[_overview]]
== Overview
Description
=== Version information
[%hardbreaks]
_Version_ : Developer build

View File

@@ -8,7 +8,7 @@
|Name|Description|Schema|
|---|---|---|
|**id** <br>*optional*||integer(int64)|
|**name** <br>*optional*|The name of the category <br>**Default** : `"DefaultCategory"` <br>**Length** : `0 - 255` <br>**Pattern** : `"[A-Za-zäöüÄÖÜß]{0,255}"` <br>**Example** : `"FoobarCategory"`|string|
|**name** <br>*optional*|The name of the category <br>**Default** : `"DefaultCategory"` <br>**Example** : `"FoobarCategory"`|string|
<a name="order"></a>
@@ -19,7 +19,7 @@
|**complete** <br>*optional*||boolean|
|**id** <br>*optional*||integer(int64)|
|**petId** <br>*optional*||integer(int64)|
|**quantity** <br>*optional*|**Default** : `0` <br>**Minimum value** : `0` <br>**Maximum value** : `10000` <br>**Example** : `10`|integer(int32)|
|**quantity** <br>*optional*|**Default** : `0` <br>**Example** : `10`|integer(int32)|
|**shipDate** <br>*optional*||string(date-time)|
|**status** <br>*optional*|Order Status|enum (Ordered, Cancelled)|
@@ -40,10 +40,10 @@
<a name="tag"></a>
### Tag
|Name|Schema|
|---|---|
|**id** <br>*optional*|integer(int64)|
|**name** <br>*optional*|string|
|Name|Description|Schema|
|---|---|---|
|**id** <br>*optional*||integer(int64)|
|**name** <br>*optional*||string|
<a name="user"></a>

View File

@@ -11,9 +11,9 @@ POST /pets
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](#pet)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](#pet)||
#### Responses
@@ -56,9 +56,9 @@ PUT /pets
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](#pet)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](#pet)||
#### Responses
@@ -107,9 +107,9 @@ Multiple status values can be provided with comma seperated strings
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Query**|**status** <br>*optional*|Status values that need to be considered for filter|< string > array(multi)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Query**|**status** <br>*optional*|Status values that need to be considered for filter|< string > array(multi)||
#### Responses
@@ -151,9 +151,9 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Query**|**tags** <br>*optional*|Tags to filter by|< string > array(multi)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Query**|**tags** <br>*optional*|Tags to filter by|< string > array(multi)||
#### Responses
@@ -191,11 +191,11 @@ POST /pets/{petId}
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be updated|string|
|**FormData**|**name** <br>*required*|Updated name of the pet|string|
|**FormData**|**status** <br>*required*|Updated status of the pet|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be updated|string||
|**FormData**|**name** <br>*required*|Updated name of the pet|string||
|**FormData**|**status** <br>*required*|Updated status of the pet|string||
#### Responses
@@ -241,9 +241,9 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error cond
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)||
#### Responses
@@ -283,10 +283,10 @@ DELETE /pets/{petId}
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Header**|**api_key** <br>*required*||string|
|**Path**|**petId** <br>*required*|Pet id to delete|integer(int64)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Header**|**api_key** <br>*required*||string||
|**Path**|**petId** <br>*required*|Pet id to delete|integer(int64)||
#### Responses
@@ -323,9 +323,9 @@ POST /stores/order
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|order placed for purchasing the pet|[Order](#order)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|order placed for purchasing the pet|[Order](#order)||
#### Responses
@@ -360,9 +360,9 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**orderId** <br>*required*|ID of pet that needs to be fetched|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**orderId** <br>*required*|ID of pet that needs to be fetched|string||
#### Responses
@@ -398,9 +398,9 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**orderId** <br>*required*|ID of the order that needs to be deleted|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**orderId** <br>*required*|ID of the order that needs to be deleted|string||
#### Responses
@@ -435,9 +435,9 @@ This can only be done by the logged in user.
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|Created user object|[User](#user)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|Created user object|[User](#user)||
#### Responses
@@ -467,9 +467,9 @@ POST /users/createWithArray
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|List of user object|< [User](#user) > array|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|List of user object|< [User](#user) > array||
#### Responses
@@ -499,9 +499,9 @@ POST /users/createWithList
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|List of user object|< [User](#user) > array|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|List of user object|< [User](#user) > array||
#### Responses
@@ -531,10 +531,10 @@ GET /users/login
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Query**|**password** <br>*optional*|The password for login in clear text|string|
|**Query**|**username** <br>*optional*|The user name for login|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Query**|**password** <br>*optional*|The password for login in clear text|string||
|**Query**|**username** <br>*optional*|The user name for login|string||
#### Responses
@@ -590,9 +590,9 @@ GET /users/{username}
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**username** <br>*required*|The name that needs to be fetched. Use user1 for testing.|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**username** <br>*required*|The name that needs to be fetched. Use user1 for testing.|string||
#### Responses
@@ -628,10 +628,10 @@ This can only be done by the logged in user.
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**username** <br>*required*|name that need to be deleted|string|
|**Body**|**body** <br>*optional*|Updated user object|[User](#user)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**username** <br>*required*|name that need to be deleted|string||
|**Body**|**body** <br>*optional*|Updated user object|[User](#user)||
#### Responses
@@ -666,9 +666,9 @@ This can only be done by the logged in user.
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**username** <br>*required*|The name that needs to be deleted|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**username** <br>*required*|The name that needs to be deleted|string||
#### Responses

View File

@@ -2,6 +2,13 @@
<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
@@ -15,11 +22,4 @@
|read_pets|read your pets|
<a name="api_key"></a>
### api_key
*Type* : apiKey
*Name* : api_key
*In* : HEADER

View File

@@ -8,7 +8,7 @@
|Name|Description|Schema|
|---|---|---|
|**id** <br>*optional*||integer(int64)|
|**name** <br>*optional*|The name of the category <br>**Default** : `"DefaultCategory"` <br>**Length** : `0 - 255` <br>**Pattern** : `"[A-Za-zäöüÄÖÜß]{0,255}"` <br>**Example** : `"FoobarCategory"`|string|
|**name** <br>*optional*|The name of the category <br>**Default** : `"DefaultCategory"` <br>**Example** : `"FoobarCategory"`|string|
<a name="order"></a>
@@ -19,7 +19,7 @@
|**complete** <br>*optional*||boolean|
|**id** <br>*optional*||integer(int64)|
|**petId** <br>*optional*||integer(int64)|
|**quantity** <br>*optional*|**Default** : `0` <br>**Minimum value** : `0` <br>**Maximum value** : `10000` <br>**Example** : `10`|integer(int32)|
|**quantity** <br>*optional*|**Default** : `0` <br>**Example** : `10`|integer(int32)|
|**shipDate** <br>*optional*||string(date-time)|
|**status** <br>*optional*|Order Status|enum (Ordered, Cancelled)|
@@ -40,10 +40,10 @@
<a name="tag"></a>
### Tag
|Name|Schema|
|---|---|
|**id** <br>*optional*|integer(int64)|
|**name** <br>*optional*|string|
|Name|Description|Schema|
|---|---|---|
|**id** <br>*optional*||integer(int64)|
|**name** <br>*optional*||string|
<a name="user"></a>

View File

@@ -11,9 +11,9 @@ POST /pets
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](definitions.md#pet)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](definitions.md#pet)||
#### Responses
@@ -56,9 +56,9 @@ PUT /pets
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](definitions.md#pet)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](definitions.md#pet)||
#### Responses
@@ -107,9 +107,9 @@ Multiple status values can be provided with comma seperated strings
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Query**|**status** <br>*optional*|Status values that need to be considered for filter|< string > array(multi)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Query**|**status** <br>*optional*|Status values that need to be considered for filter|< string > array(multi)||
#### Responses
@@ -151,9 +151,9 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Query**|**tags** <br>*optional*|Tags to filter by|< string > array(multi)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Query**|**tags** <br>*optional*|Tags to filter by|< string > array(multi)||
#### Responses
@@ -191,11 +191,11 @@ POST /pets/{petId}
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be updated|string|
|**FormData**|**name** <br>*required*|Updated name of the pet|string|
|**FormData**|**status** <br>*required*|Updated status of the pet|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be updated|string||
|**FormData**|**name** <br>*required*|Updated name of the pet|string||
|**FormData**|**status** <br>*required*|Updated status of the pet|string||
#### Responses
@@ -241,9 +241,9 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error cond
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)||
#### Responses
@@ -283,10 +283,10 @@ DELETE /pets/{petId}
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Header**|**api_key** <br>*required*||string|
|**Path**|**petId** <br>*required*|Pet id to delete|integer(int64)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Header**|**api_key** <br>*required*||string||
|**Path**|**petId** <br>*required*|Pet id to delete|integer(int64)||
#### Responses
@@ -323,9 +323,9 @@ POST /stores/order
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|order placed for purchasing the pet|[Order](definitions.md#order)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|order placed for purchasing the pet|[Order](definitions.md#order)||
#### Responses
@@ -360,9 +360,9 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**orderId** <br>*required*|ID of pet that needs to be fetched|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**orderId** <br>*required*|ID of pet that needs to be fetched|string||
#### Responses
@@ -398,9 +398,9 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**orderId** <br>*required*|ID of the order that needs to be deleted|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**orderId** <br>*required*|ID of the order that needs to be deleted|string||
#### Responses
@@ -435,9 +435,9 @@ This can only be done by the logged in user.
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|Created user object|[User](definitions.md#user)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|Created user object|[User](definitions.md#user)||
#### Responses
@@ -467,9 +467,9 @@ POST /users/createWithArray
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|List of user object|< [User](definitions.md#user) > array|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|List of user object|< [User](definitions.md#user) > array||
#### Responses
@@ -499,9 +499,9 @@ POST /users/createWithList
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Body**|**body** <br>*optional*|List of user object|< [User](definitions.md#user) > array|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body** <br>*optional*|List of user object|< [User](definitions.md#user) > array||
#### Responses
@@ -531,10 +531,10 @@ GET /users/login
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Query**|**password** <br>*optional*|The password for login in clear text|string|
|**Query**|**username** <br>*optional*|The user name for login|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Query**|**password** <br>*optional*|The password for login in clear text|string||
|**Query**|**username** <br>*optional*|The user name for login|string||
#### Responses
@@ -590,9 +590,9 @@ GET /users/{username}
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**username** <br>*required*|The name that needs to be fetched. Use user1 for testing.|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**username** <br>*required*|The name that needs to be fetched. Use user1 for testing.|string||
#### Responses
@@ -628,10 +628,10 @@ This can only be done by the logged in user.
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**username** <br>*required*|name that need to be deleted|string|
|**Body**|**body** <br>*optional*|Updated user object|[User](definitions.md#user)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**username** <br>*required*|name that need to be deleted|string||
|**Body**|**body** <br>*optional*|Updated user object|[User](definitions.md#user)||
#### Responses
@@ -666,9 +666,9 @@ This can only be done by the logged in user.
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**username** <br>*required*|The name that needs to be deleted|string|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**username** <br>*required*|The name that needs to be deleted|string||
#### Responses

View File

@@ -2,6 +2,13 @@
<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
@@ -15,11 +22,4 @@
|read_pets|read your pets|
<a name="api_key"></a>
### api_key
*Type* : apiKey
*Name* : api_key
*In* : HEADER

View File

@@ -5,10 +5,10 @@
<a name="category"></a>
### Category
|Name|Schema|
|---|---|
|**id** <br>*optional*|integer(int64)|
|**name** <br>*optional*|string|
|Name|Description|Schema|
|---|---|---|
|**id** <br>*optional*||integer(int64)|
|**name** <br>*optional*||string|
<a name="pet"></a>
@@ -27,10 +27,10 @@
<a name="tag"></a>
### Tag
|Name|Schema|
|---|---|
|**id** <br>*optional*|integer(int64)|
|**name** <br>*optional*|string|
|Name|Description|Schema|
|---|---|---|
|**id** <br>*optional*||integer(int64)|
|**name** <br>*optional*||string|

View File

@@ -15,9 +15,9 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error cond
#### Parameters
|Type|Name|Description|Schema|
|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)|
|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)||
#### Responses

View File

@@ -2,6 +2,13 @@
<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
@@ -15,11 +22,4 @@
|read_pets|read your pets|
<a name="api_key"></a>
### api_key
*Type* : apiKey
*Name* : api_key
*In* : HEADER

View File

@@ -1,9 +0,0 @@
{
"swagger": "2.0",
"info": {
"title": "Empty Contact",
"contact": {},
"version": "1.0"
},
"paths": {}
}

View File

@@ -717,6 +717,20 @@
}
}
}
},
"/objectArray": {
"patch": {
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ObjectArray"
}
}
]
}
}
},
"securityDefinitions": {
@@ -757,6 +771,19 @@
}
},
"definitions": {
"ObjectArray": {
"type": "array",
"items": {
"type": "object"
},
"example": [
{
"op": "replace",
"path": "/s",
"v": "w"
}
]
},
"Identified": {
"properties": {
"id": {

View File

@@ -1,81 +0,0 @@
{
"swagger": "2.0",
"info": {
"version": "2.0.0",
"title": "API"
},
"schemes": [
"https"
],
"basePath": "/navigation",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"paths": {
"/": {
"get": {
"operationId": "userNavigation",
"summary": "Get navigation",
"description": "Returns the navigation as a tree",
"parameters": [],
"tags": [
"Navigation"
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/NavigationEntry"
}
}
}
},
"put": {
"operationId": "updateNavigation",
"summary": "update entry",
"description": "Updates the navigation tree",
"parameters": [
{
"name": "entry",
"in": "body",
"schema": {
"$ref": "#/definitions/NavigationEntry"
}
}
],
"tags": [
"Navigation"
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/NavigationEntry"
}
}
}
}
}
},
"definitions": {
"NavigationEntry": {
"type": "object",
"properties": {
"id": {
"description": "Primary key of this entry",
"type": "number",
"format": "int64"
},
"childs": {
"type": "array",
"items": {
"$ref": "#/definitions/NavigationEntry"
}
}
}
}
}
}

View File

@@ -1,113 +0,0 @@
{
"swagger": "2.0",
"info": {
"description": "Description",
"version": "Developer build",
"title": "Title"
},
"definitions": {
"SampleRequest": {
"type": "object",
"properties": {
"sampleStringComplete": {
"type": "string",
"description": "Sample string with range 0-2 and a pattern",
"minLength": 0,
"maxLength": 2,
"pattern": "[A-Z0-9]{0,2}"
},
"sampleStringWithNoDescription": {
"type": "string",
"minLength": 0,
"maxLength": 2,
"pattern": "[A-Z0-9]{0,2}"
},
"sampleStringOnlyMinLength": {
"type": "string",
"minLength": 0
},
"sampleStringOnlyMaxLength": {
"type": "string",
"maxLength": 2
},
"sampleStringOnlyPattern": {
"type": "string",
"pattern": "[A-Z0-9]{0,2}"
},
"sampleNumberComplete": {
"type":"integer",
"format":"int32",
"description": "sample int with range 0-10",
"minimum": 0,
"maximum": 10
},
"sampleNumberNoDescription": {
"type":"integer",
"format":"int32",
"minimum": 0,
"maximum": 10
},
"sampleNumberOnlyMinimum": {
"type":"integer",
"format":"int32",
"description": "sample int with range from 0",
"minimum": 0
},
"sampleNumberOnlyMaximum": {
"type":"integer",
"format":"int32",
"description": "sample int with range to 10",
"maximum": 10
},
"sampleDoubleComplete": {
"type":"number",
"format":"double",
"description": "sample double with range 0.0-10.0",
"minimum": 0.0,
"maximum": 10.0
},
"sampleDoubleNoDescription": {
"type":"number",
"format":"double",
"minimum": 0.0,
"maximum": 10.0
},
"sampleDoubleOnlyMinimum": {
"type":"number",
"format":"double",
"description": "sample double with range from 0.0",
"minimum": 0.0
},
"sampleDoubleOnlyMaximum": {
"type":"number",
"format":"double",
"description": "sample double with range to 10.0",
"maximum": 10.0
},
"sampleDoubleExclusiveMinimum": {
"type":"number",
"format":"double",
"description": "sample double with range from 0.0 (exclusive)",
"minimum": 0.0,
"exclusiveMinimum": true
},
"sampleDoubleExclusiveMaximum": {
"type":"number",
"format":"double",
"description": "sample double with range to 10.0 (exclusive)",
"maximum": 10.0,
"exclusiveMaximum": true
},
"sampleDoubleExclusiveBoth": {
"type":"number",
"format":"double",
"description": "sample double with range 0.0-10.0 (both exclusive)",
"minimum": 0.0,
"maximum": 10.0,
"exclusiveMinimum": true,
"exclusiveMaximum": true
}
}
}
}
}

View File

@@ -600,9 +600,6 @@ definitions:
name:
type: string
description: The name of the category
minLength: 0
maxLength: 255
pattern: "[A-Za-zäöüÄÖÜß]{0,255}"
default: DefaultCategory
example: FoobarCategory
Pet:
@@ -653,8 +650,6 @@ definitions:
quantity:
type: integer
format: int32
minimum: 0
maximum: 10000.0
default: 0
example: 10
shipDate:

View File

@@ -1,706 +0,0 @@
---
swagger: "2.0"
info:
description: "This is a sample server Petstore server. You can find out more about\
\ Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).\
\ 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://swagger.io/terms/"
contact:
email: "apiteam@swagger.io"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "petstore.swagger.io"
basePath: "/v2"
tags:
- name: "pet"
description: "Everything about your Pets"
externalDocs:
description: "Find out more"
url: "http://swagger.io"
- name: "store"
description: "Access to Petstore orders"
- name: "user"
description: "Operations about user"
externalDocs:
description: "Find out more about our store"
url: "http://swagger.io"
schemes:
- "http"
paths:
/pet:
post:
tags:
- "pet"
summary: "Add a new pet to the store"
description: ""
operationId: "addPet"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Pet object that needs to be added to the store"
required: true
schema:
$ref: "#/definitions/Pet"
responses:
405:
description: "Invalid input"
security:
- petstore_auth:
- "write:pets"
- "read:pets"
put:
tags:
- "pet"
summary: "Update an existing pet"
description: ""
operationId: "updatePet"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Pet object that needs to be added to the store"
required: true
schema:
$ref: "#/definitions/Pet"
responses:
400:
description: "Invalid ID supplied"
404:
description: "Pet not found"
405:
description: "Validation exception"
security:
- petstore_auth:
- "write:pets"
- "read:pets"
/pet/findByStatus:
get:
tags:
- "pet"
summary: "Finds Pets by status"
description: "Multiple status values can be provided with comma separated strings"
operationId: "findPetsByStatus"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "status"
in: "query"
description: "Status values that need to be considered for filter"
required: true
type: "array"
items:
type: "string"
enum:
- "available"
- "pending"
- "sold"
default: "available"
collectionFormat: "multi"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/Pet"
400:
description: "Invalid status value"
security:
- petstore_auth:
- "write:pets"
- "read:pets"
/pet/findByTags:
get:
tags:
- "pet"
summary: "Finds Pets by tags"
description: "Muliple tags can be provided with comma separated strings. Use\
\ tag1, tag2, tag3 for testing."
operationId: "findPetsByTags"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "tags"
in: "query"
description: "Tags to filter by"
required: true
type: "array"
items:
type: "string"
collectionFormat: "multi"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/Pet"
400:
description: "Invalid tag value"
security:
- petstore_auth:
- "write:pets"
- "read:pets"
deprecated: true
/pet/{petId}:
get:
tags:
- "pet"
summary: "Find pet by ID"
description: "Returns a single pet"
operationId: "getPetById"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "petId"
in: "path"
description: "ID of pet to return"
required: true
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Pet"
400:
description: "Invalid ID supplied"
404:
description: "Pet not found"
security:
- api_key: []
post:
tags:
- "pet"
summary: "Updates a pet in the store with form data"
description: ""
operationId: "updatePetWithForm"
consumes:
- "application/x-www-form-urlencoded"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "petId"
in: "path"
description: "ID of pet that needs to be updated"
required: true
type: "integer"
format: "int64"
- name: "name"
in: "formData"
description: "Updated name of the pet"
required: false
type: "string"
- name: "status"
in: "formData"
description: "Updated status of the pet"
required: false
type: "string"
responses:
405:
description: "Invalid input"
security:
- petstore_auth:
- "write:pets"
- "read:pets"
delete:
tags:
- "pet"
summary: "Deletes a pet"
description: ""
operationId: "deletePet"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "api_key"
in: "header"
required: false
type: "string"
- name: "petId"
in: "path"
description: "Pet id to delete"
required: true
type: "integer"
format: "int64"
responses:
400:
description: "Invalid ID supplied"
404:
description: "Pet not found"
security:
- petstore_auth:
- "write:pets"
- "read:pets"
/pet/{petId}/uploadImage:
post:
tags:
- "pet"
summary: "uploads an image"
description: ""
operationId: "uploadFile"
consumes:
- "multipart/form-data"
produces:
- "application/json"
parameters:
- name: "petId"
in: "path"
description: "ID of pet to update"
required: true
type: "integer"
format: "int64"
- name: "additionalMetadata"
in: "formData"
description: "Additional data to pass to server"
required: false
type: "string"
- name: "file"
in: "formData"
description: "file to upload"
required: false
type: "file"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/ApiResponse"
security:
- petstore_auth:
- "write:pets"
- "read:pets"
/store/inventory:
get:
tags:
- "store"
summary: "Returns pet inventories by status"
description: "Returns a map of status codes to quantities"
operationId: "getInventory"
produces:
- "application/json"
parameters: []
responses:
200:
description: "successful operation"
schema:
type: "object"
additionalProperties:
type: "integer"
format: "int32"
security:
- api_key: []
/store/order:
post:
tags:
- "store"
summary: "Place an order for a pet"
description: ""
operationId: "placeOrder"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "order placed for purchasing the pet"
required: true
schema:
$ref: "#/definitions/Order"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Order"
400:
description: "Invalid Order"
/store/order/{orderId}:
get:
tags:
- "store"
summary: "Find purchase order by ID"
description: "For valid response try integer IDs with value >= 1 and <= 10.\
\ Other values will generated exceptions"
operationId: "getOrderById"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "orderId"
in: "path"
description: "ID of pet that needs to be fetched"
required: true
type: "integer"
maximum: 10.0
minimum: 1.0
format: "int64"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Order"
400:
description: "Invalid ID supplied"
404:
description: "Order not found"
delete:
tags:
- "store"
summary: "Delete purchase order by ID"
description: "For valid response try integer IDs with positive integer value.\
\ Negative or non-integer values will generate API errors"
operationId: "deleteOrder"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "orderId"
in: "path"
description: "ID of the order that needs to be deleted"
required: true
type: "integer"
minimum: 1.0
format: "int64"
responses:
400:
description: "Invalid ID supplied"
404:
description: "Order not found"
/user:
post:
tags:
- "user"
summary: "Create user"
description: "This can only be done by the logged in user."
operationId: "createUser"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Created user object"
required: true
schema:
$ref: "#/definitions/User"
responses:
default:
description: "successful operation"
/user/createWithArray:
post:
tags:
- "user"
summary: "Creates list of users with given input array"
description: ""
operationId: "createUsersWithArrayInput"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "List of user object"
required: true
schema:
type: "array"
items:
$ref: "#/definitions/User"
responses:
default:
description: "successful operation"
/user/createWithList:
post:
tags:
- "user"
summary: "Creates list of users with given input array"
description: ""
operationId: "createUsersWithListInput"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "List of user object"
required: true
schema:
type: "array"
items:
$ref: "#/definitions/User"
responses:
default:
description: "successful operation"
/user/login:
get:
tags:
- "user"
summary: "Logs user into the system"
description: ""
operationId: "loginUser"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "username"
in: "query"
description: "The user name for login"
required: true
type: "string"
- name: "password"
in: "query"
description: "The password for login in clear text"
required: true
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "string"
headers:
X-Rate-Limit:
type: "integer"
format: "int32"
description: "calls per hour allowed by the user"
X-Expires-After:
type: "string"
format: "date-time"
description: "date in UTC when token expires"
400:
description: "Invalid username/password supplied"
/user/logout:
get:
tags:
- "user"
summary: "Logs out current logged in user session"
description: ""
operationId: "logoutUser"
produces:
- "application/xml"
- "application/json"
parameters: []
responses:
default:
description: "successful operation"
/user/{username}:
get:
tags:
- "user"
summary: "Get user by user name"
description: ""
operationId: "getUserByName"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "username"
in: "path"
description: "The name that needs to be fetched. Use user1 for testing. "
required: true
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/User"
400:
description: "Invalid username supplied"
404:
description: "User not found"
put:
tags:
- "user"
summary: "Updated user"
description: "This can only be done by the logged in user."
operationId: "updateUser"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "username"
in: "path"
description: "name that need to be updated"
required: true
type: "string"
- in: "body"
name: "body"
description: "Updated user object"
required: true
schema:
$ref: "#/definitions/User"
responses:
400:
description: "Invalid user supplied"
404:
description: "User not found"
delete:
tags:
- "user"
summary: "Delete user"
description: "This can only be done by the logged in user."
operationId: "deleteUser"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "username"
in: "path"
description: "The name that needs to be deleted"
required: true
type: "string"
responses:
400:
description: "Invalid username supplied"
404:
description: "User not found"
securityDefinitions:
petstore_auth:
type: "oauth2"
authorizationUrl: "http://petstore.swagger.io/oauth/dialog"
flow: "implicit"
scopes:
write:pets: "modify pets in your account"
read:pets: "read your pets"
api_key:
type: "apiKey"
name: "api_key"
in: "header"
definitions:
Order:
type: "object"
properties:
id:
type: "integer"
format: "int64"
petId:
type: "integer"
format: "int64"
quantity:
type: "integer"
format: "int32"
shipDate:
type: "string"
format: "date-time"
status:
type: "string"
description: "Order Status"
enum:
- "placed"
- "approved"
- "delivered"
complete:
type: "boolean"
default: false
xml:
name: "Order"
Category:
type: "object"
properties:
id:
type: "integer"
format: "int64"
name:
type: "string"
xml:
name: "Category"
User:
type: "object"
properties:
id:
type: "integer"
format: "int64"
username:
type: "string"
firstName:
type: "string"
lastName:
type: "string"
email:
type: "string"
password:
type: "string"
phone:
type: "string"
userStatus:
type: "integer"
format: "int32"
description: "User Status"
xml:
name: "User"
Tag:
type: "object"
properties:
id:
type: "integer"
format: "int64"
name:
type: "string"
xml:
name: "Tag"
Pet:
type: "object"
required:
- "name"
- "photoUrls"
properties:
id:
type: "integer"
format: "int64"
category:
$ref: "#/definitions/Category"
name:
type: "string"
example: "doggie"
photoUrls:
type: "array"
xml:
name: "photoUrl"
wrapped: true
items:
type: "string"
tags:
type: "array"
xml:
name: "tag"
wrapped: true
items:
$ref: "#/definitions/Tag"
status:
type: "string"
description: "pet status in the store"
enum:
- "available"
- "pending"
- "sold"
xml:
name: "Pet"
ApiResponse:
type: "object"
properties:
code:
type: "integer"
format: "int32"
type:
type: "string"
message:
type: "string"
externalDocs:
description: "Find out more about Swagger"
url: "http://swagger.io"