Skip to content

Commit 5c955ab

Browse files
author
GitHub Actions Bot
committed
Update python SDK from OpenAPI changes
1 parent e85432c commit 5c955ab

File tree

274 files changed

+1079
-275
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

274 files changed

+1079
-275
lines changed

docs/HealthApi.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# permify.HealthApi
2+
3+
All URIs are relative to *http://localhost*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**health_check**](HealthApi.md#health_check) | **GET** /healthz | health api
8+
9+
10+
# **health_check**
11+
> HealthResponse health_check()
12+
13+
health api
14+
15+
### Example
16+
17+
18+
```python
19+
import permify
20+
from permify.models.health_response import HealthResponse
21+
from permify.rest import ApiException
22+
from pprint import pprint
23+
24+
# Defining the host is optional and defaults to http://localhost
25+
# See configuration.py for a list of all supported configuration parameters.
26+
configuration = permify.Configuration(
27+
host = "http://localhost"
28+
)
29+
30+
31+
# Enter a context with an instance of the API client
32+
with permify.ApiClient(configuration) as api_client:
33+
# Create an instance of the API class
34+
api_instance = permify.HealthApi(api_client)
35+
36+
try:
37+
# health api
38+
api_response = api_instance.health_check()
39+
print("The response of HealthApi->health_check:\n")
40+
pprint(api_response)
41+
except Exception as e:
42+
print("Exception when calling HealthApi->health_check: %s\n" % e)
43+
```
44+
45+
46+
47+
### Parameters
48+
49+
This endpoint does not need any parameter.
50+
51+
### Return type
52+
53+
[**HealthResponse**](HealthResponse.md)
54+
55+
### Authorization
56+
57+
No authorization required
58+
59+
### HTTP request headers
60+
61+
- **Content-Type**: Not defined
62+
- **Accept**: application/json
63+
64+
### HTTP response details
65+
66+
| Status code | Description | Response headers |
67+
|-------------|-------------|------------------|
68+
**200** | A successful response. | - |
69+
**0** | An unexpected error response. | - |
70+
71+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
72+

docs/HealthResponse.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# HealthResponse
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**status** | **str** | | [optional]
9+
10+
## Example
11+
12+
```python
13+
from permify.models.health_response import HealthResponse
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of HealthResponse from a JSON string
18+
health_response_instance = HealthResponse.from_json(json)
19+
# print the JSON string representation of the object
20+
print(HealthResponse.to_json())
21+
22+
# convert the object into a dict
23+
health_response_dict = health_response_instance.to_dict()
24+
# create an instance of HealthResponse from a dict
25+
health_response_from_dict = HealthResponse.from_dict(health_response_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

docs/PermissionApi.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ check api
2222

2323
```python
2424
import permify
25-
from permify.models.check_body import CheckBody
25+
from permify.models.permission_check_body import PermissionCheckBody
2626
from permify.models.permission_check_response import PermissionCheckResponse
2727
from permify.rest import ApiException
2828
from pprint import pprint
@@ -39,7 +39,7 @@ with permify.ApiClient(configuration) as api_client:
3939
# Create an instance of the API class
4040
api_instance = permify.PermissionApi(api_client)
4141
tenant_id = 'tenant_id_example' # str | Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.
42-
body = permify.CheckBody() # CheckBody |
42+
body = permify.PermissionCheckBody() # PermissionCheckBody |
4343

4444
try:
4545
# check api
@@ -58,7 +58,7 @@ with permify.ApiClient(configuration) as api_client:
5858
Name | Type | Description | Notes
5959
------------- | ------------- | ------------- | -------------
6060
**tenant_id** | **str**| Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant &lt;code&gt;t1&lt;/code&gt; for this field. Required, and must match the pattern \\[a-zA-Z0-9-,]+\\“, max 64 bytes. |
61-
**body** | [**CheckBody**](CheckBody.md)| |
61+
**body** | [**PermissionCheckBody**](PermissionCheckBody.md)| |
6262

6363
### Return type
6464

docs/PermissionCheckBody.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# PermissionCheckBody
2+
3+
PermissionCheckRequest is the request message for the Check method in the Permission service.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**metadata** | [**PermissionCheckRequestMetadata**](PermissionCheckRequestMetadata.md) | | [optional]
10+
**entity** | [**Entity**](Entity.md) | | [optional]
11+
**permission** | **str** | The action the user wants to perform on the resource | [optional]
12+
**subject** | [**Subject**](Subject.md) | | [optional]
13+
**context** | [**Context**](Context.md) | | [optional]
14+
**arguments** | [**List[Argument]**](Argument.md) | Additional arguments associated with this request. | [optional]
15+
16+
## Example
17+
18+
```python
19+
from permify.models.permission_check_body import PermissionCheckBody
20+
21+
# TODO update the JSON string below
22+
json = "{}"
23+
# create an instance of PermissionCheckBody from a JSON string
24+
permission_check_body_instance = PermissionCheckBody.from_json(json)
25+
# print the JSON string representation of the object
26+
print(PermissionCheckBody.to_json())
27+
28+
# convert the object into a dict
29+
permission_check_body_dict = permission_check_body_instance.to_dict()
30+
# create an instance of PermissionCheckBody from a dict
31+
permission_check_body_from_dict = PermissionCheckBody.from_dict(permission_check_body_dict)
32+
```
33+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
34+
35+

permify/api/bundle_api.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Permify is an open source authorization service for creating fine-grained and scalable authorization systems.
77
8-
The version of the OpenAPI document: v0.10.2
8+
The version of the OpenAPI document: v1.0.0
99
1010
Generated by OpenAPI Generator (https://openapi-generator.tech)
1111

permify/api/data_api.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Permify is an open source authorization service for creating fine-grained and scalable authorization systems.
77
8-
The version of the OpenAPI document: v0.10.2
8+
The version of the OpenAPI document: v1.0.0
99
1010
Generated by OpenAPI Generator (https://openapi-generator.tech)
1111

0 commit comments

Comments
 (0)