Compare commits
82 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e882975726 | ||
|
|
12209fe923 | ||
|
|
8a63744198 | ||
|
|
5871f0c9b0 | ||
|
|
908f524c64 | ||
|
|
9fa0ee3def | ||
|
|
35e9450f74 | ||
|
|
6033ea5a98 | ||
|
|
6f24c3cb39 | ||
|
|
e975e49d3e | ||
|
|
c5cfe10fa6 | ||
|
|
7c988460f0 | ||
|
|
21f1892de0 | ||
|
|
b97344849d | ||
|
|
935d48d4cc | ||
|
|
73ba233f9e | ||
|
|
ff955d392b | ||
|
|
19fde31f67 | ||
|
|
b3f368ac37 | ||
|
|
c5efb401b4 | ||
|
|
f386e6ed91 | ||
|
|
55b323c063 | ||
|
|
6f286b52d8 | ||
|
|
4850673b96 | ||
|
|
353af537ba | ||
|
|
2367d86eb7 | ||
|
|
1aec46a57c | ||
|
|
f650fb7b3e | ||
|
|
568d6a6441 | ||
|
|
630e86cd31 | ||
|
|
0e3e229434 | ||
|
|
f41d1cbcb0 | ||
|
|
20b653086d | ||
|
|
ae4cf35de4 | ||
|
|
86fc9a9746 | ||
|
|
1b4626d9ca | ||
|
|
7528b34ba3 | ||
|
|
ebecde1768 | ||
|
|
2301de6466 | ||
|
|
f7efad2480 | ||
|
|
c23bd01495 | ||
|
|
7e5986237a | ||
|
|
1bf26c95e3 | ||
|
|
3888e67d02 | ||
|
|
54e17321b6 | ||
|
|
90f56cfe61 | ||
|
|
44e33ad6f3 | ||
|
|
65d4e0c225 | ||
|
|
d37a374d02 | ||
|
|
5bb5e5ff29 | ||
|
|
de1f84d2aa | ||
|
|
aa35c0169c | ||
|
|
b53727842a | ||
|
|
f88e3d2ed4 | ||
|
|
eefda62d99 | ||
|
|
592446f714 | ||
|
|
3275a07325 | ||
|
|
1c2b9eee26 | ||
|
|
3a5533447b | ||
|
|
2fcd2d1a79 | ||
|
|
07d878be35 | ||
|
|
7a75d7874b | ||
|
|
99c3044218 | ||
|
|
fec5fb54bb | ||
|
|
031051f1f9 | ||
|
|
d432c398cf | ||
|
|
8eb44c26d2 | ||
|
|
3a76a3e920 | ||
|
|
52e80e7af6 | ||
|
|
1eac6a63d9 | ||
|
|
6e379042a0 | ||
|
|
8367195315 | ||
|
|
7de954958d | ||
|
|
a161924a7f | ||
|
|
9568f3a960 | ||
|
|
fdb24fdf33 | ||
|
|
3c0f935e99 | ||
|
|
826f4ff762 | ||
|
|
ed926139b8 | ||
|
|
cb23bfe1a4 | ||
|
|
ab7d355fe4 | ||
|
|
87ccc182f1 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -3,3 +3,6 @@
|
||||
.gradle
|
||||
build
|
||||
/bin/
|
||||
/.classpath
|
||||
/.project
|
||||
/.settings/
|
||||
|
||||
15
README.adoc
15
README.adoc
@@ -2,7 +2,7 @@
|
||||
:author: Robert Winkler
|
||||
:hardbreaks:
|
||||
|
||||
image:https://travis-ci.org/Swagger2Markup/swagger2markup.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/swagger2markup"] image:https://coveralls.io/repos/Swagger2Markup/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/Swagger2Markup/swagger2markup"] image:https://api.codacy.com/project/badge/grade/498a6a39d7d84ff687546359f58ee18d["Codacy code quality", link="https://www.codacy.com/app/robwin/swagger2markup"] image:https://api.bintray.com/packages/robwin/maven/swagger2markup/images/download.svg[link="https://bintray.com/robwin/maven/swagger2markup/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
|
||||
image:https://travis-ci.org/Swagger2Markup/swagger2markup.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/swagger2markup"] image:https://coveralls.io/repos/Swagger2Markup/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/Swagger2Markup/swagger2markup"] image:https://api.codacy.com/project/badge/grade/498a6a39d7d84ff687546359f58ee18d["Codacy code quality", link="https://www.codacy.com/app/robwin/swagger2markup"] image:https://api.bintray.com/packages/swagger2markup/Maven/swagger2markup/images/download.svg[link="https://bintray.com/swagger2markup/Maven/swagger2markup/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
|
||||
|
||||
|
||||
== Overview
|
||||
@@ -18,7 +18,7 @@ http://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc] is preferable to M
|
||||
|
||||
You can generate your HTML5, PDF and EPUB documentation via https://github.com/asciidoctor/asciidoctorj[asciidoctorj] or even better via the https://github.com/asciidoctor/asciidoctor-gradle-plugin[asciidoctor-gradle-plugin] or https://github.com/asciidoctor/asciidoctor-maven-plugin[asciidoctor-maven-plugin].
|
||||
|
||||
The project requires at least JDK 7.
|
||||
The project requires at least JDK 8.
|
||||
|
||||
== Example
|
||||
|
||||
@@ -27,8 +27,7 @@ image::src/docs/asciidoc/images/Swagger2Markup.PNG[]
|
||||
image::src/docs/asciidoc/images/Swagger2Markup_definitions.PNG[]
|
||||
|
||||
== Reference documentation
|
||||
- http://swagger2markup.readme.io/[Reference Documentation]
|
||||
- http://swagger2markup.github.io/swagger2markup/1.0.0-SNAPSHOT/[1.0.0-SNAPSHOT Documentation]
|
||||
- http://swagger2markup.github.io/swagger2markup/1.1.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]
|
||||
|
||||
@@ -38,14 +37,6 @@ image::src/docs/asciidoc/images/Swagger2Markup_definitions.PNG[]
|
||||
|
||||
Pull requests are welcome.
|
||||
|
||||
* New feature https://github.com/Swagger2Markup/swagger2markup/issues/18[Swagger2Markup/swagger2Markup#18] by https://github.com/sg-ad[@sg-ad]: In addition to the definitions.adoc you can also generate separate files for each definition model (ex: person.adoc, address.adoc, purchase.adoc).
|
||||
|
||||
* New feature https://github.com/Swagger2Markup/swagger2markup/issues/21[Swagger2Markup/swagger2Markup#21] by https://github.com/redowl[@redowl]: Support for both reference models and composed models.
|
||||
|
||||
* New feature https://github.com/Swagger2Markup/swagger2markup/issues/27[Swagger2Markup/swagger2Markup#27] by https://github.com/zmitrok[@zmitrok]: Added a hook to preprocess a Swagger Model before it is converted.
|
||||
|
||||
* New feature https://github.com/Swagger2Markup/swagger2markup/issues/48[Swagger2Markup/swagger2Markup#48] by https://github.com/MeteorBoom[@MeteorBoom]: Multi language support.
|
||||
|
||||
=== Questions
|
||||
You can ask questions about Swagger2Markup in https://gitter.im/Swagger2Markup/swagger2markup[Gitter].
|
||||
|
||||
|
||||
@@ -78,9 +78,28 @@
|
||||
|
||||
=== 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 #61: Refactor separated documents logic to support inter-document cross-references
|
||||
* Enhancement #53: Support for tags, paths and methods ordering
|
||||
* Enhancement #51: Support for separated operations files
|
||||
* Enhancement #52: Markdown generation for inline schemas
|
||||
|
||||
== Version 1.0.0
|
||||
* New configuration API
|
||||
* New extension SPI
|
||||
* Added new languages: turkish, german, france
|
||||
* New security document
|
||||
* Inline schema support
|
||||
* New configuration options
|
||||
* Support of deprecated path operations
|
||||
|
||||
=== Version 1.0.1
|
||||
* Enhancement: Support to render validation constraints of properties
|
||||
* Enhancement: Possibility to disable rendering of the security chapter below operations
|
||||
|
||||
== Version 1.1.0
|
||||
* PR #177: Fixed rendering of recursive examples
|
||||
* PR #186: Add support for Chinese language
|
||||
* PR #190: Add support for Spanish language
|
||||
* PR #192: Updated min/max value to format correctly based on the data type
|
||||
* PR #193: Added support for exclusiveMin and exclusiveMax
|
||||
|
||||
|
||||
@@ -7,16 +7,18 @@ buildscript {
|
||||
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.3'
|
||||
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.10.1'
|
||||
classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1'
|
||||
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2'
|
||||
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
|
||||
classpath "org.jfrog.buildinfo:build-info-extractor-gradle:4.0.0"
|
||||
classpath "org.ajoberstar:gradle-git:1.3.2"
|
||||
}
|
||||
}
|
||||
description = 'swagger2markup Build'
|
||||
version = '1.0.0-SNAPSHOT'
|
||||
version = '1.1.0'
|
||||
ext.releaseVersion = '1.1.0'
|
||||
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'
|
||||
@@ -39,7 +41,7 @@ repositories {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compile 'io.github.swagger2markup:markup-document-builder:1.0.0-SNAPSHOT'
|
||||
compile 'io.github.swagger2markup:markup-document-builder:1.0.0'
|
||||
compile 'io.swagger:swagger-compat-spec-parser:1.0.18'
|
||||
compile 'org.apache.commons:commons-configuration2:2.0'
|
||||
compile 'commons-beanutils:commons-beanutils:1.9.2'
|
||||
@@ -58,7 +60,6 @@ test {
|
||||
systemProperty 'http.nonProxyHosts', System.properties['http.nonProxyHosts']
|
||||
}
|
||||
systemProperty 'file.encoding', 'UTF-8'
|
||||
ignoreFailures = true
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ asciidoctor {
|
||||
sectlinks: '',
|
||||
sectanchors: '',
|
||||
hardbreaks: '',
|
||||
'release-version': project.releaseVersion
|
||||
]
|
||||
}
|
||||
|
||||
@@ -29,6 +30,6 @@ githubPages {
|
||||
|
||||
pages {
|
||||
from file(asciidoctor.outputDir.path + '/html5')
|
||||
into project.version
|
||||
into project.releaseVersion
|
||||
}
|
||||
}
|
||||
@@ -97,8 +97,9 @@ bintray {
|
||||
publish = true //If version should be auto published after an upload
|
||||
publications = ['mavenJava']
|
||||
pkg {
|
||||
repo = 'maven'
|
||||
repo = 'Maven'
|
||||
name = 'swagger2markup'
|
||||
userOrg = 'swagger2markup'
|
||||
websiteUrl = projectUrl
|
||||
issueTrackerUrl = issuesUrl
|
||||
vcsUrl = scmUrl
|
||||
|
||||
@@ -16,7 +16,7 @@ You can show the help:
|
||||
|
||||
[source, subs="attributes"]
|
||||
----
|
||||
java -jar swagger2markup-cli-{project-version}.jar help convert
|
||||
java -jar swagger2markup-cli-{release-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-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -d /tmp/asiidoc
|
||||
java -jar swagger2markup-cli-{release-version}.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-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -f /tmp/asiidoc/swagger
|
||||
java -jar swagger2markup-cli-{release-version}.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-1.0.0-SNAPSHOT.jar convert -i "http://petstore.swagger.io/v2/swagger.json" -d /tmp
|
||||
java -jar swagger2markup-cli-{release-version}.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-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -o /tmp -c /path/to/config.properties
|
||||
java -jar swagger2markup-cli-{release-version}.jar convert -i /path/to/swagger_petstore.yaml -o /tmp -c /path/to/config.properties
|
||||
----
|
||||
|
||||
|
||||
13
src/docs/asciidoc/docker.adoc
Normal file
13
src/docs/asciidoc/docker.adoc
Normal file
@@ -0,0 +1,13 @@
|
||||
== 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`
|
||||
@@ -19,7 +19,7 @@ repositories {
|
||||
jCenter()
|
||||
}
|
||||
|
||||
compile "io.github.swagger2markup:swagger2markup:{project-version}"
|
||||
compile "io.github.swagger2markup:swagger2markup:{release-version}"
|
||||
----
|
||||
|
||||
==== Snapshot
|
||||
@@ -50,7 +50,7 @@ repositories {
|
||||
<dependency>
|
||||
<groupId>io.github.swagger2markup</groupId>
|
||||
<artifactId>swagger2markup</artifactId>
|
||||
<version>{project-version}</version>
|
||||
<version>{release-version}</version>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ buildscript {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
classpath 'io.github.swagger2markup:swagger2markup-gradle-plugin:{project-version}'
|
||||
classpath 'io.github.swagger2markup:swagger2markup-gradle-plugin:{release-version}'
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 126 KiB After Width: | Height: | Size: 130 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 124 KiB After Width: | Height: | Size: 116 KiB |
@@ -5,7 +5,7 @@ Robert Winkler
|
||||
:source-highlighter: coderay
|
||||
:numbered:
|
||||
:hardbreaks:
|
||||
:revnumber: {project-version}
|
||||
:revnumber: {release-version}
|
||||
:revdate: {localdate}
|
||||
:icons: font
|
||||
:pagenums:
|
||||
@@ -26,6 +26,8 @@ include::maven_plugin.adoc[]
|
||||
|
||||
include::command_line_interface.adoc[]
|
||||
|
||||
include::docker.adoc[]
|
||||
|
||||
include::demo.adoc[]
|
||||
|
||||
include::contributing.adoc[]
|
||||
|
||||
@@ -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>{project-version}</version>
|
||||
<version>{release-version}</version>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
@@ -45,17 +45,17 @@ 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]
|
||||
[source,xml, subs="specialcharacters,attributes"]
|
||||
----
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>io.github.swagger2markup</groupId>
|
||||
<artifactId>swagger2markup-maven-plugin</artifactId>
|
||||
<version>{project-version}</version>
|
||||
<version>{release-version}</version>
|
||||
<configuration>
|
||||
<swaggerInput>${project.basedir}/src/docs/swagger/swagger_petstore.yaml</input>
|
||||
<outputDir>${project.build.directory}/asciidoc</output>
|
||||
<swaggerInput>${project.basedir}/src/docs/swagger/swagger_petstore.yaml</swaggerInput>
|
||||
<outputDir>${project.build.directory}/asciidoc</outputDir>
|
||||
<config>
|
||||
<swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
|
||||
</config>
|
||||
|
||||
@@ -141,6 +141,7 @@ 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 |
|
||||
|===
|
||||
|
||||
|
||||
@@ -22,11 +22,13 @@ import java.util.Locale;
|
||||
* @author Maksim Myshkin
|
||||
*/
|
||||
public enum Language {
|
||||
EN(new Locale("en")),
|
||||
EN(Locale.ENGLISH),
|
||||
RU(new Locale("ru")),
|
||||
FR(new Locale("fr")),
|
||||
DE(new Locale("de")),
|
||||
TR(new Locale("tr"));
|
||||
FR(Locale.FRENCH),
|
||||
DE(Locale.GERMAN),
|
||||
TR(new Locale("tr")),
|
||||
ZH(Locale.CHINESE),
|
||||
ES(new Locale("es"));
|
||||
|
||||
private final Locale lang;
|
||||
|
||||
|
||||
@@ -143,6 +143,11 @@ public interface Swagger2MarkupConfig {
|
||||
*/
|
||||
boolean isFlatBodyEnabled();
|
||||
|
||||
/**
|
||||
* Optionally disable the security section for path sections
|
||||
*/
|
||||
boolean isPathSecuritySectionEnabled();
|
||||
|
||||
/**
|
||||
* Optionally prefix all anchors for uniqueness.
|
||||
*/
|
||||
|
||||
@@ -48,6 +48,7 @@ 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";
|
||||
|
||||
@@ -109,6 +109,7 @@ 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);
|
||||
@@ -466,6 +467,16 @@ 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.
|
||||
*
|
||||
@@ -515,6 +526,7 @@ public class Swagger2MarkupConfigBuilder {
|
||||
private boolean interDocumentCrossReferencesEnabled;
|
||||
private String interDocumentCrossReferencesPrefix;
|
||||
private boolean flatBodyEnabled;
|
||||
private boolean pathSecuritySectionEnabled;
|
||||
private String anchorPrefix;
|
||||
private LineSeparator lineSeparator;
|
||||
|
||||
@@ -642,6 +654,11 @@ public class Swagger2MarkupConfigBuilder {
|
||||
return flatBodyEnabled;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isPathSecuritySectionEnabled() {
|
||||
return pathSecuritySectionEnabled;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getAnchorPrefix() {
|
||||
return anchorPrefix;
|
||||
|
||||
@@ -61,7 +61,7 @@ public class DefinitionsDocumentBuilder extends MarkupDocumentBuilder {
|
||||
public DefinitionsDocumentBuilder(Swagger2MarkupConverter.Context context, Swagger2MarkupExtensionRegistry extensionRegistry, Path outputPath) {
|
||||
super(context, extensionRegistry, outputPath);
|
||||
|
||||
ResourceBundle labels = ResourceBundle.getBundle("io/github/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
|
||||
final 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");
|
||||
|
||||
@@ -40,6 +40,7 @@ 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;
|
||||
|
||||
@@ -51,6 +52,18 @@ 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;
|
||||
@@ -85,6 +98,17 @@ 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");
|
||||
@@ -171,10 +195,11 @@ 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<>();
|
||||
List<MarkupTableColumn> cols = Arrays.asList(
|
||||
ArrayList<MarkupTableColumn> cols = new ArrayList<>(Arrays.asList(
|
||||
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
|
||||
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(11).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^11"),
|
||||
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"));
|
||||
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4")));
|
||||
ArrayList<Integer> unusedCols = new ArrayList<>(Arrays.asList(2, 1, 0));
|
||||
if (MapUtils.isNotEmpty(properties)) {
|
||||
Set<String> propertyNames = toKeySet(properties, config.getPropertyOrdering());
|
||||
for (String propertyName : propertyNames) {
|
||||
@@ -187,39 +212,113 @@ public abstract class MarkupDocumentBuilder {
|
||||
|
||||
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 (BooleanUtils.isTrue(property.getRequired()))
|
||||
if (isTrue(property.getRequired()))
|
||||
propertyNameContent.italicText(FLAGS_REQUIRED.toLowerCase());
|
||||
else
|
||||
propertyNameContent.italicText(FLAGS_OPTIONAL.toLowerCase());
|
||||
if (BooleanUtils.isTrue(property.getReadOnly())) {
|
||||
if (isTrue(property.getReadOnly())) {
|
||||
propertyNameContent.newLine(true);
|
||||
propertyNameContent.italicText(FLAGS_READ_ONLY.toLowerCase());
|
||||
}
|
||||
|
||||
MarkupDocBuilder descriptionContent = copyMarkupDocBuilder();
|
||||
String description = defaultString(swaggerMarkupDescription(property.getDescription()));
|
||||
if (isNotBlank(description))
|
||||
if (isNotBlank(description.toString()))
|
||||
descriptionContent.text(description);
|
||||
|
||||
if(defaultValue != null){
|
||||
if (isNotBlank(description))
|
||||
if (isNotBlank(descriptionContent.toString()))
|
||||
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));
|
||||
}
|
||||
|
||||
List<String> content = Arrays.asList(
|
||||
ArrayList<String> content = new ArrayList<>(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);
|
||||
|
||||
@@ -115,7 +115,7 @@ public class OverviewDocumentBuilder extends MarkupDocumentBuilder {
|
||||
}
|
||||
|
||||
private void buildContactInfoSection(Contact contact) {
|
||||
if(contact != null){
|
||||
if(contact != null && (isNotBlank(contact.getName()) || isNotBlank(contact.getEmail()))){
|
||||
this.markupDocBuilder.sectionTitleLevel2(CONTACT_INFORMATION);
|
||||
MarkupDocBuilder paragraph = copyMarkupDocBuilder();
|
||||
if(isNotBlank(contact.getName())){
|
||||
|
||||
@@ -82,7 +82,6 @@ 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);
|
||||
|
||||
@@ -278,7 +277,9 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
|
||||
buildConsumesSection(operation, docBuilder);
|
||||
buildProducesSection(operation, docBuilder);
|
||||
buildTagsSection(operation, docBuilder);
|
||||
if (config.isPathSecuritySectionEnabled()) {
|
||||
buildSecuritySchemeSection(operation, docBuilder);
|
||||
}
|
||||
buildExamplesSection(operation, docBuilder);
|
||||
applyPathsDocumentExtension(new Context(Position.OPERATION_END, docBuilder, operation));
|
||||
applyPathsDocumentExtension(new Context(Position.OPERATION_AFTER, docBuilder, operation));
|
||||
@@ -424,12 +425,13 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
|
||||
applyPathsDocumentExtension(new Context(Position.OPERATION_DESCRIPTION_BEGIN, parametersBuilder, operation));
|
||||
if (hasParameters) {
|
||||
List<List<String>> cells = new ArrayList<>();
|
||||
List<MarkupTableColumn> cols = Arrays.asList(
|
||||
new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(1).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^1"),
|
||||
ArrayList<MarkupTableColumn> cols = new ArrayList<>(Arrays.asList(
|
||||
new MarkupTableColumn(TYPE_COLUMN).withWidthRatio(2).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2"),
|
||||
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
|
||||
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(10).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^10"),
|
||||
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(9).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^9"),
|
||||
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"),
|
||||
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2"));
|
||||
new MarkupTableColumn(DEFAULT_COLUMN).withWidthRatio(2).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^2")));
|
||||
ArrayList<Integer> unusedCols = new ArrayList<>(Arrays.asList(4, 3, 2, 1, 0));
|
||||
for (Parameter parameter : parameters) {
|
||||
if (filterParameter(parameter)) {
|
||||
Type type = ParameterUtils.getType(parameter, globalContext.getSwagger().getDefinitions(), new DefinitionDocumentResolverFromOperation());
|
||||
@@ -447,15 +449,27 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
|
||||
|
||||
Object defaultValue = ParameterUtils.getDefaultValue(parameter);
|
||||
|
||||
List<String> content = Arrays.asList(
|
||||
ArrayList<String> content = new ArrayList<>(Arrays.asList(
|
||||
boldText(parameterType),
|
||||
parameterNameContent.toString(),
|
||||
defaultString(swaggerMarkupDescription(parameter.getDescription())),
|
||||
type.displaySchema(markupDocBuilder),
|
||||
defaultValue != null ? literalText(Json.pretty(defaultValue)) : "");
|
||||
defaultValue != null ? literalText(Json.pretty(defaultValue)) : ""));
|
||||
|
||||
unusedCols.removeIf(index -> !(content.get(index).equals("")));
|
||||
|
||||
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));
|
||||
@@ -594,10 +608,11 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
|
||||
|
||||
Map<String, SecuritySchemeDefinition> securityDefinitions = globalContext.getSwagger().getSecurityDefinitions();
|
||||
List<List<String>> cells = new ArrayList<>();
|
||||
List<MarkupTableColumn> cols = Arrays.asList(
|
||||
ArrayList<MarkupTableColumn> cols = new ArrayList<>(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"));
|
||||
new MarkupTableColumn(SCOPES_COLUMN).withWidthRatio(13).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^13")));
|
||||
ArrayList<Integer> unusedCols = new ArrayList<>(Arrays.asList(2, 1, 0));
|
||||
for (Map<String, List<String>> securityScheme : securitySchemes) {
|
||||
for (Map.Entry<String, List<String>> securityEntry : securityScheme.entrySet()) {
|
||||
String securityKey = securityEntry.getKey();
|
||||
@@ -606,11 +621,21 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
|
||||
type = securityDefinitions.get(securityKey).getType();
|
||||
}
|
||||
|
||||
List<String> content = Arrays.asList(boldText(type), boldText(copyMarkupDocBuilder().crossReference(securityDocumentResolver(), securityKey, securityKey).toString()),
|
||||
Joiner.on(",").join(securityEntry.getValue()));
|
||||
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("")));
|
||||
|
||||
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));
|
||||
@@ -643,11 +668,11 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
|
||||
MarkupDocBuilder responsesBuilder = copyMarkupDocBuilder();
|
||||
applyPathsDocumentExtension(new Context(Position.OPERATION_RESPONSES_BEGIN, responsesBuilder, operation));
|
||||
if (MapUtils.isNotEmpty(responses)) {
|
||||
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"));
|
||||
|
||||
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<List<String>> cells = new ArrayList<>();
|
||||
|
||||
Set<String> responseNames = toKeySet(responses, config.getResponseOrdering());
|
||||
@@ -697,7 +722,23 @@ public class PathsDocumentBuilder extends MarkupDocumentBuilder {
|
||||
}
|
||||
}
|
||||
|
||||
cells.add(Arrays.asList(boldText(responseName), descriptionBuilder.toString(), schemaContent));
|
||||
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);
|
||||
}
|
||||
}
|
||||
|
||||
responsesBuilder.tableWithColumnSpecs(responseCols, cells);
|
||||
|
||||
@@ -87,7 +87,7 @@ public class SecurityDocumentBuilder extends MarkupDocumentBuilder {
|
||||
}
|
||||
|
||||
private void buildSecuritySchemeDefinitionsSection(Map<String, SecuritySchemeDefinition> securitySchemes) {
|
||||
Set<String> securitySchemeNames = toKeySet(securitySchemes, Ordering.natural()); // TODO : provide a dedicated ordering configuration for security schemes
|
||||
Set<String> securitySchemeNames = toKeySet(securitySchemes, null); // 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));
|
||||
|
||||
@@ -27,6 +27,7 @@ import io.swagger.models.properties.RefProperty;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
@@ -35,6 +36,8 @@ 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
|
||||
*
|
||||
@@ -58,7 +61,7 @@ public class ExamplesUtil {
|
||||
|
||||
if (example == null && schema instanceof RefProperty) {
|
||||
String simpleRef = ((RefProperty) schema).getSimpleRef();
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder);
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder, new HashMap< String, Integer >());
|
||||
}
|
||||
if (example == null && generateMissingExamples) {
|
||||
example = PropertyUtils.generateExample(schema, markupDocBuilder);
|
||||
@@ -99,17 +102,17 @@ public class ExamplesUtil {
|
||||
Model schema = ((BodyParameter) parameter).getSchema();
|
||||
if (schema instanceof RefModel) {
|
||||
String simpleRef = ((RefModel) schema).getSimpleRef();
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder);
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder, new HashMap< String, Integer >());
|
||||
} else if (generateMissingExamples) {
|
||||
if (schema instanceof ComposedModel) {
|
||||
example = exampleMapForProperties(getPropertiesForComposedModel(
|
||||
(ComposedModel) schema, definitions), definitions, markupDocBuilder);
|
||||
(ComposedModel) schema, definitions), definitions, markupDocBuilder, new HashMap< String, Integer >());
|
||||
} else if (schema instanceof ArrayModel) {
|
||||
example = generateExampleForArrayModel((ArrayModel) schema, definitions, markupDocBuilder);
|
||||
example = generateExampleForArrayModel((ArrayModel) schema, definitions, markupDocBuilder, new HashMap< String, Integer >());
|
||||
} else {
|
||||
example = schema.getExample();
|
||||
if (example == null) {
|
||||
example = exampleMapForProperties(schema.getProperties(), definitions, markupDocBuilder);
|
||||
example = exampleMapForProperties(schema.getProperties(), definitions, markupDocBuilder, new HashMap< String, Integer >());
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -150,7 +153,7 @@ public class ExamplesUtil {
|
||||
}
|
||||
} else if (parameter instanceof RefParameter) {
|
||||
String simpleRef = ((RefParameter) parameter).getSimpleRef();
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder);
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, markupDocBuilder, new HashMap< String, Integer >());
|
||||
}
|
||||
|
||||
if (example != null)
|
||||
@@ -167,19 +170,30 @@ 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) {
|
||||
public static Object generateExampleForRefModel(boolean generateMissingExamples, String simpleRef, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder, Map< String, Integer > refStack) {
|
||||
Model model = definitions.get(simpleRef);
|
||||
Object example = null;
|
||||
if (model != null) {
|
||||
example = model.getExample();
|
||||
if (example == null && generateMissingExamples) {
|
||||
if (model instanceof ComposedModel) {
|
||||
example = exampleMapForProperties(getPropertiesForComposedModel((ComposedModel) model, definitions), definitions, markupDocBuilder);
|
||||
if (!refStack.containsKey(simpleRef)) {
|
||||
refStack.put(simpleRef, 1);
|
||||
} else {
|
||||
example = exampleMapForProperties(model.getProperties(), definitions, markupDocBuilder);
|
||||
refStack.put(simpleRef, refStack.get(simpleRef) + 1);
|
||||
}
|
||||
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;
|
||||
@@ -217,18 +231,20 @@ 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) {
|
||||
public static Map<String, Object> exampleMapForProperties(Map<String, Property> properties, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder, Map< String, Integer > refStack) {
|
||||
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);
|
||||
exampleObject = generateExampleForRefModel(true, ((RefProperty) property.getValue()).getSimpleRef(), definitions, markupDocBuilder, refStack);
|
||||
} else if (property.getValue() instanceof ArrayProperty) {
|
||||
exampleObject = generateExampleForArrayProperty((ArrayProperty) property.getValue(), definitions, markupDocBuilder);
|
||||
exampleObject = generateExampleForArrayProperty((ArrayProperty) property.getValue(), definitions, markupDocBuilder, refStack);
|
||||
} else if (property.getValue() instanceof MapProperty) {
|
||||
exampleObject = generateExampleForMapProperty((MapProperty) property.getValue(), markupDocBuilder);
|
||||
}
|
||||
@@ -239,6 +255,7 @@ public class ExamplesUtil {
|
||||
}
|
||||
exampleMap.put(property.getKey(), exampleObject);
|
||||
}
|
||||
}
|
||||
return exampleMap;
|
||||
}
|
||||
|
||||
@@ -255,19 +272,19 @@ public class ExamplesUtil {
|
||||
return exampleMap;
|
||||
}
|
||||
|
||||
public static Object generateExampleForArrayModel(ArrayModel model, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder) {
|
||||
public static Object generateExampleForArrayModel(ArrayModel model, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder, Map< String, Integer > refStack) {
|
||||
if (model.getExample() != null) {
|
||||
return model.getExample();
|
||||
} else if (model.getProperties() != null) {
|
||||
return new Object[]{exampleMapForProperties(model.getProperties(), definitions, markupDocBuilder)};
|
||||
return new Object[]{exampleMapForProperties(model.getProperties(), definitions, markupDocBuilder, refStack)};
|
||||
} 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)};
|
||||
return new Object[]{generateExampleForArrayProperty((ArrayProperty) itemProperty, definitions, markupDocBuilder, refStack)};
|
||||
} else if (itemProperty instanceof RefProperty) {
|
||||
return new Object[]{generateExampleForRefModel(true, ((RefProperty) itemProperty).getSimpleRef(), definitions, markupDocBuilder)};
|
||||
return new Object[]{generateExampleForRefModel(true, ((RefProperty) itemProperty).getSimpleRef(), definitions, markupDocBuilder, refStack)};
|
||||
} else {
|
||||
return new Object[]{PropertyUtils.generateExample(itemProperty, markupDocBuilder)};
|
||||
}
|
||||
@@ -282,14 +299,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) {
|
||||
public static Object[] generateExampleForArrayProperty(ArrayProperty value, Map<String, Model> definitions, MarkupDocBuilder markupDocBuilder, Map< String, Integer > refStack) {
|
||||
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)};
|
||||
return new Object[]{generateExampleForArrayProperty((ArrayProperty) property, definitions, markupDocBuilder, refStack)};
|
||||
} else if (property instanceof RefProperty) {
|
||||
return new Object[]{generateExampleForRefModel(true, ((RefProperty) property).getSimpleRef(), definitions, markupDocBuilder)};
|
||||
return new Object[]{generateExampleForRefModel(true, ((RefProperty) property).getSimpleRef(), definitions, markupDocBuilder, refStack)};
|
||||
} else {
|
||||
return new Object[]{PropertyUtils.generateExample(property, markupDocBuilder)};
|
||||
}
|
||||
|
||||
@@ -24,6 +24,7 @@ import io.swagger.models.refs.RefFormat;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.Map;
|
||||
|
||||
public final class ModelUtils {
|
||||
@@ -69,7 +70,7 @@ public final class ModelUtils {
|
||||
return new BasicType(modelImpl.getType(), modelImpl.getTitle());
|
||||
} else if (model instanceof ComposedModel) {
|
||||
ComposedModel composedModel = (ComposedModel) model;
|
||||
Map<String, Property> allProperties = new HashMap<>();
|
||||
Map<String, Property> allProperties = new LinkedHashMap<>();
|
||||
ObjectTypePolymorphism polymorphism = new ObjectTypePolymorphism(ObjectTypePolymorphism.Nature.NONE, null);
|
||||
String name = model.getTitle();
|
||||
|
||||
|
||||
@@ -51,10 +51,16 @@ public final class PropertyUtils {
|
||||
} else if (property instanceof ArrayProperty) {
|
||||
ArrayProperty arrayProperty = (ArrayProperty) property;
|
||||
Property items = arrayProperty.getItems();
|
||||
if (items == null)
|
||||
type = new ArrayType(arrayProperty.getTitle(), new ObjectType(null, null)); // FIXME : Workaround for Swagger parser issue with composed models (https://github.com/Swagger2Markup/swagger2markup/issues/150)
|
||||
else
|
||||
type = new ArrayType(arrayProperty.getTitle(), getType(items, definitionDocumentResolver));
|
||||
} else if (property instanceof MapProperty) {
|
||||
MapProperty mapProperty = (MapProperty) property;
|
||||
Property additionalProperties = mapProperty.getAdditionalProperties();
|
||||
if (additionalProperties == null)
|
||||
type = new MapType(mapProperty.getTitle(), new ObjectType(null, null)); // FIXME : Workaround for Swagger parser issue with composed models (https://github.com/Swagger2Markup/swagger2markup/issues/150)
|
||||
else
|
||||
type = new MapType(mapProperty.getTitle(), getType(additionalProperties, definitionDocumentResolver));
|
||||
} else if (property instanceof StringProperty) {
|
||||
StringProperty stringProperty = (StringProperty) property;
|
||||
@@ -85,6 +91,7 @@ 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();
|
||||
@@ -110,6 +117,142 @@ 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}.
|
||||
*
|
||||
|
||||
@@ -10,6 +10,7 @@ swagger2markup.outputLanguage=EN
|
||||
swagger2markup.inlineSchemaEnabled=true
|
||||
swagger2markup.interDocumentCrossReferencesEnabled=false
|
||||
swagger2markup.flatBodyEnabled=false
|
||||
swagger2markup.pathSecuritySectionEnabled=true
|
||||
swagger2markup.overviewDocument=overview
|
||||
swagger2markup.pathsDocument=paths
|
||||
swagger2markup.definitionsDocument=definitions
|
||||
|
||||
@@ -1,12 +1,24 @@
|
||||
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=Required
|
||||
flags.optional=Optional
|
||||
flags.read_only=Read-only
|
||||
flags.read_write=Read-write
|
||||
schema_column=Schema
|
||||
flags.required=verpflichtend
|
||||
flags.optional=optional
|
||||
flags.read_only=Nur lesen
|
||||
flags.read_write=Lesen+Schreiben
|
||||
schema_column=Typ
|
||||
name_column=Name
|
||||
description_column=Beschreibung
|
||||
headers_column=Headers
|
||||
@@ -14,7 +26,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
|
||||
@@ -28,7 +40,7 @@ uri_scheme=URI Schema
|
||||
host=Host
|
||||
base_path=Basis-Pfad
|
||||
schemes=Schemata
|
||||
security_name=
|
||||
security_name=Name
|
||||
security_type=Typ
|
||||
security_in=In
|
||||
security_flow=Flow
|
||||
|
||||
@@ -1,6 +1,17 @@
|
||||
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
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
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
|
||||
@@ -1,6 +1,17 @@
|
||||
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
|
||||
@@ -51,7 +62,7 @@ type_column=Type
|
||||
http_code_column=Code HTTP
|
||||
parameter=Param\u00E8tre
|
||||
|
||||
unknown=Unknown
|
||||
unknown=Inconnu
|
||||
no_content=Pas de contenu
|
||||
operation.deprecated=Cette op\u00E9ration est obsol\u00E8te.
|
||||
polymorphism.column=Polymorphisme
|
||||
|
||||
@@ -1,6 +1,17 @@
|
||||
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
|
||||
@@ -38,7 +49,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=\u041E\u0442\u0432\u0435\u0442\u044B
|
||||
resources=\u0420\u0435\u0441\u0443\u0440\u0441\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
|
||||
|
||||
@@ -1,6 +1,17 @@
|
||||
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
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
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=成分
|
||||
@@ -80,6 +80,25 @@ public class AsciidocConverterTest {
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversion.html");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSwagger2AsciiDocConversionInstagram() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_instagram.yaml").toURI());
|
||||
Path outputDirectory = Paths.get("build/test/asciidoc/instagram");
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
//When
|
||||
Swagger2MarkupConverter.from(file).build()
|
||||
.toFolder(outputDirectory);
|
||||
|
||||
//Then
|
||||
String[] files = outputDirectory.toFile().list();
|
||||
assertThat(files).hasSize(4).containsAll(expectedFiles);
|
||||
|
||||
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/instagram").toURI());
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionInstagram.html");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSwagger2AsciiDocConversionWithInterDocumentCrossReferences() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
@@ -171,6 +190,25 @@ public class AsciidocConverterTest {
|
||||
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");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSwagger2AsciiDocWithInlineSchema() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
@@ -351,27 +389,25 @@ public class AsciidocConverterTest {
|
||||
|
||||
@Test
|
||||
public void testSwagger2AsciiDocConversionWithRussianOutputLanguage() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
|
||||
Path outputDirectory = Paths.get("build/test/asciidoc/generated");
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
//When
|
||||
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
|
||||
.withOutputLanguage(Language.RU)
|
||||
.build();
|
||||
Swagger2MarkupConverter.from(file)
|
||||
.withConfig(config)
|
||||
.build()
|
||||
.toFolder(outputDirectory);
|
||||
|
||||
//Then
|
||||
assertThat(new String(Files.readAllBytes(outputDirectory.resolve("definitions.adoc")), Charset.forName("UTF-8")))
|
||||
.contains("== Определения");
|
||||
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");
|
||||
@@ -379,7 +415,7 @@ public class AsciidocConverterTest {
|
||||
|
||||
//When
|
||||
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
|
||||
.withOutputLanguage(Language.FR)
|
||||
.withOutputLanguage(language)
|
||||
.build();
|
||||
Swagger2MarkupConverter.from(file)
|
||||
.withConfig(config)
|
||||
@@ -387,8 +423,8 @@ public class AsciidocConverterTest {
|
||||
.toFolder(outputDirectory);
|
||||
|
||||
//Then
|
||||
assertThat(new String(Files.readAllBytes(outputDirectory.resolve("overview.adoc")), Charset.forName("UTF-8")))
|
||||
.contains("== Sch\u00E9ma d'URI");
|
||||
assertThat(new String(Files.readAllBytes(outputDirectory.resolve(outputFilename)), Charset.forName("UTF-8")))
|
||||
.contains(expected);
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -437,6 +473,30 @@ public class AsciidocConverterTest {
|
||||
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 {
|
||||
//Given
|
||||
@@ -460,6 +520,30 @@ public class AsciidocConverterTest {
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithPolymorphism.html");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSwagger2AsciiDocConversionWithPolymorphismAsIsOrdering() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
Path file = Paths.get(AsciidocConverterTest.class.getResource("/json/swagger_polymorphism.json").toURI());
|
||||
Path outputDirectory = Paths.get("build/test/asciidoc/polymorphismAsIsOrdering");
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
//When
|
||||
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
|
||||
.withPropertyOrdering(OrderBy.AS_IS)
|
||||
.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/polymorphismAsIsOrdering").toURI());
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testSwagger2AsciiDocConversionWithPolymorphismAsIsOrdering.html");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSwagger2AsciiDocConversionWithResponseHeaders() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
@@ -482,4 +566,27 @@ 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");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -67,6 +67,7 @@ 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();
|
||||
@@ -111,6 +112,7 @@ 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();
|
||||
|
||||
@@ -8,6 +8,7 @@ swagger2markup.inlineSchemaEnabled=false
|
||||
swagger2markup.interDocumentCrossReferencesEnabled=true
|
||||
swagger2markup.interDocumentCrossReferencesPrefix=xrefPrefix
|
||||
swagger2markup.flatBodyEnabled=true
|
||||
swagger2markup.pathSecuritySectionEnabled=false
|
||||
swagger2markup.anchorPrefix=anchorPrefix
|
||||
swagger2markup.overviewDocument=overviewTest
|
||||
swagger2markup.pathsDocument=pathsTest
|
||||
|
||||
@@ -13,6 +13,8 @@ _optional_||integer(int64)
|
||||
|*name* +
|
||||
_optional_|The name of the category +
|
||||
*Default* : `"DefaultCategory"` +
|
||||
*Length* : `0 - 255` +
|
||||
*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` +
|
||||
*Example* : `"FoobarCategory"`|string
|
||||
|===
|
||||
|
||||
@@ -31,6 +33,8 @@ _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)
|
||||
@@ -63,13 +67,13 @@ _optional_||< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -11,17 +11,17 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -63,17 +63,17 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Query*|*tags* +
|
||||
_optional_|Tags to filter by|< string > array(multi)|
|
||||
_optional_|Tags to filter by|< string > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -227,21 +227,21 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -286,17 +286,17 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -339,19 +339,19 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid pet value|No Content
|
||||
@@ -387,17 +387,17 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -433,17 +433,17 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -480,17 +480,17 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|Created user object|<<_user,User>>|
|
||||
_optional_|Created user object|<<_user,User>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -559,17 +559,17 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -596,17 +596,17 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -633,19 +633,19 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -677,7 +677,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -704,17 +704,17 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Path*|*username* +
|
||||
_required_|The name that needs to be deleted|string|
|
||||
_required_|The name that needs to be deleted|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
= Empty Contact
|
||||
|
||||
|
||||
[[_overview]]
|
||||
== Overview
|
||||
|
||||
=== Version information
|
||||
[%hardbreaks]
|
||||
_Version_ : 1.0
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
|
||||
|
||||
@@ -15,13 +15,13 @@ Return state
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|OK|enum (ADDED, REMOVED, CHANGED)
|
||||
|
||||
@@ -18,22 +18,22 @@ _optional_|*Example* : `"Canines"`|string
|
||||
[[_complexobject]]
|
||||
=== ComplexObject
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*subObject* +
|
||||
_optional_||object
|
||||
_optional_|object
|
||||
|===
|
||||
|
||||
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|===
|
||||
|
||||
|
||||
@@ -89,13 +89,13 @@ _optional_|the weight of the pet|number
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -11,17 +11,17 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -80,17 +80,17 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid ID supplied|No Content
|
||||
@@ -138,17 +138,17 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -189,17 +189,17 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Query*|*tags* +
|
||||
_optional_|Tags to filter by|< string > array(multi)|
|
||||
_optional_|Tags to filter by|< string > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -236,21 +236,21 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -295,17 +295,17 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Path*|*petId* +
|
||||
_required_|ID of the pet|integer(int64)|
|
||||
_required_|ID of the pet|integer(int64)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|<<_pet,Pet>>
|
||||
@@ -344,19 +344,19 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid pet value|No Content
|
||||
@@ -392,17 +392,17 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|<<_order,Order>>
|
||||
@@ -466,17 +466,17 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|<<_order,Order>>
|
||||
@@ -525,17 +525,17 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid ID supplied|No Content
|
||||
@@ -567,17 +567,17 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|Created user object|<<_user,User>>|
|
||||
_optional_|Created user object|<<_user,User>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -604,17 +604,17 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -641,17 +641,17 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -678,7 +678,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|*Query*|*password* +
|
||||
@@ -690,7 +690,7 @@ _optional_|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|string
|
||||
@@ -718,7 +718,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -745,7 +745,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|*Path*|*username* +
|
||||
@@ -755,7 +755,7 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|`"te
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|<<_user,User>>
|
||||
@@ -788,19 +788,19 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid user supplied|No Content
|
||||
@@ -832,17 +832,17 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Path*|*username* +
|
||||
_required_|The name that needs to be deleted|string|
|
||||
_required_|The name that needs to be deleted|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@ _optional_||integer(int64)
|
||||
|*name* +
|
||||
_optional_|The name of the category +
|
||||
*Default* : `"DefaultCategory"` +
|
||||
*Length* : `0 - 255` +
|
||||
*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` +
|
||||
*Example* : `"FoobarCategory"`|string
|
||||
|===
|
||||
|
||||
|
||||
@@ -13,6 +13,8 @@ _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)
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -11,17 +11,17 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -63,17 +63,17 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Query*|*tags* +
|
||||
_optional_|Tags to filter by|< string > array(multi)|
|
||||
_optional_|Tags to filter by|< string > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -227,21 +227,21 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -286,17 +286,17 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -339,19 +339,19 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid pet value|No Content
|
||||
@@ -387,17 +387,17 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -433,17 +433,17 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -480,17 +480,17 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|Created user object|<<_user,User>>|
|
||||
_optional_|Created user object|<<_user,User>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -559,17 +559,17 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -596,17 +596,17 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -633,19 +633,19 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -677,7 +677,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -704,17 +704,17 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Path*|*username* +
|
||||
_required_|The name that needs to be deleted|string|
|
||||
_required_|The name that needs to be deleted|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -11,17 +11,17 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -113,17 +113,17 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid ID supplied|No Content
|
||||
@@ -204,17 +204,17 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -282,17 +282,17 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Query*|*tags* +
|
||||
_optional_|Tags to filter by|< string > array(multi)|
|
||||
_optional_|Tags to filter by|< string > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -356,21 +356,21 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -431,17 +431,17 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Path*|*petId* +
|
||||
_required_|ID of the pet|integer(int64)|
|
||||
_required_|ID of the pet|integer(int64)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|<<_pet,Pet>>
|
||||
@@ -515,19 +515,19 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid pet value|No Content
|
||||
@@ -579,17 +579,17 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|<<_order,Order>>
|
||||
@@ -660,17 +660,17 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|<<_order,Order>>
|
||||
@@ -728,17 +728,17 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid ID supplied|No Content
|
||||
@@ -779,17 +779,17 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|Created user object|<<_user,User>>|
|
||||
_optional_|Created user object|<<_user,User>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -842,17 +842,17 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -905,17 +905,17 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -968,7 +968,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|*Query*|*password* +
|
||||
@@ -980,7 +980,7 @@ _optional_|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|string
|
||||
@@ -1036,7 +1036,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -1072,7 +1072,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|*Path*|*username* +
|
||||
@@ -1082,7 +1082,7 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string|`"te
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation|<<_user,User>>
|
||||
@@ -1143,19 +1143,19 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid user supplied|No Content
|
||||
@@ -1213,17 +1213,17 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Path*|*username* +
|
||||
_required_|The name that needs to be deleted|string|
|
||||
_required_|The name that needs to be deleted|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
|
||||
[[_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)
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
= API
|
||||
|
||||
|
||||
[[_overview]]
|
||||
== Overview
|
||||
|
||||
=== Version information
|
||||
[%hardbreaks]
|
||||
_Version_ : 2.0.0
|
||||
|
||||
|
||||
=== URI scheme
|
||||
[%hardbreaks]
|
||||
_BasePath_ : /navigation
|
||||
_Schemes_ : HTTPS
|
||||
|
||||
|
||||
=== Consumes
|
||||
|
||||
* `application/json`
|
||||
|
||||
|
||||
=== Produces
|
||||
|
||||
* `application/json`
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,126 @@
|
||||
|
||||
[[_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" : [ "..." ]
|
||||
} ]
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
|
||||
|
||||
@@ -13,6 +13,8 @@ _optional_||integer(int64)
|
||||
|*name* +
|
||||
_optional_|The name of the category +
|
||||
*Default* : `"DefaultCategory"` +
|
||||
*Length* : `0 - 255` +
|
||||
*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` +
|
||||
*Example* : `"FoobarCategory"`|string
|
||||
|===
|
||||
|
||||
@@ -31,6 +33,8 @@ _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)
|
||||
@@ -63,13 +67,13 @@ _optional_||< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -16,17 +16,17 @@ POST /pets
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -63,17 +63,17 @@ PUT /pets
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Query*|*tags* +
|
||||
_optional_|Tags to filter by|< string > array(multi)|
|
||||
_optional_|Tags to filter by|< string > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -212,21 +212,21 @@ POST /pets/{petId}
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -266,17 +266,17 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -314,19 +314,19 @@ DELETE /pets/{petId}
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid pet value|No Content
|
||||
@@ -362,17 +362,17 @@ POST /stores/order
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>
|
||||
|===
|
||||
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -403,17 +403,17 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -445,17 +445,17 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|Created user object|<<_user,User>>|
|
||||
_optional_|Created user object|<<_user,User>>
|
||||
|===
|
||||
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -519,17 +519,17 @@ POST /users/createWithArray
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -551,17 +551,17 @@ POST /users/createWithList
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -583,19 +583,19 @@ GET /users/login
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -622,7 +622,7 @@ GET /users/logout
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -644,17 +644,17 @@ GET /users/{username}
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Path*|*username* +
|
||||
_required_|The name that needs to be deleted|string|
|
||||
_required_|The name that needs to be deleted|string
|
||||
|===
|
||||
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -13,6 +13,8 @@ _optional_||integer(int64)
|
||||
|*name* +
|
||||
_optional_|The name of the category +
|
||||
*Default* : `"DefaultCategory"` +
|
||||
*Length* : `0 - 255` +
|
||||
*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` +
|
||||
*Example* : `"FoobarCategory"`|string
|
||||
|===
|
||||
|
||||
@@ -31,6 +33,8 @@ _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)
|
||||
@@ -63,13 +67,13 @@ _optional_||< <<definitions.adoc#_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -11,17 +11,17 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -63,17 +63,17 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Query*|*tags* +
|
||||
_optional_|Tags to filter by|< string > array(multi)|
|
||||
_optional_|Tags to filter by|< string > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -227,21 +227,21 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -286,17 +286,17 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -339,19 +339,19 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid pet value|No Content
|
||||
@@ -387,17 +387,17 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -433,17 +433,17 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -480,17 +480,17 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|Created user object|<<definitions.adoc#_user,User>>|
|
||||
_optional_|Created user object|<<definitions.adoc#_user,User>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -559,17 +559,17 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -596,17 +596,17 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -633,19 +633,19 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -677,7 +677,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -704,17 +704,17 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Path*|*username* +
|
||||
_required_|The name that needs to be deleted|string|
|
||||
_required_|The name that needs to be deleted|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -29,11 +29,11 @@ _optional_|Place|string
|
||||
[[_inlinedepthschema]]
|
||||
=== InlineDepthSchema
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
[[_inlinepet_tags]]
|
||||
*tags*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
[[_inlinetitlepet]]
|
||||
=== InlineTitlePet
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
[[_tagmodel]]
|
||||
*TagModel*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_mixedschema_mytable,myTable>> > array
|
||||
_optional_|< <<_mixedschema_mytable,myTable>> > array
|
||||
|===
|
||||
|
||||
[[_mixedschema_mytable]]
|
||||
*myTable*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myDict* +
|
||||
_optional_||< string, <<_mixedschema_mydict,myDict>> > map
|
||||
_optional_|< string, <<_mixedschema_mydict,myDict>> > map
|
||||
|===
|
||||
|
||||
[[_mixedschema_mydict]]
|
||||
*myDict*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_tablecontent,TableContent>> > array
|
||||
_optional_|< <<_tablecontent,TableContent>> > array
|
||||
|===
|
||||
|
||||
[[_tablecontent]]
|
||||
*TableContent*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*emptyObject* +
|
||||
_optional_||object
|
||||
_optional_|object
|
||||
|*myDict* +
|
||||
_optional_||< string, <<_kvpair,KVPair>> > map
|
||||
_optional_|< string, <<_kvpair,KVPair>> > map
|
||||
|===
|
||||
|
||||
[[_kvpair]]
|
||||
*KVPair*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -15,11 +15,11 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|Result +
|
||||
@@ -182,49 +182,49 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
_optional_|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
|===
|
||||
|
||||
[[_mixedparameters_post_mytable]]
|
||||
*myTable*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
_optional_|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
|===
|
||||
|
||||
[[_mixedparameters_post_mytable]]
|
||||
*myTable*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
@@ -281,49 +281,49 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*Version* +
|
||||
_optional_|The API version|<<_request,Request>>|
|
||||
_optional_|The API version|<<_request,Request>>
|
||||
|===
|
||||
|
||||
[[_request]]
|
||||
*Request*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_tablecontent,TableContent>> > array
|
||||
_optional_|< <<_tablecontent,TableContent>> > array
|
||||
|===
|
||||
|
||||
[[_tablecontent]]
|
||||
*TableContent*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myDict* +
|
||||
_optional_||< string, <<_kvpair,KVPair>> > map
|
||||
_optional_|< string, <<_kvpair,KVPair>> > map
|
||||
|===
|
||||
|
||||
[[_kvpair]]
|
||||
*KVPair*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|Result|<<_result,Result>>
|
||||
@@ -332,33 +332,33 @@ _optional_||string
|
||||
[[_result]]
|
||||
*Result*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_tablecontent,TableContent>> > array
|
||||
_optional_|< <<_tablecontent,TableContent>> > array
|
||||
|===
|
||||
|
||||
[[_tablecontent]]
|
||||
*TableContent*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myDict* +
|
||||
_optional_||< string, <<_kvpair,KVPair>> > map
|
||||
_optional_|< string, <<_kvpair,KVPair>> > map
|
||||
|===
|
||||
|
||||
[[_kvpair]]
|
||||
*KVPair*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -29,11 +29,11 @@ _optional_|Place|string
|
||||
[[_inlinedepthschema]]
|
||||
=== InlineDepthSchema
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
[[_inlinepet_tags]]
|
||||
*tags*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
[[_inlinetitlepet]]
|
||||
=== InlineTitlePet
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
[[_tagmodel]]
|
||||
*TagModel*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_mixedschema_mytable,myTable>> > array
|
||||
_optional_|< <<_mixedschema_mytable,myTable>> > array
|
||||
|===
|
||||
|
||||
[[_mixedschema_mytable]]
|
||||
*myTable*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myDict* +
|
||||
_optional_||< string, <<_mixedschema_mydict,myDict>> > map
|
||||
_optional_|< string, <<_mixedschema_mydict,myDict>> > map
|
||||
|===
|
||||
|
||||
[[_mixedschema_mydict]]
|
||||
*myDict*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_tablecontent,TableContent>> > array
|
||||
_optional_|< <<_tablecontent,TableContent>> > array
|
||||
|===
|
||||
|
||||
[[_tablecontent]]
|
||||
*TableContent*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*emptyObject* +
|
||||
_optional_||object
|
||||
_optional_|object
|
||||
|*myDict* +
|
||||
_optional_||< string, <<_kvpair,KVPair>> > map
|
||||
_optional_|< string, <<_kvpair,KVPair>> > map
|
||||
|===
|
||||
|
||||
[[_kvpair]]
|
||||
*KVPair*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ _optional_|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|Result +
|
||||
@@ -191,39 +191,39 @@ _Name_ : Version
|
||||
_Flags_ : optional
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
_optional_|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
|===
|
||||
|
||||
[[_mixedparameters_post_mytable]]
|
||||
*myTable*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myDict* +
|
||||
_optional_||< string, <<_mixedparameters_post_mydict,myDict>> > map
|
||||
_optional_|< string, <<_mixedparameters_post_mydict,myDict>> > map
|
||||
|===
|
||||
|
||||
[[_mixedparameters_post_mydict]]
|
||||
*myDict*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
_optional_|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
|===
|
||||
|
||||
[[_mixedparameters_post_mytable]]
|
||||
*myTable*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
@@ -286,39 +286,39 @@ _Name_ : Version
|
||||
_Flags_ : optional
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_tablecontent,TableContent>> > array
|
||||
_optional_|< <<_tablecontent,TableContent>> > array
|
||||
|===
|
||||
|
||||
[[_tablecontent]]
|
||||
*TableContent*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myDict* +
|
||||
_optional_||< string, <<_kvpair,KVPair>> > map
|
||||
_optional_|< string, <<_kvpair,KVPair>> > map
|
||||
|===
|
||||
|
||||
[[_kvpair]]
|
||||
*KVPair*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|Result|<<_result,Result>>
|
||||
@@ -327,33 +327,33 @@ _optional_||string
|
||||
[[_result]]
|
||||
*Result*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myTable* +
|
||||
_optional_||< <<_tablecontent,TableContent>> > array
|
||||
_optional_|< <<_tablecontent,TableContent>> > array
|
||||
|===
|
||||
|
||||
[[_tablecontent]]
|
||||
*TableContent*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*myDict* +
|
||||
_optional_||< string, <<_kvpair,KVPair>> > map
|
||||
_optional_|< string, <<_kvpair,KVPair>> > map
|
||||
|===
|
||||
|
||||
[[_kvpair]]
|
||||
*KVPair*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*k* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*v* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
225
src/test/resources/expected/asciidoc/instagram/definitions.adoc
Normal file
225
src/test/resources/expected/asciidoc/instagram/definitions.adoc
Normal file
@@ -0,0 +1,225 @@
|
||||
|
||||
[[_definitions]]
|
||||
== Definitions
|
||||
|
||||
[[_comment]]
|
||||
=== Comment
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*created_time* +
|
||||
_optional_|string
|
||||
|*from* +
|
||||
_optional_|<<_miniprofile,MiniProfile>>
|
||||
|*id* +
|
||||
_optional_|string
|
||||
|*text* +
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
[[_image]]
|
||||
=== Image
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*height* +
|
||||
_optional_|integer
|
||||
|*url* +
|
||||
_optional_|string
|
||||
|*width* +
|
||||
_optional_|integer
|
||||
|===
|
||||
|
||||
|
||||
[[_like]]
|
||||
=== Like
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*first_name* +
|
||||
_optional_|string
|
||||
|*id* +
|
||||
_optional_|string
|
||||
|*last_name* +
|
||||
_optional_|string
|
||||
|*type* +
|
||||
_optional_|string
|
||||
|*user_name* +
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
[[_location]]
|
||||
=== Location
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_|string
|
||||
|*latitude* +
|
||||
_optional_|number
|
||||
|*longitude* +
|
||||
_optional_|number
|
||||
|*name* +
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
[[_media]]
|
||||
=== Media
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*comments:* +
|
||||
_optional_||<<_media_comments,comments:>>
|
||||
|*created_time* +
|
||||
_optional_|Epoc time (ms)|integer
|
||||
|*filter* +
|
||||
_optional_||string
|
||||
|*id* +
|
||||
_optional_||integer
|
||||
|*images* +
|
||||
_optional_||<<_media_images,images>>
|
||||
|*likes* +
|
||||
_optional_||<<_media_likes,likes>>
|
||||
|*location* +
|
||||
_optional_||<<_location,Location>>
|
||||
|*tags* +
|
||||
_optional_||< <<_tag,Tag>> > array
|
||||
|*type* +
|
||||
_optional_||string
|
||||
|*user* +
|
||||
_optional_||<<_miniprofile,MiniProfile>>
|
||||
|*users_in_photo* +
|
||||
_optional_||< <<_miniprofile,MiniProfile>> > array
|
||||
|*videos* +
|
||||
_optional_||<<_media_videos,videos>>
|
||||
|===
|
||||
|
||||
[[_media_comments]]
|
||||
*comments:*
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*count* +
|
||||
_optional_|integer
|
||||
|*data* +
|
||||
_optional_|< <<_comment,Comment>> > array
|
||||
|===
|
||||
|
||||
[[_media_images]]
|
||||
*images*
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*low_resolution* +
|
||||
_optional_|<<_image,Image>>
|
||||
|*standard_resolution* +
|
||||
_optional_|<<_image,Image>>
|
||||
|*thumbnail* +
|
||||
_optional_|<<_image,Image>>
|
||||
|===
|
||||
|
||||
[[_media_likes]]
|
||||
*likes*
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*count* +
|
||||
_optional_|integer
|
||||
|*data* +
|
||||
_optional_|< <<_miniprofile,MiniProfile>> > array
|
||||
|===
|
||||
|
||||
[[_media_videos]]
|
||||
*videos*
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*low_resolution* +
|
||||
_optional_|<<_image,Image>>
|
||||
|*standard_resolution* +
|
||||
_optional_|<<_image,Image>>
|
||||
|===
|
||||
|
||||
|
||||
[[_miniprofile]]
|
||||
=== MiniProfile
|
||||
A shorter version of User for likes array
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*full_name* +
|
||||
_optional_|string
|
||||
|*id* +
|
||||
_optional_|integer
|
||||
|*profile_picture* +
|
||||
_optional_|string
|
||||
|*user_name* +
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*media_count* +
|
||||
_optional_|integer
|
||||
|*name* +
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*bio* +
|
||||
_optional_|string
|
||||
|*counts* +
|
||||
_optional_|<<_user_counts,counts>>
|
||||
|*full_name* +
|
||||
_optional_|string
|
||||
|*id* +
|
||||
_optional_|integer
|
||||
|*profile_picture* +
|
||||
_optional_|string
|
||||
|*username* +
|
||||
_optional_|string
|
||||
|*website* +
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
[[_user_counts]]
|
||||
*counts*
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*follows* +
|
||||
_optional_|integer
|
||||
|*follwed_by* +
|
||||
_optional_|integer
|
||||
|*media* +
|
||||
_optional_|integer
|
||||
|===
|
||||
|
||||
|
||||
|
||||
186
src/test/resources/expected/asciidoc/instagram/overview.adoc
Normal file
186
src/test/resources/expected/asciidoc/instagram/overview.adoc
Normal file
@@ -0,0 +1,186 @@
|
||||
= Instagram API
|
||||
|
||||
|
||||
[[_overview]]
|
||||
== Overview
|
||||
The first version of the Instagram API is an exciting step forward towards
|
||||
making it easier for users to have open access to their data. We created it
|
||||
so that you can surface the amazing content Instagram users share every
|
||||
second, in fun and innovative ways.
|
||||
|
||||
Build something great!
|
||||
|
||||
Once you've
|
||||
http://instagram.com/developer/register/[registered your client] it's easy
|
||||
to start requesting data from Instagram.
|
||||
|
||||
All endpoints are only accessible via https and are located at
|
||||
`api.instagram.com`. For instance: you can grab the most popular photos at
|
||||
the moment by accessing the following URL with your client ID
|
||||
(replace CLIENT-ID with your own):
|
||||
|
||||
----
|
||||
https://api.instagram.com/v1/media/popular?client_id=CLIENT-ID
|
||||
----
|
||||
|
||||
You're best off using an access_token for the authenticated user for each
|
||||
endpoint, though many endpoints don't require it.
|
||||
In some cases an access_token will give you more access to information, and
|
||||
in all cases, it means that you are operating under a per-access_token limit
|
||||
vs. the same limit for your single client_id.
|
||||
|
||||
== Limits
|
||||
|
||||
Be nice. If you're sending too many requests too quickly, we'll send back a
|
||||
`503` error code (server unavailable).
|
||||
You are limited to 5000 requests per hour per `access_token` or `client_id`
|
||||
overall. Practically, this means you should (when possible) authenticate
|
||||
users so that limits are well outside the reach of a given user.
|
||||
|
||||
== Deleting Objects
|
||||
|
||||
We do our best to have all our URLs be
|
||||
http://en.wikipedia.org/wiki/Representational_state_transfer[RESTful].
|
||||
Every endpoint (URL) may support one of four different http verbs. GET
|
||||
requests fetch information about an object, POST requests create objects,
|
||||
PUT requests update objects, and finally DELETE requests will delete
|
||||
objects.
|
||||
|
||||
Since many old browsers don't support PUT or DELETE, we've made it easy to
|
||||
fake PUTs and DELETEs. All you have to do is do a POST with _method=PUT or
|
||||
_method=DELETE as a parameter and we will treat it as if you used PUT or
|
||||
DELETE respectively.
|
||||
|
||||
== Structure
|
||||
|
||||
=== The Envelope
|
||||
|
||||
Every response is contained by an envelope. That is, each response has a
|
||||
predictable set of keys with which you can expect to interact:
|
||||
`json
|
||||
{
|
||||
"meta": {
|
||||
"code": 200
|
||||
},
|
||||
"data": {
|
||||
...
|
||||
},
|
||||
"pagination": {
|
||||
"next_url": "...",
|
||||
"next_max_id": "13872296"
|
||||
}
|
||||
}
|
||||
`
|
||||
|
||||
==== META
|
||||
|
||||
The meta key is used to communicate extra information about the response to
|
||||
the developer. If all goes well, you'll only ever see a code key with value
|
||||
200. However, sometimes things go wrong, and in that case you might see a
|
||||
response like:
|
||||
`json
|
||||
{
|
||||
"meta": {
|
||||
"error_type": "OAuthException",
|
||||
"code": 400,
|
||||
"error_message": "..."
|
||||
}
|
||||
}
|
||||
`
|
||||
|
||||
==== DATA
|
||||
|
||||
The data key is the meat of the response. It may be a list or dictionary,
|
||||
but either way this is where you'll find the data you requested.
|
||||
|
||||
==== PAGINATION
|
||||
|
||||
Sometimes you just can't get enough. For this reason, we've provided a
|
||||
convenient way to access more data in any request for sequential data.
|
||||
Simply call the url in the next_url parameter and we'll respond with the
|
||||
next set of data.
|
||||
`json
|
||||
{
|
||||
...
|
||||
"pagination": {
|
||||
"next_url": "https://api.instagram.com/v1/tags/puppy/media/recent?access_token=fb2e77d.47a0479900504cb3ab4a1f626d174d2d&max_id=13872296",
|
||||
"next_max_id": "13872296"
|
||||
}
|
||||
}
|
||||
`
|
||||
On views where pagination is present, we also support the "count" parameter.
|
||||
Simply set this to the number of items you'd like to receive. Note that the
|
||||
default values should be fine for most applications - but if you decide to
|
||||
increase this number there is a maximum value defined on each endpoint.
|
||||
|
||||
=== JSONP
|
||||
|
||||
If you're writing an AJAX application, and you'd like to wrap our response
|
||||
with a callback, all you have to do is specify a callback parameter with
|
||||
any API call:
|
||||
`
|
||||
https://api.instagram.com/v1/tags/coffee/media/recent?access_token=fb2e77d.47a0479900504cb3ab4a1f626d174d2d&callback=callbackFunction
|
||||
`
|
||||
Would respond with:
|
||||
`js
|
||||
callbackFunction({
|
||||
...
|
||||
});
|
||||
`
|
||||
|
||||
|
||||
=== Version information
|
||||
[%hardbreaks]
|
||||
_Version_ : v1
|
||||
|
||||
|
||||
=== License information
|
||||
[%hardbreaks]
|
||||
_Terms of service_ : http://instagram.com/about/legal/terms/api
|
||||
|
||||
|
||||
=== URI scheme
|
||||
[%hardbreaks]
|
||||
_Host_ : api.instagram.com
|
||||
_BasePath_ : /v1
|
||||
_Schemes_ : HTTPS
|
||||
|
||||
|
||||
=== Tags
|
||||
|
||||
* Users
|
||||
* Relationships : Relationships are expressed using the following terms:
|
||||
|
||||
**outgoing_status**: Your relationship to the user. Can be "follows",
|
||||
"requested", "none".
|
||||
**incoming_status**: A user's relationship to you. Can be "followed_by",
|
||||
"requested_by", "blocked_by_you", "none".
|
||||
|
||||
* Media : At this time, uploading via the API is not possible. We made a conscious
|
||||
choice not to add this for the following reasons:
|
||||
|
||||
* Instagram is about your life on the go – we hope to encourage photos
|
||||
from within the app.
|
||||
* We want to fight spam & low quality photos. Once we allow uploading
|
||||
from other sources, it's harder to control what comes into the Instagram
|
||||
ecosystem. All this being said, we're working on ways to ensure users
|
||||
have a consistent and high-quality experience on our platform.
|
||||
|
||||
* Commnts
|
||||
* Likes
|
||||
* Tags
|
||||
* Location
|
||||
* Subscribtions
|
||||
|
||||
|
||||
=== Consumes
|
||||
|
||||
* `application/json`
|
||||
|
||||
|
||||
=== Produces
|
||||
|
||||
* `application/json`
|
||||
|
||||
|
||||
|
||||
1228
src/test/resources/expected/asciidoc/instagram/paths.adoc
Normal file
1228
src/test/resources/expected/asciidoc/instagram/paths.adoc
Normal file
File diff suppressed because it is too large
Load Diff
32
src/test/resources/expected/asciidoc/instagram/security.adoc
Normal file
32
src/test/resources/expected/asciidoc/instagram/security.adoc
Normal file
@@ -0,0 +1,32 @@
|
||||
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_oauth]]
|
||||
=== oauth
|
||||
[%hardbreaks]
|
||||
_Type_ : oauth2
|
||||
_Flow_ : implicit
|
||||
_Token URL_ : https://instagram.com/oauth/authorize/?client_id=CLIENT-ID&redirect_uri=REDIRECT-URI&response_type=token
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|basic|to read any and all data related to a user (e.g. following/followed-by
|
||||
lists, photos, etc.) (granted by default)
|
||||
|comments|to create or delete comments on a user’s behalf
|
||||
|relationships|to follow and unfollow users on a user’s behalf
|
||||
|likes|to like and unlike items on a user’s behalf
|
||||
|===
|
||||
|
||||
|
||||
[[_key]]
|
||||
=== key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : access_token
|
||||
_In_ : QUERY
|
||||
|
||||
|
||||
|
||||
@@ -15,17 +15,17 @@ Returns integer metrics information for the application.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|String metrics|< string, integer(int32) > map|
|
||||
_optional_|String metrics|< string, integer(int32) > map
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|Mappings|< string, <<_mappinginfo,MappingInfo>> > map|
|
||||
_optional_|Mappings|< string, <<_mappinginfo,MappingInfo>> > map
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|Metrics|< string, <<_createmetrics_body,body>> > map|
|
||||
_optional_|Metrics|< string, <<_createmetrics_body,body>> > map
|
||||
|===
|
||||
|
||||
[[_createmetrics_body]]
|
||||
*body*
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*p1* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|*p2* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|String metrics|< string, string > map|
|
||||
_optional_|String metrics|< string, string > map
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|OK|< string, string > map
|
||||
|
||||
@@ -48,11 +48,11 @@ _required_||string
|
||||
Collection parent type without discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
@@ -74,7 +74,8 @@ _required_||string
|
||||
_required_||string
|
||||
|*packSize* +
|
||||
_required_|the size of the pack the dog is from +
|
||||
*Default* : `0`|integer(int32)
|
||||
*Default* : `0` +
|
||||
*Minimum value* : `0`|integer(int32)
|
||||
|*petType* +
|
||||
_required_||string
|
||||
|===
|
||||
@@ -103,13 +104,13 @@ _optional_||string
|
||||
Pet parent type with discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*name* +
|
||||
_required_||string
|
||||
_required_|string
|
||||
|*petType* +
|
||||
_required_||string
|
||||
_required_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ Get collections
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|OK|<<_collection,Collection>>
|
||||
@@ -45,7 +45,7 @@ Get pets
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|OK|<<_pet,Pet>>
|
||||
|
||||
@@ -0,0 +1,117 @@
|
||||
|
||||
[[_definitions]]
|
||||
== Definitions
|
||||
|
||||
[[_array]]
|
||||
=== Array
|
||||
An array
|
||||
|
||||
[%hardbreaks]
|
||||
_Polymorphism_ : Inheritance
|
||||
_Discriminator_ : collType
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*name* +
|
||||
_optional_||string
|
||||
|*collType* +
|
||||
_required_|collection type discriminator|string
|
||||
|===
|
||||
|
||||
|
||||
[[_cat]]
|
||||
=== Cat
|
||||
A representation of a cat
|
||||
|
||||
[%hardbreaks]
|
||||
_Polymorphism_ : Inheritance
|
||||
_Discriminator_ : petType
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*name* +
|
||||
_optional_|conflicting property with inheriting model (issue #44)|string
|
||||
|*petType* +
|
||||
_required_||string
|
||||
|*huntingSkill* +
|
||||
_required_|The measured skill for hunting +
|
||||
*Default* : `"lazy"`|enum (clueless, lazy, adventurous, aggressive)
|
||||
|===
|
||||
|
||||
|
||||
[[_collection]]
|
||||
=== Collection
|
||||
Collection parent type without discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*name* +
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
[[_dog]]
|
||||
=== Dog
|
||||
A representation of a dog with an alternative discriminator
|
||||
|
||||
[%hardbreaks]
|
||||
_Polymorphism_ : Inheritance
|
||||
_Discriminator_ : dogType
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*name* +
|
||||
_required_||string
|
||||
|*petType* +
|
||||
_required_||string
|
||||
|*dogType* +
|
||||
_required_||string
|
||||
|*packSize* +
|
||||
_required_|the size of the pack the dog is from +
|
||||
*Default* : `0` +
|
||||
*Minimum value* : `0`|integer(int32)
|
||||
|===
|
||||
|
||||
|
||||
[[_map]]
|
||||
=== Map
|
||||
A map without discriminator
|
||||
|
||||
[%hardbreaks]
|
||||
_Polymorphism_ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*name* +
|
||||
_optional_||string
|
||||
|*collType* +
|
||||
_required_|collection type discriminator|string
|
||||
|===
|
||||
|
||||
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
Pet parent type with discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*name* +
|
||||
_required_|string
|
||||
|*petType* +
|
||||
_required_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
= Title
|
||||
|
||||
|
||||
[[_overview]]
|
||||
== Overview
|
||||
Description
|
||||
|
||||
|
||||
=== Version information
|
||||
[%hardbreaks]
|
||||
_Version_ : Developer build
|
||||
|
||||
|
||||
=== URI scheme
|
||||
[%hardbreaks]
|
||||
_Host_ : localhost:8080
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
|
||||
[[_paths]]
|
||||
== Paths
|
||||
|
||||
[[_getcolls]]
|
||||
=== Get collections
|
||||
....
|
||||
GET /collections
|
||||
....
|
||||
|
||||
|
||||
==== Description
|
||||
Get collections
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|OK|<<_collection,Collection>>
|
||||
|===
|
||||
|
||||
|
||||
==== Consumes
|
||||
|
||||
* `application/json`
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
|
||||
|
||||
[[_getpets]]
|
||||
=== Get Pets
|
||||
....
|
||||
GET /pets
|
||||
....
|
||||
|
||||
|
||||
==== Description
|
||||
Get pets
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|OK|<<_pet,Pet>>
|
||||
|===
|
||||
|
||||
|
||||
==== Consumes
|
||||
|
||||
* `application/json`
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
|
||||
|
||||
@@ -5,13 +5,13 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|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,.^11,.^4"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
_optional_||integer(int64)
|
||||
_optional_|integer(int64)
|
||||
|*name* +
|
||||
_optional_||string
|
||||
_optional_|string
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -15,17 +15,17 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -55,17 +55,17 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -136,17 +136,17 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Query*|*tags* +
|
||||
_optional_|Tags to filter by|< string > array(multi)|
|
||||
_optional_|Tags to filter by|< string > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -383,21 +383,21 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*405*|Invalid input|No Content
|
||||
@@ -458,17 +458,17 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -542,19 +542,19 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid pet value|No Content
|
||||
@@ -606,17 +606,17 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>|
|
||||
_optional_|order placed for purchasing the pet|<<_order,Order>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -691,17 +691,17 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -763,17 +763,17 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|Created user object|<<_user,User>>|
|
||||
_optional_|Created user object|<<_user,User>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -876,17 +876,17 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -938,17 +938,17 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Body*|*body* +
|
||||
_optional_|List of user object|< <<_user,User>> > array|
|
||||
_optional_|List of user object|< <<_user,User>> > array
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -1000,19 +1000,19 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*200*|successful operation +
|
||||
@@ -1072,7 +1072,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*default*|successful operation|No Content
|
||||
@@ -1108,17 +1108,17 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*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=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^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=".^1,.^3,.^10,.^4,.^2"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|Type|Name|Description|Schema
|
||||
|*Path*|*username* +
|
||||
_required_|The name that needs to be deleted|string|
|
||||
_required_|The name that needs to be deleted|string
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^1,.^15,.^4"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|*400*|Invalid username supplied|No Content
|
||||
@@ -1305,6 +1305,8 @@ _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
|
||||
|===
|
||||
|
||||
@@ -1323,6 +1325,8 @@ _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)
|
||||
@@ -1398,14 +1402,6 @@ _optional_|*Example* : `"string"`|string
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -1422,4 +1418,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
_Type_ : apiKey
|
||||
_Name_ : api_key
|
||||
_In_ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
|
||||
[[_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
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
= Title
|
||||
|
||||
|
||||
[[_overview]]
|
||||
== Overview
|
||||
Description
|
||||
|
||||
|
||||
=== Version information
|
||||
[%hardbreaks]
|
||||
_Version_ : Developer build
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|Name|Description|Schema|
|
||||
|---|---|---|
|
||||
|**id** <br>*optional*||integer(int64)|
|
||||
|**name** <br>*optional*|The name of the category <br>**Default** : `"DefaultCategory"` <br>**Example** : `"FoobarCategory"`|string|
|
||||
|**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|
|
||||
|
||||
|
||||
<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>**Example** : `10`|integer(int32)|
|
||||
|**quantity** <br>*optional*|**Default** : `0` <br>**Minimum value** : `0` <br>**Maximum value** : `10000` <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|Description|Schema|
|
||||
|---|---|---|
|
||||
|**id** <br>*optional*||integer(int64)|
|
||||
|**name** <br>*optional*||string|
|
||||
|Name|Schema|
|
||||
|---|---|
|
||||
|**id** <br>*optional*|integer(int64)|
|
||||
|**name** <br>*optional*|string|
|
||||
|
||||
|
||||
<a name="user"></a>
|
||||
|
||||
@@ -11,9 +11,9 @@ POST /pets
|
||||
|
||||
#### Parameters
|
||||
|
||||
|Type|Name|Description|Schema|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](#pet)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](#pet)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Query**|**status** <br>*optional*|Status values that need to be considered for filter|< string > array(multi)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Query**|**tags** <br>*optional*|Tags to filter by|< string > array(multi)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**Query**|**tags** <br>*optional*|Tags to filter by|< string > array(multi)|
|
||||
|
||||
|
||||
#### Responses
|
||||
@@ -191,11 +191,11 @@ POST /pets/{petId}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|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||
|
||||
|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|
|
||||
|
||||
|
||||
#### 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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Header**|**api_key** <br>*required*||string||
|
||||
|**Path**|**petId** <br>*required*|Pet id to delete|integer(int64)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|order placed for purchasing the pet|[Order](#order)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**orderId** <br>*required*|ID of pet that needs to be fetched|string||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**orderId** <br>*required*|ID of the order that needs to be deleted|string||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|Created user object|[User](#user)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|Created user object|[User](#user)|
|
||||
|
||||
|
||||
#### Responses
|
||||
@@ -467,9 +467,9 @@ POST /users/createWithArray
|
||||
|
||||
#### Parameters
|
||||
|
||||
|Type|Name|Description|Schema|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|List of user object|< [User](#user) > array||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|List of user object|< [User](#user) > array|
|
||||
|
||||
|
||||
#### Responses
|
||||
@@ -499,9 +499,9 @@ POST /users/createWithList
|
||||
|
||||
#### Parameters
|
||||
|
||||
|Type|Name|Description|Schema|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|List of user object|< [User](#user) > array||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|List of user object|< [User](#user) > array|
|
||||
|
||||
|
||||
#### Responses
|
||||
@@ -531,10 +531,10 @@ GET /users/login
|
||||
|
||||
#### Parameters
|
||||
|
||||
|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||
|
||||
|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|
|
||||
|
||||
|
||||
#### Responses
|
||||
@@ -590,9 +590,9 @@ GET /users/{username}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|Type|Name|Description|Schema|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**username** <br>*required*|The name that needs to be fetched. Use user1 for testing.|string||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**username** <br>*required*|name that need to be deleted|string||
|
||||
|**Body**|**body** <br>*optional*|Updated user object|[User](#user)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**username** <br>*required*|The name that needs to be deleted|string||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**Path**|**username** <br>*required*|The name that needs to be deleted|string|
|
||||
|
||||
|
||||
#### Responses
|
||||
|
||||
@@ -2,13 +2,6 @@
|
||||
<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
|
||||
@@ -22,4 +15,11 @@
|
||||
|read_pets|read your pets|
|
||||
|
||||
|
||||
<a name="api_key"></a>
|
||||
### api_key
|
||||
*Type* : apiKey
|
||||
*Name* : api_key
|
||||
*In* : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|Name|Description|Schema|
|
||||
|---|---|---|
|
||||
|**id** <br>*optional*||integer(int64)|
|
||||
|**name** <br>*optional*|The name of the category <br>**Default** : `"DefaultCategory"` <br>**Example** : `"FoobarCategory"`|string|
|
||||
|**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|
|
||||
|
||||
|
||||
<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>**Example** : `10`|integer(int32)|
|
||||
|**quantity** <br>*optional*|**Default** : `0` <br>**Minimum value** : `0` <br>**Maximum value** : `10000` <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|Description|Schema|
|
||||
|---|---|---|
|
||||
|**id** <br>*optional*||integer(int64)|
|
||||
|**name** <br>*optional*||string|
|
||||
|Name|Schema|
|
||||
|---|---|
|
||||
|**id** <br>*optional*|integer(int64)|
|
||||
|**name** <br>*optional*|string|
|
||||
|
||||
|
||||
<a name="user"></a>
|
||||
|
||||
@@ -11,9 +11,9 @@ POST /pets
|
||||
|
||||
#### Parameters
|
||||
|
||||
|Type|Name|Description|Schema|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](definitions.md#pet)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|Pet object that needs to be added to the store|[Pet](definitions.md#pet)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Query**|**status** <br>*optional*|Status values that need to be considered for filter|< string > array(multi)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Query**|**tags** <br>*optional*|Tags to filter by|< string > array(multi)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**Query**|**tags** <br>*optional*|Tags to filter by|< string > array(multi)|
|
||||
|
||||
|
||||
#### Responses
|
||||
@@ -191,11 +191,11 @@ POST /pets/{petId}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|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||
|
||||
|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|
|
||||
|
||||
|
||||
#### 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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Header**|**api_key** <br>*required*||string||
|
||||
|**Path**|**petId** <br>*required*|Pet id to delete|integer(int64)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|order placed for purchasing the pet|[Order](definitions.md#order)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**orderId** <br>*required*|ID of pet that needs to be fetched|string||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**orderId** <br>*required*|ID of the order that needs to be deleted|string||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|Created user object|[User](definitions.md#user)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|Created user object|[User](definitions.md#user)|
|
||||
|
||||
|
||||
#### Responses
|
||||
@@ -467,9 +467,9 @@ POST /users/createWithArray
|
||||
|
||||
#### Parameters
|
||||
|
||||
|Type|Name|Description|Schema|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|List of user object|< [User](definitions.md#user) > array||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Body**|**body** <br>*optional*|List of user object|< [User](definitions.md#user) > array||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**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|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**username** <br>*required*|The name that needs to be fetched. Use user1 for testing.|string||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**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|
|
||||
|---|---|---|---|
|
||||
|**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|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**username** <br>*required*|The name that needs to be deleted|string||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**Path**|**username** <br>*required*|The name that needs to be deleted|string|
|
||||
|
||||
|
||||
#### Responses
|
||||
|
||||
@@ -2,13 +2,6 @@
|
||||
<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
|
||||
@@ -22,4 +15,11 @@
|
||||
|read_pets|read your pets|
|
||||
|
||||
|
||||
<a name="api_key"></a>
|
||||
### api_key
|
||||
*Type* : apiKey
|
||||
*Name* : api_key
|
||||
*In* : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,10 +5,10 @@
|
||||
<a name="category"></a>
|
||||
### Category
|
||||
|
||||
|Name|Description|Schema|
|
||||
|---|---|---|
|
||||
|**id** <br>*optional*||integer(int64)|
|
||||
|**name** <br>*optional*||string|
|
||||
|Name|Schema|
|
||||
|---|---|
|
||||
|**id** <br>*optional*|integer(int64)|
|
||||
|**name** <br>*optional*|string|
|
||||
|
||||
|
||||
<a name="pet"></a>
|
||||
@@ -27,10 +27,10 @@
|
||||
<a name="tag"></a>
|
||||
### Tag
|
||||
|
||||
|Name|Description|Schema|
|
||||
|---|---|---|
|
||||
|**id** <br>*optional*||integer(int64)|
|
||||
|**name** <br>*optional*||string|
|
||||
|Name|Schema|
|
||||
|---|---|
|
||||
|**id** <br>*optional*|integer(int64)|
|
||||
|**name** <br>*optional*|string|
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -15,9 +15,9 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error cond
|
||||
|
||||
#### Parameters
|
||||
|
||||
|Type|Name|Description|Schema|Default|
|
||||
|---|---|---|---|---|
|
||||
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)||
|
||||
|Type|Name|Description|Schema|
|
||||
|---|---|---|---|
|
||||
|**Path**|**petId** <br>*required*|ID of pet that needs to be fetched|integer(int64)|
|
||||
|
||||
|
||||
#### Responses
|
||||
|
||||
@@ -2,13 +2,6 @@
|
||||
<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
|
||||
@@ -22,4 +15,11 @@
|
||||
|read_pets|read your pets|
|
||||
|
||||
|
||||
<a name="api_key"></a>
|
||||
### api_key
|
||||
*Type* : apiKey
|
||||
*Name* : api_key
|
||||
*In* : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
9
src/test/resources/json/swagger_emptycontact.json
Normal file
9
src/test/resources/json/swagger_emptycontact.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Empty Contact",
|
||||
"contact": {},
|
||||
"version": "1.0"
|
||||
},
|
||||
"paths": {}
|
||||
}
|
||||
81
src/test/resources/json/swagger_recursion.json
Normal file
81
src/test/resources/json/swagger_recursion.json
Normal file
@@ -0,0 +1,81 @@
|
||||
{
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user