Compare commits
20 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8e22dd817e | ||
|
|
569f3c02cd | ||
|
|
e8c2099e4c | ||
|
|
1646fefd56 | ||
|
|
aad387802e | ||
|
|
034d0a2f50 | ||
|
|
d2c78304c6 | ||
|
|
247857a843 | ||
|
|
038ff3a40e | ||
|
|
6d8776332f | ||
|
|
4ea24b0297 | ||
|
|
12570ecb00 | ||
|
|
7b68aecbd7 | ||
|
|
7ce62a8a3d | ||
|
|
d8c3cf725d | ||
|
|
aecc531d84 | ||
|
|
f107779542 | ||
|
|
70bf17011c | ||
|
|
86ae19fe2a | ||
|
|
e8235c4c35 |
@@ -27,7 +27,7 @@ image::src/docs/asciidoc/images/Swagger2Markup.PNG[]
|
||||
image::src/docs/asciidoc/images/Swagger2Markup_definitions.PNG[]
|
||||
|
||||
== Reference documentation
|
||||
- http://swagger2markup.github.io/swagger2markup/1.2.0/[Reference Documentation]
|
||||
- http://swagger2markup.github.io/swagger2markup/1.3.1/[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]
|
||||
|
||||
|
||||
@@ -129,3 +129,12 @@
|
||||
* Updated paleo-core from 0.10.1 to 0.10.2
|
||||
* Updated swagger-parser from v1.0.23 to v1.0.25
|
||||
* Decimal numbers are formatted into locale-specific strings
|
||||
|
||||
=== Version 1.3.1
|
||||
* PR #247: Fix request path and query params example support.
|
||||
|
||||
=== Version 1.3.2
|
||||
* PR #290: Fixed list parsing in properties file
|
||||
* PR #293: Fixed crash on empty tables
|
||||
* Updated markup-document-builder from 1.1.1 to 1.1.2
|
||||
|
||||
|
||||
28
build.gradle
28
build.gradle
@@ -1,20 +1,19 @@
|
||||
buildscript {
|
||||
repositories {
|
||||
jcenter()
|
||||
mavenCentral()
|
||||
}
|
||||
dependencies {
|
||||
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.3'
|
||||
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.10.1'
|
||||
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.6'
|
||||
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.16'
|
||||
classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1'
|
||||
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"
|
||||
classpath "org.ajoberstar:gradle-git-publish:0.3.1"
|
||||
}
|
||||
}
|
||||
description = 'swagger2markup Build'
|
||||
version = '1.3.0'
|
||||
ext.releaseVersion = '1.3.0'
|
||||
version = '1.3.2-SNAPSHOT'
|
||||
ext.releaseVersion = '1.3.1'
|
||||
group = 'io.github.swagger2markup'
|
||||
|
||||
apply plugin: 'java'
|
||||
@@ -36,22 +35,21 @@ repositories {
|
||||
url "https://oss.jfrog.org/artifactory/oss-snapshot-local"
|
||||
}
|
||||
jcenter()
|
||||
mavenCentral()
|
||||
//mavenLocal()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compile 'io.github.swagger2markup:markup-document-builder:1.1.1'
|
||||
compile 'io.swagger:swagger-compat-spec-parser:1.0.25'
|
||||
compile 'io.github.swagger2markup:markup-document-builder:1.1.2'
|
||||
compile 'io.swagger:swagger-compat-spec-parser:1.0.31'
|
||||
compile 'org.apache.commons:commons-configuration2:2.1'
|
||||
compile 'commons-beanutils:commons-beanutils:1.9.2'
|
||||
compile 'org.apache.commons:commons-collections4:4.1'
|
||||
compile 'io.javaslang:javaslang:2.0.5'
|
||||
compile 'ch.netzwerg:paleo-core:0.10.2'
|
||||
testCompile 'junit:junit:4.11'
|
||||
testCompile 'org.asciidoctor:asciidoctorj:1.5.4'
|
||||
compile 'io.vavr:vavr:0.9.1'
|
||||
compile 'ch.netzwerg:paleo-core:0.11.0'
|
||||
testCompile 'junit:junit:4.12'
|
||||
testCompile 'org.asciidoctor:asciidoctorj:1.5.6'
|
||||
testCompile 'ch.qos.logback:logback-classic:1.1.2'
|
||||
testCompile 'org.assertj:assertj-core:3.5.2'
|
||||
testCompile 'org.assertj:assertj-core:3.8.0'
|
||||
testCompile 'io.github.robwin:assertj-diff:0.1.1'
|
||||
}
|
||||
|
||||
@@ -66,5 +64,5 @@ test {
|
||||
|
||||
|
||||
task wrapper(type: Wrapper) {
|
||||
gradleVersion = '3.3'
|
||||
gradleVersion = '4.3.1'
|
||||
}
|
||||
|
||||
2
gradle.properties
Normal file
2
gradle.properties
Normal file
@@ -0,0 +1,2 @@
|
||||
systemProp.file.encoding=UTF-8
|
||||
systemProp.sun.jnu.encoding=UTF-8
|
||||
@@ -1,5 +1,5 @@
|
||||
apply plugin: 'org.asciidoctor.convert'
|
||||
apply plugin: 'org.ajoberstar.github-pages'
|
||||
apply plugin: 'org.ajoberstar.git-publish'
|
||||
|
||||
asciidoctor {
|
||||
sources {
|
||||
@@ -18,17 +18,23 @@ asciidoctor {
|
||||
]
|
||||
}
|
||||
|
||||
publishGhPages.dependsOn asciidoctor
|
||||
gitPublishCommit.dependsOn asciidoctor
|
||||
|
||||
githubPages {
|
||||
repoUri = 'https://github.com/Swagger2Markup/swagger2markup.git'
|
||||
gitPublish {
|
||||
repoUri = 'git@github.com:Swagger2Markup/swagger2markup.git'
|
||||
branch = 'gh-pages'
|
||||
|
||||
credentials {
|
||||
username = project.hasProperty('githubUser') ? project.githubUser : System.getenv('GITHUB_USER')
|
||||
password = project.hasProperty('githubPassword') ? project.githubPassword : System.getenv('GITHUB_PASSWORD')
|
||||
}
|
||||
// use ENV GRGIT_USER
|
||||
// use ENV GRGIT_PASS
|
||||
// or org.ajoberstar.grgit.auth.username system property
|
||||
// org.ajoberstar.grgit.auth.password system property
|
||||
// see http://ajoberstar.org/grgit/grgit-authentication.html for details
|
||||
// credentials {
|
||||
// username = project.hasProperty('githubUser') ? project.githubUser : System.getenv('GITHUB_USER')
|
||||
// password = project.hasProperty('githubPassword') ? project.githubPassword : System.getenv('GITHUB_PASSWORD')
|
||||
// }
|
||||
|
||||
pages {
|
||||
contents {
|
||||
from file(asciidoctor.outputDir.path + '/html5')
|
||||
into project.releaseVersion
|
||||
}
|
||||
|
||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Binary file not shown.
4
gradle/wrapper/gradle-wrapper.properties
vendored
4
gradle/wrapper/gradle-wrapper.properties
vendored
@@ -1,6 +1,6 @@
|
||||
#Thu Jan 05 14:27:30 CET 2017
|
||||
#Mon Dec 04 10:24:38 CET 2017
|
||||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-bin.zip
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-4.3.1-all.zip
|
||||
|
||||
19
gradlew
vendored
19
gradlew
vendored
@@ -1,4 +1,4 @@
|
||||
#!/usr/bin/env bash
|
||||
#!/usr/bin/env sh
|
||||
|
||||
##############################################################################
|
||||
##
|
||||
@@ -154,16 +154,19 @@ if $cygwin ; then
|
||||
esac
|
||||
fi
|
||||
|
||||
# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
|
||||
function splitJvmOpts() {
|
||||
JVM_OPTS=("$@")
|
||||
# Escape application args
|
||||
save ( ) {
|
||||
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
|
||||
echo " "
|
||||
}
|
||||
eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
|
||||
JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
|
||||
APP_ARGS=$(save "$@")
|
||||
|
||||
# Collect all arguments for the java command, following the shell quoting and substitution rules
|
||||
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
|
||||
|
||||
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
|
||||
if [[ "$(uname)" == "Darwin" ]] && [[ "$HOME" == "$PWD" ]]; then
|
||||
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
|
||||
cd "$(dirname "$0")"
|
||||
fi
|
||||
|
||||
exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
|
||||
exec "$JAVACMD" "$@"
|
||||
|
||||
@@ -58,6 +58,9 @@ public class Labels {
|
||||
public static final String HOST = "host";
|
||||
public static final String BASE_PATH = "base_path";
|
||||
public static final String SCHEMES = "schemes";
|
||||
public static final String EXTERNAL_DOCS = "external_docs";
|
||||
public static final String EXTERNAL_DOCS_DESC = "external_docs_desc";
|
||||
public static final String EXTERNAL_DOCS_URL = "external_docs_url";
|
||||
|
||||
//Security Document
|
||||
public static final String SECURITY = "security";
|
||||
|
||||
@@ -75,6 +75,13 @@ public class Swagger2MarkupConfigBuilder {
|
||||
|
||||
Swagger2MarkupProperties swagger2MarkupProperties = new Swagger2MarkupProperties(compositeConfiguration);
|
||||
|
||||
config.listDelimiterEnabled = swagger2MarkupProperties.getBoolean(LIST_DELIMITER_ENABLED, false);
|
||||
config.listDelimiter = swagger2MarkupProperties.getString(LIST_DELIMITER, ",").charAt(0);
|
||||
|
||||
if (config.listDelimiterEnabled && configuration instanceof AbstractConfiguration) {
|
||||
((AbstractConfiguration)configuration).setListDelimiterHandler(new DefaultListDelimiterHandler(config.listDelimiter));
|
||||
}
|
||||
|
||||
config.markupLanguage = swagger2MarkupProperties.getRequiredMarkupLanguage(MARKUP_LANGUAGE);
|
||||
config.swaggerMarkupLanguage = swagger2MarkupProperties.getRequiredMarkupLanguage(SWAGGER_MARKUP_LANGUAGE);
|
||||
config.generatedExamplesEnabled = swagger2MarkupProperties.getRequiredBoolean(GENERATED_EXAMPLES_ENABLED);
|
||||
@@ -112,13 +119,6 @@ public class Swagger2MarkupConfigBuilder {
|
||||
|
||||
config.headerPattern = headerPattern.orElse(null);
|
||||
|
||||
config.listDelimiterEnabled = swagger2MarkupProperties.getBoolean(LIST_DELIMITER_ENABLED, false);
|
||||
config.listDelimiter = swagger2MarkupProperties.getString(LIST_DELIMITER, ",").charAt(0);
|
||||
|
||||
if (config.listDelimiterEnabled && configuration instanceof AbstractConfiguration) {
|
||||
((AbstractConfiguration)configuration).setListDelimiterHandler(new DefaultListDelimiterHandler(config.listDelimiter));
|
||||
}
|
||||
|
||||
Configuration swagger2markupConfiguration = compositeConfiguration.subset(PROPERTIES_PREFIX);
|
||||
Configuration extensionsConfiguration = swagger2markupConfiguration.subset(EXTENSION_PREFIX);
|
||||
config.extensionsProperties = new Swagger2MarkupProperties(extensionsConfiguration);
|
||||
|
||||
@@ -26,6 +26,7 @@ import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.spi.DefinitionsDocumentExtension;
|
||||
import io.github.swagger2markup.spi.MarkupComponent;
|
||||
import io.swagger.models.Model;
|
||||
import io.swagger.models.properties.Property;
|
||||
import org.apache.commons.collections4.CollectionUtils;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
|
||||
@@ -157,11 +158,14 @@ public class DefinitionComponent extends MarkupComponent<DefinitionComponent.Par
|
||||
if (isNotBlank(typeInfosString))
|
||||
markupDocBuilder.paragraph(typeInfosString, true);
|
||||
|
||||
propertiesTableComponent.apply(markupDocBuilder,
|
||||
PropertiesTableComponent.parameters(
|
||||
((ObjectType) modelType).getProperties(),
|
||||
definitionName,
|
||||
inlineDefinitions));
|
||||
Map<String, Property> properties = ((ObjectType) modelType).getProperties();
|
||||
if (!properties.isEmpty()) {
|
||||
propertiesTableComponent.apply(markupDocBuilder,
|
||||
PropertiesTableComponent.parameters(
|
||||
properties,
|
||||
definitionName,
|
||||
inlineDefinitions));
|
||||
}
|
||||
} else if (modelType != null) {
|
||||
MarkupDocBuilder typeInfos = copyMarkupDocBuilder(markupDocBuilder);
|
||||
typeInfos.italicText(labels.getLabel(TYPE_COLUMN)).textLine(COLON + modelType.displaySchema(markupDocBuilder));
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.spi.MarkupComponent;
|
||||
import io.swagger.models.ExternalDocs;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
|
||||
import static io.github.swagger2markup.Labels.EXTERNAL_DOCS;
|
||||
import static io.github.swagger2markup.Labels.EXTERNAL_DOCS_DESC;
|
||||
import static io.github.swagger2markup.Labels.EXTERNAL_DOCS_URL;
|
||||
import static io.github.swagger2markup.internal.utils.MarkupDocBuilderUtils.copyMarkupDocBuilder;
|
||||
import static org.apache.commons.lang3.StringUtils.isNotBlank;
|
||||
|
||||
public class ExternalDocsComponent extends MarkupComponent<ExternalDocsComponent.Parameters> {
|
||||
|
||||
public ExternalDocsComponent(Swagger2MarkupConverter.Context context) {
|
||||
super(context);
|
||||
}
|
||||
|
||||
public static ExternalDocsComponent.Parameters parameters(ExternalDocs externalDocs, int titleLevel) {
|
||||
return new ExternalDocsComponent.Parameters(externalDocs, titleLevel);
|
||||
}
|
||||
|
||||
@Override
|
||||
public MarkupDocBuilder apply(MarkupDocBuilder markupDocBuilder, Parameters params) {
|
||||
ExternalDocs externalDocs = params.externalDocs;
|
||||
String description = externalDocs.getDescription();
|
||||
String url = externalDocs.getUrl();
|
||||
if ((description != null && (isNotBlank(description) || (url != null && isNotBlank(url))))) {
|
||||
markupDocBuilder.sectionTitleLevel(params.titleLevel, labels.getLabel(EXTERNAL_DOCS));
|
||||
MarkupDocBuilder paragraph = copyMarkupDocBuilder(markupDocBuilder);
|
||||
|
||||
if (isNotBlank(description)) {
|
||||
paragraph.italicText(labels.getLabel(EXTERNAL_DOCS_DESC)).textLine(COLON + description);
|
||||
}
|
||||
if (isNotBlank(url)) {
|
||||
paragraph.italicText(labels.getLabel(EXTERNAL_DOCS_URL)).textLine(COLON + url);
|
||||
}
|
||||
|
||||
markupDocBuilder.paragraph(paragraph.toString(), true);
|
||||
}
|
||||
|
||||
return markupDocBuilder;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
private final int titleLevel;
|
||||
private final ExternalDocs externalDocs;
|
||||
|
||||
public Parameters(ExternalDocs externalDocs,
|
||||
int titleLevel) {
|
||||
this.externalDocs = Validate.notNull(externalDocs, "ExternalDocs must not be null");
|
||||
this.titleLevel = titleLevel;
|
||||
}
|
||||
}
|
||||
}
|
||||
48
src/main/java/io/github/swagger2markup/internal/component/PropertiesTableComponent.java
Normal file → Executable file
48
src/main/java/io/github/swagger2markup/internal/component/PropertiesTableComponent.java
Normal file → Executable file
@@ -21,6 +21,7 @@ import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.internal.adapter.PropertyAdapter;
|
||||
import io.github.swagger2markup.internal.resolver.DocumentResolver;
|
||||
import io.github.swagger2markup.internal.type.ObjectType;
|
||||
import io.github.swagger2markup.internal.type.RefType;
|
||||
import io.github.swagger2markup.internal.type.Type;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.spi.MarkupComponent;
|
||||
@@ -56,30 +57,30 @@ public class PropertiesTableComponent extends MarkupComponent<PropertiesTableCom
|
||||
* @param definitionDocumentResolver definition document resolver to apply to property type cross-reference
|
||||
*/
|
||||
PropertiesTableComponent(Swagger2MarkupConverter.Context context,
|
||||
DocumentResolver definitionDocumentResolver) {
|
||||
DocumentResolver definitionDocumentResolver) {
|
||||
super(context);
|
||||
this.definitionDocumentResolver = definitionDocumentResolver;
|
||||
this.tableComponent = new TableComponent(context);
|
||||
}
|
||||
|
||||
public static PropertiesTableComponent.Parameters parameters(Map<String, Property> properties,
|
||||
String parameterName,
|
||||
List<ObjectType> inlineDefinitions) {
|
||||
String parameterName,
|
||||
List<ObjectType> inlineDefinitions) {
|
||||
return new PropertiesTableComponent.Parameters(properties, parameterName, inlineDefinitions);
|
||||
}
|
||||
|
||||
public MarkupDocBuilder apply(MarkupDocBuilder markupDocBuilder, Parameters params) {
|
||||
//TODO: This method is too complex, split it up in smaller methods to increase readability
|
||||
StringColumn.Builder nameColumnBuilder = StringColumn.builder(ColumnIds.StringColumnId.of(labels.getLabel(NAME_COLUMN)))
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "3");
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "3");
|
||||
|
||||
StringColumn.Builder descriptionColumnBuilder = StringColumn.builder(ColumnIds.StringColumnId.of(labels.getLabel(DESCRIPTION_COLUMN)))
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "11")
|
||||
.putMetaData(TableComponent.HEADER_COLUMN, "true");
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "11")
|
||||
.putMetaData(TableComponent.HEADER_COLUMN, "true");
|
||||
|
||||
StringColumn.Builder schemaColumnBuilder = StringColumn.builder(ColumnIds.StringColumnId.of(labels.getLabel(SCHEMA_COLUMN)))
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "4")
|
||||
.putMetaData(TableComponent.HEADER_COLUMN, "true");
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "4")
|
||||
.putMetaData(TableComponent.HEADER_COLUMN, "true");
|
||||
|
||||
Map<String, Property> properties = params.properties;
|
||||
if (MapUtils.isNotEmpty(properties)) {
|
||||
@@ -166,7 +167,7 @@ public class PropertiesTableComponent extends MarkupComponent<PropertiesTableCom
|
||||
}
|
||||
|
||||
DecimalFormat numberFormatter = new DecimalFormat("#.##",
|
||||
DecimalFormatSymbols.getInstance(config.getOutputLanguage().toLocale()));
|
||||
DecimalFormatSymbols.getInstance(config.getOutputLanguage().toLocale()));
|
||||
|
||||
if (optionalMinValue.isPresent()) {
|
||||
if (isNotBlank(descriptionContent.toString())) {
|
||||
@@ -185,10 +186,15 @@ public class PropertiesTableComponent extends MarkupComponent<PropertiesTableCom
|
||||
}
|
||||
|
||||
if (optionalExample.isPresent()) {
|
||||
if (isNotBlank(description) || optionalDefaultValue.isPresent()) {
|
||||
if (isNotBlank(descriptionContent.toString())) {
|
||||
descriptionContent.newLine(true);
|
||||
}
|
||||
descriptionContent.boldText(labels.getLabel(EXAMPLE_COLUMN)).text(COLON).literalText(Json.pretty(optionalExample.get()));
|
||||
|
||||
if(propertyType instanceof RefType && isReferenceLink(optionalExample.get().toString())) {
|
||||
descriptionContent.boldText(labels.getLabel(EXAMPLE_COLUMN)).text(COLON).crossReference(optionalExample.get().toString());
|
||||
} else {
|
||||
descriptionContent.boldText(labels.getLabel(EXAMPLE_COLUMN)).text(COLON).literalText(Json.pretty(optionalExample.get()));
|
||||
}
|
||||
}
|
||||
|
||||
nameColumnBuilder.add(propertyNameContent.toString());
|
||||
@@ -198,9 +204,19 @@ public class PropertiesTableComponent extends MarkupComponent<PropertiesTableCom
|
||||
}
|
||||
|
||||
return tableComponent.apply(markupDocBuilder, TableComponent.parameters(
|
||||
nameColumnBuilder.build(),
|
||||
descriptionColumnBuilder.build(),
|
||||
schemaColumnBuilder.build()));
|
||||
nameColumnBuilder.build(),
|
||||
descriptionColumnBuilder.build(),
|
||||
schemaColumnBuilder.build()));
|
||||
}
|
||||
|
||||
/*
|
||||
* Check if a string is a link to a reference, format <<_referenceClass>>
|
||||
*
|
||||
* @param possibleAnchor String to check
|
||||
* @return true if the string is a link to an anchor, false otherwise
|
||||
*/
|
||||
private boolean isReferenceLink(String possibleAnchor) {
|
||||
return possibleAnchor.startsWith("<<_") && possibleAnchor.endsWith(">>");
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
@@ -209,8 +225,8 @@ public class PropertiesTableComponent extends MarkupComponent<PropertiesTableCom
|
||||
private final List<ObjectType> inlineDefinitions;
|
||||
|
||||
public Parameters(Map<String, Property> properties,
|
||||
String parameterName,
|
||||
List<ObjectType> inlineDefinitions) {
|
||||
String parameterName,
|
||||
List<ObjectType> inlineDefinitions) {
|
||||
|
||||
this.properties = Validate.notNull(properties, "Properties must not be null");
|
||||
this.parameterName = Validate.notBlank(parameterName, "ParameterName must not be blank");
|
||||
|
||||
@@ -88,23 +88,29 @@ public class SecuritySchemeDefinitionComponent extends MarkupComponent<SecurityS
|
||||
if (isNotBlank(oauth2Scheme.getTokenUrl())) {
|
||||
paragraphBuilder.italicText(labels.getLabel(TOKEN_URL)).textLine(COLON + oauth2Scheme.getTokenUrl());
|
||||
}
|
||||
StringColumn.Builder nameColumnBuilder = StringColumn.builder(StringColumnId.of(labels.getLabel(NAME_COLUMN)))
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "3")
|
||||
.putMetaData(TableComponent.HEADER_COLUMN, "true");
|
||||
StringColumn.Builder descriptionColumnBuilder = StringColumn.builder(StringColumnId.of(labels.getLabel(DESCRIPTION_COLUMN)))
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "17")
|
||||
.putMetaData(TableComponent.HEADER_COLUMN, "true");
|
||||
|
||||
if (oauth2Scheme.getScopes() != null) {
|
||||
markupDocBuilder.paragraph(paragraphBuilder.toString(), true);
|
||||
|
||||
if (oauth2Scheme.getScopes() != null && !oauth2Scheme.getScopes().isEmpty()) {
|
||||
StringColumn.Builder nameColumnBuilder = StringColumn.builder(StringColumnId.of(labels.getLabel(NAME_COLUMN)))
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "3")
|
||||
.putMetaData(TableComponent.HEADER_COLUMN, "true");
|
||||
StringColumn.Builder descriptionColumnBuilder = StringColumn.builder(StringColumnId.of(labels.getLabel(DESCRIPTION_COLUMN)))
|
||||
.putMetaData(TableComponent.WIDTH_RATIO, "17")
|
||||
.putMetaData(TableComponent.HEADER_COLUMN, "true");
|
||||
|
||||
for (Map.Entry<String, String> scope : oauth2Scheme.getScopes().entrySet()) {
|
||||
nameColumnBuilder.add(scope.getKey());
|
||||
descriptionColumnBuilder.add(scope.getValue());
|
||||
}
|
||||
|
||||
return tableComponent.apply(markupDocBuilder, TableComponent.parameters(nameColumnBuilder.build(),
|
||||
descriptionColumnBuilder.build()));
|
||||
} else {
|
||||
|
||||
return markupDocBuilder;
|
||||
}
|
||||
|
||||
markupDocBuilder.paragraph(paragraphBuilder.toString(), true);
|
||||
return tableComponent.apply(markupDocBuilder, TableComponent.parameters(nameColumnBuilder.build(),
|
||||
descriptionColumnBuilder.build()));
|
||||
} else {
|
||||
return markupDocBuilder.paragraph(paragraphBuilder.toString(), true);
|
||||
}
|
||||
|
||||
@@ -22,9 +22,9 @@ import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.markup.builder.MarkupLanguage;
|
||||
import io.github.swagger2markup.markup.builder.MarkupTableColumn;
|
||||
import io.github.swagger2markup.spi.MarkupComponent;
|
||||
import javaslang.collection.Array;
|
||||
import javaslang.collection.IndexedSeq;
|
||||
import javaslang.collection.List;
|
||||
import io.vavr.collection.Array;
|
||||
import io.vavr.collection.IndexedSeq;
|
||||
import io.vavr.collection.List;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
|
||||
|
||||
@@ -53,7 +53,7 @@ public class TableComponent extends MarkupComponent<TableComponent.Parameters> {
|
||||
return new MarkupTableColumn(column.getId().getName())
|
||||
.withWidthRatio(widthRatio)
|
||||
.withHeaderColumn(Boolean.parseBoolean(column.getMetaData().get(HEADER_COLUMN).getOrElse("false")))
|
||||
.withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^" + widthRatio);
|
||||
.withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^" + widthRatio + "a");
|
||||
}
|
||||
).toJavaList();
|
||||
|
||||
|
||||
@@ -20,10 +20,7 @@ import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.internal.component.*;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.spi.MarkupComponent;
|
||||
import io.swagger.models.Contact;
|
||||
import io.swagger.models.Info;
|
||||
import io.swagger.models.Swagger;
|
||||
import io.swagger.models.Tag;
|
||||
import io.swagger.models.*;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
|
||||
import java.util.List;
|
||||
@@ -45,6 +42,7 @@ public class OverviewDocument extends MarkupComponent<OverviewDocument.Parameter
|
||||
private final TagsComponent tagsComponent;
|
||||
private final ProducesComponent producesComponent;
|
||||
private final ConsumesComponent consumesComponent;
|
||||
private final ExternalDocsComponent externalDocsComponent;
|
||||
|
||||
public OverviewDocument(Swagger2MarkupConverter.Context context) {
|
||||
super(context);
|
||||
@@ -55,6 +53,7 @@ public class OverviewDocument extends MarkupComponent<OverviewDocument.Parameter
|
||||
tagsComponent = new TagsComponent(context);
|
||||
producesComponent = new ProducesComponent(context);
|
||||
consumesComponent = new ConsumesComponent(context);
|
||||
externalDocsComponent = new ExternalDocsComponent((context));
|
||||
}
|
||||
|
||||
public static OverviewDocument.Parameters parameters(Swagger swagger) {
|
||||
@@ -82,6 +81,7 @@ public class OverviewDocument extends MarkupComponent<OverviewDocument.Parameter
|
||||
buildTagsSection(markupDocBuilder, swagger.getTags());
|
||||
buildConsumesSection(markupDocBuilder, swagger.getConsumes());
|
||||
buildProducesSection(markupDocBuilder, swagger.getProduces());
|
||||
buildExternalDocsSection(markupDocBuilder, swagger.getExternalDocs());
|
||||
applyOverviewDocumentExtension(new Context(Position.DOCUMENT_END, markupDocBuilder));
|
||||
applyOverviewDocumentExtension(new Context(Position.DOCUMENT_AFTER, markupDocBuilder));
|
||||
return markupDocBuilder;
|
||||
@@ -141,6 +141,12 @@ public class OverviewDocument extends MarkupComponent<OverviewDocument.Parameter
|
||||
}
|
||||
}
|
||||
|
||||
private void buildExternalDocsSection(MarkupDocBuilder markupDocBuilder, ExternalDocs externalDocs) {
|
||||
if (externalDocs != null) {
|
||||
externalDocsComponent.apply(markupDocBuilder, ExternalDocsComponent.parameters(externalDocs, SECTION_TITLE_LEVEL));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply extension context to all OverviewContentExtension
|
||||
*
|
||||
|
||||
@@ -19,7 +19,7 @@ package io.github.swagger2markup.internal.resolver;
|
||||
import io.github.swagger2markup.Swagger2MarkupConfig;
|
||||
import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import javaslang.Function1;
|
||||
import io.vavr.Function1;
|
||||
|
||||
/**
|
||||
* A functor to return the document part of an inter-document cross-references, depending on the context.
|
||||
|
||||
@@ -20,7 +20,7 @@ import io.github.swagger2markup.Swagger2MarkupConfig;
|
||||
import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.model.PathOperation;
|
||||
import javaslang.Function1;
|
||||
import io.vavr.Function1;
|
||||
|
||||
/**
|
||||
* A functor to return the document part of an inter-document cross-references, depending on the context.
|
||||
|
||||
@@ -124,6 +124,9 @@ public class ExamplesUtil {
|
||||
if (generateMissingExamples) {
|
||||
Object abstractSerializableParameterExample;
|
||||
abstractSerializableParameterExample = ((AbstractSerializableParameter) parameter).getExample();
|
||||
if (abstractSerializableParameterExample == null) {
|
||||
abstractSerializableParameterExample = parameter.getVendorExtensions().get("x-example");
|
||||
}
|
||||
if (abstractSerializableParameterExample == null) {
|
||||
Property item = ((AbstractSerializableParameter) parameter).getItems();
|
||||
if (item != null) {
|
||||
|
||||
@@ -31,21 +31,28 @@ public class MarkupDocBuilderUtils {
|
||||
if (StringUtils.isBlank(text)) {
|
||||
return StringUtils.EMPTY;
|
||||
}
|
||||
return copyMarkupDocBuilder(markupDocBuilder).literalText(text).toString();
|
||||
return copyMarkupDocBuilder(markupDocBuilder).literalText(escapeText(text)).toString();
|
||||
}
|
||||
|
||||
private static String escapeText(String text) {
|
||||
if(text.startsWith("*")){
|
||||
text = "\\" + text;
|
||||
}
|
||||
return text;
|
||||
}
|
||||
|
||||
public static String boldText(MarkupDocBuilder markupDocBuilder, String text) {
|
||||
if (StringUtils.isBlank(text)) {
|
||||
return StringUtils.EMPTY;
|
||||
}
|
||||
return copyMarkupDocBuilder(markupDocBuilder).boldText(text).toString();
|
||||
return copyMarkupDocBuilder(markupDocBuilder).boldText(escapeText(text)).toString();
|
||||
}
|
||||
|
||||
public static String italicText(MarkupDocBuilder markupDocBuilder, String text) {
|
||||
if (StringUtils.isBlank(text)) {
|
||||
return StringUtils.EMPTY;
|
||||
}
|
||||
return copyMarkupDocBuilder(markupDocBuilder).italicText(text).toString();
|
||||
return copyMarkupDocBuilder(markupDocBuilder).italicText(escapeText(text)).toString();
|
||||
}
|
||||
|
||||
public static String crossReference(MarkupDocBuilder markupDocBuilder, String document, String anchor, String text) {
|
||||
|
||||
@@ -21,7 +21,7 @@ import io.github.swagger2markup.Swagger2MarkupConfig;
|
||||
import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.Swagger2MarkupExtensionRegistry;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import javaslang.Function2;
|
||||
import io.vavr.Function2;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ contact_information=Kontaktinformationen
|
||||
contact_name=Kontakt
|
||||
contact_email=Kontakt E-Mail
|
||||
license_information=Lizenzinformationen
|
||||
license=Linzenz
|
||||
license=Lizenz
|
||||
license_url=Lizenz-URL
|
||||
terms_of_service=Nutzungsbedingungen
|
||||
uri_scheme=URI Schema
|
||||
@@ -64,3 +64,6 @@ polymorphism.column=Polymorphism
|
||||
polymorphism.discriminator=Discriminator
|
||||
polymorphism.nature.INHERITANCE=Inheritance
|
||||
polymorphism.nature.COMPOSITION=Composition
|
||||
external_docs=Externe Doku
|
||||
external_docs_desc=Beschreibung
|
||||
external_docs_url=URL
|
||||
@@ -63,4 +63,7 @@ operation.deprecated=This operation is deprecated.
|
||||
polymorphism.column=Polymorphism
|
||||
polymorphism.discriminator=Discriminator
|
||||
polymorphism.nature.INHERITANCE=Inheritance
|
||||
polymorphism.nature.COMPOSITION=Composition
|
||||
polymorphism.nature.COMPOSITION=Composition
|
||||
external_docs=External Docs
|
||||
external_docs_desc=Description
|
||||
external_docs_url=URL
|
||||
@@ -63,4 +63,7 @@ operation.deprecated=Operaci\u00F3n obsoleta
|
||||
polymorphism.column=Polimorfismo
|
||||
polymorphism.discriminator=Discriminador
|
||||
polymorphism.nature.INHERITANCE=Herencia
|
||||
polymorphism.nature.COMPOSITION=Composici\u00F3n
|
||||
polymorphism.nature.COMPOSITION=Composici\u00F3n
|
||||
external_docs=External Docs
|
||||
external_docs_desc=Description
|
||||
external_docs_url=URL
|
||||
@@ -63,4 +63,7 @@ operation.deprecated=Cette op\u00E9ration est obsol\u00E8te.
|
||||
polymorphism.column=Polymorphisme
|
||||
polymorphism.discriminator=Discriminateur
|
||||
polymorphism.nature.INHERITANCE=H\u00E9ritage
|
||||
polymorphism.nature.COMPOSITION=Composition
|
||||
polymorphism.nature.COMPOSITION=Composition
|
||||
external_docs=External Docs
|
||||
external_docs_desc=Description
|
||||
external_docs_url=URL
|
||||
@@ -64,3 +64,6 @@ polymorphism.column=\u30dd\u30ea\u30e2\u30fc\u30d5\u30a3\u30ba\u30e0
|
||||
polymorphism.discriminator=Discriminator
|
||||
polymorphism.nature.INHERITANCE=\u7d99\u627f
|
||||
polymorphism.nature.COMPOSITION=\u5305\u542b
|
||||
external_docs=External Docs
|
||||
external_docs_desc=Description
|
||||
external_docs_url=URL
|
||||
@@ -63,4 +63,7 @@ operation.deprecated=Essa opera\u00e7\u00e3o est\u00e1 obsoleta.
|
||||
polymorphism.column=Polimorfismo
|
||||
polymorphism.discriminator=Discriminador
|
||||
polymorphism.nature.INHERITANCE=Heran\u00e7a
|
||||
polymorphism.nature.COMPOSITION=Composi\u00e7\u00e3o
|
||||
polymorphism.nature.COMPOSITION=Composi\u00e7\u00e3o
|
||||
external_docs=External Docs
|
||||
external_docs_desc=Description
|
||||
external_docs_url=URL
|
||||
@@ -1,35 +1,35 @@
|
||||
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
|
||||
minlength_column=\u041C\u0438\u043D\u0438\u043C\u0430\u043B\u044C\u043D\u0430\u044F \u0434\u043B\u0438\u043D\u0430
|
||||
maxlength_column=\u041C\u0430\u043A\u0441\u0438\u043C\u0430\u043B\u044C\u043D\u0430\u044F \u0434\u043B\u0438\u043D\u0430
|
||||
length_column=\u0414\u043B\u0438\u043D\u0430
|
||||
pattern_column=\u0428\u0430\u0431\u043B\u043E\u043D
|
||||
minvalue_column=\u041C\u0438\u043D\u0438\u043C\u0430\u043B\u044C\u043D\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435
|
||||
minvalue_exclusive_column=\u041C\u0438\u043D\u0438\u043C\u0430\u043B\u044C\u043D\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435 (\u0438\u0441\u043A\u043B\u044E\u0447\u0435\u043D\u0438\u0435)
|
||||
maxvalue_column=\u041C\u0430\u043A\u0441\u0438\u043C\u0430\u043B\u044C\u043D\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435
|
||||
maxvalue_exclusive_column=\u041C\u0430\u043A\u0441\u0438\u043C\u0430\u043B\u044C\u043D\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435 (\u0438\u0441\u043A\u043B\u044E\u0447\u0435\u043D\u0438\u0435)
|
||||
flags.column=\u0424\u043B\u0430\u0433\u0438
|
||||
flags.required=\u041E\u0431\u044F\u0437\u0430\u0442\u0435\u043B\u044C\u043D\u043E
|
||||
flags.optional=Optional
|
||||
flags.read_only=Read-only
|
||||
flags.read_write=Read-write
|
||||
flags.optional=\u041D\u0435\u043E\u0431\u044F\u0437\u0430\u0442\u0435\u043B\u044C\u043D\u043E
|
||||
flags.read_only=\u0422\u043E\u043B\u044C\u043A\u043E \u0434\u043B\u044F \u0447\u0442\u0435\u043D\u0438\u044F
|
||||
flags.read_write=\u0427\u0442\u0435\u043D\u0438\u0435 \u0438 \u0437\u0430\u043F\u0438\u0441\u044C
|
||||
example_column=\u041F\u0440\u0438\u043C\u0435\u0440
|
||||
schema_column=\u0421\u0445\u0435\u043C\u0430
|
||||
name_column=\u0418\u043C\u044F
|
||||
description_column=\u041E\u043F\u0438\u0441\u0430\u043D\u0438\u0435
|
||||
headers_column=Headers
|
||||
headers_column=\u0417\u0430\u0433\u043E\u043B\u043E\u0432\u043A\u0438
|
||||
scopes_column=\u041E\u0431\u043B\u0430\u0441\u0442\u0438 \u043F\u0440\u0438\u043C\u0435\u043D\u0435\u043D\u0438\u044F
|
||||
produces=\u0412\u043E\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442
|
||||
consumes=\u041F\u0440\u0438\u043D\u0438\u043C\u0430\u0435\u0442
|
||||
tags=\u0422\u044D\u0433\u0438
|
||||
tags=\u0422\u0435\u0433\u0438
|
||||
overview=\u041E\u0431\u0437\u043E\u0440
|
||||
current_version=\u0418\u043D\u0444\u043E\u0440\u043C\u0430\u0446\u0438\u044F \u043E \u0432\u0435\u0440\u0441\u0438\u0438
|
||||
version=\u0412\u0435\u0440\u0441\u0438\u044F
|
||||
contact_information=\u041A\u043E\u043D\u0442\u0430\u043A\u0442\u043D\u0430\u044F \u0438\u043D\u0444\u043E\u0440\u043C\u0430\u0446\u0438\u044F
|
||||
contact_name=\u041A\u043E\u043D\u0442\u0430\u043A\u0442
|
||||
contact_email=Email \u043A\u043E\u043D\u0442\u0430\u043A\u0442\u0430
|
||||
license_information=\u0418\u043D\u0444\u043E\u0440\u043C\u0430\u0446\u0438\u044F \u043E \u043B\u0438\u0446\u0435\u043D\u0446\u0438\u0438
|
||||
contact_email=E-mail \u043A\u043E\u043D\u0442\u0430\u043A\u0442\u0430
|
||||
license_information=\u0418\u043D\u0444\u043E\u0440\u043C\u0430\u0446\u0438\u044F \u043E \u043B\u0438\u0446\u0435\u043D\u0437\u0438\u0438
|
||||
license=\u041B\u0438\u0446\u0435\u043D\u0437\u0438\u044F
|
||||
license_url=URL \u043B\u0438\u0446\u0435\u043D\u0437\u0438\u0438
|
||||
terms_of_service=\u0423\u0441\u043B\u043E\u0432\u0438\u044F \u0438\u0441\u043F\u043E\u043B\u044C\u0437\u043E\u0432\u0430\u043D\u0438\u044F
|
||||
@@ -45,7 +45,7 @@ security_authorizationUrl=URL \u0430\u0432\u0442\u043E\u0440\u0438\u0437\u0430\u
|
||||
security_tokenUrl=URL \u0442\u043E\u043A\u0435\u043D\u0430
|
||||
paths=\u041F\u0443\u0442\u0438
|
||||
resources=\u0420\u0435\u0441\u0443\u0440\u0441\u044B
|
||||
operations=\u043E\u043F\u0435\u0440\u0430\u0446\u0438\u0438
|
||||
operations=\u041E\u043F\u0435\u0440\u0430\u0446\u0438\u0438
|
||||
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
|
||||
@@ -53,14 +53,17 @@ parameters=\u041F\u0430\u0440\u0430\u043C\u0435\u0442\u0440\u044B
|
||||
body_parameter=\u041F\u0430\u0440\u0430\u043C\u0435\u0442\u0440 \u0442\u0435\u043B\u0430 \u0437\u0430\u043F\u0440\u043E\u0441\u0430
|
||||
responses=\u041E\u0442\u0432\u0435\u0442\u044B
|
||||
example_request=\u041F\u0440\u0438\u043C\u0435\u0440 HTTP \u0437\u0430\u043F\u0440\u043E\u0441\u0430
|
||||
example_response=\u041F\u0440\u0438\u043C\u0435\u0440 HTTP \u0437\u0430\u043F\u0440\u043E\u0441\u0430
|
||||
example_response=\u041F\u0440\u0438\u043C\u0435\u0440 HTTP \u043E\u0442\u0432\u0435\u0442\u0430
|
||||
type_column=\u0422\u0438\u043F
|
||||
http_code_column=HTTP \u043A\u043E\u0434
|
||||
parameter=\u041F\u0430\u0440\u0430\u043C\u0435\u0442\u0440
|
||||
unknown=Unknown
|
||||
unknown=\u041D\u0435\u0438\u0437\u0432\u0435\u0441\u0442\u043D\u044B\u0439
|
||||
no_content=\u0411\u0435\u0437 \u0441\u043E\u0434\u0435\u0440\u0436\u0438\u043C\u043E\u0433\u043E
|
||||
operation.deprecated=\u042D\u0442\u0430 \u043E\u043F\u0435\u0440\u0430\u0446\u0438\u044F \u0443\u0441\u0442\u0430\u0440\u0435\u043B\u0430.
|
||||
polymorphism.column=Polymorphism
|
||||
polymorphism.discriminator=Discriminator
|
||||
polymorphism.nature.INHERITANCE=Inheritance
|
||||
polymorphism.nature.COMPOSITION=Composition
|
||||
polymorphism.column=\u041F\u043E\u043B\u0438\u043C\u043E\u0440\u0444\u0438\u0437\u043C
|
||||
polymorphism.discriminator=\u0414\u0438\u0441\u043A\u0440\u0438\u043C\u0438\u043D\u0430\u0442\u043E\u0440
|
||||
polymorphism.nature.INHERITANCE=\u041D\u0430\u0441\u043B\u0435\u0434\u043E\u0432\u0430\u043D\u0438\u0435
|
||||
polymorphism.nature.COMPOSITION=\u0421\u0442\u0440\u0443\u043A\u0442\u0443\u0440\u0430
|
||||
external_docs=External Docs
|
||||
external_docs_desc=Description
|
||||
external_docs_url=URL
|
||||
@@ -63,4 +63,7 @@ operation.deprecated=Bu i\u015Flem \u00F6nerilmemektedir.
|
||||
polymorphism.column=\u00C7okbi\u00E7imlilik
|
||||
polymorphism.discriminator=Ayr\u0131\u015Ft\u0131r\u0131c\u0131
|
||||
polymorphism.nature.INHERITANCE=Kal\u0131t\u0131m
|
||||
polymorphism.nature.COMPOSITION=Birle\u015Ftirme
|
||||
polymorphism.nature.COMPOSITION=Birle\u015Ftirme
|
||||
external_docs=External Docs
|
||||
external_docs_desc=Description
|
||||
external_docs_url=URL
|
||||
@@ -1,5 +1,5 @@
|
||||
definitions=\u5b9a\u4e49
|
||||
default_column=\u9ed8\u8ba4\u5217
|
||||
default_column=\u9ed8\u8ba4\u503c
|
||||
# validators
|
||||
minlength_column=\u6700\u5c0f\u957f\u5ea6
|
||||
maxlength_column=\u6700\u5927\u957f\u5ea6
|
||||
@@ -9,13 +9,13 @@ minvalue_column=\u6700\u5c0f\u503c
|
||||
minvalue_exclusive_column=\u6700\u5c0f\u503c(\u4e0d\u5305\u62ec)
|
||||
maxvalue_column=\u6700\u5927\u503c
|
||||
maxvalue_exclusive_column=\u6700\u5927\u503c(\u4e0d\u5305\u62ec)
|
||||
example_column=\u4f8b\u5b50
|
||||
example_column=\u6837\u4f8b
|
||||
flags.column=\u6807\u5fd7
|
||||
flags.required=\u5fc5\u586b
|
||||
flags.optional=\u53ef\u9009
|
||||
flags.read_only=\u53ea\u8bfb
|
||||
flags.read_write=\u8bfb\u5199
|
||||
schema_column=\u67b6\u6784
|
||||
schema_column=\u7c7b\u578b
|
||||
name_column=\u540d\u79f0
|
||||
description_column=\u8bf4\u660e
|
||||
headers_column=\u5934
|
||||
@@ -23,7 +23,7 @@ scopes_column=\u4f5c\u7528\u57df
|
||||
produces=\u751f\u6210
|
||||
consumes=\u6d88\u8017
|
||||
tags=\u6807\u7b7e
|
||||
overview=\u6982\u89c2
|
||||
overview=\u6982\u89c8
|
||||
current_version=\u7248\u672c\u4fe1\u606f
|
||||
version=\u7248\u672c
|
||||
contact_information=\u8054\u7cfb\u65b9\u5f0f
|
||||
@@ -64,3 +64,6 @@ polymorphism.column=\u591a\u6001\u6027
|
||||
polymorphism.discriminator=\u9274\u522b
|
||||
polymorphism.nature.INHERITANCE=\u7ee7\u627f
|
||||
polymorphism.nature.COMPOSITION=\u6210\u5206
|
||||
external_docs=External Docs
|
||||
external_docs_desc=Description
|
||||
external_docs_url=URL
|
||||
@@ -17,6 +17,7 @@ package io.github.swagger2markup;
|
||||
|
||||
import io.github.swagger2markup.assertions.DiffUtils;
|
||||
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
|
||||
import io.github.swagger2markup.markup.builder.MarkupLanguage;
|
||||
import org.apache.commons.io.FileUtils;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.junit.Before;
|
||||
@@ -522,6 +523,28 @@ public class AsciidocConverterTest {
|
||||
assertThat(paths).hasSize(18);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithAsciidocContentInTables() throws URISyntaxException {
|
||||
|
||||
//Given
|
||||
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore_with_adoc_content.yaml").toURI());
|
||||
Path outputDirectory = Paths.get("build/test/asciidoc/generated");
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
//When
|
||||
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
|
||||
.withSwaggerMarkupLanguage(MarkupLanguage.ASCIIDOC)
|
||||
.build();
|
||||
|
||||
Swagger2MarkupConverter.from(file).withConfig(config).build()
|
||||
.toFolder(outputDirectory);
|
||||
|
||||
//Then
|
||||
String[] files = outputDirectory.toFile().list();
|
||||
assertThat(files).hasSize(4).containsAll(expectedFiles);
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithRussianOutputLanguage() throws IOException, URISyntaxException {
|
||||
testWithOutputLanguage(Language.RU, "definitions.adoc", "== Определения");
|
||||
@@ -782,4 +805,28 @@ public class AsciidocConverterTest {
|
||||
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/page_breaks").toURI());
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testWithPageBreaks.html");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithEmptyTables() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/json/swagger_empty_tables.json"));
|
||||
Path outputDirectory = Paths.get("build/test/asciidoc/empty_tables");
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
//When
|
||||
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
|
||||
.withPageBreaks(new ArrayList<>(asList(PageBreakLocations.BEFORE_OPERATION, PageBreakLocations.BEFORE_OPERATION_EXAMPLE_REQUEST)))
|
||||
.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/empty_tables").toURI());
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testWithEmptyTables.html");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.assertions.DiffUtils;
|
||||
import io.github.swagger2markup.internal.document.OverviewDocument;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.swagger.models.ExternalDocs;
|
||||
import io.swagger.models.Swagger;
|
||||
import org.apache.commons.io.FileUtils;
|
||||
import org.junit.Assert;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import java.net.URISyntaxException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Path;
|
||||
import java.nio.file.Paths;
|
||||
|
||||
|
||||
public class ExternalDocsComponentTest extends AbstractComponentTest {
|
||||
|
||||
private static final String COMPONENT_NAME = "external_docs";
|
||||
private Path outputDirectory;
|
||||
|
||||
@Before
|
||||
public void setUp() {
|
||||
outputDirectory = getOutputFile(COMPONENT_NAME);
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testExternalDocsComponent() throws URISyntaxException {
|
||||
//Given
|
||||
Path file = Paths.get(DefinitionComponentTest.class.getResource("/yaml/swagger_petstore_20160612.yaml").toURI());
|
||||
Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(file).build();
|
||||
Swagger swagger = converter.getContext().getSwagger();
|
||||
|
||||
ExternalDocs externalDocs = swagger.getExternalDocs();
|
||||
Assert.assertNotNull(externalDocs);
|
||||
|
||||
Swagger2MarkupConverter.Context context = converter.getContext();
|
||||
MarkupDocBuilder markupDocBuilder = context.createMarkupDocBuilder();
|
||||
|
||||
//When
|
||||
markupDocBuilder = new ExternalDocsComponent(context).apply(markupDocBuilder, ExternalDocsComponent.parameters(externalDocs, OverviewDocument.SECTION_TITLE_LEVEL));
|
||||
markupDocBuilder.writeToFileWithoutExtension(outputDirectory, StandardCharsets.UTF_8);
|
||||
|
||||
//Then
|
||||
Path expectedFile = getExpectedFile(COMPONENT_NAME);
|
||||
DiffUtils.assertThatFileIsEqual(expectedFile, outputDirectory, getReportName(COMPONENT_NAME));
|
||||
|
||||
}
|
||||
}
|
||||
@@ -15,8 +15,10 @@
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.Swagger2MarkupConfig;
|
||||
import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.assertions.DiffUtils;
|
||||
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
|
||||
import io.github.swagger2markup.internal.resolver.DefinitionDocumentResolverFromOperation;
|
||||
import io.github.swagger2markup.internal.resolver.SecurityDocumentResolver;
|
||||
import io.github.swagger2markup.internal.utils.PathUtils;
|
||||
@@ -30,7 +32,9 @@ import java.net.URISyntaxException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Path;
|
||||
import java.nio.file.Paths;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
|
||||
public class PathOperationComponentTest extends AbstractComponentTest {
|
||||
@@ -96,5 +100,72 @@ public class PathOperationComponentTest extends AbstractComponentTest {
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithPathParamExample() throws URISyntaxException {
|
||||
String COMPONENT_NAME = "path_operation_with_path_param_example";
|
||||
Path outputDirectory = getOutputFile(COMPONENT_NAME);
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
Map<String, String> configMap = new HashMap<>();
|
||||
configMap.put("swagger2markup.generatedExamplesEnabled", "true"); // enable example
|
||||
|
||||
//Given
|
||||
Path file = Paths.get(PathOperationComponentTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
|
||||
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder(configMap).build();
|
||||
Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(file).withConfig(config) .build();
|
||||
Swagger swagger = converter.getContext().getSwagger();
|
||||
|
||||
io.swagger.models.Path path = swagger.getPaths().get("/pets/{petId}");
|
||||
List<PathOperation> pathOperations = PathUtils.toPathOperationsList("/pets/{petId}", path);
|
||||
|
||||
Swagger2MarkupConverter.Context context = converter.getContext();
|
||||
MarkupDocBuilder markupDocBuilder = context.createMarkupDocBuilder();
|
||||
|
||||
//When
|
||||
markupDocBuilder = new PathOperationComponent(context,
|
||||
new DefinitionDocumentResolverFromOperation(context),
|
||||
new SecurityDocumentResolver(context)).
|
||||
apply(markupDocBuilder, PathOperationComponent.parameters(pathOperations.get(0)));
|
||||
|
||||
markupDocBuilder.writeToFileWithoutExtension(outputDirectory, StandardCharsets.UTF_8);
|
||||
|
||||
//Then
|
||||
Path expectedFile = getExpectedFile(COMPONENT_NAME);
|
||||
DiffUtils.assertThatFileIsEqual(expectedFile, outputDirectory, getReportName(COMPONENT_NAME));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithQueryParamExample() throws URISyntaxException {
|
||||
String COMPONENT_NAME = "path_operation_with_query_param_example";
|
||||
Path outputDirectory = getOutputFile(COMPONENT_NAME);
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
Map<String, String> configMap = new HashMap<>();
|
||||
configMap.put("swagger2markup.generatedExamplesEnabled", "true"); // enable example
|
||||
|
||||
//Given
|
||||
Path file = Paths.get(PathOperationComponentTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
|
||||
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder(configMap).build();
|
||||
Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(file).withConfig(config) .build();
|
||||
Swagger swagger = converter.getContext().getSwagger();
|
||||
|
||||
io.swagger.models.Path path = swagger.getPaths().get("/pets/findByTags");
|
||||
List<PathOperation> pathOperations = PathUtils.toPathOperationsList("/pets/findByTags", path);
|
||||
|
||||
Swagger2MarkupConverter.Context context = converter.getContext();
|
||||
MarkupDocBuilder markupDocBuilder = context.createMarkupDocBuilder();
|
||||
|
||||
//When
|
||||
markupDocBuilder = new PathOperationComponent(context,
|
||||
new DefinitionDocumentResolverFromOperation(context),
|
||||
new SecurityDocumentResolver(context)).
|
||||
apply(markupDocBuilder, PathOperationComponent.parameters(pathOperations.get(0)));
|
||||
|
||||
markupDocBuilder.writeToFileWithoutExtension(outputDirectory, StandardCharsets.UTF_8);
|
||||
|
||||
//Then
|
||||
Path expectedFile = getExpectedFile(COMPONENT_NAME);
|
||||
DiffUtils.assertThatFileIsEqual(expectedFile, outputDirectory, getReportName(COMPONENT_NAME));
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -33,17 +33,21 @@ import java.nio.file.Paths;
|
||||
|
||||
public class SecuritySchemeDefinitionComponentTest extends AbstractComponentTest {
|
||||
|
||||
private static final String COMPONENT_NAME = "security_scheme_definition";
|
||||
private Path outputDirectory;
|
||||
private static final String O_AUTH_NAME = "security_scheme_definition_oauth";
|
||||
private static final String API_KEY_NAME = "security_scheme_definition_api_key";
|
||||
private Path oauthOutputDirectory;
|
||||
private Path apiKeyOutputDirectory;
|
||||
|
||||
@Before
|
||||
public void setUp() {
|
||||
outputDirectory = getOutputFile(COMPONENT_NAME);
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
oauthOutputDirectory = getOutputFile(O_AUTH_NAME);
|
||||
apiKeyOutputDirectory = getOutputFile(API_KEY_NAME);
|
||||
FileUtils.deleteQuietly(oauthOutputDirectory.toFile());
|
||||
FileUtils.deleteQuietly(apiKeyOutputDirectory.toFile());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSecuritySchemeDefinitionComponent() throws URISyntaxException {
|
||||
public void testSecuritySchemeDefinitionComponentWithOAuth() throws URISyntaxException {
|
||||
//Given
|
||||
Path file = Paths.get(SecuritySchemeDefinitionComponentTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
|
||||
Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(file).build();
|
||||
@@ -58,10 +62,35 @@ public class SecuritySchemeDefinitionComponentTest extends AbstractComponentTest
|
||||
markupDocBuilder, SecuritySchemeDefinitionComponent.parameters("petstore_auth",
|
||||
securitySchemeDefinition,
|
||||
OverviewDocument.SECTION_TITLE_LEVEL));
|
||||
markupDocBuilder.writeToFileWithoutExtension(outputDirectory, StandardCharsets.UTF_8);
|
||||
markupDocBuilder.writeToFileWithoutExtension(oauthOutputDirectory, StandardCharsets.UTF_8);
|
||||
|
||||
Path expectedFile = getExpectedFile(COMPONENT_NAME);
|
||||
DiffUtils.assertThatFileIsEqual(expectedFile, outputDirectory, getReportName(COMPONENT_NAME));
|
||||
Path expectedFile = getExpectedFile(O_AUTH_NAME);
|
||||
DiffUtils.assertThatFileIsEqual(expectedFile, oauthOutputDirectory, getReportName(O_AUTH_NAME));
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSecuritySchemeDefinitionComponentWithApiKey() throws URISyntaxException {
|
||||
//Given
|
||||
Path file = Paths.get(SecuritySchemeDefinitionComponentTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
|
||||
Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(file).build();
|
||||
Swagger swagger = converter.getContext().getSwagger();
|
||||
|
||||
SecuritySchemeDefinition securitySchemeDefinition = swagger.getSecurityDefinitions().get("api_key");
|
||||
|
||||
Swagger2MarkupConverter.Context context = converter.getContext();
|
||||
MarkupDocBuilder markupDocBuilder = context.createMarkupDocBuilder();
|
||||
|
||||
markupDocBuilder = new SecuritySchemeDefinitionComponent(context).apply(
|
||||
markupDocBuilder, SecuritySchemeDefinitionComponent.parameters("api_key",
|
||||
securitySchemeDefinition,
|
||||
OverviewDocument.SECTION_TITLE_LEVEL));
|
||||
markupDocBuilder.writeToFileWithoutExtension(apiKeyOutputDirectory, StandardCharsets.UTF_8);
|
||||
|
||||
Path expectedFile = getExpectedFile(API_KEY_NAME);
|
||||
DiffUtils.assertThatFileIsEqual(expectedFile, apiKeyOutputDirectory, getReportName(API_KEY_NAME));
|
||||
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
|
||||
8
src/test/resources/component/external_docs.adoc
Normal file
8
src/test/resources/component/external_docs.adoc
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
=== External Docs
|
||||
[%hardbreaks]
|
||||
__Description__ : Find out more about Swagger
|
||||
__URL__ : http://swagger.io
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
|
||||
@@ -8,7 +8,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -18,7 +18,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -46,7 +46,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
|
||||
@@ -12,7 +12,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**Option** +
|
||||
@@ -26,7 +26,7 @@ __optional__|Launch something new|<<_launchcommand_post_launchcommandrequest,Lau
|
||||
[[_launchcommand_post_launchcommandrequest]]
|
||||
**LaunchCommandRequest**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Command** +
|
||||
@@ -40,7 +40,7 @@ __optional__|Options k/v pairs|< <<_launchcommand_post_options,Options>> > array
|
||||
[[_launchcommand_post_command]]
|
||||
**Command**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**args** +
|
||||
@@ -52,7 +52,7 @@ __optional__|Command path|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -64,7 +64,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result +
|
||||
@@ -78,7 +78,7 @@ __optional__|option value|string
|
||||
[[_launchcommand_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Location** +
|
||||
@@ -92,7 +92,7 @@ __optional__|<description>|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
|
||||
[[_getpetbyid]]
|
||||
=== Find pet by ID
|
||||
....
|
||||
GET /pets/{petId}
|
||||
....
|
||||
|
||||
|
||||
==== Description
|
||||
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
|
||||
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
__required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
**Headers** : +
|
||||
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
|
||||
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
|
||||
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_pet,Pet>>
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
|**404**|Pet not found|No Content
|
||||
|===
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `application/json`
|
||||
* `application/xml`
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
|===
|
||||
|
||||
|
||||
==== Example HTTP request
|
||||
|
||||
===== Request path
|
||||
----
|
||||
/pets/30
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"id" : 0,
|
||||
"category" : {
|
||||
"id" : 0,
|
||||
"name" : "FoobarCategory"
|
||||
},
|
||||
"name" : "doggie",
|
||||
"photoUrls" : [ "string" ],
|
||||
"tags" : [ {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
} ],
|
||||
"status" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,96 @@
|
||||
|
||||
[[_findpetsbytags]]
|
||||
=== Finds Pets by tags
|
||||
....
|
||||
GET /pets/findByTags
|
||||
....
|
||||
|
||||
|
||||
==== Description
|
||||
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
__optional__|Tags to filter by|< string > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
**Headers** : +
|
||||
`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. +
|
||||
`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. +
|
||||
`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<_pet,Pet>> > array
|
||||
|**400**|Invalid tag value|No Content
|
||||
|===
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `application/json`
|
||||
* `application/xml`
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
|===
|
||||
|
||||
|
||||
==== Example HTTP request
|
||||
|
||||
===== Request path
|
||||
----
|
||||
/pets/findByTags
|
||||
----
|
||||
|
||||
|
||||
===== Request query
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"tags" : "adorable"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
[source,json]
|
||||
----
|
||||
[ {
|
||||
"id" : 0,
|
||||
"category" : {
|
||||
"id" : 0,
|
||||
"name" : "FoobarCategory"
|
||||
},
|
||||
"name" : "doggie",
|
||||
"photoUrls" : [ "string" ],
|
||||
"tags" : [ {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
} ],
|
||||
"status" : "string"
|
||||
} ]
|
||||
----
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
This is a standard oauth flow
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
This is another description
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
This is a standard oauth flow
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
|
||||
[options="header", cols=".^0,.^0"]
|
||||
[options="header", cols=".^0a,.^0a"]
|
||||
|===
|
||||
|type|name
|
||||
|type1|name1
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|**Example** : `"Canines"`|string
|
||||
[[_complexobject]]
|
||||
=== ComplexObject
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**subObject** +
|
||||
@@ -31,7 +31,7 @@ __optional__|**Example** : `{
|
||||
[[_subobject]]
|
||||
**SubObject**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -44,7 +44,7 @@ __optional__|**Example** : `"a value !"`|string
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -55,7 +55,7 @@ __optional__|**Example** : `0`|integer (int64)
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -79,11 +79,11 @@ __optional__|Order Status +
|
||||
Test description
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
__optional__|**Example** : `"<<_category>>"`|<<_category,Category>>
|
||||
__optional__|**Example** : <<_category>>|<<_category,Category>>
|
||||
|**id** +
|
||||
__optional__|**Example** : `0`|integer (int64)
|
||||
|**name** +
|
||||
@@ -108,7 +108,7 @@ __optional__|the weight of the pet +
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -124,7 +124,7 @@ __optional__|**Example** : `"string"`|string
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -11,7 +11,7 @@ POST /v2/pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -21,7 +21,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -47,7 +47,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -115,7 +115,7 @@ PUT /v2/pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -125,7 +125,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -153,7 +153,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -205,7 +205,7 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
@@ -215,7 +215,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -236,7 +236,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -299,7 +299,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -309,7 +309,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -330,7 +330,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -389,7 +389,7 @@ POST /v2/pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -403,7 +403,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -428,7 +428,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -463,7 +463,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -473,7 +473,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_pet,Pet>>
|
||||
@@ -495,7 +495,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -546,7 +546,7 @@ DELETE /v2/pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -558,7 +558,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -578,7 +578,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -609,7 +609,7 @@ POST /v2/stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -619,7 +619,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -689,7 +689,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -699,7 +699,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -756,7 +756,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -766,7 +766,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -806,7 +806,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -816,7 +816,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -868,7 +868,7 @@ POST /v2/users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -878,7 +878,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -930,7 +930,7 @@ POST /v2/users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -940,7 +940,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -992,7 +992,7 @@ GET /v2/users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**password** +
|
||||
@@ -1004,7 +1004,7 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|string
|
||||
@@ -1059,7 +1059,7 @@ GET /v2/users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -1094,7 +1094,7 @@ GET /v2/users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Path**|**username** +
|
||||
@@ -1104,7 +1104,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string|`"
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_user,User>>
|
||||
@@ -1164,7 +1164,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -1176,7 +1176,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -1233,7 +1233,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -1243,7 +1243,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,22 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +10,20 @@ __Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
|
||||
[[_definitions]]
|
||||
== Definitions
|
||||
|
||||
[[_category]]
|
||||
=== Category
|
||||
[%hardbreaks]
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
__optional__|integer (int64)
|
||||
|===
|
||||
|
||||
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
__optional__|integer (int64)
|
||||
|===
|
||||
|
||||
|
||||
[[_user]]
|
||||
=== User
|
||||
[%hardbreaks]
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
__optional__|integer (int64)
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
= Swagger Petstore API
|
||||
|
||||
|
||||
[[_overview]]
|
||||
== Overview
|
||||
This is a sample server Petstore server.
|
||||
|
||||
http://swagger.wordnik.com[Learn about Swagger] or join the IRC channel `#swagger` on irc.freenode.net.
|
||||
|
||||
For this sample, you can use the api key `special-key` to test the authorization filters
|
||||
|
||||
|
||||
=== Version information
|
||||
[%hardbreaks]
|
||||
__Version__ : 1.0.0
|
||||
|
||||
|
||||
=== Contact information
|
||||
[%hardbreaks]
|
||||
__Contact__ : apiteam@wordnik.com
|
||||
|
||||
|
||||
=== License information
|
||||
[%hardbreaks]
|
||||
__License__ : Apache 2.0
|
||||
__License URL__ : http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
__Terms of service__ : http://helloreverb.com/terms/
|
||||
|
||||
|
||||
=== URI scheme
|
||||
[%hardbreaks]
|
||||
__Host__ : petstore.swagger.wordnik.com
|
||||
__BasePath__ : /v2
|
||||
__Schemes__ : HTTP
|
||||
|
||||
|
||||
=== Tags
|
||||
|
||||
* user : User resource
|
||||
|
||||
|
||||
|
||||
48
src/test/resources/expected/asciidoc/empty_tables/paths.adoc
Normal file
48
src/test/resources/expected/asciidoc/empty_tables/paths.adoc
Normal file
@@ -0,0 +1,48 @@
|
||||
|
||||
[[_paths]]
|
||||
== Paths
|
||||
|
||||
<<<
|
||||
|
||||
[[_createuser]]
|
||||
=== Create user
|
||||
....
|
||||
POST /users
|
||||
....
|
||||
|
||||
|
||||
==== Description
|
||||
This can only be done by the logged in user.
|
||||
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
__optional__|Created user object|<<_user,User>>
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
|===
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `application/json`
|
||||
* `application/xml`
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ Return state
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**oldState** +
|
||||
@@ -27,7 +27,7 @@ __optional__|State as enum in object|<<_createstate_statemodel,StateModel>>
|
||||
[[_createstate_statemodel]]
|
||||
**StateModel**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**value** +
|
||||
@@ -37,7 +37,7 @@ __optional__|State value|enum (ADDED, REMOVED, CHANGED)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|enum (ADDED, REMOVED, CHANGED)
|
||||
@@ -51,7 +51,7 @@ __optional__|State value|enum (ADDED, REMOVED, CHANGED)
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
* `\*/*`
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|**Example** : `"Canines"`|string
|
||||
[[_complexobject]]
|
||||
=== ComplexObject
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**subObject** +
|
||||
@@ -31,7 +31,7 @@ __optional__|**Example** : `{
|
||||
[[_subobject]]
|
||||
**SubObject**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -44,7 +44,7 @@ __optional__|**Example** : `"a value !"`|string
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -55,7 +55,7 @@ __optional__|integer (int64)
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -79,7 +79,7 @@ __optional__|Order Status +
|
||||
Test description
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -104,7 +104,7 @@ __optional__|the weight of the pet|number
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -120,7 +120,7 @@ __optional__|string
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -11,7 +11,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -21,7 +21,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -47,7 +47,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -83,7 +83,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -93,7 +93,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -121,7 +121,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -141,7 +141,7 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
@@ -151,7 +151,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -172,7 +172,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -192,7 +192,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -202,7 +202,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -223,7 +223,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -239,7 +239,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -253,7 +253,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -278,7 +278,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -298,7 +298,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -308,7 +308,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_pet,Pet>>
|
||||
@@ -330,7 +330,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -347,7 +347,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -359,7 +359,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -379,7 +379,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -395,7 +395,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -405,7 +405,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -469,7 +469,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -479,7 +479,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -528,7 +528,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -538,7 +538,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -570,7 +570,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -580,7 +580,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -607,7 +607,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -617,7 +617,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -644,7 +644,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -654,7 +654,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -681,7 +681,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**password** +
|
||||
@@ -693,7 +693,7 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|string
|
||||
@@ -721,7 +721,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -748,7 +748,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Path**|**username** +
|
||||
@@ -758,7 +758,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string|`"
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_user,User>>
|
||||
@@ -791,7 +791,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -803,7 +803,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -835,7 +835,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -845,7 +845,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,22 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +10,20 @@ __Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ __Type__ : < integer (test) > array
|
||||
[[_integerobj]]
|
||||
=== IntegerObj
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -31,7 +31,7 @@ __Type__ : < string (test) > array
|
||||
[[_stringobj]]
|
||||
=== StringObj
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**intParam** +
|
||||
@@ -23,7 +23,7 @@ __required__|test string in query|string (test)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result|string (test)
|
||||
@@ -37,7 +37,7 @@ __required__|test string in query|string (test)
|
||||
[[_c_param_intparam_get_response_201]]
|
||||
**Response 201**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -47,7 +47,7 @@ __optional__|string (test)
|
||||
[[_c_param_intparam_get_response_202]]
|
||||
**Response 202**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -57,7 +57,7 @@ __optional__|< string (test) > array
|
||||
[[_c_param_intparam_get_response_204]]
|
||||
**Response 204**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -67,7 +67,7 @@ __optional__|integer (test)
|
||||
[[_c_param_intparam_get_response_205]]
|
||||
**Response 205**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -85,7 +85,7 @@ __optional__|< integer (test) > array
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -103,7 +103,7 @@ __required__|test integer str in body|< integer (test) > array
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -113,7 +113,7 @@ __required__|test integer str in body|<<_integerobj_get_body,body>>
|
||||
[[_integerobj_get_body]]
|
||||
**body**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -131,7 +131,7 @@ __optional__|integer (test)
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -149,7 +149,7 @@ __required__|test integer str in body|integer (test)
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -167,7 +167,7 @@ __required__|test string str in body|< string (test) > array
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -177,7 +177,7 @@ __required__|test string str in body|<<_stringobj_get_body,body>>
|
||||
[[_stringobj_get_body]]
|
||||
**body**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -195,7 +195,7 @@ __optional__|string (test)
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*id* +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*complete* +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*category* +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*email* +
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|string
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|**Example** : `"Canines"`|string
|
||||
[[_complexobject]]
|
||||
=== ComplexObject
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**subObject** +
|
||||
@@ -31,7 +31,7 @@ __optional__|**Example** : `{
|
||||
[[_subobject]]
|
||||
**SubObject**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -44,7 +44,7 @@ __optional__|**Example** : `"a value !"`|string
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -55,7 +55,7 @@ __optional__|**Example** : `0`|integer (int64)
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -79,11 +79,11 @@ __optional__|Order Status +
|
||||
Test description
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
__optional__|**Example** : `"<<_category>>"`|<<_category,Category>>
|
||||
__optional__|**Example** : <<_category>>|<<_category,Category>>
|
||||
|**id** +
|
||||
__optional__|**Example** : `0`|integer (int64)
|
||||
|**name** +
|
||||
@@ -108,7 +108,7 @@ __optional__|the weight of the pet +
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -124,7 +124,7 @@ __optional__|**Example** : `"string"`|string
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -11,7 +11,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -21,7 +21,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -47,7 +47,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -115,7 +115,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -125,7 +125,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -153,7 +153,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -205,7 +205,7 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
@@ -215,7 +215,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -236,7 +236,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -299,7 +299,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -309,7 +309,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -330,7 +330,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -389,7 +389,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -403,7 +403,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -428,7 +428,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -463,7 +463,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -473,7 +473,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_pet,Pet>>
|
||||
@@ -495,7 +495,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -546,7 +546,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -558,7 +558,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -578,7 +578,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -609,7 +609,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -619,7 +619,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -689,7 +689,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -699,7 +699,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -756,7 +756,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -766,7 +766,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -806,7 +806,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -816,7 +816,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -868,7 +868,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -878,7 +878,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -930,7 +930,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -940,7 +940,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -992,7 +992,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**password** +
|
||||
@@ -1004,7 +1004,7 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|string
|
||||
@@ -1059,7 +1059,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -1094,7 +1094,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Path**|**username** +
|
||||
@@ -1104,7 +1104,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string|`"
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_user,User>>
|
||||
@@ -1164,7 +1164,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -1176,7 +1176,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -1233,7 +1233,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -1243,7 +1243,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,22 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +10,20 @@ __Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_navigationentry]]
|
||||
=== NavigationEntry
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**childs** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Returns the navigation as a tree
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Successful response|<<_navigationentry,NavigationEntry>>
|
||||
@@ -63,7 +63,7 @@ Updates the navigation tree
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Schema
|
||||
|**Body**|**entry** +
|
||||
@@ -73,7 +73,7 @@ __optional__|<<_navigationentry,NavigationEntry>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Successful response|<<_navigationentry,NavigationEntry>>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -22,7 +22,7 @@ __optional__|The name of the category +
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -46,7 +46,7 @@ __optional__|Order Status|enum (Ordered, Cancelled)
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -67,7 +67,7 @@ __optional__||< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -80,7 +80,7 @@ __optional__|string
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -41,4 +41,10 @@ __Schemes__ : HTTP
|
||||
* user : User resource
|
||||
|
||||
|
||||
=== External Docs
|
||||
[%hardbreaks]
|
||||
__Description__ : Find out more about Swagger
|
||||
__URL__ : http://swagger.io
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ POST /pets
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -26,7 +26,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -47,7 +47,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
===== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -63,7 +63,7 @@ PUT /pets
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -73,7 +73,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -96,7 +96,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
===== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -116,7 +116,7 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
@@ -126,7 +126,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -146,7 +146,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
===== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -166,7 +166,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -176,7 +176,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -196,7 +196,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
===== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -212,7 +212,7 @@ POST /pets/{petId}
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -226,7 +226,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -246,7 +246,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
===== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -266,7 +266,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -276,7 +276,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -297,7 +297,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
===== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -314,7 +314,7 @@ DELETE /pets/{petId}
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -326,7 +326,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -341,7 +341,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
===== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -362,7 +362,7 @@ POST /stores/order
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -372,7 +372,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -403,7 +403,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -413,7 +413,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -445,7 +445,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -455,7 +455,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -487,7 +487,7 @@ This can only be done by the logged in user.
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -497,7 +497,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -519,7 +519,7 @@ POST /users/createWithArray
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -529,7 +529,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -551,7 +551,7 @@ POST /users/createWithList
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -561,7 +561,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -583,7 +583,7 @@ GET /users/login
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**password** +
|
||||
@@ -595,7 +595,7 @@ __optional__|The user name for login|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -622,7 +622,7 @@ GET /users/logout
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -644,7 +644,7 @@ GET /users/{username}
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -654,7 +654,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -686,7 +686,7 @@ This can only be done by the logged in user.
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -698,7 +698,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -725,7 +725,7 @@ This can only be done by the logged in user.
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -735,7 +735,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,15 +2,27 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
This is another description
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
This is a standard oauth flow
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -18,12 +30,4 @@ __Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -22,7 +22,7 @@ __optional__|The name of the category +
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -46,7 +46,7 @@ __optional__|Order Status|enum (Ordered, Cancelled)
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -67,7 +67,7 @@ __optional__||< <<definitions.adoc#_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -80,7 +80,7 @@ __optional__|string
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -41,4 +41,10 @@ __Schemes__ : HTTP
|
||||
* user : User resource
|
||||
|
||||
|
||||
=== External Docs
|
||||
[%hardbreaks]
|
||||
__Description__ : Find out more about Swagger
|
||||
__URL__ : http://swagger.io
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -21,7 +21,7 @@ __optional__|Pet object that needs to be added to the store|<<definitions.adoc#_
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -47,7 +47,7 @@ __optional__|Pet object that needs to be added to the store|<<definitions.adoc#_
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<security.adoc#_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -63,7 +63,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -73,7 +73,7 @@ __optional__|Pet object that needs to be added to the store|<<definitions.adoc#_
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -101,7 +101,7 @@ __optional__|Pet object that needs to be added to the store|<<definitions.adoc#_
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<security.adoc#_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -121,7 +121,7 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
@@ -131,7 +131,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -156,7 +156,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<security.adoc#_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -176,7 +176,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -186,7 +186,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -211,7 +211,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<security.adoc#_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -227,7 +227,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -241,7 +241,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -266,7 +266,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<security.adoc#_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -286,7 +286,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -296,7 +296,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -322,7 +322,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<security.adoc#_api_key,api_key>>**|
|
||||
@@ -339,7 +339,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -351,7 +351,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -371,7 +371,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<security.adoc#_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -387,7 +387,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -397,7 +397,7 @@ __optional__|order placed for purchasing the pet|<<definitions.adoc#_order,Order
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -433,7 +433,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -443,7 +443,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -480,7 +480,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -490,7 +490,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -522,7 +522,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -532,7 +532,7 @@ __optional__|Created user object|<<definitions.adoc#_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -559,7 +559,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -569,7 +569,7 @@ __optional__|List of user object|< <<definitions.adoc#_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -596,7 +596,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -606,7 +606,7 @@ __optional__|List of user object|< <<definitions.adoc#_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -633,7 +633,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**password** +
|
||||
@@ -645,7 +645,7 @@ __optional__|The user name for login|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -677,7 +677,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -704,7 +704,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -714,7 +714,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -751,7 +751,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -763,7 +763,7 @@ __optional__|Updated user object|<<definitions.adoc#_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -795,7 +795,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -805,7 +805,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,15 +2,27 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
This is another description
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
This is a standard oauth flow
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -18,12 +30,4 @@ __Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_error]]
|
||||
=== Error
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**error-code** +
|
||||
@@ -18,7 +18,7 @@ __optional__|Error message|string
|
||||
[[_inlinedepthschema]]
|
||||
=== InlineDepthSchema
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**Loop** +
|
||||
@@ -28,7 +28,7 @@ __optional__|<<_inlinedepthschema_loop,Loop>>
|
||||
[[_inlinedepthschema_loop]]
|
||||
**Loop**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p1** +
|
||||
@@ -40,7 +40,7 @@ __optional__|Description p2|<<_inlinedepthschema_p2,p2>>
|
||||
[[_inlinedepthschema_p2]]
|
||||
**p2**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-1** +
|
||||
@@ -52,7 +52,7 @@ __optional__|Description p2-2|<<_inlinedepthschema_p2_p2-2,p2-2>>
|
||||
[[_inlinedepthschema_p2_p2-2]]
|
||||
**p2-2**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-2-1** +
|
||||
@@ -64,7 +64,7 @@ __optional__|Description p2-2-2|<<_inlinedepthschema_p2_p2-2_p2-2-2,p2-2-2>>
|
||||
[[_inlinedepthschema_p2_p2-2_p2-2-1]]
|
||||
**p2-2-1**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-2-1-1** +
|
||||
@@ -76,7 +76,7 @@ __optional__|Description p2-2-1-2|boolean
|
||||
[[_inlinedepthschema_p2_p2-2_p2-2-2]]
|
||||
**p2-2-2**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-2-2-1** +
|
||||
@@ -89,7 +89,7 @@ __optional__|Description p2-2-2-2|boolean
|
||||
[[_inlinepet]]
|
||||
=== InlinePet
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**category** +
|
||||
@@ -103,7 +103,7 @@ __optional__|< <<_inlinepet_tags,tags>> > array
|
||||
[[_inlinepet_category]]
|
||||
**category**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -115,7 +115,7 @@ __optional__|string
|
||||
[[_inlinepet_tags]]
|
||||
**tags**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -128,7 +128,7 @@ __optional__|string
|
||||
[[_inlinetitlepet]]
|
||||
=== InlineTitlePet
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**category** +
|
||||
@@ -142,7 +142,7 @@ __optional__|< <<_tagmodel,TagModel>> > array
|
||||
[[_categorymodel]]
|
||||
**CategoryModel**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -154,7 +154,7 @@ __optional__|string
|
||||
[[_tagmodel]]
|
||||
**TagModel**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -167,7 +167,7 @@ __optional__|string
|
||||
[[_location]]
|
||||
=== Location
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Place** +
|
||||
@@ -180,7 +180,7 @@ __optional__|Place|string
|
||||
mixed collections and objects
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -190,7 +190,7 @@ __optional__|< <<_mixedschema_mytable,myTable>> > array
|
||||
[[_mixedschema_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -200,7 +200,7 @@ __optional__|< string, <<_mixedschema_mydict,myDict>> > map
|
||||
[[_mixedschema_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -219,7 +219,7 @@ __Type__ : < < string, <<_recursivecollectionschema_inline,RecursiveCollectionSc
|
||||
[[_recursivecollectionschema_inline]]
|
||||
**RecursiveCollectionSchema**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -234,7 +234,7 @@ __optional__|option value|string
|
||||
mixed collections and objects
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -244,7 +244,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**emptyObject** +
|
||||
@@ -256,7 +256,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**Version** +
|
||||
@@ -25,7 +25,7 @@ __optional__|The API version|< < string, <<_collectionparameters_post_version,Ve
|
||||
[[_collectionparameters_post_version]]
|
||||
**Version**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -37,7 +37,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result|< < string, <<_collectionparameters_post_response_200,Response 200>> > map > array
|
||||
@@ -46,7 +46,7 @@ __optional__|option value|string
|
||||
[[_collectionparameters_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -74,7 +74,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**Option** +
|
||||
@@ -88,7 +88,7 @@ __optional__|Launch something new|<<_launchcommand_post_launchcommandrequest,Lau
|
||||
[[_launchcommand_post_launchcommandrequest]]
|
||||
**LaunchCommandRequest**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Command** +
|
||||
@@ -102,7 +102,7 @@ __optional__|Options k/v pairs|< <<_launchcommand_post_options,Options>> > array
|
||||
[[_launchcommand_post_command]]
|
||||
**Command**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**args** +
|
||||
@@ -114,7 +114,7 @@ __optional__|Command path|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -126,7 +126,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result +
|
||||
@@ -140,7 +140,7 @@ __optional__|option value|string
|
||||
[[_launchcommand_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Location** +
|
||||
@@ -154,7 +154,7 @@ __optional__|<description>|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -182,7 +182,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**Version** +
|
||||
@@ -192,7 +192,7 @@ __optional__|The API version|<<_mixedparameters_post_version,Version>>
|
||||
[[_mixedparameters_post_version]]
|
||||
**Version**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -202,7 +202,7 @@ __optional__|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
[[_mixedparameters_post_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -212,7 +212,7 @@ __optional__|< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
|
||||
[[_mixedparameters_post_mytable_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -224,7 +224,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result|<<_mixedparameters_post_response_200,Response 200>>
|
||||
@@ -233,7 +233,7 @@ __optional__|string
|
||||
[[_mixedparameters_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -243,7 +243,7 @@ __optional__|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
[[_mixedparameters_post_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -253,7 +253,7 @@ __optional__|< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
|
||||
[[_mixedparameters_post_mytable_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -281,7 +281,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**Version** +
|
||||
@@ -291,7 +291,7 @@ __optional__|The API version|<<_request,Request>>
|
||||
[[_request]]
|
||||
**Request**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -301,7 +301,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -311,7 +311,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -323,7 +323,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result|<<_result,Result>>
|
||||
@@ -332,7 +332,7 @@ __optional__|string
|
||||
[[_result]]
|
||||
**Result**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -342,7 +342,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -352,7 +352,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_error]]
|
||||
=== Error
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**error-code** +
|
||||
@@ -18,7 +18,7 @@ __optional__|Error message|string
|
||||
[[_inlinedepthschema]]
|
||||
=== InlineDepthSchema
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**Loop** +
|
||||
@@ -28,7 +28,7 @@ __optional__|<<_inlinedepthschema_loop,Loop>>
|
||||
[[_inlinedepthschema_loop]]
|
||||
**Loop**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p1** +
|
||||
@@ -40,7 +40,7 @@ __optional__|Description p2|<<_inlinedepthschema_p2,p2>>
|
||||
[[_inlinedepthschema_p2]]
|
||||
**p2**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-1** +
|
||||
@@ -52,7 +52,7 @@ __optional__|Description p2-2|<<_inlinedepthschema_p2_p2-2,p2-2>>
|
||||
[[_inlinedepthschema_p2_p2-2]]
|
||||
**p2-2**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-2-1** +
|
||||
@@ -64,7 +64,7 @@ __optional__|Description p2-2-2|<<_inlinedepthschema_p2_p2-2_p2-2-2,p2-2-2>>
|
||||
[[_inlinedepthschema_p2_p2-2_p2-2-1]]
|
||||
**p2-2-1**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-2-1-1** +
|
||||
@@ -76,7 +76,7 @@ __optional__|Description p2-2-1-2|boolean
|
||||
[[_inlinedepthschema_p2_p2-2_p2-2-2]]
|
||||
**p2-2-2**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-2-2-1** +
|
||||
@@ -89,7 +89,7 @@ __optional__|Description p2-2-2-2|boolean
|
||||
[[_inlinepet]]
|
||||
=== InlinePet
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**category** +
|
||||
@@ -103,7 +103,7 @@ __optional__|< <<_inlinepet_tags,tags>> > array
|
||||
[[_inlinepet_category]]
|
||||
**category**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -115,7 +115,7 @@ __optional__|string
|
||||
[[_inlinepet_tags]]
|
||||
**tags**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -128,7 +128,7 @@ __optional__|string
|
||||
[[_inlinetitlepet]]
|
||||
=== InlineTitlePet
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**category** +
|
||||
@@ -142,7 +142,7 @@ __optional__|< <<_tagmodel,TagModel>> > array
|
||||
[[_categorymodel]]
|
||||
**CategoryModel**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -154,7 +154,7 @@ __optional__|string
|
||||
[[_tagmodel]]
|
||||
**TagModel**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -167,7 +167,7 @@ __optional__|string
|
||||
[[_location]]
|
||||
=== Location
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Place** +
|
||||
@@ -180,7 +180,7 @@ __optional__|Place|string
|
||||
mixed collections and objects
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -190,7 +190,7 @@ __optional__|< <<_mixedschema_mytable,myTable>> > array
|
||||
[[_mixedschema_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -200,7 +200,7 @@ __optional__|< string, <<_mixedschema_mydict,myDict>> > map
|
||||
[[_mixedschema_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -219,7 +219,7 @@ __Type__ : < < string, <<_recursivecollectionschema_inline,RecursiveCollectionSc
|
||||
[[_recursivecollectionschema_inline]]
|
||||
**RecursiveCollectionSchema**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -234,7 +234,7 @@ __optional__|option value|string
|
||||
mixed collections and objects
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -244,7 +244,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**emptyObject** +
|
||||
@@ -256,7 +256,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
|
||||
@@ -24,7 +24,7 @@ __Type__ : < < string, <<_collectionparameters_post_version,Version>> > map > ar
|
||||
[[_collectionparameters_post_version]]
|
||||
**Version**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -36,7 +36,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result|< < string, <<_collectionparameters_post_response_200,Response 200>> > map > array
|
||||
@@ -45,7 +45,7 @@ __optional__|option value|string
|
||||
[[_collectionparameters_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -73,7 +73,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**Option** +
|
||||
@@ -91,7 +91,7 @@ __Name__ : LaunchCommandRequest
|
||||
__Flags__ : optional
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Command** +
|
||||
@@ -105,7 +105,7 @@ __optional__|Options k/v pairs|< <<_launchcommand_post_options,Options>> > array
|
||||
[[_launchcommand_post_command]]
|
||||
**Command**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**args** +
|
||||
@@ -117,7 +117,7 @@ __optional__|Command path|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -129,7 +129,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result +
|
||||
@@ -143,7 +143,7 @@ __optional__|option value|string
|
||||
[[_launchcommand_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Location** +
|
||||
@@ -157,7 +157,7 @@ __optional__|<description>|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -191,7 +191,7 @@ __Name__ : Version
|
||||
__Flags__ : optional
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -201,7 +201,7 @@ __optional__|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
[[_mixedparameters_post_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -211,7 +211,7 @@ __optional__|< string, <<_mixedparameters_post_mydict,myDict>> > map
|
||||
[[_mixedparameters_post_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -223,7 +223,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result|<<_mixedparameters_post_response_200,Response 200>>
|
||||
@@ -232,7 +232,7 @@ __optional__|string
|
||||
[[_mixedparameters_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -242,7 +242,7 @@ __optional__|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
[[_mixedparameters_post_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -252,7 +252,7 @@ __optional__|< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
|
||||
[[_mixedparameters_post_mytable_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -286,7 +286,7 @@ __Name__ : Version
|
||||
__Flags__ : optional
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -296,7 +296,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -306,7 +306,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -318,7 +318,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result|<<_result,Result>>
|
||||
@@ -327,7 +327,7 @@ __optional__|string
|
||||
[[_result]]
|
||||
**Result**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -337,7 +337,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -347,7 +347,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_comment]]
|
||||
=== Comment
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**created_time** +
|
||||
@@ -22,7 +22,7 @@ __optional__|string
|
||||
[[_image]]
|
||||
=== Image
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**height** +
|
||||
@@ -37,7 +37,7 @@ __optional__|integer
|
||||
[[_like]]
|
||||
=== Like
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**first_name** +
|
||||
@@ -56,7 +56,7 @@ __optional__|string
|
||||
[[_location]]
|
||||
=== Location
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -73,7 +73,7 @@ __optional__|string
|
||||
[[_media]]
|
||||
=== Media
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**comments:** +
|
||||
@@ -105,7 +105,7 @@ __optional__||<<_media_videos,videos>>
|
||||
[[_media_comments]]
|
||||
**comments:**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**count** +
|
||||
@@ -117,7 +117,7 @@ __optional__|< <<_comment,Comment>> > array
|
||||
[[_media_images]]
|
||||
**images**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**low_resolution** +
|
||||
@@ -131,7 +131,7 @@ __optional__|<<_image,Image>>
|
||||
[[_media_likes]]
|
||||
**likes**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**count** +
|
||||
@@ -143,7 +143,7 @@ __optional__|< <<_miniprofile,MiniProfile>> > array
|
||||
[[_media_videos]]
|
||||
**videos**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**low_resolution** +
|
||||
@@ -158,7 +158,7 @@ __optional__|<<_image,Image>>
|
||||
A shorter version of User for likes array
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**full_name** +
|
||||
@@ -175,7 +175,7 @@ __optional__|string
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**media_count** +
|
||||
@@ -188,7 +188,7 @@ __optional__|string
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**bio** +
|
||||
@@ -210,7 +210,7 @@ __optional__|string
|
||||
[[_user_counts]]
|
||||
**counts**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**follows** +
|
||||
|
||||
@@ -19,7 +19,7 @@ geography, use the https://instagram.com/developer/endpoints/media/[media search
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**geo-id** +
|
||||
@@ -33,7 +33,7 @@ __optional__|Return media before this `min_id`.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|No Content
|
||||
@@ -54,7 +54,7 @@ Search for a location by geographic coordinate.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**distance** +
|
||||
@@ -79,7 +79,7 @@ __optional__|ongitude of the center search coordinate. If used, lat is required.
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_locations_search_get_response_200,Response 200>>
|
||||
@@ -88,7 +88,7 @@ __optional__|ongitude of the center search coordinate. If used, lat is required.
|
||||
[[_locations_search_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -110,7 +110,7 @@ Get information about a location.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**location-id** +
|
||||
@@ -120,7 +120,7 @@ __required__|Location ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_locations_location-id_get_response_200,Response 200>>
|
||||
@@ -129,7 +129,7 @@ __required__|Location ID|integer
|
||||
[[_locations_location-id_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -151,7 +151,7 @@ Get a list of recent media objects from a given location.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**location-id** +
|
||||
@@ -169,7 +169,7 @@ __optional__|Return media after this UNIX timestamp.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_locations_location-id_media_recent_get_response_200,Response 200>>
|
||||
@@ -178,7 +178,7 @@ __optional__|Return media after this UNIX timestamp.|integer
|
||||
[[_locations_location-id_media_recent_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -202,7 +202,7 @@ Can return mix of image and video types.
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media_popular_get_response_200,Response 200>>
|
||||
@@ -211,7 +211,7 @@ Can return mix of image and video types.
|
||||
[[_media_popular_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -235,7 +235,7 @@ the last 5 days. Can return mix of image and video types.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**DISTANCE** +
|
||||
@@ -255,7 +255,7 @@ this timestamp.|integer|
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media_search_get_response_200,Response 200>>
|
||||
@@ -264,7 +264,7 @@ this timestamp.|integer|
|
||||
[[_media_search_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -292,7 +292,7 @@ has liked this media item.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -302,7 +302,7 @@ __required__|The media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media,Media>>
|
||||
@@ -328,7 +328,7 @@ Create a comment on a media object with the following rules:
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -341,7 +341,7 @@ media-id.|number
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media_media-id_comments_post_response_200,Response 200>>
|
||||
@@ -350,7 +350,7 @@ media-id.|number
|
||||
[[_media_media-id_comments_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -362,7 +362,7 @@ __optional__|<<_media_media-id_comments_post_meta,meta>>
|
||||
[[_media_media-id_comments_post_meta]]
|
||||
**meta**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -378,7 +378,7 @@ __optional__|number
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_oauth,oauth>>**|comments
|
||||
@@ -394,7 +394,7 @@ Get a list of recent comments on a media object.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -404,7 +404,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media_media-id_comments_get_response_200,Response 200>>
|
||||
@@ -413,7 +413,7 @@ __required__|Media ID|integer
|
||||
[[_media_media-id_comments_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -425,7 +425,7 @@ __optional__|<<_media_media-id_comments_get_meta,meta>>
|
||||
[[_media_media-id_comments_get_meta]]
|
||||
**meta**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -448,7 +448,7 @@ authored by the authenticated user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -458,7 +458,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media_media-id_comments_delete_response_200,Response 200>>
|
||||
@@ -467,7 +467,7 @@ __required__|Media ID|integer
|
||||
[[_media_media-id_comments_delete_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -479,7 +479,7 @@ __optional__|<<_media_media-id_comments_delete_meta,meta>>
|
||||
[[_media_media-id_comments_delete_meta]]
|
||||
**meta**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -501,7 +501,7 @@ Set a like on this media by the currently authenticated user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -511,7 +511,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media_media-id_likes_post_response_200,Response 200>>
|
||||
@@ -520,7 +520,7 @@ __required__|Media ID|integer
|
||||
[[_media_media-id_likes_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -532,7 +532,7 @@ __optional__|<<_media_media-id_likes_post_meta,meta>>
|
||||
[[_media_media-id_likes_post_meta]]
|
||||
**meta**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -547,7 +547,7 @@ __optional__|number
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_oauth,oauth>>**|comments
|
||||
@@ -563,7 +563,7 @@ Get a list of users who have liked this media.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -573,7 +573,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media_media-id_likes_get_response_200,Response 200>>
|
||||
@@ -582,7 +582,7 @@ __required__|Media ID|integer
|
||||
[[_media_media-id_likes_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -594,7 +594,7 @@ __optional__|<<_media_media-id_likes_get_meta,meta>>
|
||||
[[_media_media-id_likes_get_meta]]
|
||||
**meta**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -617,7 +617,7 @@ Remove a like on this media by the currently authenticated user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -627,7 +627,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media_media-id_likes_delete_response_200,Response 200>>
|
||||
@@ -636,7 +636,7 @@ __required__|Media ID|integer
|
||||
[[_media_media-id_likes_delete_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -648,7 +648,7 @@ __optional__|<<_media_media-id_likes_delete_meta,meta>>
|
||||
[[_media_media-id_likes_delete_meta]]
|
||||
**meta**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -674,7 +674,7 @@ Its corresponding shortcode is D.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**shortcode** +
|
||||
@@ -684,7 +684,7 @@ __required__|The media shortcode|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media,Media>>
|
||||
@@ -701,7 +701,7 @@ __required__|The media shortcode|string
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**q** +
|
||||
@@ -711,7 +711,7 @@ __optional__|A valid tag name without a leading #. (eg. snowy, nofilter)|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_tags_search_get_response_200,Response 200>>
|
||||
@@ -720,7 +720,7 @@ __optional__|A valid tag name without a leading #. (eg. snowy, nofilter)|string
|
||||
[[_tags_search_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -732,7 +732,7 @@ __optional__|<<_tags_search_get_meta,meta>>
|
||||
[[_tags_search_get_meta]]
|
||||
**meta**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -754,7 +754,7 @@ Get information about a tag object.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**tag-name** +
|
||||
@@ -764,7 +764,7 @@ __required__|Tag name|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_tag,Tag>>
|
||||
@@ -787,7 +787,7 @@ these objects.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**tag-name** +
|
||||
@@ -797,7 +797,7 @@ __required__|Tag name|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_tags_tag-name_media_recent_get_response_200,Response 200>>
|
||||
@@ -806,7 +806,7 @@ __required__|Tag name|string
|
||||
[[_tags_tag-name_media_recent_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -828,7 +828,7 @@ Search for a user by name.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**count** +
|
||||
@@ -840,7 +840,7 @@ __required__|A query string|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_users_search_get_response_200,Response 200>>
|
||||
@@ -849,7 +849,7 @@ __required__|A query string|string
|
||||
[[_users_search_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -871,7 +871,7 @@ See the authenticated user's feed.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**count** +
|
||||
@@ -885,7 +885,7 @@ __optional__|Return media later than this min_id.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_users_self_feed_get_response_200,Response 200>>
|
||||
@@ -894,7 +894,7 @@ __optional__|Return media later than this min_id.|integer
|
||||
[[_users_self_feed_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -919,7 +919,7 @@ available for the currently authenticated user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**count** +
|
||||
@@ -931,7 +931,7 @@ __optional__|Return media liked before this id.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_users_self_media_liked_get_response_200,Response 200>>
|
||||
@@ -940,7 +940,7 @@ __optional__|Return media liked before this id.|integer
|
||||
[[_users_self_media_liked_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -962,7 +962,7 @@ List the users who have requested this user's permission to follow.
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_users_self_requested-by_get_response_200,Response 200>>
|
||||
@@ -971,7 +971,7 @@ List the users who have requested this user's permission to follow.
|
||||
[[_users_self_requested-by_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -983,7 +983,7 @@ __optional__|<<_users_self_requested-by_get_meta,meta>>
|
||||
[[_users_self_requested-by_get_meta]]
|
||||
**meta**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -1005,7 +1005,7 @@ Get basic information about a user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**user-id** +
|
||||
@@ -1015,7 +1015,7 @@ __required__|The user identifier number|number
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|The user object|<<_users_user-id_get_response_200,Response 200>>
|
||||
@@ -1024,7 +1024,7 @@ __required__|The user identifier number|number
|
||||
[[_users_user-id_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1039,7 +1039,7 @@ __optional__|<<_user,User>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_key,key>>**|
|
||||
@@ -1056,7 +1056,7 @@ Get the list of users this user is followed by.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**user-id** +
|
||||
@@ -1066,7 +1066,7 @@ __required__|The user identifier number|number
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_users_user-id_followed-by_get_response_200,Response 200>>
|
||||
@@ -1075,7 +1075,7 @@ __required__|The user identifier number|number
|
||||
[[_users_user-id_followed-by_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1097,7 +1097,7 @@ Get the list of users this user follows.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**user-id** +
|
||||
@@ -1107,7 +1107,7 @@ __required__|The user identifier number|number
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_users_user-id_follows_get_response_200,Response 200>>
|
||||
@@ -1116,7 +1116,7 @@ __required__|The user identifier number|number
|
||||
[[_users_user-id_follows_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1134,7 +1134,7 @@ __optional__|< <<_miniprofile,MiniProfile>> > array
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**user-id** +
|
||||
@@ -1154,7 +1154,7 @@ __optional__|Return media after this UNIX timestamp.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Get the most recent media published by a user. To get the most recent
|
||||
@@ -1165,7 +1165,7 @@ instead of the `user-id`.|<<_users_user-id_media_recent_get_response_200,Respons
|
||||
[[_users_user-id_media_recent_get_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1187,7 +1187,7 @@ Modify the relationship between the current user and thetarget user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**user-id** +
|
||||
@@ -1199,7 +1199,7 @@ __optional__|One of follow/unfollow/block/unblock/approve/ignore.|enum (follow,
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_users_user-id_relationship_post_response_200,Response 200>>
|
||||
@@ -1208,7 +1208,7 @@ __optional__|One of follow/unfollow/block/unblock/approve/ignore.|enum (follow,
|
||||
[[_users_user-id_relationship_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1223,7 +1223,7 @@ __optional__|< <<_miniprofile,MiniProfile>> > array
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_oauth,oauth>>**|relationships
|
||||
|
||||
@@ -10,7 +10,7 @@ __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"]
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|basic|to read any and all data related to a user (e.g. following/followed-by
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
Information about a given HTTP mapping.
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**bean** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Returns integer metrics information for the application.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -25,7 +25,7 @@ __optional__|String metrics|< string, integer (int32) > map
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|< string, string > map
|
||||
@@ -39,7 +39,7 @@ __optional__|String metrics|< string, integer (int32) > map
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
* `\*/*`
|
||||
|
||||
|
||||
==== Tags
|
||||
@@ -60,7 +60,7 @@ Returns a collated list of all `@RequestMapping` paths.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -70,7 +70,7 @@ __optional__|Mappings|< string, <<_mappinginfo,MappingInfo>> > map
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|< string, <<_mappinginfo,MappingInfo>> > map
|
||||
@@ -84,7 +84,7 @@ __optional__|Mappings|< string, <<_mappinginfo,MappingInfo>> > map
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
* `\*/*`
|
||||
|
||||
|
||||
==== Tags
|
||||
@@ -105,7 +105,7 @@ Returns metrics information for the application.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -115,7 +115,7 @@ __optional__|Metrics|< string, <<_createmetrics_body,body>> > map
|
||||
[[_createmetrics_body]]
|
||||
**body**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**p1** +
|
||||
@@ -127,7 +127,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|< string, <<_createmetrics_response_200,Response 200>> > map
|
||||
@@ -136,7 +136,7 @@ __optional__|string
|
||||
[[_createmetrics_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**p1** +
|
||||
@@ -153,7 +153,7 @@ __optional__|string
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
* `\*/*`
|
||||
|
||||
|
||||
==== Tags
|
||||
@@ -174,7 +174,7 @@ Returns string metrics information for the application.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -184,7 +184,7 @@ __optional__|String metrics|< string, string > map
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|< string, string > map
|
||||
@@ -198,7 +198,7 @@ __optional__|String metrics|< string, string > map
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
* `\*/*`
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|**Example** : `"Canines"`|string
|
||||
[[_complexobject]]
|
||||
=== ComplexObject
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**subObject** +
|
||||
@@ -31,7 +31,7 @@ __optional__|**Example** : `{
|
||||
[[_subobject]]
|
||||
**SubObject**
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -44,7 +44,7 @@ __optional__|**Example** : `"a value !"`|string
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -55,7 +55,7 @@ __optional__|integer (int64)
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -79,7 +79,7 @@ __optional__|Order Status +
|
||||
Test description
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -104,7 +104,7 @@ __optional__|the weight of the pet|number
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -120,7 +120,7 @@ __optional__|string
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -13,7 +13,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -23,7 +23,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -49,7 +49,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -87,7 +87,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -97,7 +97,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -125,7 +125,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -147,7 +147,7 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
@@ -157,7 +157,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -178,7 +178,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -200,7 +200,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -210,7 +210,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -231,7 +231,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -249,7 +249,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -263,7 +263,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -288,7 +288,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -310,7 +310,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -320,7 +320,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_pet,Pet>>
|
||||
@@ -342,7 +342,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -361,7 +361,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -373,7 +373,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -393,7 +393,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -411,7 +411,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -421,7 +421,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -489,7 +489,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -499,7 +499,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -550,7 +550,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -560,7 +560,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -594,7 +594,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -604,7 +604,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -633,7 +633,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -643,7 +643,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -672,7 +672,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -682,7 +682,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -711,7 +711,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**password** +
|
||||
@@ -723,7 +723,7 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|string
|
||||
@@ -753,7 +753,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -782,7 +782,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Path**|**username** +
|
||||
@@ -792,7 +792,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string|`"
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_user,User>>
|
||||
@@ -827,7 +827,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -839,7 +839,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -873,7 +873,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -883,7 +883,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,22 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +10,20 @@ __Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : collType
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**collType** +
|
||||
@@ -30,7 +30,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : petType
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**huntingSkill** +
|
||||
@@ -48,7 +48,7 @@ __required__||string
|
||||
Collection parent type without discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**name** +
|
||||
@@ -65,7 +65,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : dogType
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**dogType** +
|
||||
@@ -89,7 +89,7 @@ A map without discriminator
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**collType** +
|
||||
@@ -104,7 +104,7 @@ __optional__||string
|
||||
Pet parent type with discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**name** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Get collections
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_collection,Collection>>
|
||||
@@ -29,7 +29,7 @@ Get collections
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
* `\*/*`
|
||||
|
||||
|
||||
[[_getpets]]
|
||||
@@ -45,7 +45,7 @@ Get pets
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_pet,Pet>>
|
||||
@@ -59,7 +59,7 @@ Get pets
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
* `\*/*`
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : collType
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**name** +
|
||||
@@ -30,7 +30,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : petType
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**name** +
|
||||
@@ -48,7 +48,7 @@ __required__|The measured skill for hunting +
|
||||
Collection parent type without discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**name** +
|
||||
@@ -65,7 +65,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : dogType
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**name** +
|
||||
@@ -89,7 +89,7 @@ A map without discriminator
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**name** +
|
||||
@@ -104,7 +104,7 @@ __required__|collection type discriminator|string
|
||||
Pet parent type with discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**name** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Get collections
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_collection,Collection>>
|
||||
@@ -29,7 +29,7 @@ Get collections
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
* `\*/*`
|
||||
|
||||
|
||||
[[_getpets]]
|
||||
@@ -45,7 +45,7 @@ Get pets
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_pet,Pet>>
|
||||
@@ -59,7 +59,7 @@ Get pets
|
||||
|
||||
==== Produces
|
||||
|
||||
* `*/*`
|
||||
* `\*/*`
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|string
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -39,7 +39,7 @@ __optional__||< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -25,7 +25,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -59,7 +59,7 @@ This is an important value !. +
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
|
||||
@@ -2,22 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
@@ -26,4 +10,20 @@ __Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|read_pets|read your pets
|
||||
|===
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -41,6 +41,12 @@ __Schemes__ : HTTP
|
||||
* user : User resource
|
||||
|
||||
|
||||
=== External Docs
|
||||
[%hardbreaks]
|
||||
__Description__ : Find out more about Swagger
|
||||
__URL__ : http://swagger.io
|
||||
|
||||
|
||||
|
||||
|
||||
[[_paths]]
|
||||
@@ -55,7 +61,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -65,7 +71,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -91,7 +97,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -107,7 +113,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -117,7 +123,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -145,7 +151,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -165,7 +171,7 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
@@ -175,7 +181,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -200,7 +206,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -220,7 +226,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -230,7 +236,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -255,7 +261,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -271,7 +277,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -285,7 +291,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -310,7 +316,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -330,7 +336,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -340,7 +346,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -366,7 +372,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -383,7 +389,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -395,7 +401,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -415,7 +421,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -431,7 +437,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -441,7 +447,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -477,7 +483,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -487,7 +493,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -524,7 +530,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -534,7 +540,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -566,7 +572,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -576,7 +582,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -603,7 +609,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -613,7 +619,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -640,7 +646,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -650,7 +656,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -677,7 +683,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**password** +
|
||||
@@ -689,7 +695,7 @@ __optional__|The user name for login|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -721,7 +727,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -748,7 +754,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -758,7 +764,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -795,7 +801,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -807,7 +813,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -839,7 +845,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -849,7 +855,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
@@ -876,7 +882,7 @@ __required__|The name that needs to be deleted|string
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -893,7 +899,7 @@ __optional__|The name of the category +
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -917,7 +923,7 @@ __optional__|Order Status|enum (Ordered, Cancelled)
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -938,7 +944,7 @@ __optional__||< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3,.^4"]
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -951,7 +957,7 @@ __optional__|string
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
@@ -978,15 +984,27 @@ __optional__||string
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
This is another description
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
This is a standard oauth flow
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : oauth2
|
||||
__Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3,.^17"]
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -994,12 +1012,4 @@ __Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user