diff --git a/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicDefinitionsDocumentExtension.java b/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicDefinitionsDocumentExtension.java index 07f73bb..7acc6a5 100644 --- a/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicDefinitionsDocumentExtension.java +++ b/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicDefinitionsDocumentExtension.java @@ -31,13 +31,7 @@ import java.util.Optional; /** - * Dynamically search for markup files in {@code contentPath} to append in Definitions, with the format :
- * - {@code document-before-*.} : import before Definitions document with levelOffset = 0
- * - {@code document-after-*.} : import after Definitions document with levelOffset = 0
- * - {@code document-begin-*.} : import just after Definitions document main title with levelOffset = 1
- * - {@code document-end-*.} : import at the end of Definitions document with levelOffset = 1
- * - {@code definition-begin-*.} : import just after each definition title with levelOffset = 2
- * - {@code definition-end-*.} : import at the end of each definition with levelOffset = 2
+ * Dynamically search for markup files in {@code contentPath} to append in Definitions document. *

* Markup files are appended in the natural order of their names, for each category. */ @@ -120,12 +114,12 @@ public void apply(Context context) { case DOCUMENT_END: dynamicContent.extensionsSection(extensionMarkupLanguage, contentPath, contentPrefix(position), levelOffset(context)); break; + case DEFINITION_BEFORE: case DEFINITION_BEGIN: case DEFINITION_END: + case DEFINITION_AFTER: dynamicContent.extensionsSection(extensionMarkupLanguage, contentPath.resolve(Paths.get(IOUtils.normalizeName(context.getDefinitionName().get()))), contentPrefix(position), levelOffset(context)); break; - default: - throw new RuntimeException(String.format("Unknown position '%s'", position)); } } } diff --git a/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicOverviewDocumentExtension.java b/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicOverviewDocumentExtension.java index 47f90af..c15ee66 100644 --- a/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicOverviewDocumentExtension.java +++ b/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicOverviewDocumentExtension.java @@ -30,11 +30,7 @@ import java.util.Optional; /** - * Dynamically search for markup files in {@code contentPath} to append to Overview, with the format :
- * - {@code document-before-*.} : import before Overview document with levelOffset = 0
- * - {@code document-after-*.} : import after Overview document with levelOffset = 0
- * - {@code document-begin-*.} : import just after Overview document main title with levelOffset = 1
- * - {@code document-end-*.} : import at the end of Overview document with levelOffset = 1
+ * Dynamically search for markup files in {@code contentPath} to append to Overview document. *

* Markup files are appended in the natural order of their names, for each category. */ @@ -117,8 +113,6 @@ public void apply(Context context) { case DOCUMENT_END: dynamicContent.extensionsSection(extensionMarkupLanguage, contentPath, contentPrefix(position), levelOffset(context)); break; - default: - throw new RuntimeException(String.format("Unknown position '%s'", position)); } } } diff --git a/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicPathsDocumentExtension.java b/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicPathsDocumentExtension.java index fe10069..62c2956 100644 --- a/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicPathsDocumentExtension.java +++ b/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicPathsDocumentExtension.java @@ -31,13 +31,7 @@ import java.util.Optional; /** - * Dynamically search for markup files in {@code contentPath} to append to Operations, with the format :
- * - {@code document-before-*.} : import before Paths document with levelOffset = 0
- * - {@code document-after-*.} : import after Paths document with levelOffset = 0
- * - {@code document-begin-*.} : import just after Paths document main title with levelOffset = 1
- * - {@code document-end-*.} : import at the end of Paths document with levelOffset = 1
- * - {@code operation-begin-*.} : import just after each operation title with levelOffset = 2(GroupBy.AS_IS) | 3(GroupBy.TAGS)
- * - {@code operation-end-*.} : import at the end of each operation with levelOffset = 2(GroupBy.AS_IS) | 3(GroupBy.TAGS)
+ * Dynamically search for markup files in {@code contentPath} to append to Paths document. *

* Markup files are appended in the natural order of their names, for each category. */ @@ -120,12 +114,28 @@ public void apply(Context context) { case DOCUMENT_END: dynamicContent.extensionsSection(extensionMarkupLanguage, contentPath, contentPrefix(position), levelOffset(context)); break; + case OPERATION_BEFORE: case OPERATION_BEGIN: case OPERATION_END: + case OPERATION_AFTER: + case OPERATION_DESCRIPTION_BEFORE: + case OPERATION_DESCRIPTION_AFTER: + case OPERATION_PARAMETERS_BEFORE: + case OPERATION_PARAMETERS_AFTER: + case OPERATION_RESPONSES_BEFORE: + case OPERATION_RESPONSES_AFTER: + case OPERATION_SECURITY_BEFORE: + case OPERATION_SECURITY_AFTER: + case OPERATION_DESCRIPTION_BEGIN: + case OPERATION_DESCRIPTION_END: + case OPERATION_PARAMETERS_BEGIN: + case OPERATION_PARAMETERS_END: + case OPERATION_RESPONSES_BEGIN: + case OPERATION_RESPONSES_END: + case OPERATION_SECURITY_BEGIN: + case OPERATION_SECURITY_END: dynamicContent.extensionsSection(extensionMarkupLanguage, contentPath.resolve(IOUtils.normalizeName(context.getOperation().get().getId())), contentPrefix(position), levelOffset(context)); break; - default: - throw new RuntimeException(String.format("Unknown position '%s'", position)); } } } diff --git a/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicSecurityDocumentExtension.java b/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicSecurityDocumentExtension.java index 76f6855..3d0c168 100644 --- a/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicSecurityDocumentExtension.java +++ b/swagger2markup-import-files-ext/src/main/java/io/github/swagger2markup/extensions/DynamicSecurityDocumentExtension.java @@ -31,13 +31,7 @@ import java.util.Optional; /** - * Dynamically search for markup files in {@code contentPath} to append to Overview, with the format :
- * - {@code document-before-*.} : import before Overview document with levelOffset = 0
- * - {@code document-after-*.} : import after Overview document with levelOffset = 0
- * - {@code document-begin-*.} : import just after Overview document main title with levelOffset = 1
- * - {@code document-end-*.} : import at the end of Overview document with levelOffset = 1
- * - {@code definition-begin-*.} : import just after each definition title with levelOffset = 2
- * - {@code definition-end-*.} : import at the end of each definition with levelOffset = 2
+ * Dynamically search for markup files in {@code contentPath} to append to Security document. *

* Markup files are appended in the natural order of their names, for each category. */ @@ -120,12 +114,12 @@ public void apply(Context context) { case DOCUMENT_END: dynamicContent.extensionsSection(extensionMarkupLanguage, contentPath, contentPrefix(position), levelOffset(context)); break; - case DEFINITION_BEGIN: - case DEFINITION_END: - dynamicContent.extensionsSection(extensionMarkupLanguage, contentPath.resolve(IOUtils.normalizeName(context.getDefinitionName().get())), contentPrefix(position), levelOffset(context)); + case SECURITY_SCHEME_BEFORE: + case SECURITY_SCHEME_BEGIN: + case SECURITY_SCHEME_END: + case SECURITY_SCHEME_AFTER: + dynamicContent.extensionsSection(extensionMarkupLanguage, contentPath.resolve(IOUtils.normalizeName(context.getSecuritySchemeName().get())), contentPrefix(position), levelOffset(context)); break; - default: - throw new RuntimeException(String.format("Unknown position '%s'", position)); } } } diff --git a/swagger2markup-import-files-ext/src/test/java/io/github/swagger2markup/extensions/DynamicDocumentExtensionTest.java b/swagger2markup-import-files-ext/src/test/java/io/github/swagger2markup/extensions/DynamicDocumentExtensionTest.java index db25edd..8d5ea9b 100644 --- a/swagger2markup-import-files-ext/src/test/java/io/github/swagger2markup/extensions/DynamicDocumentExtensionTest.java +++ b/swagger2markup-import-files-ext/src/test/java/io/github/swagger2markup/extensions/DynamicDocumentExtensionTest.java @@ -40,7 +40,7 @@ public class DynamicDocumentExtensionTest { public void testSwagger2AsciiDocExtensions() throws IOException, URISyntaxException { //Given Path file = Paths.get(DynamicDocumentExtensionTest.class.getResource("/yaml/swagger_petstore.yaml").toURI()); - Path outputDirectory = Paths.get("build/docs/asciidoc/generated"); + Path outputDirectory = Paths.get("build/test/asciidoc/generated"); FileUtils.deleteQuietly(outputDirectory.toFile()); //When @@ -70,7 +70,7 @@ public void testSwagger2AsciiDocExtensions() throws IOException, URISyntaxExcept public void testSwagger2MarkdownExtensions() throws IOException, URISyntaxException { //Given Path file = Paths.get(DynamicDocumentExtensionTest.class.getResource("/yaml/swagger_petstore.yaml").toURI()); - Path outputDirectory = Paths.get("build/docs/markdown/generated"); + Path outputDirectory = Paths.get("build/test/markdown/generated"); FileUtils.deleteQuietly(outputDirectory.toFile()); //When diff --git a/swagger2markup-import-schemas-ext/src/main/java/io/github/swagger2markup/extensions/SchemaExtension.java b/swagger2markup-import-schemas-ext/src/main/java/io/github/swagger2markup/extensions/SchemaExtension.java index 8c02acf..a813e33 100644 --- a/swagger2markup-import-schemas-ext/src/main/java/io/github/swagger2markup/extensions/SchemaExtension.java +++ b/swagger2markup-import-schemas-ext/src/main/java/io/github/swagger2markup/extensions/SchemaExtension.java @@ -124,19 +124,11 @@ public void apply(Context context) { if (schemaBaseUri != null) { switch (context.getPosition()) { - case DOCUMENT_BEFORE: - case DOCUMENT_AFTER: - case DOCUMENT_BEGIN: - case DOCUMENT_END: - case DEFINITION_BEGIN: - break; case DEFINITION_END: for (SchemaMetadata schema : DEFAULT_SCHEMAS) { schemaSection(context, schema, levelOffset(context)); } break; - default: - throw new RuntimeException(String.format("Unknown position '%s'", context.getPosition())); } } } diff --git a/swagger2markup-import-schemas-ext/src/test/java/io/github/swagger2markup/extensions/SchemaExtensionTest.java b/swagger2markup-import-schemas-ext/src/test/java/io/github/swagger2markup/extensions/SchemaExtensionTest.java index c182328..aef028e 100644 --- a/swagger2markup-import-schemas-ext/src/test/java/io/github/swagger2markup/extensions/SchemaExtensionTest.java +++ b/swagger2markup-import-schemas-ext/src/test/java/io/github/swagger2markup/extensions/SchemaExtensionTest.java @@ -40,7 +40,7 @@ public class SchemaExtensionTest { public void testSwagger2AsciiDocSchemaExtension() throws IOException, URISyntaxException { //Given Path file = Paths.get(SchemaExtensionTest.class.getResource("/yaml/swagger_petstore.yaml").toURI()); - Path outputDirectory = Paths.get("build/docs/asciidoc/generated"); + Path outputDirectory = Paths.get("build/test/asciidoc/generated"); FileUtils.deleteQuietly(outputDirectory.toFile()); //When diff --git a/swagger2markup-spring-restdocs-ext/src/test/java/io/github/swagger2markup/extensions/SpringRestDocsExtensionsTest.java b/swagger2markup-spring-restdocs-ext/src/test/java/io/github/swagger2markup/extensions/SpringRestDocsExtensionsTest.java index e809df1..456e004 100644 --- a/swagger2markup-spring-restdocs-ext/src/test/java/io/github/swagger2markup/extensions/SpringRestDocsExtensionsTest.java +++ b/swagger2markup-spring-restdocs-ext/src/test/java/io/github/swagger2markup/extensions/SpringRestDocsExtensionsTest.java @@ -53,7 +53,7 @@ public void setUp(){ public void testSwagger2AsciiDocConversionWithSpringRestDocsExtension() throws IOException, URISyntaxException { //Given Path file = Paths.get(SpringRestDocsExtensionsTest.class.getResource("/yaml/swagger_petstore.yaml").toURI()); - Path outputDirectory = Paths.get("build/docs/asciidoc/spring_rest_docs"); + Path outputDirectory = Paths.get("build/test/asciidoc/spring_rest_docs"); FileUtils.deleteQuietly(outputDirectory.toFile()); //When diff --git a/swagger2markup-spring-restdocs-ext/src/test/resources/expected_results/asciidoc/spring_rest_docs/paths.adoc b/swagger2markup-spring-restdocs-ext/src/test/resources/expected_results/asciidoc/spring_rest_docs/paths.adoc index b53708a..a00033e 100644 --- a/swagger2markup-spring-restdocs-ext/src/test/resources/expected_results/asciidoc/spring_rest_docs/paths.adoc +++ b/swagger2markup-spring-restdocs-ext/src/test/resources/expected_results/asciidoc/spring_rest_docs/paths.adoc @@ -11,21 +11,20 @@ POST /pets ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| +|Type|Name|Description|Schema|Default +|*Body*|*body* + +_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>| |=== ==== Responses -===== HTTP Code 405 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|405|Invalid input|No Content +|*405*|Invalid input|No Content |=== @@ -48,10 +47,10 @@ POST /pets ==== Security -[options="header", cols=".^1h,.^1h,.^6"] +[options="header", cols=".^3,.^4,.^13"] |=== |Type|Name|Scopes -|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets +|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets |=== @@ -102,39 +101,22 @@ PUT /pets ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Body|body|Pet object that needs to be added to the store|false|<<_pet,Pet>>| +|Type|Name|Description|Schema|Default +|*Body*|*body* + +_optional_|Pet object that needs to be added to the store|<<_pet,Pet>>| |=== ==== Responses -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|400|Invalid ID supplied|No Content -|=== - - -===== HTTP Code 404 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|404|Pet not found|No Content -|=== - - -===== HTTP Code 405 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|405|Validation exception|No Content +|*400*|Invalid ID supplied|No Content +|*404*|Pet not found|No Content +|*405*|Validation exception|No Content |=== @@ -157,10 +139,10 @@ PUT /pets ==== Security -[options="header", cols=".^1h,.^1h,.^6"] +[options="header", cols=".^3,.^4,.^13"] |=== |Type|Name|Scopes -|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets +|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets |=== @@ -177,40 +159,25 @@ Multiple status values can be provided with comma seperated strings ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Query|status|Status values that need to be considered for filter|false|multi string array| +|Type|Name|Description|Schema|Default +|*Query*|*status* + +_optional_|Status values that need to be considered for filter|< string > array(multi)| |=== ==== Responses -===== HTTP Code 200 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<_pet,Pet>> array -|=== - -*Headers* - -[options="header", cols=".^1h,.^3,.^1,.^1"] -|=== -|Name|Description|Schema|Default -|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| -|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| -|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| -|=== - - -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|400|Invalid status value|No Content +|*200*|successful operation + +*Headers* : + +`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. + +`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. + +`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<_pet,Pet>> > array +|*400*|Invalid status value|No Content |=== @@ -227,10 +194,10 @@ Multiple status values can be provided with comma seperated strings ==== Security -[options="header", cols=".^1h,.^1h,.^6"] +[options="header", cols=".^3,.^4,.^13"] |=== |Type|Name|Scopes -|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets +|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets |=== @@ -247,40 +214,25 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Query|tags|Tags to filter by|false|multi string array| +|Type|Name|Description|Schema|Default +|*Query*|*tags* + +_optional_|Tags to filter by|< string > array(multi)| |=== ==== Responses -===== HTTP Code 200 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<_pet,Pet>> array -|=== - -*Headers* - -[options="header", cols=".^1h,.^3,.^1,.^1"] -|=== -|Name|Description|Schema|Default -|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| -|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| -|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| -|=== - - -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|400|Invalid tag value|No Content +|*200*|successful operation + +*Headers* : + +`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. + +`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. + +`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|< <<_pet,Pet>> > array +|*400*|Invalid tag value|No Content |=== @@ -297,10 +249,10 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 ==== Security -[options="header", cols=".^1h,.^1h,.^6"] +[options="header", cols=".^3,.^4,.^13"] |=== |Type|Name|Scopes -|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets +|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets |=== @@ -313,23 +265,24 @@ POST /pets/{petId} ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Path|petId|ID of pet that needs to be updated|true|string| -|FormData|name|Updated name of the pet|true|string| -|FormData|status|Updated status of the pet|true|string| +|Type|Name|Description|Schema|Default +|*Path*|*petId* + +_required_|ID of pet that needs to be updated|string| +|*FormData*|*name* + +_required_|Updated name of the pet|string| +|*FormData*|*status* + +_required_|Updated status of the pet|string| |=== ==== Responses -===== HTTP Code 405 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|405|Invalid input|No Content +|*405*|Invalid input|No Content |=== @@ -351,10 +304,10 @@ POST /pets/{petId} ==== Security -[options="header", cols=".^1h,.^1h,.^6"] +[options="header", cols=".^3,.^4,.^13"] |=== |Type|Name|Scopes -|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets +|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets |=== @@ -371,49 +324,26 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Path|petId|ID of pet that needs to be fetched|true|integer(int64)| +|Type|Name|Description|Schema|Default +|*Path*|*petId* + +_required_|ID of pet that needs to be fetched|integer(int64)| |=== ==== Responses -===== HTTP Code 200 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<_pet,Pet>> -|=== - -*Headers* - -[options="header", cols=".^1h,.^3,.^1,.^1"] -|=== -|Name|Description|Schema|Default -|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| -|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| -|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| -|=== - - -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|400|Invalid ID supplied|No Content -|=== - - -===== HTTP Code 404 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|404|Pet not found|No Content +|*200*|successful operation + +*Headers* : + +`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. + +`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. + +`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_pet,Pet>> +|*400*|Invalid ID supplied|No Content +|*404*|Pet not found|No Content |=== @@ -430,11 +360,11 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error ==== Security -[options="header", cols=".^1h,.^1h,.^6"] +[options="header", cols=".^3,.^4,.^13"] |=== |Type|Name|Scopes -|apiKey|<<_api_key,api_key>>| -|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets +|*apiKey*|*<<_api_key,api_key>>*| +|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets |=== @@ -447,22 +377,22 @@ DELETE /pets/{petId} ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Header|api_key||true|string| -|Path|petId|Pet id to delete|true|integer(int64)| +|Type|Name|Description|Schema|Default +|*Header*|*api_key* + +_required_||string| +|*Path*|*petId* + +_required_|Pet id to delete|integer(int64)| |=== ==== Responses -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|400|Invalid pet value|No Content +|*400*|Invalid pet value|No Content |=== @@ -479,10 +409,10 @@ DELETE /pets/{petId} ==== Security -[options="header", cols=".^1h,.^1h,.^6"] +[options="header", cols=".^3,.^4,.^13"] |=== |Type|Name|Scopes -|oauth2|<<_petstore_auth,petstore_auth>>|write_pets,read_pets +|*oauth2*|*<<_petstore_auth,petstore_auth>>*|write_pets,read_pets |=== @@ -495,40 +425,25 @@ POST /stores/order ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Body|body|order placed for purchasing the pet|false|<<_order,Order>>| +|Type|Name|Description|Schema|Default +|*Body*|*body* + +_optional_|order placed for purchasing the pet|<<_order,Order>>| |=== ==== Responses -===== HTTP Code 200 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|200|successful operation|<<_order,Order>> -|=== - -*Headers* - -[options="header", cols=".^1h,.^3,.^1,.^1"] -|=== -|Name|Description|Schema|Default -|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| -|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| -|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| -|=== - - -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|400|Invalid Order|No Content +|*200*|successful operation + +*Headers* : + +`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. + +`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. + +`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_order,Order>> +|*400*|Invalid Order|No Content |=== @@ -556,49 +471,26 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Path|orderId|ID of pet that needs to be fetched|true|string| +|Type|Name|Description|Schema|Default +|*Path*|*orderId* + +_required_|ID of pet that needs to be fetched|string| |=== ==== Responses -===== HTTP Code 200 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<_order,Order>> -|=== - -*Headers* - -[options="header", cols=".^1h,.^3,.^1,.^1"] -|=== -|Name|Description|Schema|Default -|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| -|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| -|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| -|=== - - -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|400|Invalid ID supplied|No Content -|=== - - -===== HTTP Code 404 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|404|Order not found|No Content +|*200*|successful operation + +*Headers* : + +`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. + +`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. + +`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_order,Order>> +|*400*|Invalid ID supplied|No Content +|*404*|Order not found|No Content |=== @@ -626,30 +518,21 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Path|orderId|ID of the order that needs to be deleted|true|string| +|Type|Name|Description|Schema|Default +|*Path*|*orderId* + +_required_|ID of the order that needs to be deleted|string| |=== ==== Responses -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|400|Invalid ID supplied|No Content -|=== - - -===== HTTP Code 404 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|404|Order not found|No Content +|*400*|Invalid ID supplied|No Content +|*404*|Order not found|No Content |=== @@ -677,21 +560,20 @@ This can only be done by the logged in user. ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Body|body|Created user object|false|<<_user,User>>| +|Type|Name|Description|Schema|Default +|*Body*|*body* + +_optional_|Created user object|<<_user,User>>| |=== ==== Responses -===== HTTP Code default - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|default|successful operation|No Content +|*default*|successful operation|No Content |=== @@ -715,21 +597,20 @@ POST /users/createWithArray ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Body|body|List of user object|false|<<_user,User>> array| +|Type|Name|Description|Schema|Default +|*Body*|*body* + +_optional_|List of user object|< <<_user,User>> > array| |=== ==== Responses -===== HTTP Code default - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|default|successful operation|No Content +|*default*|successful operation|No Content |=== @@ -753,21 +634,20 @@ POST /users/createWithList ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Body|body|List of user object|false|<<_user,User>> array| +|Type|Name|Description|Schema|Default +|*Body*|*body* + +_optional_|List of user object|< <<_user,User>> > array| |=== ==== Responses -===== HTTP Code default - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|default|successful operation|No Content +|*default*|successful operation|No Content |=== @@ -791,41 +671,27 @@ GET /users/login ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Query|password|The password for login in clear text|false|string| -|Query|username|The user name for login|false|string| +|Type|Name|Description|Schema|Default +|*Query*|*password* + +_optional_|The password for login in clear text|string| +|*Query*|*username* + +_optional_|The user name for login|string| |=== ==== Responses -===== HTTP Code 200 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|string -|=== - -*Headers* - -[options="header", cols=".^1h,.^3,.^1,.^1"] -|=== -|Name|Description|Schema|Default -|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| -|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| -|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| -|=== - - -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|400|Invalid username/password supplied|No Content +|*200*|successful operation + +*Headers* : + +`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. + +`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. + +`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|string +|*400*|Invalid username/password supplied|No Content |=== @@ -849,12 +715,10 @@ GET /users/logout ==== Responses -===== HTTP Code default - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|default|successful operation|No Content +|*default*|successful operation|No Content |=== @@ -878,49 +742,26 @@ GET /users/{username} ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Path|username|The name that needs to be fetched. Use user1 for testing.|true|string| +|Type|Name|Description|Schema|Default +|*Path*|*username* + +_required_|The name that needs to be fetched. Use user1 for testing.|string| |=== ==== Responses -===== HTTP Code 200 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<_user,User>> -|=== - -*Headers* - -[options="header", cols=".^1h,.^3,.^1,.^1"] -|=== -|Name|Description|Schema|Default -|X-Rate-Limit-Limit|The number of allowed requests in the current period|integer| -|X-Rate-Limit-Remaining|The number of remaining requests in the current period|integer| -|X-Rate-Limit-Reset|The number of seconds left in the current period|integer| -|=== - - -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|400|Invalid username supplied|No Content -|=== - - -===== HTTP Code 404 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|404|User not found|No Content +|*200*|successful operation + +*Headers* : + +`X-Rate-Limit-Limit` (integer) : The number of allowed requests in the current period. + +`X-Rate-Limit-Remaining` (integer) : The number of remaining requests in the current period. + +`X-Rate-Limit-Reset` (integer) : The number of seconds left in the current period.|<<_user,User>> +|*400*|Invalid username supplied|No Content +|*404*|User not found|No Content |=== @@ -948,31 +789,23 @@ This can only be done by the logged in user. ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Path|username|name that need to be deleted|true|string| -|Body|body|Updated user object|false|<<_user,User>>| +|Type|Name|Description|Schema|Default +|*Path*|*username* + +_required_|name that need to be deleted|string| +|*Body*|*body* + +_optional_|Updated user object|<<_user,User>>| |=== ==== Responses -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|400|Invalid user supplied|No Content -|=== - - -===== HTTP Code 404 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|404|User not found|No Content +|*400*|Invalid user supplied|No Content +|*404*|User not found|No Content |=== @@ -1000,30 +833,21 @@ This can only be done by the logged in user. ==== Parameters -[options="header", cols=".^1h,.^1h,.^6,.^1,.^1,.^1"] +[options="header", cols=".^1,.^3,.^10,.^4,.^2"] |=== -|Type|Name|Description|Required|Schema|Default -|Path|username|The name that needs to be deleted|true|string| +|Type|Name|Description|Schema|Default +|*Path*|*username* + +_required_|The name that needs to be deleted|string| |=== ==== Responses -===== HTTP Code 400 - -[options="header", cols=".^1h,.^3,.^1"] -|=== -|HTTP Code|Description|Schema -|400|Invalid username supplied|No Content -|=== - - -===== HTTP Code 404 - -[options="header", cols=".^1h,.^3,.^1"] +[options="header", cols=".^1,.^15,.^4"] |=== |HTTP Code|Description|Schema -|404|User not found|No Content +|*400*|Invalid username supplied|No Content +|*404*|User not found|No Content |===