fix model docstring to use keyword instead of param

ChangeLog.md

@@ -20,6 +20,7 @@
 **Bug Fixes**
 
 - Correctly pad operation groups with reserved names with `Operations`  #1005
+- Fix the generated docstrings for input kwargs of models  #1026
 
 ### 2021-07-13 - 5.8.4
 

autorest/codegen/serializers/model_base_serializer.py

@@ -56,7 +56,7 @@ def prop_documentation_string(prop: Property) -> str:
         if prop.constant or prop.readonly:
             param_doc_string = f":ivar {prop.name}:"
         else:
-            param_doc_string = f":param {prop.name}:"
+            param_doc_string = f":keyword {prop.name}:"
         description = prop.description
         if prop.name == "tags":
             description = "A set of tags. " + description
@@ -90,7 +90,7 @@ def prop_type_documentation_string(prop: Property) -> str:
         if prop.constant or prop.readonly:
             type_doc_string = f":vartype {prop.name}: "
         else:
-            type_doc_string = f":type {prop.name}: "
+            type_doc_string = f":paramtype {prop.name}: "
         type_doc_string += prop.schema.docstring_type
         return type_doc_string
 

docs/samples/specification/directives/generated/azure/directives/sample/models/_models.py

@@ -13,10 +13,10 @@
 class Error(msrest.serialization.Model):
     """Error.
 
-    :param status:
-    :type status: int
-    :param message:
-    :type message: str
+    :keyword status:
+    :paramtype status: int
+    :keyword message:
+    :paramtype message: str
     """
 
     _attribute_map = {
@@ -36,8 +36,8 @@ def __init__(
 class Product(msrest.serialization.Model):
     """Product.
 
-    :param properties:
-    :type properties: ~azure.directives.sample.models.ProductProperties
+    :keyword properties:
+    :paramtype properties: ~azure.directives.sample.models.ProductProperties
     """
 
     _attribute_map = {
@@ -55,10 +55,10 @@ def __init__(
 class ProductProperties(msrest.serialization.Model):
     """ProductProperties.
 
-    :param id:
-    :type id: int
-    :param name:
-    :type name: str
+    :keyword id:
+    :paramtype id: int
+    :keyword name:
+    :paramtype name: str
     """
 
     _attribute_map = {
@@ -78,10 +78,10 @@ def __init__(
 class ProductResult(msrest.serialization.Model):
     """ProductResult.
 
-    :param value:
-    :type value: list[~azure.directives.sample.models.Product]
-    :param next_link:
-    :type next_link: str
+    :keyword value:
+    :paramtype value: list[~azure.directives.sample.models.Product]
+    :keyword next_link:
+    :paramtype next_link: str
     """
 
     _attribute_map = {

docs/samples/specification/directives/generated/azure/directives/sample/models/_models_py3.py

@@ -15,10 +15,10 @@
 class Error(msrest.serialization.Model):
     """Error.
 
-    :param status:
-    :type status: int
-    :param message:
-    :type message: str
+    :keyword status:
+    :paramtype status: int
+    :keyword message:
+    :paramtype message: str
     """
 
     _attribute_map = {
@@ -41,8 +41,8 @@ def __init__(
 class Product(msrest.serialization.Model):
     """Product.
 
-    :param properties:
-    :type properties: ~azure.directives.sample.models.ProductProperties
+    :keyword properties:
+    :paramtype properties: ~azure.directives.sample.models.ProductProperties
     """
 
     _attribute_map = {
@@ -62,10 +62,10 @@ def __init__(
 class ProductProperties(msrest.serialization.Model):
     """ProductProperties.
 
-    :param id:
-    :type id: int
-    :param name:
-    :type name: str
+    :keyword id:
+    :paramtype id: int
+    :keyword name:
+    :paramtype name: str
     """
 
     _attribute_map = {
@@ -88,10 +88,10 @@ def __init__(
 class ProductResult(msrest.serialization.Model):
     """ProductResult.
 
-    :param value:
-    :type value: list[~azure.directives.sample.models.Product]
-    :param next_link:
-    :type next_link: str
+    :keyword value:
+    :paramtype value: list[~azure.directives.sample.models.Product]
+    :keyword next_link:
+    :paramtype next_link: str
     """
 
     _attribute_map = {

docs/samples/specification/multiapi/generated/azure/multiapi/sample/v1/models/_models.py

@@ -13,10 +13,10 @@
 class Error(msrest.serialization.Model):
     """Error.
 
-    :param status:
-    :type status: int
-    :param message:
-    :type message: str
+    :keyword status:
+    :paramtype status: int
+    :keyword message:
+    :paramtype message: str
     """
 
     _attribute_map = {
@@ -36,10 +36,10 @@ def __init__(
 class PagingResult(msrest.serialization.Model):
     """PagingResult.
 
-    :param values:
-    :type values: list[~azure.multiapi.sample.v1.models.Product]
-    :param next_link:
-    :type next_link: str
+    :keyword values:
+    :paramtype values: list[~azure.multiapi.sample.v1.models.Product]
+    :keyword next_link:
+    :paramtype next_link: str
     """
 
     _attribute_map = {
@@ -59,8 +59,8 @@ def __init__(
 class Product(msrest.serialization.Model):
     """Product.
 
-    :param id:
-    :type id: int
+    :keyword id:
+    :paramtype id: int
     """
 
     _attribute_map = {
@@ -78,11 +78,11 @@ def __init__(
 class TestLroAndPagingOptions(msrest.serialization.Model):
     """Parameter group.
 
-    :param maxresults: Sets the maximum number of items to return in the response.
-    :type maxresults: int
-    :param timeout: Sets the maximum time that the server can spend processing the request, in
+    :keyword maxresults: Sets the maximum number of items to return in the response.
+    :paramtype maxresults: int
+    :keyword timeout: Sets the maximum time that the server can spend processing the request, in
      seconds. The default is 30 seconds.
-    :type timeout: int
+    :paramtype timeout: int
     """
 
     _attribute_map = {

docs/samples/specification/multiapi/generated/azure/multiapi/sample/v1/models/_models_py3.py

@@ -15,10 +15,10 @@
 class Error(msrest.serialization.Model):
     """Error.
 
-    :param status:
-    :type status: int
-    :param message:
-    :type message: str
+    :keyword status:
+    :paramtype status: int
+    :keyword message:
+    :paramtype message: str
     """
 
     _attribute_map = {
@@ -41,10 +41,10 @@ def __init__(
 class PagingResult(msrest.serialization.Model):
     """PagingResult.
 
-    :param values:
-    :type values: list[~azure.multiapi.sample.v1.models.Product]
-    :param next_link:
-    :type next_link: str
+    :keyword values:
+    :paramtype values: list[~azure.multiapi.sample.v1.models.Product]
+    :keyword next_link:
+    :paramtype next_link: str
     """
 
     _attribute_map = {
@@ -67,8 +67,8 @@ def __init__(
 class Product(msrest.serialization.Model):
     """Product.
 
-    :param id:
-    :type id: int
+    :keyword id:
+    :paramtype id: int
     """
 
     _attribute_map = {
@@ -88,11 +88,11 @@ def __init__(
 class TestLroAndPagingOptions(msrest.serialization.Model):
     """Parameter group.
 
-    :param maxresults: Sets the maximum number of items to return in the response.
-    :type maxresults: int
-    :param timeout: Sets the maximum time that the server can spend processing the request, in
+    :keyword maxresults: Sets the maximum number of items to return in the response.
+    :paramtype maxresults: int
+    :keyword timeout: Sets the maximum time that the server can spend processing the request, in
      seconds. The default is 30 seconds.
-    :type timeout: int
+    :paramtype timeout: int
     """
 
     _attribute_map = {

docs/samples/specification/multiapi/generated/azure/multiapi/sample/v2/models/_models.py

@@ -13,10 +13,10 @@
 class Error(msrest.serialization.Model):
     """Error.
 
-    :param status:
-    :type status: int
-    :param message:
-    :type message: str
+    :keyword status:
+    :paramtype status: int
+    :keyword message:
+    :paramtype message: str
     """
 
     _attribute_map = {
@@ -38,10 +38,10 @@ class ModelTwo(msrest.serialization.Model):
 
     All required parameters must be populated in order to send to Azure.
 
-    :param id: Required.
-    :type id: int
-    :param message:
-    :type message: str
+    :keyword id: Required.
+    :paramtype id: int
+    :keyword message:
+    :paramtype message: str
     """
 
     _validation = {

docs/samples/specification/multiapi/generated/azure/multiapi/sample/v2/models/_models_py3.py

@@ -15,10 +15,10 @@
 class Error(msrest.serialization.Model):
     """Error.
 
-    :param status:
-    :type status: int
-    :param message:
-    :type message: str
+    :keyword status:
+    :paramtype status: int
+    :keyword message:
+    :paramtype message: str
     """
 
     _attribute_map = {
@@ -43,10 +43,10 @@ class ModelTwo(msrest.serialization.Model):
 
     All required parameters must be populated in order to send to Azure.
 
-    :param id: Required.
-    :type id: int
-    :param message:
-    :type message: str
+    :keyword id: Required.
+    :paramtype id: int
+    :keyword message:
+    :paramtype message: str
     """
 
     _validation = {

docs/samples/specification/multiapi/generated/azure/multiapi/sample/v3/models/_models.py

@@ -13,10 +13,10 @@
 class Error(msrest.serialization.Model):
     """Error.
 
-    :param status:
-    :type status: int
-    :param message:
-    :type message: str
+    :keyword status:
+    :paramtype status: int
+    :keyword message:
+    :paramtype message: str
     """
 
     _attribute_map = {
@@ -36,8 +36,8 @@ def __init__(
 class ModelThree(msrest.serialization.Model):
     """Only exists in api version 3.0.0.
 
-    :param optional_property:
-    :type optional_property: str
+    :keyword optional_property:
+    :paramtype optional_property: str
     """
 
     _attribute_map = {
@@ -55,10 +55,10 @@ def __init__(
 class PagingResult(msrest.serialization.Model):
     """PagingResult.
 
-    :param values:
-    :type values: list[~azure.multiapi.sample.v3.models.ModelThree]
-    :param next_link:
-    :type next_link: str
+    :keyword values:
+    :paramtype values: list[~azure.multiapi.sample.v3.models.ModelThree]
+    :keyword next_link:
+    :paramtype next_link: str
     """
 
     _attribute_map = {
@@ -78,8 +78,8 @@ def __init__(
 class SourcePath(msrest.serialization.Model):
     """Uri or local path to source data.
 
-    :param source: File source path.
-    :type source: str
+    :keyword source: File source path.
+    :paramtype source: str
     """
 
     _validation = {