Mark required type fields in User and Roles API v2 (#75)

api-clients-generation-pipeline[bot] · jirikuncar · ci.datadog-api-spec · web-flow · commit afd2d825547e · 2020-09-17T16:48:22.000+02:00
* Fix type of type property

* Regenerate client from commit 372420b of spec repo

Co-authored-by: Jiri Kuncar &lt;jiri.kuncar@gmail.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.2.0",
-            "regenerated": "2020-09-17 09:15:42.720492",
-            "spec_repo_commit": "2cc8a06"
+            "regenerated": "2020-09-17 14:32:56.640351",
+            "spec_repo_commit": "372420b"
         },
         "v2": {
             "apigentools_version": "1.2.0",
-            "regenerated": "2020-09-17 09:15:53.976903",
-            "spec_repo_commit": "2cc8a06"
+            "regenerated": "2020-09-17 14:33:07.288180",
+            "spec_repo_commit": "372420b"
         }
     }
 }
diff --git a/docs/v2/RelationshipToOrganizationData.md b/docs/v2/RelationshipToOrganizationData.md
@@ -4,8 +4,8 @@ Relationship to organization object.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **str** | ID of the organization. | [optional] 
-**type** | [**OrganizationsType**](OrganizationsType.md) |  | [optional] 
+**id** | **str** | ID of the organization. | 
+**type** | [**OrganizationsType**](OrganizationsType.md) |  | 
 
 [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
 
diff --git a/docs/v2/RelationshipToUserData.md b/docs/v2/RelationshipToUserData.md
@@ -4,8 +4,8 @@ Relationship to user object.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **str** | ID of the user. | [optional] 
-**type** | **str** | Users type. | [optional] [readonly]  if omitted the server will use the default value of "users"
+**id** | **str** | ID of the user. | 
+**type** | [**UsersType**](UsersType.md) |  | 
 
 [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
 
diff --git a/docs/v2/RolesApi.md b/docs/v2/RolesApi.md
@@ -186,7 +186,7 @@ with datadog_api_client.v2.ApiClient(configuration) as api_client:
     body = RelationshipToUser(
         data=RelationshipToUserData(
             id="id_example",
-            type="users",
+            type=UsersType("users"),
         ),
     ) # RelationshipToUser |  (optional)
 
@@ -312,7 +312,7 @@ with datadog_api_client.v2.ApiClient(configuration) as api_client:
                     data=[
                         RelationshipToUserData(
                             id="id_example",
-                            type="users",
+                            type=UsersType("users"),
                         ),
                     ],
                 ),
@@ -1097,7 +1097,7 @@ with datadog_api_client.v2.ApiClient(configuration) as api_client:
     body = RelationshipToUser(
         data=RelationshipToUserData(
             id="id_example",
-            type="users",
+            type=UsersType("users"),
         ),
     ) # RelationshipToUser |  (optional)
 
diff --git a/docs/v2/UsersApi.md b/docs/v2/UsersApi.md
@@ -751,7 +751,7 @@ with datadog_api_client.v2.ApiClient(configuration) as api_client:
                     user=RelationshipToUser(
                         data=RelationshipToUserData(
                             id="id_example",
-                            type="users",
+                            type=UsersType("users"),
                         ),
                     ),
                 ),
diff --git a/src/datadog_api_client/v2/model/relationship_to_organization_data.py b/src/datadog_api_client/v2/model/relationship_to_organization_data.py
@@ -102,9 +102,13 @@ def discriminator():
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, *args, **kwargs):  # noqa: E501
+    def __init__(self, id, type, *args, **kwargs):  # noqa: E501
         """RelationshipToOrganizationData - a model defined in OpenAPI
 
+        Args:
+            id (str): ID of the organization.
+            type (OrganizationsType):
+
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
@@ -136,8 +140,6 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            id (str): ID of the organization.. [optional]  # noqa: E501
-            type (OrganizationsType): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -163,6 +165,8 @@ def __init__(self, *args, **kwargs):  # noqa: E501
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.id = id
+        self.type = type
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
diff --git a/src/datadog_api_client/v2/model/relationship_to_user_data.py b/src/datadog_api_client/v2/model/relationship_to_user_data.py
@@ -25,6 +25,10 @@
     validate_get_composed_info,
 )
 
+def lazy_import():
+    from datadog_api_client.v2.model.users_type import UsersType
+    globals()['UsersType'] = UsersType
+
 
 class RelationshipToUserData(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
@@ -70,9 +74,10 @@ def openapi_types():
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
+        lazy_import()
         return {
             'id': (str,),  # noqa: E501
-            'type': (str,),  # noqa: E501
+            'type': (UsersType,),  # noqa: E501
         }
 
     @cached_property
@@ -97,9 +102,13 @@ def discriminator():
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, *args, **kwargs):  # noqa: E501
+    def __init__(self, id, type, *args, **kwargs):  # noqa: E501
         """RelationshipToUserData - a model defined in OpenAPI
 
+        Args:
+            id (str): ID of the user.
+            type (UsersType):
+
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
@@ -131,8 +140,6 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            id (str): ID of the user.. [optional]  # noqa: E501
-            type (str): Users type.. [optional] if omitted the server will use the default value of "users"  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -158,6 +165,8 @@ def __init__(self, *args, **kwargs):  # noqa: E501
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.id = id
+        self.type = type
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
diff --git a/src/datadog_api_client/v2/openapi.yaml b/src/datadog_api_client/v2/openapi.yaml
@@ -1193,6 +1193,9 @@ components:
           type: string
         type:
           $ref: '#/components/schemas/OrganizationsType'
+      required:
+      - id
+      - type
       type: object
     RelationshipToOrganizations:
       description: Relationship to organizations.
@@ -1265,10 +1268,10 @@ components:
           description: ID of the user.
           type: string
         type:
-          default: users
-          description: Users type.
-          readOnly: true
-          type: string
+          $ref: '#/components/schemas/UsersType'
+      required:
+      - id
+      - type
       type: object
     RelationshipToUsers:
       description: Relationship to users.
@@ -2224,6 +2227,7 @@ components:
       description: Users resource type.
       enum:
       - users
+      example: users
       type: string
       x-enum-varnames:
       - USERS
diff --git a/tests/v2/test_scenarios.py b/tests/v2/test_scenarios.py
@@ -104,7 +104,7 @@ def user_has_role(vcr_cassette, client, user, role):
     body = relationship_to_user.RelationshipToUser(
         data=relationship_to_user_data.RelationshipToUserData(
             id=user.data.id,
-            type=str(user.data.type),
+            type=user.data.type,
         ))
     yield api.add_user_to_role(role.data.id, body=body)
     if vcr_cassette.record_mode != "none":
@@ -137,7 +137,7 @@ def user_invitation(vcr_cassette, client, user):
                     user=relationship_to_user.RelationshipToUser(
                         data=relationship_to_user_data.RelationshipToUserData(
                             id=user.data.id,
-                            type=str(user.data.type),
+                            type=user.data.type,
                         ))))
         ], )
     yield api.send_invitations(body=body).data[0]

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.2.0",`
`7`		`- "regenerated": "2020-09-17 09:15:42.720492",`
`8`		`- "spec_repo_commit": "2cc8a06"`
	`7`	`+ "regenerated": "2020-09-17 14:32:56.640351",`
	`8`	`+ "spec_repo_commit": "372420b"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.2.0",`
`12`		`- "regenerated": "2020-09-17 09:15:53.976903",`
`13`		`- "spec_repo_commit": "2cc8a06"`
	`12`	`+ "regenerated": "2020-09-17 14:33:07.288180",`
	`13`	`+ "spec_repo_commit": "372420b"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`