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

saigiridhar21 · wing328 · commit ec3569e92271 · 2019-10-30T17:10:02.000+08:00
* feat(documentation): Adding model documentation

* feat(documentation): Adding model documentation

* feat(documentation): Adding model documentation

* feat(documentation): Adding model documentation
diff --git a/modules/openapi-generator/src/main/resources/python/model_doc.mustache b/modules/openapi-generator/src/main/resources/python/model_doc.mustache
@@ -1,5 +1,7 @@
 {{#models}}{{#model}}# {{classname}}
 
+{{#description}}{{description}}
+{{/description}}
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/modules/openapi-generator/src/main/resources/python/python-experimental/model_doc.mustache b/modules/openapi-generator/src/main/resources/python/python-experimental/model_doc.mustache
@@ -1,5 +1,7 @@
 {{#models}}{{#model}}# {{classname}}
 
+{{#description}}{{description}}
+{{/description}}
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-asyncio/docs/ClassModel.md b/samples/client/petstore/python-asyncio/docs/ClassModel.md
@@ -1,5 +1,6 @@
 # ClassModel
 
+Model for testing model with \&quot;_class\&quot; property
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-asyncio/docs/File.md b/samples/client/petstore/python-asyncio/docs/File.md
@@ -1,5 +1,6 @@
 # File
 
+Must be named &#x60;File&#x60; for test.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-asyncio/docs/Model200Response.md b/samples/client/petstore/python-asyncio/docs/Model200Response.md
@@ -1,5 +1,6 @@
 # Model200Response
 
+Model for testing model name starting with number
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-asyncio/docs/ModelReturn.md b/samples/client/petstore/python-asyncio/docs/ModelReturn.md
@@ -1,5 +1,6 @@
 # ModelReturn
 
+Model for testing reserved words
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-asyncio/docs/Name.md b/samples/client/petstore/python-asyncio/docs/Name.md
@@ -1,5 +1,6 @@
 # Name
 
+Model for testing model name same as property name
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-experimental/docs/ClassModel.md b/samples/client/petstore/python-experimental/docs/ClassModel.md
@@ -1,5 +1,6 @@
 # ClassModel
 
+Model for testing model with \&quot;_class\&quot; property
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-experimental/docs/File.md b/samples/client/petstore/python-experimental/docs/File.md
@@ -1,5 +1,6 @@
 # File
 
+Must be named &#x60;File&#x60; for test.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-experimental/docs/Model200Response.md b/samples/client/petstore/python-experimental/docs/Model200Response.md
@@ -1,5 +1,6 @@
 # Model200Response
 
+Model for testing model name starting with number
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-experimental/docs/ModelReturn.md b/samples/client/petstore/python-experimental/docs/ModelReturn.md
@@ -1,5 +1,6 @@
 # ModelReturn
 
+Model for testing reserved words
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-experimental/docs/Name.md b/samples/client/petstore/python-experimental/docs/Name.md
@@ -1,5 +1,6 @@
 # Name
 
+Model for testing model name same as property name
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-experimental/docs/TypeHolderDefault.md b/samples/client/petstore/python-experimental/docs/TypeHolderDefault.md
@@ -1,5 +1,6 @@
 # TypeHolderDefault
 
+a model to test optional properties with server defaults
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-experimental/docs/TypeHolderExample.md b/samples/client/petstore/python-experimental/docs/TypeHolderExample.md
@@ -1,5 +1,6 @@
 # TypeHolderExample
 
+a model to test required properties with an example and length one enum
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-tornado/docs/ClassModel.md b/samples/client/petstore/python-tornado/docs/ClassModel.md
@@ -1,5 +1,6 @@
 # ClassModel
 
+Model for testing model with \&quot;_class\&quot; property
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-tornado/docs/File.md b/samples/client/petstore/python-tornado/docs/File.md
@@ -1,5 +1,6 @@
 # File
 
+Must be named &#x60;File&#x60; for test.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-tornado/docs/Model200Response.md b/samples/client/petstore/python-tornado/docs/Model200Response.md
@@ -1,5 +1,6 @@
 # Model200Response
 
+Model for testing model name starting with number
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-tornado/docs/ModelReturn.md b/samples/client/petstore/python-tornado/docs/ModelReturn.md
@@ -1,5 +1,6 @@
 # ModelReturn
 
+Model for testing reserved words
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python-tornado/docs/Name.md b/samples/client/petstore/python-tornado/docs/Name.md
@@ -1,5 +1,6 @@
 # Name
 
+Model for testing model name same as property name
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python/docs/ClassModel.md b/samples/client/petstore/python/docs/ClassModel.md
@@ -1,5 +1,6 @@
 # ClassModel
 
+Model for testing model with \&quot;_class\&quot; property
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python/docs/File.md b/samples/client/petstore/python/docs/File.md
@@ -1,5 +1,6 @@
 # File
 
+Must be named &#x60;File&#x60; for test.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python/docs/Model200Response.md b/samples/client/petstore/python/docs/Model200Response.md
@@ -1,5 +1,6 @@
 # Model200Response
 
+Model for testing model name starting with number
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python/docs/ModelReturn.md b/samples/client/petstore/python/docs/ModelReturn.md
@@ -1,5 +1,6 @@
 # ModelReturn
 
+Model for testing reserved words
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/client/petstore/python/docs/Name.md b/samples/client/petstore/python/docs/Name.md
@@ -1,5 +1,6 @@
 # Name
 
+Model for testing model name same as property name
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/openapi3/client/petstore/python/docs/ClassModel.md b/samples/openapi3/client/petstore/python/docs/ClassModel.md
@@ -1,5 +1,6 @@
 # ClassModel
 
+Model for testing model with \&quot;_class\&quot; property
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/openapi3/client/petstore/python/docs/File.md b/samples/openapi3/client/petstore/python/docs/File.md
@@ -1,5 +1,6 @@
 # File
 
+Must be named &#x60;File&#x60; for test.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/openapi3/client/petstore/python/docs/HealthCheckResult.md b/samples/openapi3/client/petstore/python/docs/HealthCheckResult.md
@@ -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
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/openapi3/client/petstore/python/docs/Model200Response.md b/samples/openapi3/client/petstore/python/docs/Model200Response.md
@@ -1,5 +1,6 @@
 # Model200Response
 
+Model for testing model name starting with number
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/openapi3/client/petstore/python/docs/ModelReturn.md b/samples/openapi3/client/petstore/python/docs/ModelReturn.md
@@ -1,5 +1,6 @@
 # ModelReturn
 
+Model for testing reserved words
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
diff --git a/samples/openapi3/client/petstore/python/docs/Name.md b/samples/openapi3/client/petstore/python/docs/Name.md
@@ -1,5 +1,6 @@
 # Name
 
+Model for testing model name same as property name
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
