diff --git a/src/test/resources/expected/asciidoc/default/definitions.adoc b/src/test/resources/expected/asciidoc/default/definitions.adoc index 9a434ed9..89a744ea 100644 --- a/src/test/resources/expected/asciidoc/default/definitions.adoc +++ b/src/test/resources/expected/asciidoc/default/definitions.adoc @@ -32,7 +32,9 @@ _optional_||integer(int64) |*petId* + _optional_||integer(int64) |*quantity* + -_optional_|*Default* : `0`*Minimum value* : `0.0`*Maximum value* : `10000.0` + +_optional_|*Default* : `0` + +*Minimum value* : `0.0` + +*Maximum value* : `10000.0` + *Example* : `10`|integer(int32) |*shipDate* + _optional_||string(date-time) diff --git a/src/test/resources/expected/asciidoc/default/security.adoc b/src/test/resources/expected/asciidoc/default/security.adoc index 6f896a69..3ac0b280 100644 --- a/src/test/resources/expected/asciidoc/default/security.adoc +++ b/src/test/resources/expected/asciidoc/default/security.adoc @@ -2,14 +2,6 @@ [[_securityscheme]] == Security -[[_api_key]] -=== api_key -[%hardbreaks] -_Type_ : apiKey -_Name_ : api_key -_In_ : HEADER - - [[_petstore_auth]] === petstore_auth [%hardbreaks] @@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog |=== +[[_api_key]] +=== api_key +[%hardbreaks] +_Type_ : apiKey +_Name_ : api_key +_In_ : HEADER + + diff --git a/src/test/resources/expected/asciidoc/examples/security.adoc b/src/test/resources/expected/asciidoc/examples/security.adoc index 36e1dd21..d67a883b 100644 --- a/src/test/resources/expected/asciidoc/examples/security.adoc +++ b/src/test/resources/expected/asciidoc/examples/security.adoc @@ -2,14 +2,6 @@ [[_securityscheme]] == Security -[[_api_key]] -=== api_key -[%hardbreaks] -_Type_ : apiKey -_Name_ : api_key -_In_ : HEADER - - [[_petstore_auth]] === petstore_auth [%hardbreaks] @@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog |=== +[[_api_key]] +=== api_key +[%hardbreaks] +_Type_ : apiKey +_Name_ : api_key +_In_ : HEADER + + diff --git a/src/test/resources/expected/asciidoc/generated/definitions/Category.adoc b/src/test/resources/expected/asciidoc/generated/definitions/Category.adoc index 05a70871..02a5dadc 100644 --- a/src/test/resources/expected/asciidoc/generated/definitions/Category.adoc +++ b/src/test/resources/expected/asciidoc/generated/definitions/Category.adoc @@ -10,6 +10,8 @@ _optional_||integer(int64) |*name* + _optional_|The name of the category + *Default* : `"DefaultCategory"` + +*Length* : `0 - 255` + +*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` + *Example* : `"FoobarCategory"`|string |=== diff --git a/src/test/resources/expected/asciidoc/generated/definitions/Order.adoc b/src/test/resources/expected/asciidoc/generated/definitions/Order.adoc index 2e6d7d93..dfac7f1e 100644 --- a/src/test/resources/expected/asciidoc/generated/definitions/Order.adoc +++ b/src/test/resources/expected/asciidoc/generated/definitions/Order.adoc @@ -13,6 +13,8 @@ _optional_||integer(int64) _optional_||integer(int64) |*quantity* + _optional_|*Default* : `0` + +*Minimum value* : `0.0` + +*Maximum value* : `10000.0` + *Example* : `10`|integer(int32) |*shipDate* + _optional_||string(date-time) diff --git a/src/test/resources/expected/asciidoc/generated/paths.adoc b/src/test/resources/expected/asciidoc/generated/paths.adoc index 77da934e..3de8cf68 100644 --- a/src/test/resources/expected/asciidoc/generated/paths.adoc +++ b/src/test/resources/expected/asciidoc/generated/paths.adoc @@ -11,7 +11,7 @@ POST /pets ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Body*|*body* + @@ -21,7 +21,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*405*|Invalid input|No Content @@ -63,7 +63,7 @@ PUT /pets ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Body*|*body* + @@ -73,7 +73,7 @@ _optional_|Pet object that needs to be added to the store|<<_pet,Pet>>| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*400*|Invalid ID supplied|No Content @@ -121,7 +121,7 @@ Multiple status values can be provided with comma seperated strings ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Query*|*status* + @@ -131,7 +131,7 @@ _optional_|Status values that need to be considered for filter|< string > array( ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|successful operation + @@ -176,7 +176,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Query*|*tags* + @@ -186,7 +186,7 @@ _optional_|Tags to filter by|< string > array(multi)| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|successful operation + @@ -227,7 +227,7 @@ POST /pets/{petId} ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*petId* + @@ -241,7 +241,7 @@ _required_|Updated status of the pet|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*405*|Invalid input|No Content @@ -286,7 +286,7 @@ Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*petId* + @@ -296,7 +296,7 @@ _required_|ID of pet that needs to be fetched|integer(int64)| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|successful operation + @@ -339,7 +339,7 @@ DELETE /pets/{petId} ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Header*|*api_key* + @@ -351,7 +351,7 @@ _required_|Pet id to delete|integer(int64)| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*400*|Invalid pet value|No Content @@ -387,7 +387,7 @@ POST /stores/order ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Body*|*body* + @@ -397,7 +397,7 @@ _optional_|order placed for purchasing the pet|<<_order,Order>>| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|successful operation + @@ -433,7 +433,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*orderId* + @@ -443,7 +443,7 @@ _required_|ID of pet that needs to be fetched|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|successful operation + @@ -480,7 +480,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*orderId* + @@ -490,7 +490,7 @@ _required_|ID of the order that needs to be deleted|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*400*|Invalid ID supplied|No Content @@ -522,7 +522,7 @@ This can only be done by the logged in user. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Body*|*body* + @@ -532,7 +532,7 @@ _optional_|Created user object|<<_user,User>>| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*default*|successful operation|No Content @@ -559,7 +559,7 @@ POST /users/createWithArray ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Body*|*body* + @@ -569,7 +569,7 @@ _optional_|List of user object|< <<_user,User>> > array| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*default*|successful operation|No Content @@ -596,7 +596,7 @@ POST /users/createWithList ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Body*|*body* + @@ -606,7 +606,7 @@ _optional_|List of user object|< <<_user,User>> > array| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*default*|successful operation|No Content @@ -633,7 +633,7 @@ GET /users/login ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Query*|*password* + @@ -645,7 +645,7 @@ _optional_|The user name for login|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|successful operation + @@ -677,7 +677,7 @@ GET /users/logout ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*default*|successful operation|No Content @@ -704,7 +704,7 @@ GET /users/{username} ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*username* + @@ -714,7 +714,7 @@ _required_|The name that needs to be fetched. Use user1 for testing.|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|successful operation + @@ -751,7 +751,7 @@ This can only be done by the logged in user. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*username* + @@ -763,7 +763,7 @@ _optional_|Updated user object|<<_user,User>>| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*400*|Invalid user supplied|No Content @@ -795,7 +795,7 @@ This can only be done by the logged in user. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*username* + @@ -805,7 +805,7 @@ _required_|The name that needs to be deleted|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*400*|Invalid username supplied|No Content diff --git a/src/test/resources/expected/asciidoc/generated/security.adoc b/src/test/resources/expected/asciidoc/generated/security.adoc index 6f896a69..3ac0b280 100644 --- a/src/test/resources/expected/asciidoc/generated/security.adoc +++ b/src/test/resources/expected/asciidoc/generated/security.adoc @@ -2,14 +2,6 @@ [[_securityscheme]] == Security -[[_api_key]] -=== api_key -[%hardbreaks] -_Type_ : apiKey -_Name_ : api_key -_In_ : HEADER - - [[_petstore_auth]] === petstore_auth [%hardbreaks] @@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog |=== +[[_api_key]] +=== api_key +[%hardbreaks] +_Type_ : apiKey +_Name_ : api_key +_In_ : HEADER + + diff --git a/src/test/resources/expected/asciidoc/generated_examples/security.adoc b/src/test/resources/expected/asciidoc/generated_examples/security.adoc index 36e1dd21..d67a883b 100644 --- a/src/test/resources/expected/asciidoc/generated_examples/security.adoc +++ b/src/test/resources/expected/asciidoc/generated_examples/security.adoc @@ -2,14 +2,6 @@ [[_securityscheme]] == Security -[[_api_key]] -=== api_key -[%hardbreaks] -_Type_ : apiKey -_Name_ : api_key -_In_ : HEADER - - [[_petstore_auth]] === petstore_auth [%hardbreaks] @@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.wordnik.com/api/oauth/dialog |=== +[[_api_key]] +=== api_key +[%hardbreaks] +_Type_ : apiKey +_Name_ : api_key +_In_ : HEADER + + diff --git a/src/test/resources/expected/asciidoc/group_by_tags/definitions.adoc b/src/test/resources/expected/asciidoc/group_by_tags/definitions.adoc index 12be6505..89a744ea 100644 --- a/src/test/resources/expected/asciidoc/group_by_tags/definitions.adoc +++ b/src/test/resources/expected/asciidoc/group_by_tags/definitions.adoc @@ -13,6 +13,8 @@ _optional_||integer(int64) |*name* + _optional_|The name of the category + *Default* : `"DefaultCategory"` + +*Length* : `0 - 255` + +*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` + *Example* : `"FoobarCategory"`|string |=== @@ -31,6 +33,8 @@ _optional_||integer(int64) _optional_||integer(int64) |*quantity* + _optional_|*Default* : `0` + +*Minimum value* : `0.0` + +*Maximum value* : `10000.0` + *Example* : `10`|integer(int32) |*shipDate* + _optional_||string(date-time) diff --git a/src/test/resources/expected/asciidoc/group_by_tags/security.adoc b/src/test/resources/expected/asciidoc/group_by_tags/security.adoc index 6f896a69..3ac0b280 100644 --- a/src/test/resources/expected/asciidoc/group_by_tags/security.adoc +++ b/src/test/resources/expected/asciidoc/group_by_tags/security.adoc @@ -2,14 +2,6 @@ [[_securityscheme]] == Security -[[_api_key]] -=== api_key -[%hardbreaks] -_Type_ : apiKey -_Name_ : api_key -_In_ : HEADER - - [[_petstore_auth]] === petstore_auth [%hardbreaks] @@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog |=== +[[_api_key]] +=== api_key +[%hardbreaks] +_Type_ : apiKey +_Name_ : api_key +_In_ : HEADER + + diff --git a/src/test/resources/expected/asciidoc/idxref/definitions.adoc b/src/test/resources/expected/asciidoc/idxref/definitions.adoc index 9eadcafd..5d1af8d3 100644 --- a/src/test/resources/expected/asciidoc/idxref/definitions.adoc +++ b/src/test/resources/expected/asciidoc/idxref/definitions.adoc @@ -13,6 +13,8 @@ _optional_||integer(int64) |*name* + _optional_|The name of the category + *Default* : `"DefaultCategory"` + +*Length* : `0 - 255` + +*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` + *Example* : `"FoobarCategory"`|string |=== @@ -31,6 +33,8 @@ _optional_||integer(int64) _optional_||integer(int64) |*quantity* + _optional_|*Default* : `0` + +*Minimum value* : `0.0` + +*Maximum value* : `10000.0` + *Example* : `10`|integer(int32) |*shipDate* + _optional_||string(date-time) diff --git a/src/test/resources/expected/asciidoc/idxref/security.adoc b/src/test/resources/expected/asciidoc/idxref/security.adoc index 6f896a69..3ac0b280 100644 --- a/src/test/resources/expected/asciidoc/idxref/security.adoc +++ b/src/test/resources/expected/asciidoc/idxref/security.adoc @@ -2,14 +2,6 @@ [[_securityscheme]] == Security -[[_api_key]] -=== api_key -[%hardbreaks] -_Type_ : apiKey -_Name_ : api_key -_In_ : HEADER - - [[_petstore_auth]] === petstore_auth [%hardbreaks] @@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog |=== +[[_api_key]] +=== api_key +[%hardbreaks] +_Type_ : apiKey +_Name_ : api_key +_In_ : HEADER + + diff --git a/src/test/resources/expected/asciidoc/instagram/overview.adoc b/src/test/resources/expected/asciidoc/instagram/overview.adoc index 0a2d95f9..23630aac 100644 --- a/src/test/resources/expected/asciidoc/instagram/overview.adoc +++ b/src/test/resources/expected/asciidoc/instagram/overview.adoc @@ -18,11 +18,9 @@ All endpoints are only accessible via https and are located at `api.instagram.com`. For instance: you can grab the most popular photos at the moment by accessing the following URL with your client ID (replace CLIENT-ID with your own): - ----- +` https://api.instagram.com/v1/media/popular?client_id=CLIENT-ID ----- - +` You're best off using an access_token for the authenticated user for each endpoint, though many endpoints don't require it. In some cases an access_token will give you more access to information, and diff --git a/src/test/resources/expected/asciidoc/instagram/paths.adoc b/src/test/resources/expected/asciidoc/instagram/paths.adoc index 5add2566..0ababf08 100644 --- a/src/test/resources/expected/asciidoc/instagram/paths.adoc +++ b/src/test/resources/expected/asciidoc/instagram/paths.adoc @@ -19,7 +19,7 @@ geography, use the https://instagram.com/developer/endpoints/media/[media search ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*geo-id* + @@ -33,7 +33,7 @@ _optional_|Return media before this `min_id`.|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|No Content @@ -49,7 +49,7 @@ Search for a location by geographic coordinate. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Query*|*distance* + @@ -74,7 +74,7 @@ _optional_|ongitude of the center search coordinate. If used, lat is required.|n ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_locations_search_get_response_200,Response 200>> @@ -105,7 +105,7 @@ Get information about a location. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*location-id* + @@ -115,7 +115,7 @@ _required_|Location ID|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_locations_location-id_get_response_200,Response 200>> @@ -146,7 +146,7 @@ Get a list of recent media objects from a given location. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*location-id* + @@ -164,7 +164,7 @@ _optional_|Return media after this UNIX timestamp.|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_locations_location-id_media_recent_get_response_200,Response 200>> @@ -197,7 +197,7 @@ Can return mix of image and video types. ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media_popular_get_response_200,Response 200>> @@ -230,7 +230,7 @@ the last 5 days. Can return mix of image and video types. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Query*|*DISTANCE* + @@ -250,7 +250,7 @@ this timestamp.|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media_search_get_response_200,Response 200>> @@ -287,7 +287,7 @@ has liked this media item. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*media-id* + @@ -297,7 +297,7 @@ _required_|The media ID|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media,Media>> @@ -323,7 +323,7 @@ Create a comment on a media object with the following rules: ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*media-id* + @@ -336,7 +336,7 @@ media-id.|number| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media_media-id_comments_post_response_200,Response 200>> @@ -389,7 +389,7 @@ Get a list of recent comments on a media object. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*media-id* + @@ -399,7 +399,7 @@ _required_|Media ID|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media_media-id_comments_get_response_200,Response 200>> @@ -443,7 +443,7 @@ authored by the authenticated user. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*media-id* + @@ -453,7 +453,7 @@ _required_|Media ID|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media_media-id_comments_delete_response_200,Response 200>> @@ -496,7 +496,7 @@ Set a like on this media by the currently authenticated user. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*media-id* + @@ -506,7 +506,7 @@ _required_|Media ID|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media_media-id_likes_post_response_200,Response 200>> @@ -558,7 +558,7 @@ Get a list of users who have liked this media. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*media-id* + @@ -568,7 +568,7 @@ _required_|Media ID|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media_media-id_likes_get_response_200,Response 200>> @@ -612,7 +612,7 @@ Remove a like on this media by the currently authenticated user. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*media-id* + @@ -622,7 +622,7 @@ _required_|Media ID|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media_media-id_likes_delete_response_200,Response 200>> @@ -669,7 +669,7 @@ Its corresponding shortcode is D. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*shortcode* + @@ -679,7 +679,7 @@ _required_|The media shortcode|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_media,Media>> @@ -696,7 +696,7 @@ _required_|The media shortcode|string| ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Query*|*q* + @@ -706,7 +706,7 @@ _optional_|A valid tag name without a leading #. (eg. snowy, nofilter)|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_tags_search_get_response_200,Response 200>> @@ -749,7 +749,7 @@ Get information about a tag object. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*tag-name* + @@ -759,7 +759,7 @@ _required_|Tag name|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_tag,Tag>> @@ -782,7 +782,7 @@ these objects. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*tag-name* + @@ -792,7 +792,7 @@ _required_|Tag name|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_tags_tag-name_media_recent_get_response_200,Response 200>> @@ -823,7 +823,7 @@ Search for a user by name. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Query*|*count* + @@ -835,7 +835,7 @@ _required_|A query string|string| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_users_search_get_response_200,Response 200>> @@ -866,7 +866,7 @@ See the authenticated user's feed. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Query*|*count* + @@ -880,7 +880,7 @@ _optional_|Return media later than this min_id.|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_users_self_feed_get_response_200,Response 200>> @@ -914,7 +914,7 @@ available for the currently authenticated user. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Query*|*count* + @@ -926,7 +926,7 @@ _optional_|Return media liked before this id.|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_users_self_media_liked_get_response_200,Response 200>> @@ -957,7 +957,7 @@ List the users who have requested this user's permission to follow. ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_users_self_requested-by_get_response_200,Response 200>> @@ -1000,7 +1000,7 @@ Get basic information about a user. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*user-id* + @@ -1010,7 +1010,7 @@ _required_|The user identifier number|number| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|The user object|<<_users_user-id_get_response_200,Response 200>> @@ -1051,7 +1051,7 @@ Get the list of users this user is followed by. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*user-id* + @@ -1061,7 +1061,7 @@ _required_|The user identifier number|number| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_users_user-id_followed-by_get_response_200,Response 200>> @@ -1092,7 +1092,7 @@ Get the list of users this user follows. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*user-id* + @@ -1102,7 +1102,7 @@ _required_|The user identifier number|number| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_users_user-id_follows_get_response_200,Response 200>> @@ -1129,7 +1129,7 @@ _optional_||< <<_miniprofile,MiniProfile>> > array ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*user-id* + @@ -1149,7 +1149,7 @@ _optional_|Return media after this UNIX timestamp.|integer| ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[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 @@ -1182,7 +1182,7 @@ Modify the relationship between the current user and thetarget user. ==== Parameters -[options="header", cols=".^1,.^3,.^10,.^4,.^2"] +[options="header", cols=".^2,.^3,.^9,.^4,.^2"] |=== |Type|Name|Description|Schema|Default |*Path*|*user-id* + @@ -1194,7 +1194,7 @@ _optional_|One of follow/unfollow/block/unblock/approve/ignore.|enum (follow, un ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_users_user-id_relationship_post_response_200,Response 200>> diff --git a/src/test/resources/expected/asciidoc/instagram/security.adoc b/src/test/resources/expected/asciidoc/instagram/security.adoc index 342ff00f..ad5af387 100644 --- a/src/test/resources/expected/asciidoc/instagram/security.adoc +++ b/src/test/resources/expected/asciidoc/instagram/security.adoc @@ -2,14 +2,6 @@ [[_securityscheme]] == Security -[[_key]] -=== key -[%hardbreaks] -_Type_ : apiKey -_Name_ : access_token -_In_ : QUERY - - [[_oauth]] === oauth [%hardbreaks] @@ -29,4 +21,12 @@ _Token URL_ : https://instagram.com/oauth/authorize/?client_id=CLIENT-ID&redirec |=== +[[_key]] +=== key +[%hardbreaks] +_Type_ : apiKey +_Name_ : access_token +_In_ : QUERY + + diff --git a/src/test/resources/expected/asciidoc/polymorphism/definitions.adoc b/src/test/resources/expected/asciidoc/polymorphism/definitions.adoc index e5fe8396..124d4a15 100644 --- a/src/test/resources/expected/asciidoc/polymorphism/definitions.adoc +++ b/src/test/resources/expected/asciidoc/polymorphism/definitions.adoc @@ -74,7 +74,8 @@ _required_||string _required_||string |*packSize* + _required_|the size of the pack the dog is from + -*Default* : `0`|integer(int32) +*Default* : `0` + +*Minimum value* : `0.0`|integer(int32) |*petType* + _required_||string |=== diff --git a/src/test/resources/expected/asciidoc/polymorphismAsIsOrdering/definitions.adoc b/src/test/resources/expected/asciidoc/polymorphismAsIsOrdering/definitions.adoc index 32628dba..cab39dbf 100644 --- a/src/test/resources/expected/asciidoc/polymorphismAsIsOrdering/definitions.adoc +++ b/src/test/resources/expected/asciidoc/polymorphismAsIsOrdering/definitions.adoc @@ -76,7 +76,8 @@ _required_||string _required_||string |*packSize* + _required_|the size of the pack the dog is from + -*Default* : `0`|integer(int32) +*Default* : `0` + +*Minimum value* : `0.0`|integer(int32) |=== diff --git a/src/test/resources/expected/asciidoc/polymorphismAsIsOrdering/paths.adoc b/src/test/resources/expected/asciidoc/polymorphismAsIsOrdering/paths.adoc index 79030474..4264f711 100644 --- a/src/test/resources/expected/asciidoc/polymorphismAsIsOrdering/paths.adoc +++ b/src/test/resources/expected/asciidoc/polymorphismAsIsOrdering/paths.adoc @@ -15,7 +15,7 @@ Get collections ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_collection,Collection>> @@ -45,7 +45,7 @@ Get pets ==== Responses -[options="header", cols=".^1,.^15,.^4"] +[options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema |*200*|OK|<<_pet,Pet>> diff --git a/src/test/resources/expected/asciidoc/response_headers/security.adoc b/src/test/resources/expected/asciidoc/response_headers/security.adoc index 6f896a69..3ac0b280 100644 --- a/src/test/resources/expected/asciidoc/response_headers/security.adoc +++ b/src/test/resources/expected/asciidoc/response_headers/security.adoc @@ -2,14 +2,6 @@ [[_securityscheme]] == Security -[[_api_key]] -=== api_key -[%hardbreaks] -_Type_ : apiKey -_Name_ : api_key -_In_ : HEADER - - [[_petstore_auth]] === petstore_auth [%hardbreaks] @@ -26,4 +18,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog |=== +[[_api_key]] +=== api_key +[%hardbreaks] +_Type_ : apiKey +_Name_ : api_key +_In_ : HEADER + + diff --git a/src/test/resources/expected/asciidoc/toFile/outputFile.adoc b/src/test/resources/expected/asciidoc/toFile/outputFile.adoc index 737deda8..73d8b535 100644 --- a/src/test/resources/expected/asciidoc/toFile/outputFile.adoc +++ b/src/test/resources/expected/asciidoc/toFile/outputFile.adoc @@ -1305,6 +1305,8 @@ _optional_|*Example* : `0`|integer(int64) |*name* + _optional_|The name of the category + *Default* : `"DefaultCategory"` + +*Length* : `0 - 255` + +*Pattern* : `"[A-Za-zäöüÄÖÜß]{0,255}"` + *Example* : `"FoobarCategory"`|string |=== @@ -1323,6 +1325,8 @@ _optional_|*Example* : `0`|integer(int64) _optional_|*Example* : `0`|integer(int64) |*quantity* + _optional_|*Default* : `0` + +*Minimum value* : `0.0` + +*Maximum value* : `10000.0` + *Example* : `10`|integer(int32) |*shipDate* + _optional_|*Example* : `"string"`|string(date-time) @@ -1398,14 +1402,6 @@ _optional_|*Example* : `"string"`|string [[_securityscheme]] == Security -[[_api_key]] -=== api_key -[%hardbreaks] -_Type_ : apiKey -_Name_ : api_key -_In_ : HEADER - - [[_petstore_auth]] === petstore_auth [%hardbreaks] @@ -1422,4 +1418,12 @@ _Token URL_ : http://petstore.swagger.io/api/oauth/dialog |=== +[[_api_key]] +=== api_key +[%hardbreaks] +_Type_ : apiKey +_Name_ : api_key +_In_ : HEADER + + diff --git a/src/test/resources/expected/markdown/default/definitions.md b/src/test/resources/expected/markdown/default/definitions.md index d1c67ca4..fadfb26e 100644 --- a/src/test/resources/expected/markdown/default/definitions.md +++ b/src/test/resources/expected/markdown/default/definitions.md @@ -8,7 +8,7 @@ |Name|Description|Schema| |---|---|---| |**id**
*optional*||integer(int64)| -|**name**
*optional*|The name of the category
**Default** : `"DefaultCategory"`
**Example** : `"FoobarCategory"`|string| +|**name**
*optional*|The name of the category
**Default** : `"DefaultCategory"`
**Length** : `0 - 255`
**Pattern** : `"[A-Za-zäöüÄÖÜß]{0,255}"`
**Example** : `"FoobarCategory"`|string| @@ -19,7 +19,7 @@ |**complete**
*optional*||boolean| |**id**
*optional*||integer(int64)| |**petId**
*optional*||integer(int64)| -|**quantity**
*optional*|**Default** : `0`
**Example** : `10`|integer(int32)| +|**quantity**
*optional*|**Default** : `0`
**Minimum value** : `0.0`
**Maximum value** : `10000.0`
**Example** : `10`|integer(int32)| |**shipDate**
*optional*||string(date-time)| |**status**
*optional*|Order Status|enum (Ordered, Cancelled)| diff --git a/src/test/resources/expected/markdown/default/security.md b/src/test/resources/expected/markdown/default/security.md index c58a2b9c..b29ccd38 100644 --- a/src/test/resources/expected/markdown/default/security.md +++ b/src/test/resources/expected/markdown/default/security.md @@ -2,13 +2,6 @@ ## Security - -### api_key -*Type* : apiKey -*Name* : api_key -*In* : HEADER - - ### petstore_auth *Type* : oauth2 @@ -22,4 +15,11 @@ |read_pets|read your pets| + +### api_key +*Type* : apiKey +*Name* : api_key +*In* : HEADER + + diff --git a/src/test/resources/expected/markdown/idxref/definitions.md b/src/test/resources/expected/markdown/idxref/definitions.md index 73d81239..f131c248 100644 --- a/src/test/resources/expected/markdown/idxref/definitions.md +++ b/src/test/resources/expected/markdown/idxref/definitions.md @@ -8,7 +8,7 @@ |Name|Description|Schema| |---|---|---| |**id**
*optional*||integer(int64)| -|**name**
*optional*|The name of the category
**Default** : `"DefaultCategory"`
**Example** : `"FoobarCategory"`|string| +|**name**
*optional*|The name of the category
**Default** : `"DefaultCategory"`
**Length** : `0 - 255`
**Pattern** : `"[A-Za-zäöüÄÖÜß]{0,255}"`
**Example** : `"FoobarCategory"`|string| @@ -19,7 +19,7 @@ |**complete**
*optional*||boolean| |**id**
*optional*||integer(int64)| |**petId**
*optional*||integer(int64)| -|**quantity**
*optional*|**Default** : `0`
**Example** : `10`|integer(int32)| +|**quantity**
*optional*|**Default** : `0`
**Minimum value** : `0.0`
**Maximum value** : `10000.0`
**Example** : `10`|integer(int32)| |**shipDate**
*optional*||string(date-time)| |**status**
*optional*|Order Status|enum (Ordered, Cancelled)| diff --git a/src/test/resources/expected/markdown/idxref/security.md b/src/test/resources/expected/markdown/idxref/security.md index c58a2b9c..b29ccd38 100644 --- a/src/test/resources/expected/markdown/idxref/security.md +++ b/src/test/resources/expected/markdown/idxref/security.md @@ -2,13 +2,6 @@ ## Security - -### api_key -*Type* : apiKey -*Name* : api_key -*In* : HEADER - - ### petstore_auth *Type* : oauth2 @@ -22,4 +15,11 @@ |read_pets|read your pets| + +### api_key +*Type* : apiKey +*Name* : api_key +*In* : HEADER + + diff --git a/src/test/resources/expected/markdown/response_headers/security.md b/src/test/resources/expected/markdown/response_headers/security.md index c58a2b9c..b29ccd38 100644 --- a/src/test/resources/expected/markdown/response_headers/security.md +++ b/src/test/resources/expected/markdown/response_headers/security.md @@ -2,13 +2,6 @@ ## Security - -### api_key -*Type* : apiKey -*Name* : api_key -*In* : HEADER - - ### petstore_auth *Type* : oauth2 @@ -22,4 +15,11 @@ |read_pets|read your pets| + +### api_key +*Type* : apiKey +*Name* : api_key +*In* : HEADER + +