[asciidoc] Allow the inclusion of additional documentation to t… (#5260)

* [asccidoc] Allow the inclusion of additional documentation to the asccidoc generated

Resolves #5228
This commit is contained in:
LEZIER-S2
2020-03-24 03:22:40 +01:00
committed by GitHub
parent 6bf432a1d9
commit dec57d375e
5 changed files with 301 additions and 283 deletions

View File

@@ -1 +1 @@
4.2.3-SNAPSHOT
4.3.0-SNAPSHOT

View File

@@ -17,7 +17,7 @@ team@openapitools.org
This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
// markup not found, no include ::intro.adoc[opts=optional]
// markup not found, no include::{specDir}intro.adoc[opts=optional]
== Access
@@ -47,7 +47,7 @@ Add a new pet to the store
// markup not found, no include ::pet/POST/spec.adoc[opts=optional]
// markup not found, no include::{specDir}pet/POST/spec.adoc[opts=optional]
@@ -96,10 +96,10 @@ Add a new pet to the store
===== Samples
// markup not found, no include ::pet/POST/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/POST/http-request.adoc[opts=optional]
// markup not found, no include ::pet/POST/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/POST/http-response.adoc[opts=optional]
@@ -109,7 +109,7 @@ Add a new pet to the store
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::pet/POST/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}pet/POST/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -127,7 +127,7 @@ Deletes a pet
// markup not found, no include ::pet/{petId}/DELETE/spec.adoc[opts=optional]
// markup not found, no include::{specDir}pet/\{petId\}/DELETE/spec.adoc[opts=optional]
@@ -189,10 +189,10 @@ Deletes a pet
===== Samples
// markup not found, no include ::pet/{petId}/DELETE/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/\{petId\}/DELETE/http-request.adoc[opts=optional]
// markup not found, no include ::pet/{petId}/DELETE/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/\{petId\}/DELETE/http-response.adoc[opts=optional]
@@ -202,7 +202,7 @@ Deletes a pet
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::pet/{petId}/DELETE/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}pet/\{petId\}/DELETE/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -220,7 +220,7 @@ Finds Pets by status
Multiple status values can be provided with comma separated strings
// markup not found, no include ::pet/findByStatus/GET/spec.adoc[opts=optional]
// markup not found, no include::{specDir}pet/findByStatus/GET/spec.adoc[opts=optional]
@@ -277,10 +277,10 @@ array[<<Pet>>]
===== Samples
// markup not found, no include ::pet/findByStatus/GET/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/findByStatus/GET/http-request.adoc[opts=optional]
// markup not found, no include ::pet/findByStatus/GET/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/findByStatus/GET/http-response.adoc[opts=optional]
@@ -290,7 +290,7 @@ array[<<Pet>>]
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::pet/findByStatus/GET/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}pet/findByStatus/GET/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -308,7 +308,7 @@ Finds Pets by tags
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
// markup not found, no include ::pet/findByTags/GET/spec.adoc[opts=optional]
// markup not found, no include::{specDir}pet/findByTags/GET/spec.adoc[opts=optional]
@@ -365,10 +365,10 @@ array[<<Pet>>]
===== Samples
// markup not found, no include ::pet/findByTags/GET/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/findByTags/GET/http-request.adoc[opts=optional]
// markup not found, no include ::pet/findByTags/GET/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/findByTags/GET/http-response.adoc[opts=optional]
@@ -378,7 +378,7 @@ array[<<Pet>>]
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::pet/findByTags/GET/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}pet/findByTags/GET/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -396,7 +396,7 @@ Find pet by ID
Returns a single pet
// markup not found, no include ::pet/{petId}/GET/spec.adoc[opts=optional]
// markup not found, no include::{specDir}pet/\{petId\}/GET/spec.adoc[opts=optional]
@@ -458,10 +458,10 @@ Returns a single pet
===== Samples
// markup not found, no include ::pet/{petId}/GET/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/\{petId\}/GET/http-request.adoc[opts=optional]
// markup not found, no include ::pet/{petId}/GET/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/\{petId\}/GET/http-response.adoc[opts=optional]
@@ -471,7 +471,7 @@ Returns a single pet
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::pet/{petId}/GET/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}pet/\{petId\}/GET/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -489,7 +489,7 @@ Update an existing pet
// markup not found, no include ::pet/PUT/spec.adoc[opts=optional]
// markup not found, no include::{specDir}pet/PUT/spec.adoc[opts=optional]
@@ -548,10 +548,10 @@ Update an existing pet
===== Samples
// markup not found, no include ::pet/PUT/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/PUT/http-request.adoc[opts=optional]
// markup not found, no include ::pet/PUT/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/PUT/http-response.adoc[opts=optional]
@@ -561,7 +561,7 @@ Update an existing pet
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::pet/PUT/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}pet/PUT/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -579,7 +579,7 @@ Updates a pet in the store with form data
// markup not found, no include ::pet/{petId}/POST/spec.adoc[opts=optional]
// markup not found, no include::{specDir}pet/\{petId\}/POST/spec.adoc[opts=optional]
@@ -647,10 +647,10 @@ Updates a pet in the store with form data
===== Samples
// markup not found, no include ::pet/{petId}/POST/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/\{petId\}/POST/http-request.adoc[opts=optional]
// markup not found, no include ::pet/{petId}/POST/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/\{petId\}/POST/http-response.adoc[opts=optional]
@@ -660,7 +660,7 @@ Updates a pet in the store with form data
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::pet/{petId}/POST/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}pet/\{petId\}/POST/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -678,7 +678,7 @@ uploads an image
// markup not found, no include ::pet/{petId}/uploadImage/POST/spec.adoc[opts=optional]
// markup not found, no include::{specDir}pet/\{petId\}/uploadImage/POST/spec.adoc[opts=optional]
@@ -748,10 +748,10 @@ uploads an image
===== Samples
// markup not found, no include ::pet/{petId}/uploadImage/POST/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/\{petId\}/uploadImage/POST/http-request.adoc[opts=optional]
// markup not found, no include ::pet/{petId}/uploadImage/POST/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}pet/\{petId\}/uploadImage/POST/http-response.adoc[opts=optional]
@@ -761,7 +761,7 @@ uploads an image
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::pet/{petId}/uploadImage/POST/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}pet/\{petId\}/uploadImage/POST/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -783,7 +783,7 @@ Delete purchase order by ID
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
// markup not found, no include ::store/order/{orderId}/DELETE/spec.adoc[opts=optional]
// markup not found, no include::{specDir}store/order/\{orderId\}/DELETE/spec.adoc[opts=optional]
@@ -837,10 +837,10 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
===== Samples
// markup not found, no include ::store/order/{orderId}/DELETE/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}store/order/\{orderId\}/DELETE/http-request.adoc[opts=optional]
// markup not found, no include ::store/order/{orderId}/DELETE/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}store/order/\{orderId\}/DELETE/http-response.adoc[opts=optional]
@@ -850,7 +850,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::store/order/{orderId}/DELETE/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}store/order/\{orderId\}/DELETE/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -868,7 +868,7 @@ Returns pet inventories by status
Returns a map of status codes to quantities
// markup not found, no include ::store/inventory/GET/spec.adoc[opts=optional]
// markup not found, no include::{specDir}store/inventory/GET/spec.adoc[opts=optional]
@@ -907,10 +907,10 @@ Returns a map of status codes to quantities
===== Samples
// markup not found, no include ::store/inventory/GET/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}store/inventory/GET/http-request.adoc[opts=optional]
// markup not found, no include ::store/inventory/GET/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}store/inventory/GET/http-response.adoc[opts=optional]
@@ -920,7 +920,7 @@ Returns a map of status codes to quantities
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::store/inventory/GET/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}store/inventory/GET/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -938,7 +938,7 @@ Find purchase order by ID
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
// markup not found, no include ::store/order/{orderId}/GET/spec.adoc[opts=optional]
// markup not found, no include::{specDir}store/order/\{orderId\}/GET/spec.adoc[opts=optional]
@@ -1000,10 +1000,10 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
===== Samples
// markup not found, no include ::store/order/{orderId}/GET/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}store/order/\{orderId\}/GET/http-request.adoc[opts=optional]
// markup not found, no include ::store/order/{orderId}/GET/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}store/order/\{orderId\}/GET/http-response.adoc[opts=optional]
@@ -1013,7 +1013,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::store/order/{orderId}/GET/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}store/order/\{orderId\}/GET/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -1031,7 +1031,7 @@ Place an order for a pet
// markup not found, no include ::store/order/POST/spec.adoc[opts=optional]
// markup not found, no include::{specDir}store/order/POST/spec.adoc[opts=optional]
@@ -1088,10 +1088,10 @@ Place an order for a pet
===== Samples
// markup not found, no include ::store/order/POST/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}store/order/POST/http-request.adoc[opts=optional]
// markup not found, no include ::store/order/POST/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}store/order/POST/http-response.adoc[opts=optional]
@@ -1101,7 +1101,7 @@ Place an order for a pet
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::store/order/POST/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}store/order/POST/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -1123,7 +1123,7 @@ Create user
This can only be done by the logged in user.
// markup not found, no include ::user/POST/spec.adoc[opts=optional]
// markup not found, no include::{specDir}user/POST/spec.adoc[opts=optional]
@@ -1172,10 +1172,10 @@ This can only be done by the logged in user.
===== Samples
// markup not found, no include ::user/POST/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/POST/http-request.adoc[opts=optional]
// markup not found, no include ::user/POST/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/POST/http-response.adoc[opts=optional]
@@ -1185,7 +1185,7 @@ This can only be done by the logged in user.
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::user/POST/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}user/POST/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -1203,7 +1203,7 @@ Creates list of users with given input array
// markup not found, no include ::user/createWithArray/POST/spec.adoc[opts=optional]
// markup not found, no include::{specDir}user/createWithArray/POST/spec.adoc[opts=optional]
@@ -1252,10 +1252,10 @@ Creates list of users with given input array
===== Samples
// markup not found, no include ::user/createWithArray/POST/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/createWithArray/POST/http-request.adoc[opts=optional]
// markup not found, no include ::user/createWithArray/POST/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/createWithArray/POST/http-response.adoc[opts=optional]
@@ -1265,7 +1265,7 @@ Creates list of users with given input array
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::user/createWithArray/POST/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}user/createWithArray/POST/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -1283,7 +1283,7 @@ Creates list of users with given input array
// markup not found, no include ::user/createWithList/POST/spec.adoc[opts=optional]
// markup not found, no include::{specDir}user/createWithList/POST/spec.adoc[opts=optional]
@@ -1332,10 +1332,10 @@ Creates list of users with given input array
===== Samples
// markup not found, no include ::user/createWithList/POST/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/createWithList/POST/http-request.adoc[opts=optional]
// markup not found, no include ::user/createWithList/POST/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/createWithList/POST/http-response.adoc[opts=optional]
@@ -1345,7 +1345,7 @@ Creates list of users with given input array
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::user/createWithList/POST/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}user/createWithList/POST/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -1363,7 +1363,7 @@ Delete user
This can only be done by the logged in user.
// markup not found, no include ::user/{username}/DELETE/spec.adoc[opts=optional]
// markup not found, no include::{specDir}user/\{username\}/DELETE/spec.adoc[opts=optional]
@@ -1417,10 +1417,10 @@ This can only be done by the logged in user.
===== Samples
// markup not found, no include ::user/{username}/DELETE/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/\{username\}/DELETE/http-request.adoc[opts=optional]
// markup not found, no include ::user/{username}/DELETE/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/\{username\}/DELETE/http-response.adoc[opts=optional]
@@ -1430,7 +1430,7 @@ This can only be done by the logged in user.
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::user/{username}/DELETE/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}user/\{username\}/DELETE/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -1448,7 +1448,7 @@ Get user by user name
// markup not found, no include ::user/{username}/GET/spec.adoc[opts=optional]
// markup not found, no include::{specDir}user/\{username\}/GET/spec.adoc[opts=optional]
@@ -1510,10 +1510,10 @@ Get user by user name
===== Samples
// markup not found, no include ::user/{username}/GET/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/\{username\}/GET/http-request.adoc[opts=optional]
// markup not found, no include ::user/{username}/GET/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/\{username\}/GET/http-response.adoc[opts=optional]
@@ -1523,7 +1523,7 @@ Get user by user name
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::user/{username}/GET/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}user/\{username\}/GET/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -1541,7 +1541,7 @@ Logs user into the system
// markup not found, no include ::user/login/GET/spec.adoc[opts=optional]
// markup not found, no include::{specDir}user/login/GET/spec.adoc[opts=optional]
@@ -1605,10 +1605,10 @@ Logs user into the system
===== Samples
// markup not found, no include ::user/login/GET/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/login/GET/http-request.adoc[opts=optional]
// markup not found, no include ::user/login/GET/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/login/GET/http-response.adoc[opts=optional]
@@ -1618,7 +1618,7 @@ Logs user into the system
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::user/login/GET/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}user/login/GET/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -1636,7 +1636,7 @@ Logs out current logged in user session
// markup not found, no include ::user/logout/GET/spec.adoc[opts=optional]
// markup not found, no include::{specDir}user/logout/GET/spec.adoc[opts=optional]
@@ -1672,10 +1672,10 @@ Logs out current logged in user session
===== Samples
// markup not found, no include ::user/logout/GET/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/logout/GET/http-request.adoc[opts=optional]
// markup not found, no include ::user/logout/GET/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/logout/GET/http-response.adoc[opts=optional]
@@ -1685,7 +1685,7 @@ Logs out current logged in user session
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::user/logout/GET/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}user/logout/GET/implementation.adoc[opts=optional]
endif::internal-generation[]
@@ -1703,7 +1703,7 @@ Updated user
This can only be done by the logged in user.
// markup not found, no include ::user/{username}/PUT/spec.adoc[opts=optional]
// markup not found, no include::{specDir}user/\{username\}/PUT/spec.adoc[opts=optional]
@@ -1770,10 +1770,10 @@ This can only be done by the logged in user.
===== Samples
// markup not found, no include ::user/{username}/PUT/http-request.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/\{username\}/PUT/http-request.adoc[opts=optional]
// markup not found, no include ::user/{username}/PUT/http-response.adoc[opts=optional]
// markup not found, no include::{snippetDir}user/\{username\}/PUT/http-response.adoc[opts=optional]
@@ -1783,7 +1783,7 @@ This can only be done by the logged in user.
ifdef::internal-generation[]
===== Implementation
// markup not found, no include ::user/{username}/PUT/implementation.adoc[opts=optional]
// markup not found, no include::{specDir}user/\{username\}/PUT/implementation.adoc[opts=optional]
endif::internal-generation[]