-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update python SDK from OpenAPI changes
- Loading branch information
GitHub Actions Bot
committed
Aug 13, 2024
1 parent
e85432c
commit 5c955ab
Showing
274 changed files
with
1,079 additions
and
275 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
|
Oops, something went wrong.