feat: regenerate project, schema version is now required in authz models (#12)

Author: rhamzeh

.fossa.yml

@@ -5,5 +5,5 @@ server: https://app.fossa.com
 project:
   id: github.com/openfga/python-sdk
   name: github.com/openfga/python-sdk
-  link: fga.dev
+  link: openfga.dev
   url: github.com/openfga/python-sdk

.openapi-generator/FILES

@@ -2,8 +2,6 @@
 .github/CODEOWNERS
 .github/ISSUE_TEMPLATES/bug_report.md
 .github/ISSUE_TEMPLATES/feature_request.md
-.github/PULL_REQUEST_TEMPLATE.md
-.github/SECURITY.md
 .github/workflows/main.yaml
 .github/workflows/semgrep.yaml
 .gitignore

.openapi-generator/VERSION

@@ -1 +1 @@
-6.3.0
+6.4.0

README.md

@@ -324,7 +324,8 @@ async def write_authorization_model():
     # Create an instance of the API class
     api_client = openfga_sdk.ApiClient(configuration)
     api_instance = open_fga_api.OpenFgaApi(api_client)
-    type_definitions = WriteAuthorizationModelRequest(
+    body = WriteAuthorizationModelRequest(
+        schema_version = "1.1",
         type_definitions=[
             TypeDefinition(
                 type="user",
@@ -351,8 +352,8 @@ async def write_authorization_model():
         ],
     )
 
-    response = await api_instance.write_authorization_model(type_definitions)
-    # response.authorization_model_id = "1uHxCSuTP0VKPYSnkq1pbb1jeZw"
+    response = await api_instance.write_authorization_model(body)
+    # response.authorization_model_id = "01GXSA8YR785C4FYS3C0RTG7B1"
     await api_client.close()
 ```
 
@@ -373,10 +374,10 @@ async def read_authorization_id():
     # Create an instance of the API class
     api_client = openfga_sdk.ApiClient(configuration)
     api_instance = open_fga_api.OpenFgaApi(api_client)
-    id = "1uHxCSuTP0VKPYSnkq1pbb1jeZw" #  Assuming `1uHxCSuTP0VKPYSnkq1pbb1jeZw` is an id of an existing model
+    id = "01GXSA8YR785C4FYS3C0RTG7B1" #  Assuming `01GXSA8YR785C4FYS3C0RTG7B1` is an id of an existing model
 
     response = await api_instance.read_authorization_model(id)
-    # response.authorization_model =  AuthorizationModel(id='1uHxCSuTP0VKPYSnkq1pbb1jeZw', type_definitions=type_definitions[...])
+    # response.authorization_model =  AuthorizationModel(id='01GXSA8YR785C4FYS3C0RTG7B1', schema_version = '1.1', type_definitions=type_definitions[...])
     await api_client.close()
 ```
 
@@ -398,7 +399,7 @@ async def read_authorization_models():
     api_instance = open_fga_api.OpenFgaApi(api_client)
 
     response = await api_instance.read_authorization_models()
-    # response.authorization_models = [AuthorizationModel(id='1uHxCSuTP0VKPYSnkq1pbb1jeZw', type_definitions=type_definitions[...], AuthorizationModel(id='GtQpMohWezFmIbyXxVEocOCxxgq', type_definitions=type_definitions[...])]
+    # response.authorization_models = [AuthorizationModel(id='01GXSA8YR785C4FYS3C0RTG7B1', schema_version = '1.1', type_definitions=type_definitions[...], AuthorizationModel(id='01GXSBM5PVYHCJNRNKXMB4QZTW', schema_version = '1.1', type_definitions=type_definitions[...])]
     await api_client.close()
 ```
 
@@ -425,7 +426,7 @@ async def check():
             relation="viewer",
             object="document:roadmap",
         ),
-        authorization_model_id="1uHxCSuTP0VKPYSnkq1pbb1jeZw",
+        authorization_model_id="01GXSA8YR785C4FYS3C0RTG7B1",
     )
 
     response = await api_instance.check(body)
@@ -460,7 +461,7 @@ async def write():
                 ),
             ],
         ),
-        authorization_model_id="1uHxCSuTP0VKPYSnkq1pbb1jeZw",
+        authorization_model_id="01GXSA8YR785C4FYS3C0RTG7B1",
     )
 
     response = await api_instance.write(body)
@@ -493,7 +494,7 @@ async def delete():
                 ),
             ],
         ),
-        authorization_model_id="1uHxCSuTP0VKPYSnkq1pbb1jeZw",
+        authorization_model_id="01GXSA8YR785C4FYS3C0RTG7B1",
     ) 
 
     response = await api_instance.write(body)
@@ -521,7 +522,7 @@ async def expand():
             relation="viewer",
             object="document:roadmap",
         ),
-        authorization_model_id="1uHxCSuTP0VKPYSnkq1pbb1jeZw",
+        authorization_model_id="01GXSA8YR785C4FYS3C0RTG7B1",
     )
 
     response = await api_instance.expand(body)
@@ -630,7 +631,7 @@ async def list_objects():
     api_client = openfga_sdk.ApiClient(configuration)
     api_instance = open_fga_api.OpenFgaApi(api_client)
     body = ListObjectsRequest(
-        authorization_model_id="1uHxCSuTP0VKPYSnkq1pbb1jeZw",
+        authorization_model_id="01GXSA8YR785C4FYS3C0RTG7B1",
         user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         relation="viewer",
         type="document",
@@ -660,7 +661,7 @@ Class | Method | HTTP request | Description
 *OpenFgaApi* | [**delete_store**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#delete_store) | **DELETE** /stores/{store_id} | Delete a store
 *OpenFgaApi* | [**expand**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#expand) | **POST** /stores/{store_id}/expand | Expand all relationships in userset tree format, and following userset rewrite rules.  Useful to reason about and debug a certain relationship
 *OpenFgaApi* | [**get_store**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#get_store) | **GET** /stores/{store_id} | Get a store
-*OpenFgaApi* | [**list_objects**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#list_objects) | **POST** /stores/{store_id}/list-objects | [EXPERIMENTAL] Get all objects of the given type that the user has a relation with
+*OpenFgaApi* | [**list_objects**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#list_objects) | **POST** /stores/{store_id}/list-objects | Get all objects of the given type that the user has a relation with
 *OpenFgaApi* | [**list_stores**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#list_stores) | **GET** /stores | List all stores
 *OpenFgaApi* | [**read**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#read) | **POST** /stores/{store_id}/read | Get tuples from the store that matches a query, without following userset rewrite rules
 *OpenFgaApi* | [**read_assertions**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#read_assertions) | **GET** /stores/{store_id}/assertions/{authorization_model_id} | Read assertions for an authorization model ID

docs/AuthorizationModel.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **str** |  | [optional] 
-**schema_version** | **str** |  | [optional] 
+**schema_version** | **str** |  | 
 **type_definitions** | [**list[TypeDefinition]**](TypeDefinition.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/OpenFgaApi.md

@@ -9,7 +9,7 @@ Method | HTTP request | Description
 [**delete_store**](OpenFgaApi.md#delete_store) | **DELETE** /stores/{store_id} | Delete a store
 [**expand**](OpenFgaApi.md#expand) | **POST** /stores/{store_id}/expand | Expand all relationships in userset tree format, and following userset rewrite rules.  Useful to reason about and debug a certain relationship
 [**get_store**](OpenFgaApi.md#get_store) | **GET** /stores/{store_id} | Get a store
-[**list_objects**](OpenFgaApi.md#list_objects) | **POST** /stores/{store_id}/list-objects | [EXPERIMENTAL] Get all objects of the given type that the user has a relation with
+[**list_objects**](OpenFgaApi.md#list_objects) | **POST** /stores/{store_id}/list-objects | Get all objects of the given type that the user has a relation with
 [**list_stores**](OpenFgaApi.md#list_stores) | **GET** /stores | List all stores
 [**read**](OpenFgaApi.md#read) | **POST** /stores/{store_id}/read | Get tuples from the store that matches a query, without following userset rewrite rules
 [**read_assertions**](OpenFgaApi.md#read_assertions) | **GET** /stores/{store_id}/assertions/{authorization_model_id} | Read assertions for an authorization model ID
@@ -417,9 +417,9 @@ No authorization required
 # **list_objects**
 > ListObjectsResponse list_objects(body)
 
-[EXPERIMENTAL] Get all objects of the given type that the user has a relation with
+Get all objects of the given type that the user has a relation with
 
-The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is, it will be used to decide the underlying implementation used. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\")  
+The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is, it will be used to decide the underlying implementation used. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). Note: If you have `and` or `but not` in your model while using ListObjects, checkout the [caveats](https://openfga.dev/docs/interacting/relationship-queries#caveats-and-when-not-to-use-it-3). 
 
 ### Example
 
@@ -456,7 +456,7 @@ async with openfga_sdk.ApiClient(configuration) as api_client:
     body = openfga_sdk.ListObjectsRequest() # ListObjectsRequest | 
 
     try:
-        # [EXPERIMENTAL] Get all objects of the given type that the user has a relation with
+        # Get all objects of the given type that the user has a relation with
         api_response = await api_instance.api_instance.list_objects(body)
         pprint(api_response)
     except ApiException as e:

openfga_sdk/api/open_fga_api.py

@@ -728,9 +728,9 @@ async def get_store_with_http_info(self, **kwargs):  # noqa: E501
             _request_auth=local_var_params.get('_request_auth')))
 
     async def list_objects(self, body, **kwargs):  # noqa: E501
-        """[EXPERIMENTAL] Get all objects of the given type that the user has a relation with  # noqa: E501
+        """Get all objects of the given type that the user has a relation with  # noqa: E501
 
-        The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is, it will be used to decide the underlying implementation used. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\")    # noqa: E501
+        The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is, it will be used to decide the underlying implementation used. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). Note: If you have `and` or `but not` in your model while using ListObjects, checkout the [caveats](https://openfga.dev/docs/interacting/relationship-queries#caveats-and-when-not-to-use-it-3).   # noqa: E501
 
         >>> thread = await api.list_objects(body)
 
@@ -755,9 +755,9 @@ async def list_objects(self, body, **kwargs):  # noqa: E501
         return await(self.list_objects_with_http_info(body, **kwargs))  # noqa: E501
 
     async def list_objects_with_http_info(self, body, **kwargs):  # noqa: E501
-        """[EXPERIMENTAL] Get all objects of the given type that the user has a relation with  # noqa: E501
+        """Get all objects of the given type that the user has a relation with  # noqa: E501
 
-        The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is, it will be used to decide the underlying implementation used. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\")    # noqa: E501
+        The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is, it will be used to decide the underlying implementation used. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). Note: If you have `and` or `but not` in your model while using ListObjects, checkout the [caveats](https://openfga.dev/docs/interacting/relationship-queries#caveats-and-when-not-to-use-it-3).   # noqa: E501
 
         >>> thread = api.list_objects_with_http_info(body)
 

openfga_sdk/api_client.py

@@ -92,7 +92,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
         self.cookie = cookie
         # Set default User-Agent.
         self.user_agent = 'openfga-sdk {sdkId}/{packageVersion}'.replace(
-            '{sdkId}', '').replace('{packageVersion}', '0.1.1')
+            '{sdkId}', 'python').replace('{packageVersion}', '0.1.1')
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

openfga_sdk/configuration.py

@@ -42,7 +42,7 @@ class RetryParams(object):
     :param min_wait_in_ms: Minimum wait (in ms) between retry
     """
 
-    def __init__(self, max_retry=3, min_wait_in_ms=100):
+    def __init__(self, max_retry=15, min_wait_in_ms=100):
         self._max_retry = max_retry
         self._min_wait_in_ms = min_wait_in_ms
 

openfga_sdk/models/authorization_model.py

@@ -62,8 +62,7 @@ def __init__(self, id=None, schema_version=None, type_definitions=None, local_va
 
         if id is not None:
             self.id = id
-        if schema_version is not None:
-            self.schema_version = schema_version
+        self.schema_version = schema_version
         if type_definitions is not None:
             self.type_definitions = type_definitions
 
@@ -106,6 +105,8 @@ def schema_version(self, schema_version):
         :param schema_version: The schema_version of this AuthorizationModel.  # noqa: E501
         :type schema_version: str
         """
+        if self.local_vars_configuration.client_side_validation and schema_version is None:  # noqa: E501
+            raise ValueError("Invalid value for `schema_version`, must not be `None`")  # noqa: E501
 
         self._schema_version = schema_version