Skip to content

Commit f6e3ef8

Browse files
rhamzehrhamzeh
committed
fix(python-sdk): clean up interfaces
1 parent b8623fa commit f6e3ef8

20 files changed

Lines changed: 247 additions & 193 deletions

‎.openapi-generator-ignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ test/*
33
!test/__init__.py
44
!test/test_open_fga_api.py
55
!test/test_credentials.py
6-
!test/test_openfga_client.py
6+
!test/test_client.py
77
.gitlab-ci.yml
88
.travis.yml
99
tox.ini

‎.openapi-generator/FILES‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,21 @@ openfga_sdk/api/__init__.py
7272
openfga_sdk/api/open_fga_api.py
7373
openfga_sdk/api_client.py
7474
openfga_sdk/client/__init__.py
75-
openfga_sdk/client/batch_check_response.py
76-
openfga_sdk/client/check_request_body.py
77-
openfga_sdk/client/client_tuple.py
78-
openfga_sdk/client/client_write_request.py
79-
openfga_sdk/client/client_write_response.py
75+
openfga_sdk/client/client.py
8076
openfga_sdk/client/configuration.py
81-
openfga_sdk/client/expand_request_body.py
82-
openfga_sdk/client/list_objects_request_body.py
83-
openfga_sdk/client/list_relations_request_body.py
84-
openfga_sdk/client/openfga_client.py
85-
openfga_sdk/client/read_changes_body.py
86-
openfga_sdk/client/single_write_response.py
87-
openfga_sdk/client/write_transaction.py
77+
openfga_sdk/client/models/__init__.py
78+
openfga_sdk/client/models/assertion.py
79+
openfga_sdk/client/models/batch_check_response.py
80+
openfga_sdk/client/models/check_request.py
81+
openfga_sdk/client/models/expand_request.py
82+
openfga_sdk/client/models/list_objects_request.py
83+
openfga_sdk/client/models/list_relations_request.py
84+
openfga_sdk/client/models/read_changes_request.py
85+
openfga_sdk/client/models/tuple.py
86+
openfga_sdk/client/models/write_request.py
87+
openfga_sdk/client/models/write_response.py
88+
openfga_sdk/client/models/write_single_response.py
89+
openfga_sdk/client/models/write_transaction_opts.py
8890
openfga_sdk/configuration.py
8991
openfga_sdk/credentials.py
9092
openfga_sdk/exceptions.py
@@ -144,13 +146,12 @@ openfga_sdk/models/write_authorization_model_request.py
144146
openfga_sdk/models/write_authorization_model_response.py
145147
openfga_sdk/models/write_request.py
146148
openfga_sdk/rest.py
147-
openfga_sdk/test/validation.py
148149
openfga_sdk/validation.py
149150
requirements.txt
150151
setup.cfg
151152
setup.py
152153
test-requirements.txt
153154
test/__init__.py
155+
test/test_client.py
154156
test/test_credentials.py
155157
test/test_open_fga_api.py
156-
test/test_openfga_client.py

‎openfga_sdk/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
__version__ = "0.1.1"
1818

19-
from openfga_sdk.client.openfga_client import OpenFgaClient
19+
from openfga_sdk.client.client import OpenFgaClient
2020
from openfga_sdk.client.configuration import ClientConfiguration
2121

2222
# import apis into sdk package

‎openfga_sdk/client/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@
1313
"""
1414

1515
# import openfga client + configurations
16-
from openfga_sdk.client.openfga_client import OpenFgaClient
16+
from openfga_sdk.client.client import OpenFgaClient
1717
from openfga_sdk.client.configuration import ClientConfiguration
18-
from openfga_sdk.client.check_request_body import CheckRequestBody
18+
from openfga_sdk.client.models.check_request import ClientCheckRequest

openfga_sdk/client/openfga_client.py renamed to openfga_sdk/client/client.py

Lines changed: 63 additions & 51 deletions
Large diffs are not rendered by default.

‎openfga_sdk/client/models/__init__.py‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# flake8: noqa
2+
3+
"""
4+
Python SDK for OpenFGA
5+
6+
API version: 0.1
7+
Website: https://openfga.dev
8+
Documentation: https://openfga.dev/docs
9+
Support: https://discord.gg/8naAwJfWN6
10+
License: [Apache-2.0](https://github.com/openfga/python-sdk/blob/main/LICENSE)
11+
12+
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
13+
"""
14+
15+
from openfga_sdk.client.models.assertion import ClientAssertion
16+
from openfga_sdk.client.models.batch_check_response import BatchCheckResponse
17+
from openfga_sdk.client.models.check_request import ClientCheckRequest
18+
from openfga_sdk.client.models.expand_request import ClientExpandRequest
19+
from openfga_sdk.client.models.list_objects_request import ClientListObjectsRequest
20+
from openfga_sdk.client.models.list_relations_request import ClientListRelationsRequest
21+
from openfga_sdk.client.models.read_changes_request import ClientReadChangesRequest
22+
from openfga_sdk.client.models.tuple import ClientTuple
23+
from openfga_sdk.client.models.write_request import ClientWriteRequest
24+
from openfga_sdk.client.models.write_response import ClientWriteResponse
25+
from openfga_sdk.client.models.write_transaction_opts import WriteTransactionOpts

‎openfga_sdk/client/models/assertion.py‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# coding: utf-8
2+
"""
3+
Python SDK for OpenFGA
4+
5+
API version: 0.1
6+
Website: https://openfga.dev
7+
Documentation: https://openfga.dev/docs
8+
Support: https://discord.gg/8naAwJfWN6
9+
License: [Apache-2.0](https://github.com/openfga/python-sdk/blob/main/LICENSE)
10+
11+
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
12+
"""
13+
14+
15+
class ClientAssertion():
16+
"""
17+
ClientAssertion flattens the input necessary for an Assertion
18+
"""
19+
20+
def __init__(self, user: str, relation: str, object: str, expectation: bool):
21+
self._user = user
22+
self._relation = relation
23+
self._object = object
24+
self._expectation = expectation
25+
26+
@property
27+
def user(self):
28+
"""
29+
Return user
30+
"""
31+
return self._user
32+
33+
@property
34+
def relation(self):
35+
"""
36+
Return relation
37+
"""
38+
return self._relation
39+
40+
@property
41+
def object(self):
42+
"""
43+
Return object
44+
"""
45+
return self._object
46+
47+
@property
48+
def expectation(self):
49+
"""
50+
Return expectation
51+
"""
52+
return self._expectation

openfga_sdk/client/batch_check_response.py renamed to openfga_sdk/client/models/batch_check_response.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
1212
"""
1313

14-
from openfga_sdk.client.check_request_body import CheckRequestBody
14+
from openfga_sdk.client.models.check_request import ClientCheckRequest
1515
from openfga_sdk.models.check_response import CheckResponse
1616

1717

@@ -20,7 +20,7 @@ class BatchCheckResponse():
2020
BatchCheckResponse encapsulates the response for a single batch check
2121
"""
2222

23-
def __init__(self, allowed: bool, request: CheckRequestBody, response: CheckResponse, error: Exception = None):
23+
def __init__(self, allowed: bool, request: ClientCheckRequest, response: CheckResponse, error: Exception = None):
2424
self._allowed = allowed
2525
self._request = request
2626
self._response = response

openfga_sdk/client/check_request_body.py renamed to openfga_sdk/client/models/check_request.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@
1111
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
1212
"""
1313

14-
from openfga_sdk.client.client_tuple import ClientTuple
14+
from openfga_sdk.client.models.tuple import ClientTuple
1515

1616
from typing import List
1717

1818

19-
def construct_check_request_body(user: str, relation: str, object: str, contextual_tuples: List[ClientTuple] = None):
19+
def construct_check_request(user: str, relation: str, object: str, contextual_tuples: List[ClientTuple] = None):
2020
"""
2121
helper function to construct the check request body
2222
"""
23-
return CheckRequestBody(user, relation, object, contextual_tuples)
23+
return ClientCheckRequest(user, relation, object, contextual_tuples)
2424

2525

26-
class CheckRequestBody():
26+
class ClientCheckRequest():
2727
"""
28-
CheckRequestBody encapsulates the parameters for check request
28+
ClientCheckRequest encapsulates the parameters for check request
2929
"""
3030

3131
def __init__(self, user: str, relation: str, object: str, contextual_tuples: List[ClientTuple] = None):

openfga_sdk/client/expand_request_body.py renamed to openfga_sdk/client/models/expand_request.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
"""
1313

1414

15-
class ExpandRequestBody():
15+
class ClientExpandRequest():
1616
"""
17-
ExpandRequestBody encapsulates the parameters required to expand request
17+
ClientExpandRequest encapsulates the parameters required to expand request
1818
"""
1919

2020
def __init__(self, relation: str, object: str):

0 commit comments

Comments
 (0)