Skip to content

[python][fix] Adding model summary to model documentation files #4306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 4 commits into from
Oct 30, 2019
Merged

[python][fix] Adding model summary to model documentation files #4306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a155f05
feat(documentation): Adding model documentation
saigiridhar21 Oct 29, 2019
3cefe97
feat(documentation): Adding model documentation
saigiridhar21 Oct 29, 2019
30f5782
feat(documentation): Adding model documentation
saigiridhar21 Oct 29, 2019
9a7fdc5
feat(documentation): Adding model documentation
saigiridhar21 Oct 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions modules/openapi-generator/src/main/resources/python/model_doc.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{{#models}}{{#model}}# {{classname}}

{{#description}}{{description}}
{{/description}}
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
2 changes: 2 additions & 0 deletions modules/openapi-generator/src/main/resources/python/python-experimental/model_doc.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{{#models}}{{#model}}# {{classname}}

{{#description}}{{description}}
{{/description}}
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-asyncio/docs/ClassModel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ClassModel

Model for testing model with \"_class\" property
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-asyncio/docs/File.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# File

Must be named `File` for test.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-asyncio/docs/Model200Response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Model200Response

Model for testing model name starting with number
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-asyncio/docs/ModelReturn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ModelReturn

Model for testing reserved words
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-asyncio/docs/Name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Name

Model for testing model name same as property name
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-experimental/docs/ClassModel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ClassModel

Model for testing model with \"_class\" property
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-experimental/docs/File.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# File

Must be named `File` for test.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-experimental/docs/Model200Response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Model200Response

Model for testing model name starting with number
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-experimental/docs/ModelReturn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ModelReturn

Model for testing reserved words
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-experimental/docs/Name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Name

Model for testing model name same as property name
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-experimental/docs/TypeHolderDefault.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# TypeHolderDefault

a model to test optional properties with server defaults
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-experimental/docs/TypeHolderExample.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# TypeHolderExample

a model to test required properties with an example and length one enum
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-tornado/docs/ClassModel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ClassModel

Model for testing model with \"_class\" property
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-tornado/docs/File.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# File

Must be named `File` for test.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-tornado/docs/Model200Response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Model200Response

Model for testing model name starting with number
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-tornado/docs/ModelReturn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ModelReturn

Model for testing reserved words
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python-tornado/docs/Name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Name

Model for testing model name same as property name
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python/docs/ClassModel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ClassModel

Model for testing model with \"_class\" property
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python/docs/File.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# File

Must be named `File` for test.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python/docs/Model200Response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Model200Response

Model for testing model name starting with number
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python/docs/ModelReturn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ModelReturn

Model for testing reserved words
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/python/docs/Name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Name

Model for testing model name same as property name
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/openapi3/client/petstore/python/docs/ClassModel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ClassModel

Model for testing model with \"_class\" property
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/openapi3/client/petstore/python/docs/File.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# File

Must be named `File` for test.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/openapi3/client/petstore/python/docs/HealthCheckResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# HealthCheckResult

Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/openapi3/client/petstore/python/docs/Model200Response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Model200Response

Model for testing model name starting with number
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/openapi3/client/petstore/python/docs/ModelReturn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ModelReturn

Model for testing reserved words
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions samples/openapi3/client/petstore/python/docs/Name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Name

Model for testing model name same as property name
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down