From 63c8d0e0719631c27d527879d3ca1e2484df103f Mon Sep 17 00:00:00 2001 From: Barak Amar Date: Sun, 19 Nov 2023 11:29:59 +0200 Subject: [PATCH] python docs templates minor fixes (#17133) --- .../src/main/resources/python/api_doc.mustache | 2 ++ .../src/main/resources/python/api_doc_example.mustache | 3 ++- .../src/main/resources/python/model_doc.mustache | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) 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 4a1d3648013c..6a58fc9aa906 100644 --- a/modules/openapi-generator/src/main/resources/python/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/python/api_doc.mustache @@ -40,6 +40,7 @@ Method | HTTP request | Description {{> api_doc_example }} ### Parameters + {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} @@ -61,6 +62,7 @@ Name | Type | Description | Notes {{#responses.0}} ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| {{#responses}} diff --git a/modules/openapi-generator/src/main/resources/python/api_doc_example.mustache b/modules/openapi-generator/src/main/resources/python/api_doc_example.mustache index 15fbe332696a..ad276db28153 100644 --- a/modules/openapi-generator/src/main/resources/python/api_doc_example.mustache +++ b/modules/openapi-generator/src/main/resources/python/api_doc_example.mustache @@ -1,3 +1,4 @@ + ```python import time import os @@ -35,4 +36,4 @@ from pprint import pprint {{{.}}} {{/vendorExtensions.x-py-postponed-example-imports}} {{classname}}.update_forward_refs() -{{/vendorExtensions.x-py-postponed-example-imports.size}} \ No newline at end of file +{{/vendorExtensions.x-py-postponed-example-imports.size}} diff --git a/modules/openapi-generator/src/main/resources/python/model_doc.mustache b/modules/openapi-generator/src/main/resources/python/model_doc.mustache index dd54470b3be5..deb49f248848 100644 --- a/modules/openapi-generator/src/main/resources/python/model_doc.mustache +++ b/modules/openapi-generator/src/main/resources/python/model_doc.mustache @@ -4,6 +4,7 @@ {{/description}} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- {{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}