loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

python docs templates minor fixes (#17133)

Browse Source
This commit is contained in:
Barak Amar
2023-11-19 11:29:59 +02:00
committed by GitHub
parent 186fde250b
commit 63c8d0e071
3 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/openapi-generator/src/main/resources/python/api_doc.mustache vendored
View File

@@ -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}}

3
modules/openapi-generator/src/main/resources/python/api_doc_example.mustache vendored
View File

@@ -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}}
{{/vendorExtensions.x-py-postponed-example-imports.size}}

1
modules/openapi-generator/src/main/resources/python/model_doc.mustache vendored
View File

@@ -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}}