From 50acdcb4a3f833d5609813151b3c46c9fbb04b3e Mon Sep 17 00:00:00 2001 From: guy-har <60321938+guy-har@users.noreply.github.com> Date: Wed, 18 Aug 2021 11:25:30 +0300 Subject: [PATCH 1/2] Fix python generated markdown documentation for Jekyll (#10111) * Fix python generated markdown documentation * Generated `build the project` and upate sample scripts --- .../main/resources/python/api_doc.mustache | 2 + .../petstore/python/docs/AnotherFakeApi.md | 2 + .../client/petstore/python/docs/FakeApi.md | 32 +++++++++++ .../python/docs/FakeClassnameTags123Api.md | 2 + samples/client/petstore/python/docs/PetApi.md | 18 +++++++ .../client/petstore/python/docs/StoreApi.md | 8 +++ .../client/petstore/python/docs/UserApi.md | 16 ++++++ .../docs/AnotherFakeApi.md | 2 + .../docs/FakeApi.md | 32 +++++++++++ .../docs/FakeClassnameTags123Api.md | 2 + .../docs/PetApi.md | 18 +++++++ .../docs/StoreApi.md | 8 +++ .../docs/UserApi.md | 16 ++++++ .../x-auth-id-alias/python/docs/UsageApi.md | 8 +++ .../dynamic-servers/python/docs/UsageApi.md | 4 ++ .../petstore/python/docs/AnotherFakeApi.md | 2 + .../client/petstore/python/docs/DefaultApi.md | 2 + .../client/petstore/python/docs/FakeApi.md | 54 +++++++++++++++++++ .../python/docs/FakeClassnameTags123Api.md | 2 + .../client/petstore/python/docs/PetApi.md | 14 +++++ .../client/petstore/python/docs/StoreApi.md | 8 +++ .../client/petstore/python/docs/UserApi.md | 16 ++++++ 22 files changed, 268 insertions(+) diff --git a/modules/openapi-generator/src/main/resources/python/api_doc.mustache b/modules/openapi-generator/src/main/resources/python/api_doc.mustache index 9a03d79b56e..1e8d4c123ab 100644 --- a/modules/openapi-generator/src/main/resources/python/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/python/api_doc.mustache @@ -37,6 +37,7 @@ Method | HTTP request | Description {{/isOAuth }} {{/authMethods}} {{/hasAuthMethods}} + {{> api_doc_example }} ### Parameters @@ -64,6 +65,7 @@ Name | Type | Description | Notes {{#responses.0}} ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| {{#responses}} diff --git a/samples/client/petstore/python/docs/AnotherFakeApi.md b/samples/client/petstore/python/docs/AnotherFakeApi.md index 470caed72cc..d2d58609c8b 100644 --- a/samples/client/petstore/python/docs/AnotherFakeApi.md +++ b/samples/client/petstore/python/docs/AnotherFakeApi.md @@ -16,6 +16,7 @@ To test special tags and operation ID starting with number ### Example + ```python import time import petstore_api @@ -68,6 +69,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python/docs/FakeApi.md b/samples/client/petstore/python/docs/FakeApi.md index bfd6467215b..62754a474ed 100644 --- a/samples/client/petstore/python/docs/FakeApi.md +++ b/samples/client/petstore/python/docs/FakeApi.md @@ -31,6 +31,7 @@ Test serialization of ArrayModel ### Example + ```python import time import petstore_api @@ -83,6 +84,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output model | - | @@ -98,6 +100,7 @@ Test serialization of outer boolean types ### Example + ```python import time import petstore_api @@ -147,6 +150,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output boolean | - | @@ -162,6 +166,7 @@ this route creates an XmlItem ### Example + ```python import time import petstore_api @@ -259,6 +264,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -274,6 +280,7 @@ Test serialization of outer number types ### Example + ```python import time import petstore_api @@ -324,6 +331,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output number | - | @@ -339,6 +347,7 @@ Test serialization of object with $refed properties ### Example + ```python import time import petstore_api @@ -393,6 +402,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output model | - | @@ -408,6 +418,7 @@ Test serialization of outer string types ### Example + ```python import time import petstore_api @@ -457,6 +468,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output string | - | @@ -472,6 +484,7 @@ Test serialization of outer enum ### Example + ```python import time import petstore_api @@ -522,6 +535,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output enum | - | @@ -537,6 +551,7 @@ For this test, the body for this request much reference a schema named `File`. ### Example + ```python import time import petstore_api @@ -594,6 +609,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | @@ -607,6 +623,7 @@ No authorization required ### Example + ```python import time import petstore_api @@ -666,6 +683,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | @@ -681,6 +699,7 @@ To test \"client\" model ### Example + ```python import time import petstore_api @@ -733,6 +752,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -748,6 +768,7 @@ This route has required values with enums of 1 ### Example + ```python import time import petstore_api @@ -798,6 +819,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | @@ -814,6 +836,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイ ### Example * Basic Authentication (http_basic_test): + ```python import time import petstore_api @@ -906,6 +929,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid username supplied | - | @@ -922,6 +946,7 @@ To test enum parameters ### Example + ```python import time import petstore_api @@ -989,6 +1014,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid request | - | @@ -1005,6 +1031,7 @@ Fake endpoint to test group parameters (optional) ### Example + ```python import time import petstore_api @@ -1071,6 +1098,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Someting wrong | - | @@ -1084,6 +1112,7 @@ test inline additionalProperties ### Example + ```python import time import petstore_api @@ -1134,6 +1163,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -1147,6 +1177,7 @@ test json serialization of form data ### Example + ```python import time import petstore_api @@ -1197,6 +1228,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python/docs/FakeClassnameTags123Api.md b/samples/client/petstore/python/docs/FakeClassnameTags123Api.md index 3452fd6ddff..af671645dd6 100644 --- a/samples/client/petstore/python/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/python/docs/FakeClassnameTags123Api.md @@ -17,6 +17,7 @@ To test class name in snake case ### Example * Api Key Authentication (api_key_query): + ```python import time import petstore_api @@ -79,6 +80,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python/docs/PetApi.md b/samples/client/petstore/python/docs/PetApi.md index dcff2fcd072..a3fc6a60673 100644 --- a/samples/client/petstore/python/docs/PetApi.md +++ b/samples/client/petstore/python/docs/PetApi.md @@ -23,6 +23,7 @@ Add a new pet to the store ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -100,6 +101,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -115,6 +117,7 @@ Deletes a pet ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -183,6 +186,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -200,6 +204,7 @@ Multiple status values can be provided with comma separated strings ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -262,6 +267,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -279,6 +285,7 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -341,6 +348,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -358,6 +366,7 @@ Returns a single pet ### Example * Api Key Authentication (api_key): + ```python import time import petstore_api @@ -418,6 +427,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -434,6 +444,7 @@ Update an existing pet ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -511,6 +522,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -528,6 +540,7 @@ Updates a pet in the store with form data ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -598,6 +611,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **405** | Invalid input | - | @@ -612,6 +626,7 @@ uploads an image ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -687,6 +702,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -701,6 +717,7 @@ uploads an image (required) ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -774,6 +791,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python/docs/StoreApi.md b/samples/client/petstore/python/docs/StoreApi.md index b5df4fc1fee..d2e7f8a925b 100644 --- a/samples/client/petstore/python/docs/StoreApi.md +++ b/samples/client/petstore/python/docs/StoreApi.md @@ -19,6 +19,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non ### Example + ```python import time import petstore_api @@ -67,6 +68,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid ID supplied | - | @@ -84,6 +86,7 @@ Returns a map of status codes to quantities ### Example * Api Key Authentication (api_key): + ```python import time import petstore_api @@ -139,6 +142,7 @@ This endpoint does not need any parameter. ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -154,6 +158,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge ### Example + ```python import time import petstore_api @@ -204,6 +209,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -219,6 +225,7 @@ Place an order for a pet ### Example + ```python import time import petstore_api @@ -276,6 +283,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python/docs/UserApi.md b/samples/client/petstore/python/docs/UserApi.md index 3c04b81d196..9f90c838493 100644 --- a/samples/client/petstore/python/docs/UserApi.md +++ b/samples/client/petstore/python/docs/UserApi.md @@ -23,6 +23,7 @@ This can only be done by the logged in user. ### Example + ```python import time import petstore_api @@ -81,6 +82,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -94,6 +96,7 @@ Creates list of users with given input array ### Example + ```python import time import petstore_api @@ -154,6 +157,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -167,6 +171,7 @@ Creates list of users with given input array ### Example + ```python import time import petstore_api @@ -227,6 +232,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -242,6 +248,7 @@ This can only be done by the logged in user. ### Example + ```python import time import petstore_api @@ -290,6 +297,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid username supplied | - | @@ -304,6 +312,7 @@ Get user by user name ### Example + ```python import time import petstore_api @@ -354,6 +363,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -369,6 +379,7 @@ Logs user into the system ### Example + ```python import time import petstore_api @@ -420,6 +431,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user
* X-Expires-After - date in UTC when token expires
| @@ -434,6 +446,7 @@ Logs out current logged in user session ### Example + ```python import time import petstore_api @@ -478,6 +491,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -493,6 +507,7 @@ This can only be done by the logged in user. ### Example + ```python import time import petstore_api @@ -553,6 +568,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid user supplied | - | diff --git a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/AnotherFakeApi.md b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/AnotherFakeApi.md index 470caed72cc..d2d58609c8b 100644 --- a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/AnotherFakeApi.md +++ b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/AnotherFakeApi.md @@ -16,6 +16,7 @@ To test special tags and operation ID starting with number ### Example + ```python import time import petstore_api @@ -68,6 +69,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/FakeApi.md b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/FakeApi.md index bfd6467215b..62754a474ed 100644 --- a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/FakeApi.md +++ b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/FakeApi.md @@ -31,6 +31,7 @@ Test serialization of ArrayModel ### Example + ```python import time import petstore_api @@ -83,6 +84,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output model | - | @@ -98,6 +100,7 @@ Test serialization of outer boolean types ### Example + ```python import time import petstore_api @@ -147,6 +150,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output boolean | - | @@ -162,6 +166,7 @@ this route creates an XmlItem ### Example + ```python import time import petstore_api @@ -259,6 +264,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -274,6 +280,7 @@ Test serialization of outer number types ### Example + ```python import time import petstore_api @@ -324,6 +331,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output number | - | @@ -339,6 +347,7 @@ Test serialization of object with $refed properties ### Example + ```python import time import petstore_api @@ -393,6 +402,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output model | - | @@ -408,6 +418,7 @@ Test serialization of outer string types ### Example + ```python import time import petstore_api @@ -457,6 +468,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output string | - | @@ -472,6 +484,7 @@ Test serialization of outer enum ### Example + ```python import time import petstore_api @@ -522,6 +535,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output enum | - | @@ -537,6 +551,7 @@ For this test, the body for this request much reference a schema named `File`. ### Example + ```python import time import petstore_api @@ -594,6 +609,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | @@ -607,6 +623,7 @@ No authorization required ### Example + ```python import time import petstore_api @@ -666,6 +683,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | @@ -681,6 +699,7 @@ To test \"client\" model ### Example + ```python import time import petstore_api @@ -733,6 +752,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -748,6 +768,7 @@ This route has required values with enums of 1 ### Example + ```python import time import petstore_api @@ -798,6 +819,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | @@ -814,6 +836,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイ ### Example * Basic Authentication (http_basic_test): + ```python import time import petstore_api @@ -906,6 +929,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid username supplied | - | @@ -922,6 +946,7 @@ To test enum parameters ### Example + ```python import time import petstore_api @@ -989,6 +1014,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid request | - | @@ -1005,6 +1031,7 @@ Fake endpoint to test group parameters (optional) ### Example + ```python import time import petstore_api @@ -1071,6 +1098,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Someting wrong | - | @@ -1084,6 +1112,7 @@ test inline additionalProperties ### Example + ```python import time import petstore_api @@ -1134,6 +1163,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -1147,6 +1177,7 @@ test json serialization of form data ### Example + ```python import time import petstore_api @@ -1197,6 +1228,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/FakeClassnameTags123Api.md b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/FakeClassnameTags123Api.md index 3452fd6ddff..af671645dd6 100644 --- a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/FakeClassnameTags123Api.md @@ -17,6 +17,7 @@ To test class name in snake case ### Example * Api Key Authentication (api_key_query): + ```python import time import petstore_api @@ -79,6 +80,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/PetApi.md b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/PetApi.md index dcff2fcd072..a3fc6a60673 100644 --- a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/PetApi.md +++ b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/PetApi.md @@ -23,6 +23,7 @@ Add a new pet to the store ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -100,6 +101,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -115,6 +117,7 @@ Deletes a pet ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -183,6 +186,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -200,6 +204,7 @@ Multiple status values can be provided with comma separated strings ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -262,6 +267,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -279,6 +285,7 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -341,6 +348,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -358,6 +366,7 @@ Returns a single pet ### Example * Api Key Authentication (api_key): + ```python import time import petstore_api @@ -418,6 +427,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -434,6 +444,7 @@ Update an existing pet ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -511,6 +522,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -528,6 +540,7 @@ Updates a pet in the store with form data ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -598,6 +611,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **405** | Invalid input | - | @@ -612,6 +626,7 @@ uploads an image ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -687,6 +702,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -701,6 +717,7 @@ uploads an image (required) ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -774,6 +791,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/StoreApi.md b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/StoreApi.md index b5df4fc1fee..d2e7f8a925b 100644 --- a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/StoreApi.md +++ b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/StoreApi.md @@ -19,6 +19,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non ### Example + ```python import time import petstore_api @@ -67,6 +68,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid ID supplied | - | @@ -84,6 +86,7 @@ Returns a map of status codes to quantities ### Example * Api Key Authentication (api_key): + ```python import time import petstore_api @@ -139,6 +142,7 @@ This endpoint does not need any parameter. ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -154,6 +158,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge ### Example + ```python import time import petstore_api @@ -204,6 +209,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -219,6 +225,7 @@ Place an order for a pet ### Example + ```python import time import petstore_api @@ -276,6 +283,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/UserApi.md b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/UserApi.md index 3c04b81d196..9f90c838493 100644 --- a/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/UserApi.md +++ b/samples/client/petstore/python_disallowAdditionalPropertiesIfNotPresent/docs/UserApi.md @@ -23,6 +23,7 @@ This can only be done by the logged in user. ### Example + ```python import time import petstore_api @@ -81,6 +82,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -94,6 +96,7 @@ Creates list of users with given input array ### Example + ```python import time import petstore_api @@ -154,6 +157,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -167,6 +171,7 @@ Creates list of users with given input array ### Example + ```python import time import petstore_api @@ -227,6 +232,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -242,6 +248,7 @@ This can only be done by the logged in user. ### Example + ```python import time import petstore_api @@ -290,6 +297,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid username supplied | - | @@ -304,6 +312,7 @@ Get user by user name ### Example + ```python import time import petstore_api @@ -354,6 +363,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -369,6 +379,7 @@ Logs user into the system ### Example + ```python import time import petstore_api @@ -420,6 +431,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user
* X-Expires-After - date in UTC when token expires
| @@ -434,6 +446,7 @@ Logs out current logged in user session ### Example + ```python import time import petstore_api @@ -478,6 +491,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -493,6 +507,7 @@ This can only be done by the logged in user. ### Example + ```python import time import petstore_api @@ -553,6 +568,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid user supplied | - | diff --git a/samples/openapi3/client/extensions/x-auth-id-alias/python/docs/UsageApi.md b/samples/openapi3/client/extensions/x-auth-id-alias/python/docs/UsageApi.md index ef6b5c4b05b..ab5eb72d726 100644 --- a/samples/openapi3/client/extensions/x-auth-id-alias/python/docs/UsageApi.md +++ b/samples/openapi3/client/extensions/x-auth-id-alias/python/docs/UsageApi.md @@ -21,6 +21,7 @@ Use any API key * Api Key Authentication (api_key): * Api Key Authentication (api_key_query): + ```python import time import x_auth_id_alias @@ -82,6 +83,7 @@ This endpoint does not need any parameter. ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -99,6 +101,7 @@ Use both API keys * Api Key Authentication (api_key): * Api Key Authentication (api_key_query): + ```python import time import x_auth_id_alias @@ -160,6 +163,7 @@ This endpoint does not need any parameter. ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -176,6 +180,7 @@ Use API key in header ### Example * Api Key Authentication (api_key): + ```python import time import x_auth_id_alias @@ -231,6 +236,7 @@ This endpoint does not need any parameter. ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -247,6 +253,7 @@ Use API key in query ### Example * Api Key Authentication (api_key_query): + ```python import time import x_auth_id_alias @@ -302,6 +309,7 @@ This endpoint does not need any parameter. ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/openapi3/client/features/dynamic-servers/python/docs/UsageApi.md b/samples/openapi3/client/features/dynamic-servers/python/docs/UsageApi.md index b36425e24bb..d05596b2bf2 100644 --- a/samples/openapi3/client/features/dynamic-servers/python/docs/UsageApi.md +++ b/samples/openapi3/client/features/dynamic-servers/python/docs/UsageApi.md @@ -17,6 +17,7 @@ Use custom server ### Example + ```python import time import dynamic_servers @@ -62,6 +63,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -77,6 +79,7 @@ Use default server ### Example + ```python import time import dynamic_servers @@ -122,6 +125,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/openapi3/client/petstore/python/docs/AnotherFakeApi.md b/samples/openapi3/client/petstore/python/docs/AnotherFakeApi.md index 043aa7d5dba..cd2bfcaa3b2 100644 --- a/samples/openapi3/client/petstore/python/docs/AnotherFakeApi.md +++ b/samples/openapi3/client/petstore/python/docs/AnotherFakeApi.md @@ -16,6 +16,7 @@ To test special tags and operation ID starting with number ### Example + ```python import time import petstore_api @@ -68,6 +69,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/openapi3/client/petstore/python/docs/DefaultApi.md b/samples/openapi3/client/petstore/python/docs/DefaultApi.md index 08052341aee..c3e035bbb44 100644 --- a/samples/openapi3/client/petstore/python/docs/DefaultApi.md +++ b/samples/openapi3/client/petstore/python/docs/DefaultApi.md @@ -14,6 +14,7 @@ Method | HTTP request | Description ### Example + ```python import time import petstore_api @@ -59,6 +60,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | response | - | diff --git a/samples/openapi3/client/petstore/python/docs/FakeApi.md b/samples/openapi3/client/petstore/python/docs/FakeApi.md index 3e57af9888a..1e12020457b 100644 --- a/samples/openapi3/client/petstore/python/docs/FakeApi.md +++ b/samples/openapi3/client/petstore/python/docs/FakeApi.md @@ -40,6 +40,7 @@ Additional Properties with Array of Enums ### Example + ```python import time import petstore_api @@ -95,6 +96,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Got object with additional properties with array of enums | - | @@ -110,6 +112,7 @@ Test serialization of ArrayModel ### Example + ```python import time import petstore_api @@ -162,6 +165,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output model | - | @@ -175,6 +179,7 @@ Array of Enums ### Example + ```python import time import petstore_api @@ -228,6 +233,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Got named array of enums | - | @@ -243,6 +249,7 @@ Test serialization of outer boolean types ### Example + ```python import time import petstore_api @@ -292,6 +299,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output boolean | - | @@ -307,6 +315,7 @@ Test serialization of object with $refed properties ### Example + ```python import time import petstore_api @@ -357,6 +366,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output model | - | @@ -370,6 +380,7 @@ downloads a file using Content-Disposition ### Example + ```python import time import petstore_api @@ -419,6 +430,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * Content-Disposition - describes the received file. Looks like: 'attachment; filename=fileName.txt'
| @@ -432,6 +444,7 @@ Object contains enum properties and array properties containing enums ### Example + ```python import time import petstore_api @@ -501,6 +514,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Got object containing enums | - | @@ -514,6 +528,7 @@ Health check endpoint ### Example + ```python import time import petstore_api @@ -560,6 +575,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | The instance started successfully | - | @@ -575,6 +591,7 @@ Test serialization of mammals ### Example + ```python import time import petstore_api @@ -628,6 +645,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output mammal | - | @@ -643,6 +661,7 @@ Test serialization of outer number types ### Example + ```python import time import petstore_api @@ -693,6 +712,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output number | - | @@ -708,6 +728,7 @@ Test serialization of object with $refed properties ### Example + ```python import time import petstore_api @@ -762,6 +783,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output model | - | @@ -775,6 +797,7 @@ No authorization required ### Example + ```python import time import petstore_api @@ -833,6 +856,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | InlineAdditionalPropertiesPayload | - | @@ -846,6 +870,7 @@ No authorization required ### Example + ```python import time import petstore_api @@ -904,6 +929,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | InlineAdditionalPropertiesRefPayload | - | @@ -919,6 +945,7 @@ Test serialization of outer string types ### Example + ```python import time import petstore_api @@ -968,6 +995,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output string | - | @@ -983,6 +1011,7 @@ Test serialization of outer enum ### Example + ```python import time import petstore_api @@ -1033,6 +1062,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Output enum | - | @@ -1048,6 +1078,7 @@ For this test, the body for this request much reference a schema named `File`. ### Example + ```python import time import petstore_api @@ -1105,6 +1136,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | @@ -1118,6 +1150,7 @@ No authorization required ### Example + ```python import time import petstore_api @@ -1181,6 +1214,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | @@ -1196,6 +1230,7 @@ To test \"client\" model ### Example + ```python import time import petstore_api @@ -1248,6 +1283,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -1264,6 +1300,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン ### Example * Basic Authentication (http_basic_test): + ```python import time import petstore_api @@ -1356,6 +1393,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid username supplied | - | @@ -1372,6 +1410,7 @@ To test enum parameters ### Example + ```python import time import petstore_api @@ -1439,6 +1478,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid request | - | @@ -1456,6 +1496,7 @@ Fake endpoint to test group parameters (optional) ### Example * Bearer (JWT) Authentication (bearer_test): + ```python import time import petstore_api @@ -1531,6 +1572,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Someting wrong | - | @@ -1544,6 +1586,7 @@ test inline additionalProperties ### Example + ```python import time import petstore_api @@ -1594,6 +1637,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -1607,6 +1651,7 @@ test json serialization of form data ### Example + ```python import time import petstore_api @@ -1657,6 +1702,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -1672,6 +1718,7 @@ To test the collection format in query parameters ### Example + ```python import time import petstore_api @@ -1737,6 +1784,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | @@ -1750,6 +1798,7 @@ uploads a file and downloads a file using application/octet-stream ### Example + ```python import time import petstore_api @@ -1799,6 +1848,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -1812,6 +1862,7 @@ uploads a file using multipart/form-data ### Example + ```python import time import petstore_api @@ -1873,6 +1924,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -1886,6 +1938,7 @@ uploads files using multipart/form-data ### Example + ```python import time import petstore_api @@ -1937,6 +1990,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/openapi3/client/petstore/python/docs/FakeClassnameTags123Api.md b/samples/openapi3/client/petstore/python/docs/FakeClassnameTags123Api.md index a00c272201f..a83c7e53949 100644 --- a/samples/openapi3/client/petstore/python/docs/FakeClassnameTags123Api.md +++ b/samples/openapi3/client/petstore/python/docs/FakeClassnameTags123Api.md @@ -17,6 +17,7 @@ To test class name in snake case ### Example * Api Key Authentication (api_key_query): + ```python import time import petstore_api @@ -79,6 +80,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/openapi3/client/petstore/python/docs/PetApi.md b/samples/openapi3/client/petstore/python/docs/PetApi.md index 7486621b5e2..00721414113 100644 --- a/samples/openapi3/client/petstore/python/docs/PetApi.md +++ b/samples/openapi3/client/petstore/python/docs/PetApi.md @@ -21,6 +21,7 @@ Add a new pet to the store ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -157,6 +158,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **405** | Invalid input | - | @@ -171,6 +173,7 @@ Deletes a pet ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -239,6 +242,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid pet value | - | @@ -255,6 +259,7 @@ Multiple status values can be provided with comma separated strings ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -377,6 +382,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -394,6 +400,7 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -514,6 +521,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -531,6 +539,7 @@ Returns a single pet ### Example * Api Key Authentication (api_key): + ```python import time import petstore_api @@ -591,6 +600,7 @@ Name | Type | Description | Notes ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -607,6 +617,7 @@ Update an existing pet ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -743,6 +754,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid ID supplied | - | @@ -759,6 +771,7 @@ Updates a pet in the store with form data ### Example * OAuth Authentication (petstore_auth): + ```python import time import petstore_api @@ -829,6 +842,7 @@ void (empty response body) ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **405** | Invalid input | - | diff --git a/samples/openapi3/client/petstore/python/docs/StoreApi.md b/samples/openapi3/client/petstore/python/docs/StoreApi.md index 3ceceacf1ad..36d2367cd29 100644 --- a/samples/openapi3/client/petstore/python/docs/StoreApi.md +++ b/samples/openapi3/client/petstore/python/docs/StoreApi.md @@ -19,6 +19,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non ### Example + ```python import time import petstore_api @@ -67,6 +68,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid ID supplied | - | @@ -84,6 +86,7 @@ Returns a map of status codes to quantities ### Example * Api Key Authentication (api_key): + ```python import time import petstore_api @@ -139,6 +142,7 @@ This endpoint does not need any parameter. ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -154,6 +158,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge ### Example + ```python import time import petstore_api @@ -204,6 +209,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -219,6 +225,7 @@ Place an order for a pet ### Example + ```python import time import petstore_api @@ -276,6 +283,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | diff --git a/samples/openapi3/client/petstore/python/docs/UserApi.md b/samples/openapi3/client/petstore/python/docs/UserApi.md index e3511719d56..5411ecef2af 100644 --- a/samples/openapi3/client/petstore/python/docs/UserApi.md +++ b/samples/openapi3/client/petstore/python/docs/UserApi.md @@ -23,6 +23,7 @@ This can only be done by the logged in user. ### Example + ```python import time import petstore_api @@ -85,6 +86,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -98,6 +100,7 @@ Creates list of users with given input array ### Example + ```python import time import petstore_api @@ -162,6 +165,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -175,6 +179,7 @@ Creates list of users with given input array ### Example + ```python import time import petstore_api @@ -239,6 +244,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -254,6 +260,7 @@ This can only be done by the logged in user. ### Example + ```python import time import petstore_api @@ -302,6 +309,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid username supplied | - | @@ -316,6 +324,7 @@ Get user by user name ### Example + ```python import time import petstore_api @@ -366,6 +375,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | - | @@ -381,6 +391,7 @@ Logs user into the system ### Example + ```python import time import petstore_api @@ -432,6 +443,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user
* X-Expires-After - date in UTC when token expires
| @@ -446,6 +458,7 @@ Logs out current logged in user session ### Example + ```python import time import petstore_api @@ -490,6 +503,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **0** | successful operation | - | @@ -505,6 +519,7 @@ This can only be done by the logged in user. ### Example + ```python import time import petstore_api @@ -569,6 +584,7 @@ No authorization required ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **400** | Invalid user supplied | - | From 2be2195660e7d8eb563037af0a5a260455a8201f Mon Sep 17 00:00:00 2001 From: Nikita Karnaukh Date: Wed, 18 Aug 2021 11:42:27 +0300 Subject: [PATCH 2/2] fix registering gradle tasks when apply plugin to project (#10079) Co-authored-by: n.karnaukh --- .../generator/gradle/plugin/OpenApiGeneratorPlugin.kt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/OpenApiGeneratorPlugin.kt b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/OpenApiGeneratorPlugin.kt index 4563e69e49a..be865049c77 100644 --- a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/OpenApiGeneratorPlugin.kt +++ b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/OpenApiGeneratorPlugin.kt @@ -63,14 +63,14 @@ class OpenApiGeneratorPlugin : Plugin { generate.outputDir.set("$buildDir/generate-resources/main") tasks.apply { - create("openApiGenerators", GeneratorsTask::class.java) { + register("openApiGenerators", GeneratorsTask::class.java).configure { group = pluginGroup description = "Lists generators available via Open API Generators." include.set(generators.include) } - create("openApiMeta", MetaTask::class.java) { + register("openApiMeta", MetaTask::class.java).configure { group = pluginGroup description = "Generates a new generator to be consumed via Open API Generator." @@ -79,7 +79,7 @@ class OpenApiGeneratorPlugin : Plugin { outputFolder.set(meta.outputFolder) } - create("openApiValidate", ValidateTask::class.java) { + register("openApiValidate", ValidateTask::class.java).configure { group = pluginGroup description = "Validates an Open API 2.0 or 3.x specification document." @@ -87,7 +87,7 @@ class OpenApiGeneratorPlugin : Plugin { recommend.set(validate.recommend) } - create("openApiGenerate", GenerateTask::class.java) { + register("openApiGenerate", GenerateTask::class.java).configure { group = pluginGroup description = "Generate code via Open API Tools Generator for Open API 2.0 or 3.x specification documents."