Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
052b417fdb | ||
|
|
8f16457e49 | ||
|
|
2d8f46f5f6 | ||
|
|
2886d30dec | ||
|
|
282e74becb | ||
|
|
164b1ad2a8 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -6,3 +6,4 @@ build
|
||||
/.classpath
|
||||
/.project
|
||||
/.settings/
|
||||
/out/
|
||||
@@ -132,15 +132,3 @@
|
||||
|
||||
=== 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
|
||||
|
||||
=== Version 1.3.3
|
||||
* Updated swagger-parser from v1.0.25 to 1.0.35
|
||||
* PR #294: Examples always start with a newline if there is other content in the same cell
|
||||
* PR 307: Include required parameters in example request
|
||||
|
||||
|
||||
|
||||
28
build.gradle
28
build.gradle
@@ -1,19 +1,20 @@
|
||||
buildscript {
|
||||
repositories {
|
||||
jcenter()
|
||||
mavenCentral()
|
||||
}
|
||||
dependencies {
|
||||
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.6'
|
||||
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.16'
|
||||
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.3'
|
||||
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.10.1'
|
||||
classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1'
|
||||
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
|
||||
classpath "org.jfrog.buildinfo:build-info-extractor-gradle:4.0.0"
|
||||
classpath "org.ajoberstar:gradle-git-publish:0.3.1"
|
||||
classpath "org.ajoberstar:gradle-git:1.3.2"
|
||||
}
|
||||
}
|
||||
description = 'swagger2markup Build'
|
||||
version = '1.3.3'
|
||||
ext.releaseVersion = '1.3.3'
|
||||
version = '1.3.2-SNAPSHOT'
|
||||
ext.releaseVersion = '1.3.1'
|
||||
group = 'io.github.swagger2markup'
|
||||
|
||||
apply plugin: 'java'
|
||||
@@ -35,21 +36,22 @@ repositories {
|
||||
url "https://oss.jfrog.org/artifactory/oss-snapshot-local"
|
||||
}
|
||||
jcenter()
|
||||
mavenCentral()
|
||||
//mavenLocal()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compile 'io.github.swagger2markup:markup-document-builder:1.1.2'
|
||||
compile 'io.swagger:swagger-compat-spec-parser:1.0.35'
|
||||
compile 'io.github.swagger2markup:markup-document-builder:1.1.1'
|
||||
compile 'io.swagger:swagger-compat-spec-parser:1.0.25'
|
||||
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.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'
|
||||
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'
|
||||
testCompile 'ch.qos.logback:logback-classic:1.1.2'
|
||||
testCompile 'org.assertj:assertj-core:3.8.0'
|
||||
testCompile 'org.assertj:assertj-core:3.5.2'
|
||||
testCompile 'io.github.robwin:assertj-diff:0.1.1'
|
||||
}
|
||||
|
||||
@@ -64,5 +66,5 @@ test {
|
||||
|
||||
|
||||
task wrapper(type: Wrapper) {
|
||||
gradleVersion = '4.3.1'
|
||||
gradleVersion = '3.3'
|
||||
}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
apply plugin: 'org.asciidoctor.convert'
|
||||
apply plugin: 'org.ajoberstar.git-publish'
|
||||
apply plugin: 'org.ajoberstar.github-pages'
|
||||
|
||||
asciidoctor {
|
||||
sources {
|
||||
@@ -18,23 +18,17 @@ asciidoctor {
|
||||
]
|
||||
}
|
||||
|
||||
gitPublishCommit.dependsOn asciidoctor
|
||||
publishGhPages.dependsOn asciidoctor
|
||||
|
||||
gitPublish {
|
||||
repoUri = 'git@github.com:Swagger2Markup/swagger2markup.git'
|
||||
branch = 'gh-pages'
|
||||
githubPages {
|
||||
repoUri = 'https://github.com/Swagger2Markup/swagger2markup.git'
|
||||
|
||||
// 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')
|
||||
// }
|
||||
credentials {
|
||||
username = project.hasProperty('githubUser') ? project.githubUser : System.getenv('GITHUB_USER')
|
||||
password = project.hasProperty('githubPassword') ? project.githubPassword : System.getenv('GITHUB_PASSWORD')
|
||||
}
|
||||
|
||||
contents {
|
||||
pages {
|
||||
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 @@
|
||||
#Mon Dec 04 10:24:38 CET 2017
|
||||
#Thu Jan 05 14:27:30 CET 2017
|
||||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-4.3.1-all.zip
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-bin.zip
|
||||
|
||||
19
gradlew
vendored
19
gradlew
vendored
@@ -1,4 +1,4 @@
|
||||
#!/usr/bin/env sh
|
||||
#!/usr/bin/env bash
|
||||
|
||||
##############################################################################
|
||||
##
|
||||
@@ -154,19 +154,16 @@ if $cygwin ; then
|
||||
esac
|
||||
fi
|
||||
|
||||
# Escape application args
|
||||
save ( ) {
|
||||
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
|
||||
echo " "
|
||||
# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
|
||||
function splitJvmOpts() {
|
||||
JVM_OPTS=("$@")
|
||||
}
|
||||
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"
|
||||
eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
|
||||
JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
|
||||
|
||||
# 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" "$@"
|
||||
exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
|
||||
|
||||
14
src/main/java/io/github/swagger2markup/ExampleType.java
Normal file
14
src/main/java/io/github/swagger2markup/ExampleType.java
Normal file
@@ -0,0 +1,14 @@
|
||||
package io.github.swagger2markup;
|
||||
|
||||
/**
|
||||
* swagger2markup (c) Duco Hosting
|
||||
* Created by cas on 02-Oct-17.
|
||||
*/
|
||||
public enum ExampleType {
|
||||
QUERY,
|
||||
POST,
|
||||
HEADER,
|
||||
PATH,
|
||||
BODY,
|
||||
OTHER
|
||||
}
|
||||
@@ -17,14 +17,12 @@
|
||||
package io.github.swagger2markup.builder;
|
||||
|
||||
import com.google.common.collect.Ordering;
|
||||
|
||||
import io.github.swagger2markup.*;
|
||||
import io.github.swagger2markup.markup.builder.LineSeparator;
|
||||
import io.github.swagger2markup.markup.builder.MarkupLanguage;
|
||||
import io.github.swagger2markup.model.PathOperation;
|
||||
import io.swagger.models.HttpMethod;
|
||||
import io.swagger.models.parameters.Parameter;
|
||||
|
||||
import org.apache.commons.configuration2.*;
|
||||
import org.apache.commons.configuration2.builder.fluent.Configurations;
|
||||
import org.apache.commons.configuration2.convert.DefaultListDelimiterHandler;
|
||||
@@ -75,13 +73,6 @@ 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);
|
||||
@@ -118,7 +109,14 @@ public class Swagger2MarkupConfigBuilder {
|
||||
Optional<Pattern> headerPattern = swagger2MarkupProperties.getHeaderPattern(HEADER_REGEX);
|
||||
|
||||
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);
|
||||
@@ -218,19 +216,20 @@ public class Swagger2MarkupConfigBuilder {
|
||||
config.separatedOperationsEnabled = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Allows properties to contain a list of elements delimited by a specified character.
|
||||
*
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withListDelimiter() {
|
||||
config.listDelimiterEnabled = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Specifies the list delimiter which should be used.
|
||||
*
|
||||
*
|
||||
* @param delimiter the delimiter
|
||||
* @return this builder
|
||||
*/
|
||||
@@ -763,7 +762,7 @@ public class Swagger2MarkupConfigBuilder {
|
||||
public Character getListDelimiter() {
|
||||
return listDelimiter;
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
public boolean isListDelimiterEnabled() {
|
||||
return listDelimiterEnabled;
|
||||
|
||||
@@ -139,13 +139,8 @@ public final class PropertyAdapter {
|
||||
Property items = arrayProperty.getItems();
|
||||
if (items == null)
|
||||
type = new ArrayType(arrayProperty.getTitle(), new ObjectType(null, null)); // FIXME : Workaround for Swagger parser issue with composed models (https://github.com/Swagger2Markup/swagger2markup/issues/150)
|
||||
else {
|
||||
Type arrayType = new PropertyAdapter(items).getType(definitionDocumentResolver);
|
||||
if (arrayType == null)
|
||||
type = new ArrayType(arrayProperty.getTitle(), new ObjectType(null, null)); // FIXME : Workaround for Swagger parser issue with composed models (https://github.com/Swagger2Markup/swagger2markup/issues/150)
|
||||
else
|
||||
type = new ArrayType(arrayProperty.getTitle(), new PropertyAdapter(items).getType(definitionDocumentResolver));
|
||||
}
|
||||
else
|
||||
type = new ArrayType(arrayProperty.getTitle(), new PropertyAdapter(items).getType(definitionDocumentResolver));
|
||||
} else if (property instanceof MapProperty) {
|
||||
MapProperty mapProperty = (MapProperty) property;
|
||||
Property additionalProperties = mapProperty.getAdditionalProperties();
|
||||
@@ -166,9 +161,7 @@ public final class PropertyAdapter {
|
||||
} else if (property instanceof ObjectProperty) {
|
||||
type = new ObjectType(property.getTitle(), ((ObjectProperty) property).getProperties());
|
||||
} else {
|
||||
if (property.getType() == null) {
|
||||
return null;
|
||||
} else if (isNotBlank(property.getFormat())) {
|
||||
if (isNotBlank(property.getFormat())) {
|
||||
type = new BasicType(property.getType(), property.getTitle(), property.getFormat());
|
||||
} else {
|
||||
type = new BasicType(property.getType(), property.getTitle());
|
||||
|
||||
@@ -26,7 +26,6 @@ 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;
|
||||
|
||||
@@ -158,14 +157,11 @@ public class DefinitionComponent extends MarkupComponent<DefinitionComponent.Par
|
||||
if (isNotBlank(typeInfosString))
|
||||
markupDocBuilder.paragraph(typeInfosString, true);
|
||||
|
||||
Map<String, Property> properties = ((ObjectType) modelType).getProperties();
|
||||
if (!properties.isEmpty()) {
|
||||
propertiesTableComponent.apply(markupDocBuilder,
|
||||
PropertiesTableComponent.parameters(
|
||||
properties,
|
||||
definitionName,
|
||||
inlineDefinitions));
|
||||
}
|
||||
propertiesTableComponent.apply(markupDocBuilder,
|
||||
PropertiesTableComponent.parameters(
|
||||
((ObjectType) modelType).getProperties(),
|
||||
definitionName,
|
||||
inlineDefinitions));
|
||||
} else if (modelType != null) {
|
||||
MarkupDocBuilder typeInfos = copyMarkupDocBuilder(markupDocBuilder);
|
||||
typeInfos.italicText(labels.getLabel(TYPE_COLUMN)).textLine(COLON + modelType.displaySchema(markupDocBuilder));
|
||||
|
||||
@@ -345,15 +345,17 @@ public class PathOperationComponent extends MarkupComponent<PathOperationCompone
|
||||
* @param operation the Swagger Operation
|
||||
*/
|
||||
private void buildExamplesSection(MarkupDocBuilder markupDocBuilder, PathOperation operation, List<PageBreakLocations> locations) {
|
||||
|
||||
// Generate examples
|
||||
Map<String, Object> generatedRequestExampleMap = ExamplesUtil.generateRequestExampleMap(config.isGeneratedExamplesEnabled(), operation, definitions, definitionDocumentResolver, markupDocBuilder);
|
||||
Map<String, Object> generatedResponseExampleMap = ExamplesUtil.generateResponseExampleMap(config.isGeneratedExamplesEnabled(), operation, definitions, definitionDocumentResolver, markupDocBuilder);
|
||||
|
||||
// Get page break settings
|
||||
boolean beforeExampleRequestBreak = locations.contains(BEFORE_OPERATION_EXAMPLE_REQUEST);
|
||||
boolean afterExampleRequestBreak = locations.contains(AFTER_OPERATION_EXAMPLE_REQUEST);
|
||||
boolean beforeExampleResponseBreak = locations.contains(BEFORE_OPERATION_EXAMPLE_RESPONSE);
|
||||
boolean afterExampleResponseBreak = locations.contains(AFTER_OPERATION_EXAMPLE_RESPONSE);
|
||||
|
||||
// Write examples
|
||||
exampleMap(markupDocBuilder, generatedRequestExampleMap, labels.getLabel(EXAMPLE_REQUEST), labels.getLabel(REQUEST), beforeExampleRequestBreak, afterExampleRequestBreak);
|
||||
exampleMap(markupDocBuilder, generatedResponseExampleMap, labels.getLabel(EXAMPLE_RESPONSE), labels.getLabel(RESPONSE), beforeExampleResponseBreak, afterExampleResponseBreak);
|
||||
}
|
||||
@@ -373,7 +375,6 @@ public class PathOperationComponent extends MarkupComponent<PathOperationCompone
|
||||
Iterator<Map.Entry<String, JsonNode>> fieldsIterator = rootNode.fields();
|
||||
|
||||
|
||||
|
||||
if (!fieldsIterator.hasNext()) {
|
||||
// rootNode contains a single example, no need to further iterate.
|
||||
String example = Json.pretty(rootNode);
|
||||
@@ -407,6 +408,10 @@ public class PathOperationComponent extends MarkupComponent<PathOperationCompone
|
||||
} else if (entry.getKey().equals("path")) {
|
||||
// Path shouldn't have quotes around it
|
||||
markupDocBuilder.listingBlock(entry.getValue().toString());
|
||||
} else if (entry.getKey().equals("query")) {
|
||||
//TODO issue #264: print query parameters in table
|
||||
// markupDocBuilder.listingBlock(entry.getValue().toString());
|
||||
logger.debug("Skipping query parameter: " + entry.getValue().toString());
|
||||
} else {
|
||||
markupDocBuilder.listingBlock(Json.pretty(entry.getValue()), "json");
|
||||
}
|
||||
|
||||
@@ -186,7 +186,7 @@ public class PropertiesTableComponent extends MarkupComponent<PropertiesTableCom
|
||||
}
|
||||
|
||||
if (optionalExample.isPresent()) {
|
||||
if (isNotBlank(descriptionContent.toString())) {
|
||||
if (isNotBlank(description) || optionalDefaultValue.isPresent()) {
|
||||
descriptionContent.newLine(true);
|
||||
}
|
||||
|
||||
|
||||
@@ -20,15 +20,12 @@ import ch.netzwerg.paleo.StringColumn;
|
||||
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.BasicType;
|
||||
import io.github.swagger2markup.internal.type.ObjectType;
|
||||
import io.github.swagger2markup.internal.type.Type;
|
||||
import io.github.swagger2markup.internal.utils.ModelUtils;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.model.PathOperation;
|
||||
import io.github.swagger2markup.spi.MarkupComponent;
|
||||
import io.github.swagger2markup.spi.PathsDocumentExtension;
|
||||
import io.swagger.models.Model;
|
||||
import io.swagger.models.Response;
|
||||
import io.swagger.models.properties.Property;
|
||||
import io.swagger.util.Json;
|
||||
@@ -49,13 +46,11 @@ import static org.apache.commons.lang3.StringUtils.isNotBlank;
|
||||
public class ResponseComponent extends MarkupComponent<ResponseComponent.Parameters> {
|
||||
|
||||
private final TableComponent tableComponent;
|
||||
private final Map<String, Model> definitions;
|
||||
private final DocumentResolver definitionDocumentResolver;
|
||||
|
||||
ResponseComponent(Swagger2MarkupConverter.Context context,
|
||||
DocumentResolver definitionDocumentResolver) {
|
||||
super(context);
|
||||
this.definitions = context.getSwagger().getDefinitions();
|
||||
this.definitionDocumentResolver = Validate.notNull(definitionDocumentResolver, "DocumentResolver must not be null");
|
||||
this.tableComponent = new TableComponent(context);
|
||||
}
|
||||
@@ -86,15 +81,9 @@ public class ResponseComponent extends MarkupComponent<ResponseComponent.Paramet
|
||||
Map<String, Response> sortedResponses = toSortedMap(responses, config.getResponseOrdering());
|
||||
sortedResponses.forEach((String responseName, Response response) -> {
|
||||
String schemaContent = labels.getLabel(NO_CONTENT);
|
||||
if (response.getResponseSchema() != null) {
|
||||
Model model = response.getResponseSchema();
|
||||
Type type = null;
|
||||
|
||||
if (model != null) {
|
||||
type = ModelUtils.getType(model, definitions, definitionDocumentResolver);
|
||||
} else {
|
||||
type = new BasicType("string", responseName);
|
||||
}
|
||||
if (response.getSchema() != null) {
|
||||
Property property = response.getSchema();
|
||||
Type type = new PropertyAdapter(property).getType(definitionDocumentResolver);
|
||||
|
||||
if (config.isInlineSchemaEnabled()) {
|
||||
type = createInlineType(type, labels.getLabel(RESPONSE) + " " + responseName, operation.getId() + " " + labels.getLabel(RESPONSE) + " " + responseName, params.inlineDefinitions);
|
||||
|
||||
@@ -88,29 +88,23 @@ 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");
|
||||
|
||||
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");
|
||||
|
||||
if (oauth2Scheme.getScopes() != null) {
|
||||
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 io.vavr.collection.Array;
|
||||
import io.vavr.collection.IndexedSeq;
|
||||
import io.vavr.collection.List;
|
||||
import javaslang.collection.Array;
|
||||
import javaslang.collection.IndexedSeq;
|
||||
import javaslang.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 + "a");
|
||||
.withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^" + widthRatio);
|
||||
}
|
||||
).toJavaList();
|
||||
|
||||
|
||||
@@ -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 io.vavr.Function1;
|
||||
import javaslang.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 io.vavr.Function1;
|
||||
import javaslang.Function1;
|
||||
|
||||
/**
|
||||
* A functor to return the document part of an inter-document cross-references, depending on the context.
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
package io.github.swagger2markup.internal.utils;
|
||||
|
||||
import io.github.swagger2markup.ExampleType;
|
||||
|
||||
/**
|
||||
* swagger2markup (c) Duco Hosting
|
||||
* Created by cas on 02-Oct-17.
|
||||
*/
|
||||
public class Example {
|
||||
private ExampleType type;
|
||||
private Object example;
|
||||
|
||||
public Example(ExampleType type, Object example) {
|
||||
this.type = type;
|
||||
this.example = example;
|
||||
}
|
||||
|
||||
public ExampleType getType() {
|
||||
return type;
|
||||
}
|
||||
|
||||
public Object getExample() {
|
||||
return example;
|
||||
}
|
||||
}
|
||||
@@ -16,11 +16,6 @@
|
||||
|
||||
package io.github.swagger2markup.internal.utils;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import io.github.swagger2markup.internal.adapter.ParameterAdapter;
|
||||
import io.github.swagger2markup.internal.adapter.PropertyAdapter;
|
||||
import io.github.swagger2markup.internal.resolver.DocumentResolver;
|
||||
@@ -33,7 +28,11 @@ import io.swagger.models.properties.ArrayProperty;
|
||||
import io.swagger.models.properties.MapProperty;
|
||||
import io.swagger.models.properties.Property;
|
||||
import io.swagger.models.properties.RefProperty;
|
||||
import io.swagger.models.utils.PropertyModelConverter;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
public class ExamplesUtil {
|
||||
|
||||
@@ -56,22 +55,19 @@ public class ExamplesUtil {
|
||||
Response response = responseEntry.getValue();
|
||||
Object example = response.getExamples();
|
||||
if (example == null) {
|
||||
Model model = response.getResponseSchema();
|
||||
if (model != null) {
|
||||
Property schema = new PropertyModelConverter().modelToProperty(model);
|
||||
if (schema != null) {
|
||||
example = schema.getExample();
|
||||
Property schema = response.getSchema();
|
||||
if (schema != null) {
|
||||
example = schema.getExample();
|
||||
|
||||
if (example == null && schema instanceof RefProperty) {
|
||||
String simpleRef = ((RefProperty) schema).getSimpleRef();
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
}
|
||||
if (example == null && schema instanceof ArrayProperty && generateMissingExamples) {
|
||||
example = generateExampleForArrayProperty((ArrayProperty) schema, definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
}
|
||||
if (example == null && generateMissingExamples) {
|
||||
example = PropertyAdapter.generateExample(schema, markupDocBuilder);
|
||||
}
|
||||
if (example == null && schema instanceof RefProperty) {
|
||||
String simpleRef = ((RefProperty) schema).getSimpleRef();
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
}
|
||||
if (example == null && schema instanceof ArrayProperty && generateMissingExamples) {
|
||||
example = generateExampleForArrayProperty((ArrayProperty) schema, definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
}
|
||||
if (example == null && generateMissingExamples) {
|
||||
example = PropertyAdapter.generateExample(schema, markupDocBuilder);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -104,60 +100,10 @@ public class ExamplesUtil {
|
||||
for (Parameter parameter : parameters) {
|
||||
Object example = null;
|
||||
if (parameter instanceof BodyParameter) {
|
||||
example = ((BodyParameter) parameter).getExamples();
|
||||
if (example == null) {
|
||||
Model schema = ((BodyParameter) parameter).getSchema();
|
||||
if (schema instanceof RefModel) {
|
||||
String simpleRef = ((RefModel) schema).getSimpleRef();
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
} else if (generateMissingExamples) {
|
||||
if (schema instanceof ComposedModel) {
|
||||
//FIXME: getProperties() may throw NullPointerException
|
||||
example = exampleMapForProperties(((ObjectType) ModelUtils.getType(schema, definitions, definitionDocumentResolver)).getProperties(), definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
} else if (schema instanceof ArrayModel) {
|
||||
example = generateExampleForArrayModel((ArrayModel) schema, definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
} else {
|
||||
example = schema.getExample();
|
||||
if (example == null) {
|
||||
example = exampleMapForProperties(schema.getProperties(), definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
example = generateBodyParameterExample(parameter, generateMissingExamples, definitions, definitionDocumentResolver, markupDocBuilder);
|
||||
} else if (parameter instanceof AbstractSerializableParameter) {
|
||||
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) {
|
||||
abstractSerializableParameterExample = item.getExample();
|
||||
if (abstractSerializableParameterExample == null) {
|
||||
abstractSerializableParameterExample = PropertyAdapter.generateExample(item, markupDocBuilder);
|
||||
}
|
||||
}
|
||||
if (abstractSerializableParameterExample == null) {
|
||||
abstractSerializableParameterExample = ParameterAdapter.generateExample((AbstractSerializableParameter) parameter);
|
||||
}
|
||||
}
|
||||
if (parameter instanceof PathParameter) {
|
||||
String pathExample = (String) examples.get("path");
|
||||
pathExample = pathExample.replace('{' + parameter.getName() + '}', String.valueOf(abstractSerializableParameterExample));
|
||||
example = pathExample;
|
||||
} else if (parameter instanceof QueryParameter) {
|
||||
if (parameter.getRequired())
|
||||
{
|
||||
String path = (String) examples.get("path");
|
||||
String separator = path.contains("?") ? "&" : "?";
|
||||
String pathExample = path + separator + parameter.getName() + "=" + String.valueOf(abstractSerializableParameterExample);
|
||||
examples.put("path", pathExample);
|
||||
}
|
||||
} else {
|
||||
example = abstractSerializableParameterExample;
|
||||
}
|
||||
example = generateAbstractSerializableParameterExample(parameter, examples, markupDocBuilder);
|
||||
}
|
||||
} else if (parameter instanceof RefParameter) {
|
||||
String simpleRef = ((RefParameter) parameter).getSimpleRef();
|
||||
@@ -171,6 +117,81 @@ public class ExamplesUtil {
|
||||
return examples;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates example for a body parameter
|
||||
*
|
||||
* @param parameter Body paramteter to generate example for
|
||||
* @param generateMissingExamples Should an example be generated if none is defined
|
||||
* @param definitions the map of definitions
|
||||
* @param definitionDocumentResolver definitions document resolver
|
||||
* @param markupDocBuilder the markup builder
|
||||
* @return Object containing example
|
||||
*/
|
||||
private static Object generateBodyParameterExample(Parameter parameter, Boolean generateMissingExamples, Map<String, Model> definitions, DocumentResolver definitionDocumentResolver, MarkupDocBuilder markupDocBuilder) {
|
||||
Object example = ((BodyParameter) parameter).getExamples();
|
||||
if (example == null) {
|
||||
Model schema = ((BodyParameter) parameter).getSchema();
|
||||
if (schema instanceof RefModel) {
|
||||
String simpleRef = ((RefModel) schema).getSimpleRef();
|
||||
example = generateExampleForRefModel(generateMissingExamples, simpleRef, definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
} else if (generateMissingExamples) {
|
||||
if (schema instanceof ComposedModel) {
|
||||
//FIXME: getProperties() may throw NullPointerException
|
||||
example = exampleMapForProperties(((ObjectType) ModelUtils.getType(schema, definitions, definitionDocumentResolver)).getProperties(), definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
} else if (schema instanceof ArrayModel) {
|
||||
example = generateExampleForArrayModel((ArrayModel) schema, definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
} else {
|
||||
example = schema.getExample();
|
||||
if (example == null) {
|
||||
example = exampleMapForProperties(schema.getProperties(), definitions, definitionDocumentResolver, markupDocBuilder, new HashMap<>());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return example;
|
||||
}
|
||||
|
||||
private static Object generateAbstractSerializableParameterExample(Parameter parameter, Map<String, Object> examples, MarkupDocBuilder markupDocBuilder) {
|
||||
Object abstractSerializableParameterExample;
|
||||
Object example;
|
||||
abstractSerializableParameterExample = ((AbstractSerializableParameter) parameter).getExample();
|
||||
if (abstractSerializableParameterExample == null) {
|
||||
abstractSerializableParameterExample = parameter.getVendorExtensions().get("x-example");
|
||||
}
|
||||
if (abstractSerializableParameterExample == null) {
|
||||
Property item = ((AbstractSerializableParameter) parameter).getItems();
|
||||
if (item != null) {
|
||||
abstractSerializableParameterExample = item.getExample();
|
||||
if (abstractSerializableParameterExample == null) {
|
||||
abstractSerializableParameterExample = PropertyAdapter.generateExample(item, markupDocBuilder);
|
||||
}
|
||||
}
|
||||
if (abstractSerializableParameterExample == null) {
|
||||
abstractSerializableParameterExample = ParameterAdapter.generateExample((AbstractSerializableParameter) parameter);
|
||||
}
|
||||
}
|
||||
if (parameter instanceof PathParameter) {
|
||||
String pathExample = (String) examples.get("path");
|
||||
pathExample = pathExample.replace('{' + parameter.getName() + '}', String.valueOf(abstractSerializableParameterExample));
|
||||
example = pathExample;
|
||||
} else {
|
||||
example = abstractSerializableParameterExample;
|
||||
}
|
||||
if (parameter instanceof QueryParameter) {
|
||||
//TODO: #264 query parameters seem to be collected here
|
||||
//noinspection unchecked
|
||||
@SuppressWarnings("unchecked")
|
||||
Map<String, Object> queryExampleMap = (Map<String, Object>) examples.get("query");
|
||||
if (queryExampleMap == null) {
|
||||
queryExampleMap = new LinkedHashMap<>();
|
||||
}
|
||||
queryExampleMap.put(parameter.getName(), abstractSerializableParameterExample);
|
||||
example = queryExampleMap;
|
||||
}
|
||||
return example;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates an example object from a simple reference
|
||||
*
|
||||
|
||||
@@ -69,9 +69,7 @@ public final class ModelUtils {
|
||||
objectType.getPolymorphism().setDiscriminator(modelImpl.getDiscriminator());
|
||||
|
||||
return objectType;
|
||||
} else if (modelImpl.getType() == null)
|
||||
return null;
|
||||
else if (isNotBlank(modelImpl.getFormat()))
|
||||
} else if (isNotBlank(modelImpl.getFormat()))
|
||||
return new BasicType(modelImpl.getType(), modelImpl.getTitle(), modelImpl.getFormat());
|
||||
else
|
||||
return new BasicType(modelImpl.getType(), modelImpl.getTitle());
|
||||
@@ -86,10 +84,7 @@ public final class ModelUtils {
|
||||
|
||||
for (Model innerModel : composedModel.getAllOf()) {
|
||||
Type innerModelType = resolveRefType(getType(innerModel, definitions, definitionDocumentResolver));
|
||||
|
||||
if (innerModelType != null) {
|
||||
name = innerModelType.getName();
|
||||
}
|
||||
name = innerModelType.getName();
|
||||
|
||||
if (innerModelType instanceof ObjectType) {
|
||||
|
||||
|
||||
@@ -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 io.vavr.Function2;
|
||||
import javaslang.Function2;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
|
||||
@@ -15,9 +15,12 @@
|
||||
*/
|
||||
package io.github.swagger2markup;
|
||||
|
||||
import static java.util.Arrays.asList;
|
||||
import static org.assertj.core.api.Assertions.failBecauseExceptionWasNotThrown;
|
||||
import static org.assertj.core.api.BDDAssertions.assertThat;
|
||||
import io.github.swagger2markup.assertions.DiffUtils;
|
||||
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
|
||||
import org.apache.commons.io.FileUtils;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.URISyntaxException;
|
||||
@@ -28,14 +31,9 @@ import java.nio.file.Paths;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import org.apache.commons.io.FileUtils;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import io.github.swagger2markup.assertions.DiffUtils;
|
||||
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
|
||||
import io.github.swagger2markup.markup.builder.MarkupLanguage;
|
||||
import static java.util.Arrays.asList;
|
||||
import static org.assertj.core.api.Assertions.failBecauseExceptionWasNotThrown;
|
||||
import static org.assertj.core.api.BDDAssertions.assertThat;
|
||||
|
||||
public class AsciidocConverterTest {
|
||||
|
||||
@@ -346,31 +344,6 @@ public class AsciidocConverterTest {
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testWithGeneratedRecursiveExamples.html");
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void testWithGeneratedExamplesAndRequiredQueryParameters() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/yaml/swagger_examples_required_parameters.yaml"));
|
||||
Path outputDirectory = Paths.get("build/test/asciidoc/generated_examples_required_parameters");
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
//When
|
||||
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
|
||||
.withGeneratedExamples()
|
||||
.build();
|
||||
|
||||
Swagger2MarkupConverter.from(swaggerJsonString)
|
||||
.withConfig(config)
|
||||
.build()
|
||||
.toFolder(outputDirectory);
|
||||
|
||||
//Then
|
||||
String[] files = outputDirectory.toFile().list();
|
||||
assertThat(files).hasSize(4).containsAll(expectedFiles);
|
||||
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/generated_examples_required_parameters").toURI());
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testWithGeneratedExamplesAndRequiredParameters.html");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithInlineSchema() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
@@ -549,28 +522,6 @@ 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", "== Определения");
|
||||
@@ -833,18 +784,18 @@ public class AsciidocConverterTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testWithEmptyTables() throws IOException, URISyntaxException {
|
||||
public void testWithQueryParameters() throws IOException, URISyntaxException {
|
||||
//Given
|
||||
String swaggerJsonString = IOUtils.toString(getClass().getResourceAsStream("/json/swagger_empty_tables.json"));
|
||||
Path outputDirectory = Paths.get("build/test/asciidoc/empty_tables");
|
||||
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_query_params.yaml").toURI());
|
||||
Path outputDirectory = Paths.get("build/test/asciidoc/query_params");
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
//When
|
||||
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
|
||||
.withPageBreaks(new ArrayList<>(asList(PageBreakLocations.BEFORE_OPERATION, PageBreakLocations.BEFORE_OPERATION_EXAMPLE_REQUEST)))
|
||||
.withGeneratedExamples()
|
||||
.build();
|
||||
|
||||
Swagger2MarkupConverter.from(swaggerJsonString)
|
||||
Swagger2MarkupConverter.from(file)
|
||||
.withConfig(config)
|
||||
.build()
|
||||
.toFolder(outputDirectory);
|
||||
@@ -852,7 +803,8 @@ public class AsciidocConverterTest {
|
||||
//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");
|
||||
|
||||
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/query_params").toURI());
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "textWithQueryParameters.html");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -33,21 +33,17 @@ import java.nio.file.Paths;
|
||||
|
||||
public class SecuritySchemeDefinitionComponentTest extends AbstractComponentTest {
|
||||
|
||||
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;
|
||||
private static final String COMPONENT_NAME = "security_scheme_definition";
|
||||
private Path outputDirectory;
|
||||
|
||||
@Before
|
||||
public void setUp() {
|
||||
oauthOutputDirectory = getOutputFile(O_AUTH_NAME);
|
||||
apiKeyOutputDirectory = getOutputFile(API_KEY_NAME);
|
||||
FileUtils.deleteQuietly(oauthOutputDirectory.toFile());
|
||||
FileUtils.deleteQuietly(apiKeyOutputDirectory.toFile());
|
||||
outputDirectory = getOutputFile(COMPONENT_NAME);
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSecuritySchemeDefinitionComponentWithOAuth() throws URISyntaxException {
|
||||
public void testSecuritySchemeDefinitionComponent() throws URISyntaxException {
|
||||
//Given
|
||||
Path file = Paths.get(SecuritySchemeDefinitionComponentTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
|
||||
Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(file).build();
|
||||
@@ -62,35 +58,10 @@ public class SecuritySchemeDefinitionComponentTest extends AbstractComponentTest
|
||||
markupDocBuilder, SecuritySchemeDefinitionComponent.parameters("petstore_auth",
|
||||
securitySchemeDefinition,
|
||||
OverviewDocument.SECTION_TITLE_LEVEL));
|
||||
markupDocBuilder.writeToFileWithoutExtension(oauthOutputDirectory, StandardCharsets.UTF_8);
|
||||
markupDocBuilder.writeToFileWithoutExtension(outputDirectory, StandardCharsets.UTF_8);
|
||||
|
||||
Path expectedFile = getExpectedFile(O_AUTH_NAME);
|
||||
DiffUtils.assertThatFileIsEqual(expectedFile, oauthOutputDirectory, getReportName(O_AUTH_NAME));
|
||||
Path expectedFile = getExpectedFile(COMPONENT_NAME);
|
||||
DiffUtils.assertThatFileIsEqual(expectedFile, outputDirectory, getReportName(COMPONENT_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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
|
||||
@@ -8,7 +8,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
|
||||
@@ -12,7 +12,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**args** +
|
||||
@@ -52,7 +52,7 @@ __optional__|Command path|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -64,7 +64,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result +
|
||||
@@ -78,7 +78,7 @@ __optional__|option value|string
|
||||
[[_launchcommand_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Location** +
|
||||
@@ -92,7 +92,7 @@ __optional__|<description>|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
|
||||
@@ -12,7 +12,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -22,7 +22,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -48,7 +48,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
|
||||
@@ -12,7 +12,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -22,7 +22,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -47,7 +47,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -62,6 +62,15 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
----
|
||||
|
||||
|
||||
===== Request query
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"tags" : "adorable"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
|
||||
@@ -1,15 +1,13 @@
|
||||
|
||||
[[_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"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
This is another description
|
||||
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
|
||||
[[_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=".^0a,.^0a"]
|
||||
[options="header", cols=".^0,.^0"]
|
||||
|===
|
||||
|type|name
|
||||
|type1|name1
|
||||
|
||||
16
src/test/resources/expected/asciidoc/basepathprefix/definitions.adoc
Normal file → Executable file
16
src/test/resources/expected/asciidoc/basepathprefix/definitions.adoc
Normal file → Executable file
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|**Example** : `"Canines"`|string
|
||||
[[_complexobject]]
|
||||
=== ComplexObject
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**subObject** +
|
||||
@@ -31,7 +31,7 @@ __optional__|**Example** : `{
|
||||
[[_subobject]]
|
||||
**SubObject**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -44,7 +44,7 @@ __optional__|**Example** : `"a value !"`|string
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -55,7 +55,7 @@ __optional__|**Example** : `0`|integer (int64)
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -79,7 +79,7 @@ __optional__|Order Status +
|
||||
Test description
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -108,7 +108,7 @@ __optional__|the weight of the pet +
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -124,7 +124,7 @@ __optional__|**Example** : `"string"`|string
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -11,7 +11,7 @@ POST /v2/pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -115,7 +115,7 @@ PUT /v2/pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -251,6 +251,15 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
----
|
||||
|
||||
|
||||
===== Request query
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"status" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
@@ -290,7 +299,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -300,7 +309,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -321,7 +330,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -336,6 +345,15 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
----
|
||||
|
||||
|
||||
===== Request query
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"tags" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
@@ -371,7 +389,7 @@ POST /v2/pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -385,7 +403,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -410,7 +428,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -445,7 +463,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -455,7 +473,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_pet,Pet>>
|
||||
@@ -477,7 +495,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -528,7 +546,7 @@ DELETE /v2/pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -540,7 +558,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -560,7 +578,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -591,7 +609,7 @@ POST /v2/stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -601,7 +619,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -671,7 +689,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -681,7 +699,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -738,7 +756,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -748,7 +766,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -788,7 +806,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -798,7 +816,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -850,7 +868,7 @@ POST /v2/users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -860,7 +878,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -912,7 +930,7 @@ POST /v2/users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -922,7 +940,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -974,7 +992,7 @@ GET /v2/users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**password** +
|
||||
@@ -986,7 +1004,7 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|string
|
||||
@@ -1013,6 +1031,16 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
----
|
||||
|
||||
|
||||
===== Request query
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"password" : "string",
|
||||
"username" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
@@ -1031,7 +1059,7 @@ GET /v2/users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -1066,7 +1094,7 @@ GET /v2/users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Path**|**username** +
|
||||
@@ -1076,7 +1104,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string|`"
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_user,User>>
|
||||
@@ -1136,7 +1164,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -1148,7 +1176,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -1205,7 +1233,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -1215,7 +1243,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -18,7 +10,7 @@ __Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -26,4 +18,12 @@ __Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
|
||||
[[_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)
|
||||
|===
|
||||
|
||||
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
= 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
|
||||
|
||||
|
||||
|
||||
@@ -1,48 +0,0 @@
|
||||
|
||||
[[_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
|
||||
|
||||
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
|
||||
[[_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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**value** +
|
||||
@@ -37,7 +37,7 @@ __optional__|State value|enum (ADDED, REMOVED, CHANGED)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|enum (ADDED, REMOVED, CHANGED)
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|**Example** : `"Canines"`|string
|
||||
[[_complexobject]]
|
||||
=== ComplexObject
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**subObject** +
|
||||
@@ -31,7 +31,7 @@ __optional__|**Example** : `{
|
||||
[[_subobject]]
|
||||
**SubObject**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -44,7 +44,7 @@ __optional__|**Example** : `"a value !"`|string
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -55,7 +55,7 @@ __optional__|integer (int64)
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -79,7 +79,7 @@ __optional__|Order Status +
|
||||
Test description
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -104,7 +104,7 @@ __optional__|the weight of the pet|number
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -120,7 +120,7 @@ __optional__|string
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -11,7 +11,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -83,7 +83,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -202,7 +202,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -239,7 +239,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -253,7 +253,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -278,7 +278,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -308,7 +308,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_pet,Pet>>
|
||||
@@ -330,7 +330,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -347,7 +347,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -359,7 +359,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -395,7 +395,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -405,7 +405,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -479,7 +479,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -580,7 +580,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -607,7 +607,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -617,7 +617,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -644,7 +644,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -654,7 +654,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -681,7 +681,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**password** +
|
||||
@@ -693,7 +693,7 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|string
|
||||
@@ -721,7 +721,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -748,7 +748,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -803,7 +803,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -845,7 +845,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -18,7 +10,7 @@ __Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -26,4 +18,12 @@ __Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ __Type__ : < integer (test) > array
|
||||
[[_integerobj]]
|
||||
=== IntegerObj
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -31,7 +31,7 @@ __Type__ : < string (test) > array
|
||||
[[_stringobj]]
|
||||
=== StringObj
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**intParam** +
|
||||
@@ -23,7 +23,7 @@ __required__|test string in query|string (test)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -47,7 +47,7 @@ __optional__|string (test)
|
||||
[[_c_param_intparam_get_response_202]]
|
||||
**Response 202**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -57,7 +57,7 @@ __optional__|< string (test) > array
|
||||
[[_c_param_intparam_get_response_204]]
|
||||
**Response 204**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -67,7 +67,7 @@ __optional__|integer (test)
|
||||
[[_c_param_intparam_get_response_205]]
|
||||
**Response 205**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -85,7 +85,7 @@ __optional__|< integer (test) > array
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -103,7 +103,7 @@ __required__|test integer str in body|< integer (test) > array
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -131,7 +131,7 @@ __optional__|integer (test)
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -149,7 +149,7 @@ __required__|test integer str in body|integer (test)
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -167,7 +167,7 @@ __required__|test string str in body|< string (test) > array
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**test** +
|
||||
@@ -195,7 +195,7 @@ __optional__|string (test)
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*id* +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*complete* +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*category* +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|*id* +
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|*email* +
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|string
|
||||
|
||||
16
src/test/resources/expected/asciidoc/generated_examples/definitions.adoc
Normal file → Executable file
16
src/test/resources/expected/asciidoc/generated_examples/definitions.adoc
Normal file → Executable file
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|**Example** : `"Canines"`|string
|
||||
[[_complexobject]]
|
||||
=== ComplexObject
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**subObject** +
|
||||
@@ -31,7 +31,7 @@ __optional__|**Example** : `{
|
||||
[[_subobject]]
|
||||
**SubObject**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -44,7 +44,7 @@ __optional__|**Example** : `"a value !"`|string
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -55,7 +55,7 @@ __optional__|**Example** : `0`|integer (int64)
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -79,7 +79,7 @@ __optional__|Order Status +
|
||||
Test description
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -108,7 +108,7 @@ __optional__|the weight of the pet +
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -124,7 +124,7 @@ __optional__|**Example** : `"string"`|string
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -11,7 +11,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -115,7 +115,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -251,6 +251,15 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
----
|
||||
|
||||
|
||||
===== Request query
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"status" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
@@ -290,7 +299,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -300,7 +309,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
@@ -321,7 +330,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -336,6 +345,15 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
----
|
||||
|
||||
|
||||
===== Request query
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"tags" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
@@ -371,7 +389,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -385,7 +403,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -410,7 +428,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -445,7 +463,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -455,7 +473,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_pet,Pet>>
|
||||
@@ -477,7 +495,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -528,7 +546,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -540,7 +558,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -560,7 +578,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -591,7 +609,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -601,7 +619,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -671,7 +689,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -681,7 +699,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_order,Order>>
|
||||
@@ -738,7 +756,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -748,7 +766,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -788,7 +806,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -798,7 +816,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -850,7 +868,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -860,7 +878,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -912,7 +930,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -922,7 +940,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -974,7 +992,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**password** +
|
||||
@@ -986,7 +1004,7 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|string
|
||||
@@ -1013,6 +1031,16 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
----
|
||||
|
||||
|
||||
===== Request query
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"password" : "string",
|
||||
"username" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
@@ -1031,7 +1059,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -1066,7 +1094,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Path**|**username** +
|
||||
@@ -1076,7 +1104,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string|`"
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_user,User>>
|
||||
@@ -1136,7 +1164,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -1148,7 +1176,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -1205,7 +1233,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -1215,7 +1243,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -18,7 +10,7 @@ __Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -26,4 +18,12 @@ __Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,246 +0,0 @@
|
||||
|
||||
[[_paths]]
|
||||
== Paths
|
||||
|
||||
[[_findpetsbycategory]]
|
||||
=== Finds Pets by category and status
|
||||
....
|
||||
GET /pet/findByCategory
|
||||
....
|
||||
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**category** +
|
||||
__required__|Category name that needs to be considered for filter|string
|
||||
|**Query**|**optional** +
|
||||
__optional__|Optional filter parameter|integer
|
||||
|**Query**|**status** +
|
||||
__required__|Status values that need to be considered for filter|< enum (available, pending, sold) > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
|**400**|Invalid status value|No Content
|
||||
|===
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `application/xml`
|
||||
* `application/json`
|
||||
|
||||
|
||||
==== 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
|
||||
----
|
||||
/pet/findByCategory?category=Herding&status=string
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
[source,json]
|
||||
----
|
||||
[ {
|
||||
"id" : 0,
|
||||
"category" : {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
},
|
||||
"name" : "doggie",
|
||||
"photoUrls" : [ "string" ],
|
||||
"tags" : [ {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
} ],
|
||||
"status" : "string"
|
||||
} ]
|
||||
----
|
||||
|
||||
|
||||
[[_findpetsbyfunnypath]]
|
||||
=== Finds Pets with funny/illegal path
|
||||
....
|
||||
GET /pet/findByFunnyPath?always=1
|
||||
....
|
||||
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**category** +
|
||||
__required__|Category name that needs to be considered for filter|string
|
||||
|**Query**|**optional** +
|
||||
__optional__|Optional filter parameter|integer
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
|**400**|Invalid status value|No Content
|
||||
|===
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `application/xml`
|
||||
* `application/json`
|
||||
|
||||
|
||||
==== 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
|
||||
----
|
||||
/pet/findByFunnyPath?always=1&category=Herding
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
[source,json]
|
||||
----
|
||||
[ {
|
||||
"id" : 0,
|
||||
"category" : {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
},
|
||||
"name" : "doggie",
|
||||
"photoUrls" : [ "string" ],
|
||||
"tags" : [ {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
} ],
|
||||
"status" : "string"
|
||||
} ]
|
||||
----
|
||||
|
||||
|
||||
[[_findpetsbystatus]]
|
||||
=== Finds Pets by status
|
||||
....
|
||||
GET /pet/findByStatus
|
||||
....
|
||||
|
||||
|
||||
==== Description
|
||||
Multiple status values can be provided with comma separated strings
|
||||
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
__required__|Status values that need to be considered for filter|< enum (available, pending, sold) > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
|**400**|Invalid status value|No Content
|
||||
|===
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `application/xml`
|
||||
* `application/json`
|
||||
|
||||
|
||||
==== 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
|
||||
----
|
||||
/pet/findByStatus?status=string
|
||||
----
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
[source,json]
|
||||
----
|
||||
[ {
|
||||
"id" : 0,
|
||||
"category" : {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
},
|
||||
"name" : "doggie",
|
||||
"photoUrls" : [ "string" ],
|
||||
"tags" : [ {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
} ],
|
||||
"status" : "string"
|
||||
} ]
|
||||
----
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_navigationentry]]
|
||||
=== NavigationEntry
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**childs** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Returns the navigation as a tree
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Successful response|<<_navigationentry,NavigationEntry>>
|
||||
@@ -63,7 +63,7 @@ Updates the navigation tree
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^4"]
|
||||
|===
|
||||
|Type|Name|Schema
|
||||
|**Body**|**entry** +
|
||||
@@ -73,7 +73,7 @@ __optional__|<<_navigationentry,NavigationEntry>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Successful response|<<_navigationentry,NavigationEntry>>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -22,7 +22,7 @@ __optional__|The name of the category +
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -46,7 +46,7 @@ __optional__|Order Status|enum (Ordered, Cancelled)
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -67,7 +67,7 @@ __optional__||< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -80,7 +80,7 @@ __optional__|string
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -16,7 +16,7 @@ POST /pets
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -63,7 +63,7 @@ PUT /pets
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -176,7 +176,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -196,7 +196,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
===== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -212,7 +212,7 @@ POST /pets/{petId}
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -226,7 +226,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -246,7 +246,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
===== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -314,7 +314,7 @@ DELETE /pets/{petId}
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -326,7 +326,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -362,7 +362,7 @@ POST /stores/order
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -372,7 +372,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -413,7 +413,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -497,7 +497,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -519,7 +519,7 @@ POST /users/createWithArray
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -529,7 +529,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -551,7 +551,7 @@ POST /users/createWithList
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -561,7 +561,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -583,7 +583,7 @@ GET /users/login
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**password** +
|
||||
@@ -595,7 +595,7 @@ __optional__|The user name for login|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -622,7 +622,7 @@ GET /users/logout
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -644,7 +644,7 @@ GET /users/{username}
|
||||
|
||||
===== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -698,7 +698,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -735,7 +735,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
===== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,27 +2,15 @@
|
||||
[[_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=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -30,4 +18,12 @@ __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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -22,7 +22,7 @@ __optional__|The name of the category +
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -46,7 +46,7 @@ __optional__|Order Status|enum (Ordered, Cancelled)
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -67,7 +67,7 @@ __optional__||< <<definitions.adoc#_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -80,7 +80,7 @@ __optional__|string
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -11,7 +11,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<security.adoc#_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -63,7 +63,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -186,7 +186,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -211,7 +211,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -241,7 +241,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -266,7 +266,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<security.adoc#_api_key,api_key>>**|
|
||||
@@ -339,7 +339,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -351,7 +351,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -443,7 +443,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -532,7 +532,7 @@ __optional__|Created user object|<<definitions.adoc#_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -559,7 +559,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -569,7 +569,7 @@ __optional__|List of user object|< <<definitions.adoc#_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -596,7 +596,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -606,7 +606,7 @@ __optional__|List of user object|< <<definitions.adoc#_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -633,7 +633,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**password** +
|
||||
@@ -645,7 +645,7 @@ __optional__|The user name for login|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -677,7 +677,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -704,7 +704,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -763,7 +763,7 @@ __optional__|Updated user object|<<definitions.adoc#_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -805,7 +805,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,27 +2,15 @@
|
||||
[[_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=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -30,4 +18,12 @@ __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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**error-code** +
|
||||
@@ -18,7 +18,7 @@ __optional__|Error message|string
|
||||
[[_inlinedepthschema]]
|
||||
=== InlineDepthSchema
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**Loop** +
|
||||
@@ -28,7 +28,7 @@ __optional__|<<_inlinedepthschema_loop,Loop>>
|
||||
[[_inlinedepthschema_loop]]
|
||||
**Loop**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p1** +
|
||||
@@ -40,7 +40,7 @@ __optional__|Description p2|<<_inlinedepthschema_p2,p2>>
|
||||
[[_inlinedepthschema_p2]]
|
||||
**p2**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-2-2-1** +
|
||||
@@ -89,7 +89,7 @@ __optional__|Description p2-2-2-2|boolean
|
||||
[[_inlinepet]]
|
||||
=== InlinePet
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**category** +
|
||||
@@ -103,7 +103,7 @@ __optional__|< <<_inlinepet_tags,tags>> > array
|
||||
[[_inlinepet_category]]
|
||||
**category**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -115,7 +115,7 @@ __optional__|string
|
||||
[[_inlinepet_tags]]
|
||||
**tags**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -128,7 +128,7 @@ __optional__|string
|
||||
[[_inlinetitlepet]]
|
||||
=== InlineTitlePet
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**category** +
|
||||
@@ -142,7 +142,7 @@ __optional__|< <<_tagmodel,TagModel>> > array
|
||||
[[_categorymodel]]
|
||||
**CategoryModel**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -154,7 +154,7 @@ __optional__|string
|
||||
[[_tagmodel]]
|
||||
**TagModel**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -167,7 +167,7 @@ __optional__|string
|
||||
[[_location]]
|
||||
=== Location
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Place** +
|
||||
@@ -180,7 +180,7 @@ __optional__|Place|string
|
||||
mixed collections and objects
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -190,7 +190,7 @@ __optional__|< <<_mixedschema_mytable,myTable>> > array
|
||||
[[_mixedschema_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -200,7 +200,7 @@ __optional__|< string, <<_mixedschema_mydict,myDict>> > map
|
||||
[[_mixedschema_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -219,7 +219,7 @@ __Type__ : < < string, <<_recursivecollectionschema_inline,RecursiveCollectionSc
|
||||
[[_recursivecollectionschema_inline]]
|
||||
**RecursiveCollectionSchema**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -234,7 +234,7 @@ __optional__|option value|string
|
||||
mixed collections and objects
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -244,7 +244,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**emptyObject** +
|
||||
@@ -256,7 +256,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -37,7 +37,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -74,7 +74,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**args** +
|
||||
@@ -114,7 +114,7 @@ __optional__|Command path|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -126,7 +126,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result +
|
||||
@@ -140,7 +140,7 @@ __optional__|option value|string
|
||||
[[_launchcommand_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Location** +
|
||||
@@ -154,7 +154,7 @@ __optional__|<description>|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -182,7 +182,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -202,7 +202,7 @@ __optional__|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
[[_mixedparameters_post_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -212,7 +212,7 @@ __optional__|< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
|
||||
[[_mixedparameters_post_mytable_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -224,7 +224,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -243,7 +243,7 @@ __optional__|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
[[_mixedparameters_post_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -253,7 +253,7 @@ __optional__|< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
|
||||
[[_mixedparameters_post_mytable_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -281,7 +281,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**Version** +
|
||||
@@ -291,7 +291,7 @@ __optional__|The API version|<<_request,Request>>
|
||||
[[_request]]
|
||||
**Request**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -301,7 +301,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -311,7 +311,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -323,7 +323,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result|<<_result,Result>>
|
||||
@@ -332,7 +332,7 @@ __optional__|string
|
||||
[[_result]]
|
||||
**Result**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -342,7 +342,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -352,7 +352,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_error]]
|
||||
=== Error
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**error-code** +
|
||||
@@ -18,7 +18,7 @@ __optional__|Error message|string
|
||||
[[_inlinedepthschema]]
|
||||
=== InlineDepthSchema
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**Loop** +
|
||||
@@ -28,7 +28,7 @@ __optional__|<<_inlinedepthschema_loop,Loop>>
|
||||
[[_inlinedepthschema_loop]]
|
||||
**Loop**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p1** +
|
||||
@@ -40,7 +40,7 @@ __optional__|Description p2|<<_inlinedepthschema_p2,p2>>
|
||||
[[_inlinedepthschema_p2]]
|
||||
**p2**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**p2-2-2-1** +
|
||||
@@ -89,7 +89,7 @@ __optional__|Description p2-2-2-2|boolean
|
||||
[[_inlinepet]]
|
||||
=== InlinePet
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**category** +
|
||||
@@ -103,7 +103,7 @@ __optional__|< <<_inlinepet_tags,tags>> > array
|
||||
[[_inlinepet_category]]
|
||||
**category**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -115,7 +115,7 @@ __optional__|string
|
||||
[[_inlinepet_tags]]
|
||||
**tags**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -128,7 +128,7 @@ __optional__|string
|
||||
[[_inlinetitlepet]]
|
||||
=== InlineTitlePet
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**category** +
|
||||
@@ -142,7 +142,7 @@ __optional__|< <<_tagmodel,TagModel>> > array
|
||||
[[_categorymodel]]
|
||||
**CategoryModel**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -154,7 +154,7 @@ __optional__|string
|
||||
[[_tagmodel]]
|
||||
**TagModel**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -167,7 +167,7 @@ __optional__|string
|
||||
[[_location]]
|
||||
=== Location
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Place** +
|
||||
@@ -180,7 +180,7 @@ __optional__|Place|string
|
||||
mixed collections and objects
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -190,7 +190,7 @@ __optional__|< <<_mixedschema_mytable,myTable>> > array
|
||||
[[_mixedschema_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -200,7 +200,7 @@ __optional__|< string, <<_mixedschema_mydict,myDict>> > map
|
||||
[[_mixedschema_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -219,7 +219,7 @@ __Type__ : < < string, <<_recursivecollectionschema_inline,RecursiveCollectionSc
|
||||
[[_recursivecollectionschema_inline]]
|
||||
**RecursiveCollectionSchema**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -234,7 +234,7 @@ __optional__|option value|string
|
||||
mixed collections and objects
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -244,7 +244,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**emptyObject** +
|
||||
@@ -256,7 +256,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
|
||||
@@ -24,7 +24,7 @@ __Type__ : < < string, <<_collectionparameters_post_version,Version>> > map > ar
|
||||
[[_collectionparameters_post_version]]
|
||||
**Version**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -36,7 +36,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -73,7 +73,7 @@ Dummy description
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**Option** +
|
||||
@@ -91,7 +91,7 @@ __Name__ : LaunchCommandRequest
|
||||
__Flags__ : optional
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**args** +
|
||||
@@ -117,7 +117,7 @@ __optional__|Command path|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -129,7 +129,7 @@ __optional__|option value|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result +
|
||||
@@ -143,7 +143,7 @@ __optional__|option value|string
|
||||
[[_launchcommand_post_response_200]]
|
||||
**Response 200**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**Location** +
|
||||
@@ -157,7 +157,7 @@ __optional__|<description>|string
|
||||
[[_launchcommand_post_options]]
|
||||
**Options**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**key** +
|
||||
@@ -191,7 +191,7 @@ __Name__ : Version
|
||||
__Flags__ : optional
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -201,7 +201,7 @@ __optional__|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
[[_mixedparameters_post_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -211,7 +211,7 @@ __optional__|< string, <<_mixedparameters_post_mydict,myDict>> > map
|
||||
[[_mixedparameters_post_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -223,7 +223,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -242,7 +242,7 @@ __optional__|< <<_mixedparameters_post_mytable,myTable>> > array
|
||||
[[_mixedparameters_post_mytable]]
|
||||
**myTable**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -252,7 +252,7 @@ __optional__|< string, <<_mixedparameters_post_mytable_mydict,myDict>> > map
|
||||
[[_mixedparameters_post_mytable_mydict]]
|
||||
**myDict**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -286,7 +286,7 @@ __Name__ : Version
|
||||
__Flags__ : optional
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -296,7 +296,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -306,7 +306,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
@@ -318,7 +318,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|Result|<<_result,Result>>
|
||||
@@ -327,7 +327,7 @@ __optional__|string
|
||||
[[_result]]
|
||||
**Result**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myTable** +
|
||||
@@ -337,7 +337,7 @@ __optional__|< <<_tablecontent,TableContent>> > array
|
||||
[[_tablecontent]]
|
||||
**TableContent**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**myDict** +
|
||||
@@ -347,7 +347,7 @@ __optional__|< string, <<_kvpair,KVPair>> > map
|
||||
[[_kvpair]]
|
||||
**KVPair**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**k** +
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_comment]]
|
||||
=== Comment
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**created_time** +
|
||||
@@ -22,7 +22,7 @@ __optional__|string
|
||||
[[_image]]
|
||||
=== Image
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**height** +
|
||||
@@ -37,7 +37,7 @@ __optional__|integer
|
||||
[[_like]]
|
||||
=== Like
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**first_name** +
|
||||
@@ -56,7 +56,7 @@ __optional__|string
|
||||
[[_location]]
|
||||
=== Location
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -73,7 +73,7 @@ __optional__|string
|
||||
[[_media]]
|
||||
=== Media
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**comments:** +
|
||||
@@ -105,7 +105,7 @@ __optional__||<<_media_videos,videos>>
|
||||
[[_media_comments]]
|
||||
**comments:**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**count** +
|
||||
@@ -117,7 +117,7 @@ __optional__|< <<_comment,Comment>> > array
|
||||
[[_media_images]]
|
||||
**images**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**low_resolution** +
|
||||
@@ -131,7 +131,7 @@ __optional__|<<_image,Image>>
|
||||
[[_media_likes]]
|
||||
**likes**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**count** +
|
||||
@@ -143,7 +143,7 @@ __optional__|< <<_miniprofile,MiniProfile>> > array
|
||||
[[_media_videos]]
|
||||
**videos**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**low_resolution** +
|
||||
@@ -158,7 +158,7 @@ __optional__|<<_image,Image>>
|
||||
A shorter version of User for likes array
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**full_name** +
|
||||
@@ -175,7 +175,7 @@ __optional__|string
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**media_count** +
|
||||
@@ -188,7 +188,7 @@ __optional__|string
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**bio** +
|
||||
@@ -210,7 +210,7 @@ __optional__|string
|
||||
[[_user_counts]]
|
||||
**counts**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**follows** +
|
||||
|
||||
@@ -19,7 +19,7 @@ geography, use the https://instagram.com/developer/endpoints/media/[media search
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**geo-id** +
|
||||
@@ -33,7 +33,7 @@ __optional__|Return media before this `min_id`.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|No Content
|
||||
@@ -54,7 +54,7 @@ Search for a location by geographic coordinate.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -110,7 +110,7 @@ Get information about a location.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**location-id** +
|
||||
@@ -120,7 +120,7 @@ __required__|Location ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -151,7 +151,7 @@ Get a list of recent media objects from a given location.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**location-id** +
|
||||
@@ -169,7 +169,7 @@ __optional__|Return media after this UNIX timestamp.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -202,7 +202,7 @@ Can return mix of image and video types.
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -235,7 +235,7 @@ the last 5 days. Can return mix of image and video types.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**DISTANCE** +
|
||||
@@ -255,7 +255,7 @@ this timestamp.|integer|
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -292,7 +292,7 @@ has liked this media item.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -302,7 +302,7 @@ __required__|The media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -341,7 +341,7 @@ media-id.|number
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -378,7 +378,7 @@ __optional__|number
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -404,7 +404,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -448,7 +448,7 @@ authored by the authenticated user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -458,7 +458,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -501,7 +501,7 @@ Set a like on this media by the currently authenticated user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -511,7 +511,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -547,7 +547,7 @@ __optional__|number
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -573,7 +573,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -617,7 +617,7 @@ Remove a like on this media by the currently authenticated user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**media-id** +
|
||||
@@ -627,7 +627,7 @@ __required__|Media ID|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -674,7 +674,7 @@ Its corresponding shortcode is D.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**shortcode** +
|
||||
@@ -684,7 +684,7 @@ __required__|The media shortcode|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_media,Media>>
|
||||
@@ -701,7 +701,7 @@ __required__|The media shortcode|string
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -732,7 +732,7 @@ __optional__|<<_tags_search_get_meta,meta>>
|
||||
[[_tags_search_get_meta]]
|
||||
**meta**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -754,7 +754,7 @@ Get information about a tag object.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**tag-name** +
|
||||
@@ -764,7 +764,7 @@ __required__|Tag name|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_tag,Tag>>
|
||||
@@ -787,7 +787,7 @@ these objects.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**tag-name** +
|
||||
@@ -797,7 +797,7 @@ __required__|Tag name|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -828,7 +828,7 @@ Search for a user by name.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**count** +
|
||||
@@ -840,7 +840,7 @@ __required__|A query string|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -871,7 +871,7 @@ See the authenticated user's feed.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**count** +
|
||||
@@ -885,7 +885,7 @@ __optional__|Return media later than this min_id.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -919,7 +919,7 @@ available for the currently authenticated user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**count** +
|
||||
@@ -931,7 +931,7 @@ __optional__|Return media liked before this id.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -962,7 +962,7 @@ List the users who have requested this user's permission to follow.
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**code** +
|
||||
@@ -1005,7 +1005,7 @@ Get basic information about a user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**user-id** +
|
||||
@@ -1015,7 +1015,7 @@ __required__|The user identifier number|number
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1039,7 +1039,7 @@ __optional__|<<_user,User>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_key,key>>**|
|
||||
@@ -1056,7 +1056,7 @@ Get the list of users this user is followed by.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**user-id** +
|
||||
@@ -1066,7 +1066,7 @@ __required__|The user identifier number|number
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1097,7 +1097,7 @@ Get the list of users this user follows.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**user-id** +
|
||||
@@ -1107,7 +1107,7 @@ __required__|The user identifier number|number
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1134,7 +1134,7 @@ __optional__|< <<_miniprofile,MiniProfile>> > array
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**user-id** +
|
||||
@@ -1154,7 +1154,7 @@ __optional__|Return media after this UNIX timestamp.|integer
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1187,7 +1187,7 @@ Modify the relationship between the current user and thetarget user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**data** +
|
||||
@@ -1223,7 +1223,7 @@ __optional__|< <<_miniprofile,MiniProfile>> > array
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**bean** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Returns integer metrics information for the application.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -25,7 +25,7 @@ __optional__|String metrics|< string, integer (int32) > map
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|< string, string > map
|
||||
@@ -60,7 +60,7 @@ Returns a collated list of all `@RequestMapping` paths.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -70,7 +70,7 @@ __optional__|Mappings|< string, <<_mappinginfo,MappingInfo>> > map
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|< string, <<_mappinginfo,MappingInfo>> > map
|
||||
@@ -105,7 +105,7 @@ Returns metrics information for the application.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -115,7 +115,7 @@ __optional__|Metrics|< string, <<_createmetrics_body,body>> > map
|
||||
[[_createmetrics_body]]
|
||||
**body**
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**p1** +
|
||||
@@ -127,7 +127,7 @@ __optional__|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**p1** +
|
||||
@@ -174,7 +174,7 @@ Returns string metrics information for the application.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -184,7 +184,7 @@ __optional__|String metrics|< string, string > map
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|< string, string > map
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|**Example** : `"Canines"`|string
|
||||
[[_complexobject]]
|
||||
=== ComplexObject
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**subObject** +
|
||||
@@ -31,7 +31,7 @@ __optional__|**Example** : `{
|
||||
[[_subobject]]
|
||||
**SubObject**
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -44,7 +44,7 @@ __optional__|**Example** : `"a value !"`|string
|
||||
[[_identified]]
|
||||
=== Identified
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -55,7 +55,7 @@ __optional__|integer (int64)
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -79,7 +79,7 @@ __optional__|Order Status +
|
||||
Test description
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -104,7 +104,7 @@ __optional__|the weight of the pet|number
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -120,7 +120,7 @@ __optional__|string
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -13,7 +13,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -87,7 +87,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -210,7 +210,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -249,7 +249,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -263,7 +263,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -288,7 +288,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -320,7 +320,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|<<_pet,Pet>>
|
||||
@@ -342,7 +342,7 @@ __required__|ID of the pet|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -361,7 +361,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -373,7 +373,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -411,7 +411,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -421,7 +421,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -499,7 +499,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -604,7 +604,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -633,7 +633,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -643,7 +643,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -672,7 +672,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -682,7 +682,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -711,7 +711,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|Type|Name|Description|Schema|Default
|
||||
|**Query**|**password** +
|
||||
@@ -723,7 +723,7 @@ __optional__|The user name for login|string|`"testUser"`
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|string
|
||||
@@ -753,7 +753,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -782,7 +782,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a,.^2a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -839,7 +839,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -883,7 +883,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -18,7 +10,7 @@ __Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -26,4 +18,12 @@ __Token URL__ : http://petstore.swagger.wordnik.com/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : collType
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**collType** +
|
||||
@@ -30,7 +30,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : petType
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**huntingSkill** +
|
||||
@@ -48,7 +48,7 @@ __required__||string
|
||||
Collection parent type without discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**name** +
|
||||
@@ -65,7 +65,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : dogType
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**dogType** +
|
||||
@@ -89,7 +89,7 @@ A map without discriminator
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**collType** +
|
||||
@@ -104,7 +104,7 @@ __optional__||string
|
||||
Pet parent type with discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**name** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Get collections
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_collection,Collection>>
|
||||
@@ -45,7 +45,7 @@ Get pets
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_pet,Pet>>
|
||||
|
||||
@@ -11,7 +11,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : collType
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**name** +
|
||||
@@ -30,7 +30,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : petType
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**name** +
|
||||
@@ -48,7 +48,7 @@ __required__|The measured skill for hunting +
|
||||
Collection parent type without discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**name** +
|
||||
@@ -65,7 +65,7 @@ __Polymorphism__ : Inheritance
|
||||
__Discriminator__ : dogType
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**name** +
|
||||
@@ -89,7 +89,7 @@ A map without discriminator
|
||||
__Polymorphism__ : Composition
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**name** +
|
||||
@@ -104,7 +104,7 @@ __required__|collection type discriminator|string
|
||||
Pet parent type with discriminator
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**name** +
|
||||
|
||||
@@ -15,7 +15,7 @@ Get collections
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_collection,Collection>>
|
||||
@@ -45,7 +45,7 @@ Get pets
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|OK|<<_pet,Pet>>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|**Example** : `"string"`|string
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -40,7 +40,7 @@ __optional__|**Example** : `[ "<<_tag>>" ]`|< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
91
src/test/resources/expected/asciidoc/query_params/paths.adoc
Normal file
91
src/test/resources/expected/asciidoc/query_params/paths.adoc
Normal file
@@ -0,0 +1,91 @@
|
||||
|
||||
[[_paths]]
|
||||
== Paths
|
||||
|
||||
[[_findpetsbystatus]]
|
||||
=== Finds Pets by status
|
||||
....
|
||||
GET /pet/findByStatus
|
||||
....
|
||||
|
||||
|
||||
==== Description
|
||||
Multiple status values can be provided with comma separated strings
|
||||
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
__required__|Status values that need to be considered for filter|< enum (available, pending, sold) > array(multi)
|
||||
|===
|
||||
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation|< <<_pet,Pet>> > array
|
||||
|**400**|Invalid status value|No Content
|
||||
|===
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `application/xml`
|
||||
* `application/json`
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write:pets,read:pets
|
||||
|===
|
||||
|
||||
|
||||
==== Example HTTP request
|
||||
|
||||
===== Request path
|
||||
----
|
||||
/pet/findByStatus
|
||||
----
|
||||
|
||||
|
||||
===== Request query
|
||||
|
||||
|===
|
||||
|Name|Value
|
||||
|status|string
|
||||
|===
|
||||
|
||||
|
||||
==== Example HTTP response
|
||||
|
||||
===== Response 200
|
||||
[source,json]
|
||||
----
|
||||
[ {
|
||||
"id" : 0,
|
||||
"category" : {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
},
|
||||
"name" : "doggie",
|
||||
"photoUrls" : [ "string" ],
|
||||
"tags" : [ {
|
||||
"id" : 0,
|
||||
"name" : "string"
|
||||
} ],
|
||||
"status" : "string"
|
||||
} ]
|
||||
----
|
||||
@@ -10,7 +10,7 @@ __Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.io/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write:pets|modify pets in your account
|
||||
@@ -24,6 +24,3 @@ __Token URL__ : http://petstore.swagger.io/oauth/dialog
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -18,7 +18,7 @@ __optional__|string
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -39,7 +39,7 @@ __optional__||< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -59,7 +59,7 @@ This is an important value !. +
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
|
||||
@@ -2,14 +2,6 @@
|
||||
[[_securityscheme]]
|
||||
== Security
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
[[_petstore_auth]]
|
||||
=== petstore_auth
|
||||
[%hardbreaks]
|
||||
@@ -18,7 +10,7 @@ __Flow__ : implicit
|
||||
__Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|
||||
|
||||
[options="header", cols=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -26,4 +18,12 @@ __Token URL__ : http://petstore.swagger.io/api/oauth/dialog
|
||||
|===
|
||||
|
||||
|
||||
[[_api_key]]
|
||||
=== api_key
|
||||
[%hardbreaks]
|
||||
__Type__ : apiKey
|
||||
__Name__ : api_key
|
||||
__In__ : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -71,7 +71,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -97,7 +97,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -113,7 +113,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -123,7 +123,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -151,7 +151,7 @@ __optional__|Pet object that needs to be added to the store|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -171,7 +171,7 @@ Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**status** +
|
||||
@@ -181,7 +181,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -206,7 +206,7 @@ __optional__|Status values that need to be considered for filter|< string > arra
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -226,7 +226,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -236,7 +236,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -261,7 +261,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -277,7 +277,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -291,7 +291,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -316,7 +316,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -336,7 +336,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -346,7 +346,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -372,7 +372,7 @@ __required__|ID of pet that needs to be fetched|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -389,7 +389,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -401,7 +401,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid pet value|No Content
|
||||
@@ -421,7 +421,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -437,7 +437,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -447,7 +447,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -483,7 +483,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -493,7 +493,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -530,7 +530,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -540,7 +540,7 @@ __required__|ID of the order that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid ID supplied|No Content
|
||||
@@ -572,7 +572,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -582,7 +582,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -609,7 +609,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -619,7 +619,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -646,7 +646,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -656,7 +656,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -683,7 +683,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**password** +
|
||||
@@ -695,7 +695,7 @@ __optional__|The user name for login|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -727,7 +727,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -754,7 +754,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -764,7 +764,7 @@ __required__|The name that needs to be fetched. Use user1 for testing.|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -801,7 +801,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -813,7 +813,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid user supplied|No Content
|
||||
@@ -845,7 +845,7 @@ This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -855,7 +855,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
@@ -882,7 +882,7 @@ __required__|The name that needs to be deleted|string
|
||||
[[_category]]
|
||||
=== Category
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -899,7 +899,7 @@ __optional__|The name of the category +
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -923,7 +923,7 @@ __optional__|Order Status|enum (Ordered, Cancelled)
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -944,7 +944,7 @@ __optional__||< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -957,7 +957,7 @@ __optional__|string
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
@@ -984,27 +984,15 @@ __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=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -1012,4 +1000,12 @@ __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=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**id** +
|
||||
@@ -22,7 +22,7 @@ __optional__|The name of the category +
|
||||
[[_order]]
|
||||
=== Order
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**complete** +
|
||||
@@ -46,7 +46,7 @@ __optional__|Order Status|enum (Ordered, Cancelled)
|
||||
[[_pet]]
|
||||
=== Pet
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**category** +
|
||||
@@ -67,7 +67,7 @@ __optional__||< <<_tag,Tag>> > array
|
||||
[[_tag]]
|
||||
=== Tag
|
||||
|
||||
[options="header", cols=".^3a,.^4a"]
|
||||
[options="header", cols=".^3,.^4"]
|
||||
|===
|
||||
|Name|Schema
|
||||
|**id** +
|
||||
@@ -80,7 +80,7 @@ __optional__|string
|
||||
[[_user]]
|
||||
=== User
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**email** +
|
||||
|
||||
@@ -11,7 +11,7 @@ POST /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -63,7 +63,7 @@ PUT /pets
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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|<<_pet,Pet>>
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**tags** +
|
||||
@@ -186,7 +186,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -211,7 +211,7 @@ __optional__|Tags to filter by|< string > array(multi)
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -227,7 +227,7 @@ POST /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**petId** +
|
||||
@@ -241,7 +241,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**405**|Invalid input|No Content
|
||||
@@ -266,7 +266,7 @@ __required__|Updated status of the pet|string
|
||||
|
||||
==== Security
|
||||
|
||||
[options="header", cols=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**apiKey**|**<<_api_key,api_key>>**|
|
||||
@@ -339,7 +339,7 @@ DELETE /pets/{petId}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Header**|**api_key** +
|
||||
@@ -351,7 +351,7 @@ __required__|Pet id to delete|integer (int64)
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^3a,.^4a,.^13a"]
|
||||
[options="header", cols=".^3,.^4,.^13"]
|
||||
|===
|
||||
|Type|Name|Scopes
|
||||
|**oauth2**|**<<_petstore_auth,petstore_auth>>**|write_pets,read_pets
|
||||
@@ -387,7 +387,7 @@ POST /stores/order
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -397,7 +397,7 @@ __optional__|order placed for purchasing the pet|<<_order,Order>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**orderId** +
|
||||
@@ -443,7 +443,7 @@ __required__|ID of pet that needs to be fetched|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -532,7 +532,7 @@ __optional__|Created user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -559,7 +559,7 @@ POST /users/createWithArray
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -569,7 +569,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -596,7 +596,7 @@ POST /users/createWithList
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Body**|**body** +
|
||||
@@ -606,7 +606,7 @@ __optional__|List of user object|< <<_user,User>> > array
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -633,7 +633,7 @@ GET /users/login
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Query**|**password** +
|
||||
@@ -645,7 +645,7 @@ __optional__|The user name for login|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**200**|successful operation +
|
||||
@@ -677,7 +677,7 @@ GET /users/logout
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**default**|successful operation|No Content
|
||||
@@ -704,7 +704,7 @@ GET /users/{username}
|
||||
|
||||
==== Parameters
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -763,7 +763,7 @@ __optional__|Updated user object|<<_user,User>>
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|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=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2,.^3,.^9,.^4"]
|
||||
|===
|
||||
|Type|Name|Description|Schema
|
||||
|**Path**|**username** +
|
||||
@@ -805,7 +805,7 @@ __required__|The name that needs to be deleted|string
|
||||
|
||||
==== Responses
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
[options="header", cols=".^2,.^14,.^4"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|**400**|Invalid username supplied|No Content
|
||||
|
||||
@@ -2,27 +2,15 @@
|
||||
[[_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=".^3a,.^17a"]
|
||||
[options="header", cols=".^3,.^17"]
|
||||
|===
|
||||
|Name|Description
|
||||
|write_pets|modify pets in your account
|
||||
@@ -30,4 +18,12 @@ __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 @@
|
||||
[[_samplerequest]]
|
||||
=== SampleRequest
|
||||
|
||||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||||
[options="header", cols=".^3,.^11,.^4"]
|
||||
|===
|
||||
|Name|Description|Schema
|
||||
|**sampleDoubleComplete** +
|
||||
|
||||
@@ -2,19 +2,8 @@
|
||||
<a name="securityscheme"></a>
|
||||
## Security
|
||||
|
||||
<a name="api_key"></a>
|
||||
### api_key
|
||||
This is another description
|
||||
|
||||
*Type* : apiKey
|
||||
*Name* : api_key
|
||||
*In* : HEADER
|
||||
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
This is a standard oauth flow
|
||||
|
||||
*Type* : oauth2
|
||||
*Flow* : implicit
|
||||
*Token URL* : http://petstore.swagger.io/api/oauth/dialog
|
||||
@@ -26,4 +15,11 @@ This is a standard oauth flow
|
||||
|read_pets|read your pets|
|
||||
|
||||
|
||||
<a name="api_key"></a>
|
||||
### api_key
|
||||
*Type* : apiKey
|
||||
*Name* : api_key
|
||||
*In* : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2,13 +2,6 @@
|
||||
<a name="securityscheme"></a>
|
||||
## Security
|
||||
|
||||
<a name="api_key"></a>
|
||||
### api_key
|
||||
*Type* : apiKey
|
||||
*Name* : api_key
|
||||
*In* : HEADER
|
||||
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
*Type* : oauth2
|
||||
@@ -22,4 +15,11 @@
|
||||
|read_pets|read your pets|
|
||||
|
||||
|
||||
<a name="api_key"></a>
|
||||
### api_key
|
||||
*Type* : apiKey
|
||||
*Name* : api_key
|
||||
*In* : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2,19 +2,8 @@
|
||||
<a name="securityscheme"></a>
|
||||
## Security
|
||||
|
||||
<a name="api_key"></a>
|
||||
### api_key
|
||||
This is another description
|
||||
|
||||
*Type* : apiKey
|
||||
*Name* : api_key
|
||||
*In* : HEADER
|
||||
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
This is a standard oauth flow
|
||||
|
||||
*Type* : oauth2
|
||||
*Flow* : implicit
|
||||
*Token URL* : http://petstore.swagger.io/api/oauth/dialog
|
||||
@@ -26,4 +15,11 @@ This is a standard oauth flow
|
||||
|read_pets|read your pets|
|
||||
|
||||
|
||||
<a name="api_key"></a>
|
||||
### api_key
|
||||
*Type* : apiKey
|
||||
*Name* : api_key
|
||||
*In* : HEADER
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,122 +0,0 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n",
|
||||
"version": "1.0.0",
|
||||
"title": "Swagger Petstore API",
|
||||
"termsOfService": "http://helloreverb.com/terms/",
|
||||
"contact": {
|
||||
"name": "apiteam@wordnik.com"
|
||||
},
|
||||
"license": {
|
||||
"name": "Apache 2.0",
|
||||
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
|
||||
}
|
||||
},
|
||||
"host": "petstore.swagger.wordnik.com",
|
||||
"basePath": "/v2",
|
||||
"schemes": [
|
||||
"http"
|
||||
],
|
||||
"tags": [
|
||||
{
|
||||
"name": "user",
|
||||
"description": "User resource"
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/users": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Create user",
|
||||
"description": "This can only be done by the logged in user.",
|
||||
"operationId": "createUser",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Created user object",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/User"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"default": {
|
||||
"description": "successful operation"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"securityDefinitions": {
|
||||
"api_key": {
|
||||
"type": "apiKey",
|
||||
"name": "api_key",
|
||||
"in": "header"
|
||||
},
|
||||
"petstore_auth": {
|
||||
"type": "oauth2",
|
||||
"authorizationUrl": "http://petstore.swagger.wordnik.com/api/oauth/dialog",
|
||||
"flow": "implicit",
|
||||
"scopes": {
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"FoundPets": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Pet"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parameters": {
|
||||
"petId": {
|
||||
"in": "path",
|
||||
"name": "petId",
|
||||
"description": "ID of the pet",
|
||||
"required": true,
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"Identified": {
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
}
|
||||
}
|
||||
},
|
||||
"User": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/Identified"
|
||||
},
|
||||
{
|
||||
"properties": {
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"Category": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/Identified"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user