Skip to content

Commit

Permalink
Update python SDK from OpenAPI changes
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions Bot committed Aug 13, 2024
1 parent e85432c commit 5c955ab
Show file tree
Hide file tree
Showing 274 changed files with 1,079 additions and 275 deletions.
72 changes: 72 additions & 0 deletions docs/HealthApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# permify.HealthApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**health_check**](HealthApi.md#health_check) | **GET** /healthz | health api


# **health_check**
> HealthResponse health_check()
health api

### Example


```python
import permify
from permify.models.health_response import HealthResponse
from permify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = permify.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with permify.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = permify.HealthApi(api_client)

try:
# health api
api_response = api_instance.health_check()
print("The response of HealthApi->health_check:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling HealthApi->health_check: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**HealthResponse**](HealthResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A successful response. | - |
**0** | An unexpected error response. | - |

[[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)

29 changes: 29 additions & 0 deletions docs/HealthResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# HealthResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **str** | | [optional]

## Example

```python
from permify.models.health_response import HealthResponse

# TODO update the JSON string below
json = "{}"
# create an instance of HealthResponse from a JSON string
health_response_instance = HealthResponse.from_json(json)
# print the JSON string representation of the object
print(HealthResponse.to_json())

# convert the object into a dict
health_response_dict = health_response_instance.to_dict()
# create an instance of HealthResponse from a dict
health_response_from_dict = HealthResponse.from_dict(health_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


6 changes: 3 additions & 3 deletions docs/PermissionApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ check api

```python
import permify
from permify.models.check_body import CheckBody
from permify.models.permission_check_body import PermissionCheckBody
from permify.models.permission_check_response import PermissionCheckResponse
from permify.rest import ApiException
from pprint import pprint
Expand All @@ -39,7 +39,7 @@ with permify.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = permify.PermissionApi(api_client)
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.
body = permify.CheckBody() # CheckBody |
body = permify.PermissionCheckBody() # PermissionCheckBody |

try:
# check api
Expand All @@ -58,7 +58,7 @@ with permify.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**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. |
**body** | [**CheckBody**](CheckBody.md)| |
**body** | [**PermissionCheckBody**](PermissionCheckBody.md)| |

### Return type

Expand Down
35 changes: 35 additions & 0 deletions docs/PermissionCheckBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# PermissionCheckBody

PermissionCheckRequest is the request message for the Check method in the Permission service.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**metadata** | [**PermissionCheckRequestMetadata**](PermissionCheckRequestMetadata.md) | | [optional]
**entity** | [**Entity**](Entity.md) | | [optional]
**permission** | **str** | The action the user wants to perform on the resource | [optional]
**subject** | [**Subject**](Subject.md) | | [optional]
**context** | [**Context**](Context.md) | | [optional]
**arguments** | [**List[Argument]**](Argument.md) | Additional arguments associated with this request. | [optional]

## Example

```python
from permify.models.permission_check_body import PermissionCheckBody

# TODO update the JSON string below
json = "{}"
# create an instance of PermissionCheckBody from a JSON string
permission_check_body_instance = PermissionCheckBody.from_json(json)
# print the JSON string representation of the object
print(PermissionCheckBody.to_json())

# convert the object into a dict
permission_check_body_dict = permission_check_body_instance.to_dict()
# create an instance of PermissionCheckBody from a dict
permission_check_body_from_dict = PermissionCheckBody.from_dict(permission_check_body_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 1 addition & 1 deletion permify/api/bundle_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Permify is an open source authorization service for creating fine-grained and scalable authorization systems.
The version of the OpenAPI document: v0.10.2
The version of the OpenAPI document: v1.0.0
Contact: [email protected]
Generated by OpenAPI Generator (https://openapi-generator.tech)
Expand Down
2 changes: 1 addition & 1 deletion permify/api/data_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Permify is an open source authorization service for creating fine-grained and scalable authorization systems.
The version of the OpenAPI document: v0.10.2
The version of the OpenAPI document: v1.0.0
Contact: [email protected]
Generated by OpenAPI Generator (https://openapi-generator.tech)
Expand Down
Loading

0 comments on commit 5c955ab

Please sign in to comment.