ory-keto-client 0.0.0.alpha58 → 0.4.0.alpha1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +19 -5
- data/docs/AddOryAccessControlPolicyRoleMembersBody.md +7 -8
- data/docs/AuthorizationResult.md +7 -8
- data/docs/EnginesApi.md +129 -319
- data/docs/HealthApi.md +15 -50
- data/docs/HealthNotReadyStatus.md +7 -8
- data/docs/HealthStatus.md +7 -8
- data/docs/InlineResponse500.md +17 -18
- data/docs/OryAccessControlPolicy.md +19 -20
- data/docs/OryAccessControlPolicyAllowedInput.md +13 -14
- data/docs/OryAccessControlPolicyRole.md +9 -10
- data/docs/Version.md +7 -8
- data/docs/VersionApi.md +9 -26
- data/lib/ory-keto-client.rb +16 -2
- data/lib/ory-keto-client/api/engines_api.rb +35 -46
- data/lib/ory-keto-client/api/health_api.rb +8 -10
- data/lib/ory-keto-client/api/version_api.rb +5 -6
- data/lib/ory-keto-client/api_client.rb +46 -50
- data/lib/ory-keto-client/api_error.rb +2 -2
- data/lib/ory-keto-client/configuration.rb +7 -34
- data/lib/ory-keto-client/models/add_ory_access_control_policy_role_members_body.rb +8 -20
- data/lib/ory-keto-client/models/add_ory_access_control_policy_role_members_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/authorization_result.rb +8 -20
- data/lib/ory-keto-client/models/delete_ory_access_control_policy_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/delete_ory_access_control_policy_role_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/do_ory_access_control_policies_allow_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/get_ory_access_control_policy_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/get_ory_access_control_policy_not_found_body.rb +3 -3
- data/lib/ory-keto-client/models/get_ory_access_control_policy_role_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/get_ory_access_control_policy_role_not_found_body.rb +3 -3
- data/lib/ory-keto-client/models/health_not_ready_status.rb +8 -20
- data/lib/ory-keto-client/models/health_status.rb +8 -20
- data/lib/ory-keto-client/models/inline_response500.rb +9 -21
- data/lib/ory-keto-client/models/is_instance_alive_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/list_ory_access_control_policies_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/list_ory_access_control_policy_roles_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/ory_access_control_policy.rb +12 -22
- data/lib/ory-keto-client/models/ory_access_control_policy_allowed_input.rb +12 -22
- data/lib/ory-keto-client/models/ory_access_control_policy_role.rb +8 -20
- data/lib/ory-keto-client/models/remove_ory_access_control_policy_role_members_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/upsert_ory_access_control_policy_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/upsert_ory_access_control_policy_role_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/version.rb +9 -20
- data/lib/ory-keto-client/version.rb +3 -3
- data/ory-keto-client.gemspec +5 -4
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +3 -3
- data/spec/spec_helper.rb +3 -3
- metadata +79 -59
data/docs/HealthApi.md
CHANGED
@@ -2,52 +2,35 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**is_instance_alive**](HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
|
8
|
+
[**is_instance_ready**](HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
|
9
|
+
|
9
10
|
|
10
11
|
|
11
12
|
## is_instance_alive
|
12
13
|
|
13
|
-
>
|
14
|
+
> HealthStatus is_instance_alive
|
14
15
|
|
15
16
|
Check alive status
|
16
17
|
|
17
18
|
This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
18
19
|
|
19
|
-
###
|
20
|
+
### Example
|
20
21
|
|
21
22
|
```ruby
|
22
|
-
|
23
|
+
# load the gem
|
23
24
|
require 'ory-keto-client'
|
24
25
|
|
25
26
|
api_instance = OryHydraClient::HealthApi.new
|
26
27
|
|
27
28
|
begin
|
28
|
-
#
|
29
|
+
#Check alive status
|
29
30
|
result = api_instance.is_instance_alive
|
30
31
|
p result
|
31
32
|
rescue OryHydraClient::ApiError => e
|
32
|
-
puts "
|
33
|
-
end
|
34
|
-
```
|
35
|
-
|
36
|
-
#### Using the is_instance_alive_with_http_info variant
|
37
|
-
|
38
|
-
This returns an Array which contains the response data, status code and headers.
|
39
|
-
|
40
|
-
> <Array(<HealthStatus>, Integer, Hash)> is_instance_alive_with_http_info
|
41
|
-
|
42
|
-
```ruby
|
43
|
-
begin
|
44
|
-
# Check alive status
|
45
|
-
data, status_code, headers = api_instance.is_instance_alive_with_http_info
|
46
|
-
p status_code # => 2xx
|
47
|
-
p headers # => { ... }
|
48
|
-
p data # => <HealthStatus>
|
49
|
-
rescue OryHydraClient::ApiError => e
|
50
|
-
puts "Error when calling HealthApi->is_instance_alive_with_http_info: #{e}"
|
33
|
+
puts "Exception when calling HealthApi->is_instance_alive: #{e}"
|
51
34
|
end
|
52
35
|
```
|
53
36
|
|
@@ -71,44 +54,26 @@ No authorization required
|
|
71
54
|
|
72
55
|
## is_instance_ready
|
73
56
|
|
74
|
-
>
|
57
|
+
> HealthStatus is_instance_ready
|
75
58
|
|
76
59
|
Check readiness status
|
77
60
|
|
78
61
|
This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
79
62
|
|
80
|
-
###
|
63
|
+
### Example
|
81
64
|
|
82
65
|
```ruby
|
83
|
-
|
66
|
+
# load the gem
|
84
67
|
require 'ory-keto-client'
|
85
68
|
|
86
69
|
api_instance = OryHydraClient::HealthApi.new
|
87
70
|
|
88
71
|
begin
|
89
|
-
#
|
72
|
+
#Check readiness status
|
90
73
|
result = api_instance.is_instance_ready
|
91
74
|
p result
|
92
75
|
rescue OryHydraClient::ApiError => e
|
93
|
-
puts "
|
94
|
-
end
|
95
|
-
```
|
96
|
-
|
97
|
-
#### Using the is_instance_ready_with_http_info variant
|
98
|
-
|
99
|
-
This returns an Array which contains the response data, status code and headers.
|
100
|
-
|
101
|
-
> <Array(<HealthStatus>, Integer, Hash)> is_instance_ready_with_http_info
|
102
|
-
|
103
|
-
```ruby
|
104
|
-
begin
|
105
|
-
# Check readiness status
|
106
|
-
data, status_code, headers = api_instance.is_instance_ready_with_http_info
|
107
|
-
p status_code # => 2xx
|
108
|
-
p headers # => { ... }
|
109
|
-
p data # => <HealthStatus>
|
110
|
-
rescue OryHydraClient::ApiError => e
|
111
|
-
puts "Error when calling HealthApi->is_instance_ready_with_http_info: #{e}"
|
76
|
+
puts "Exception when calling HealthApi->is_instance_ready: #{e}"
|
112
77
|
end
|
113
78
|
```
|
114
79
|
|
@@ -2,17 +2,16 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional]
|
8
8
|
|
9
|
-
##
|
9
|
+
## Code Sample
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'OryHydraClient'
|
13
13
|
|
14
|
-
instance = OryHydraClient::HealthNotReadyStatus.new(
|
15
|
-
errors: null
|
16
|
-
)
|
14
|
+
instance = OryHydraClient::HealthNotReadyStatus.new(errors: null)
|
17
15
|
```
|
18
16
|
|
17
|
+
|
data/docs/HealthStatus.md
CHANGED
@@ -2,17 +2,16 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**status** | **String** | Status always contains \"ok\". | [optional]
|
8
8
|
|
9
|
-
##
|
9
|
+
## Code Sample
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'OryHydraClient'
|
13
13
|
|
14
|
-
instance = OryHydraClient::HealthStatus.new(
|
15
|
-
status: null
|
16
|
-
)
|
14
|
+
instance = OryHydraClient::HealthStatus.new(status: null)
|
17
15
|
```
|
18
16
|
|
17
|
+
|
data/docs/InlineResponse500.md
CHANGED
@@ -2,27 +2,26 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | | [optional]
|
8
|
+
**details** | **Array<Hash<String, Object>>** | | [optional]
|
9
|
+
**message** | **String** | | [optional]
|
10
|
+
**reason** | **String** | | [optional]
|
11
|
+
**request** | **String** | | [optional]
|
12
|
+
**status** | **String** | | [optional]
|
13
13
|
|
14
|
-
##
|
14
|
+
## Code Sample
|
15
15
|
|
16
16
|
```ruby
|
17
|
-
require '
|
17
|
+
require 'OryHydraClient'
|
18
18
|
|
19
|
-
instance = OryHydraClient::InlineResponse500.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
status: null
|
26
|
-
)
|
19
|
+
instance = OryHydraClient::InlineResponse500.new(code: null,
|
20
|
+
details: null,
|
21
|
+
message: null,
|
22
|
+
reason: null,
|
23
|
+
request: null,
|
24
|
+
status: null)
|
27
25
|
```
|
28
26
|
|
27
|
+
|
@@ -2,29 +2,28 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**actions** | **Array<String>** | Actions is an array representing all the actions this ORY Access Policy applies to. | [optional]
|
8
|
+
**conditions** | **Hash<String, Object>** | Conditions represents a keyed object of conditions under which this ORY Access Policy is active. | [optional]
|
9
|
+
**description** | **String** | Description is an optional, human-readable description. | [optional]
|
10
|
+
**effect** | **String** | Effect is the effect of this ORY Access Policy. It can be \"allow\" or \"deny\". | [optional]
|
11
|
+
**id** | **String** | ID is the unique identifier of the ORY Access Policy. It is used to query, update, and remove the ORY Access Policy. | [optional]
|
12
|
+
**resources** | **Array<String>** | Resources is an array representing all the resources this ORY Access Policy applies to. | [optional]
|
13
|
+
**subjects** | **Array<String>** | Subjects is an array representing all the subjects this ORY Access Policy applies to. | [optional]
|
14
14
|
|
15
|
-
##
|
15
|
+
## Code Sample
|
16
16
|
|
17
17
|
```ruby
|
18
|
-
require '
|
18
|
+
require 'OryHydraClient'
|
19
19
|
|
20
|
-
instance = OryHydraClient::OryAccessControlPolicy.new(
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
subjects: null
|
28
|
-
)
|
20
|
+
instance = OryHydraClient::OryAccessControlPolicy.new(actions: null,
|
21
|
+
conditions: null,
|
22
|
+
description: null,
|
23
|
+
effect: null,
|
24
|
+
id: null,
|
25
|
+
resources: null,
|
26
|
+
subjects: null)
|
29
27
|
```
|
30
28
|
|
29
|
+
|
@@ -2,23 +2,22 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**action** | **String** | Action is the action that is requested on the resource. | [optional]
|
8
|
+
**context** | **Hash<String, Object>** | Context is the request's environmental context. | [optional]
|
9
|
+
**resource** | **String** | Resource is the resource that access is requested to. | [optional]
|
10
|
+
**subject** | **String** | Subject is the subject that is requesting access. | [optional]
|
11
11
|
|
12
|
-
##
|
12
|
+
## Code Sample
|
13
13
|
|
14
14
|
```ruby
|
15
|
-
require '
|
15
|
+
require 'OryHydraClient'
|
16
16
|
|
17
|
-
instance = OryHydraClient::OryAccessControlPolicyAllowedInput.new(
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
subject: null
|
22
|
-
)
|
17
|
+
instance = OryHydraClient::OryAccessControlPolicyAllowedInput.new(action: null,
|
18
|
+
context: null,
|
19
|
+
resource: null,
|
20
|
+
subject: null)
|
23
21
|
```
|
24
22
|
|
23
|
+
|
@@ -2,19 +2,18 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | ID is the role's unique id. | [optional]
|
8
|
+
**members** | **Array<String>** | Members is who belongs to the role. | [optional]
|
9
9
|
|
10
|
-
##
|
10
|
+
## Code Sample
|
11
11
|
|
12
12
|
```ruby
|
13
|
-
require '
|
13
|
+
require 'OryHydraClient'
|
14
14
|
|
15
|
-
instance = OryHydraClient::OryAccessControlPolicyRole.new(
|
16
|
-
|
17
|
-
members: null
|
18
|
-
)
|
15
|
+
instance = OryHydraClient::OryAccessControlPolicyRole.new(id: null,
|
16
|
+
members: null)
|
19
17
|
```
|
20
18
|
|
19
|
+
|
data/docs/Version.md
CHANGED
@@ -2,17 +2,16 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**version** | **String** | Version is the service's version. | [optional]
|
8
8
|
|
9
|
-
##
|
9
|
+
## Code Sample
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'OryHydraClient'
|
13
13
|
|
14
|
-
instance = OryHydraClient::Version.new(
|
15
|
-
version: null
|
16
|
-
)
|
14
|
+
instance = OryHydraClient::Version.new(version: null)
|
17
15
|
```
|
18
16
|
|
17
|
+
|
data/docs/VersionApi.md
CHANGED
@@ -2,51 +2,34 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_version**](VersionApi.md#get_version) | **GET** /version | Get service version
|
8
|
+
|
8
9
|
|
9
10
|
|
10
11
|
## get_version
|
11
12
|
|
12
|
-
>
|
13
|
+
> Version get_version
|
13
14
|
|
14
15
|
Get service version
|
15
16
|
|
16
17
|
This endpoint returns the service version typically notated using semantic versioning. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
17
18
|
|
18
|
-
###
|
19
|
+
### Example
|
19
20
|
|
20
21
|
```ruby
|
21
|
-
|
22
|
+
# load the gem
|
22
23
|
require 'ory-keto-client'
|
23
24
|
|
24
25
|
api_instance = OryHydraClient::VersionApi.new
|
25
26
|
|
26
27
|
begin
|
27
|
-
#
|
28
|
+
#Get service version
|
28
29
|
result = api_instance.get_version
|
29
30
|
p result
|
30
31
|
rescue OryHydraClient::ApiError => e
|
31
|
-
puts "
|
32
|
-
end
|
33
|
-
```
|
34
|
-
|
35
|
-
#### Using the get_version_with_http_info variant
|
36
|
-
|
37
|
-
This returns an Array which contains the response data, status code and headers.
|
38
|
-
|
39
|
-
> <Array(<Version>, Integer, Hash)> get_version_with_http_info
|
40
|
-
|
41
|
-
```ruby
|
42
|
-
begin
|
43
|
-
# Get service version
|
44
|
-
data, status_code, headers = api_instance.get_version_with_http_info
|
45
|
-
p status_code # => 2xx
|
46
|
-
p headers # => { ... }
|
47
|
-
p data # => <Version>
|
48
|
-
rescue OryHydraClient::ApiError => e
|
49
|
-
puts "Error when calling VersionApi->get_version_with_http_info: #{e}"
|
32
|
+
puts "Exception when calling VersionApi->get_version: #{e}"
|
50
33
|
end
|
51
34
|
```
|
52
35
|
|
data/lib/ory-keto-client.rb
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#Ory Keto is a cloud native access control server providing best-practice patterns (RBAC, ABAC, ACL, AWS IAM Policies, Kubernetes Roles, ...) via REST APIs.
|
5
5
|
|
6
|
-
The version of the OpenAPI document:
|
6
|
+
The version of the OpenAPI document: Latest
|
7
7
|
Contact: hi@ory.sh
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 4.2.2
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -18,13 +18,27 @@ require 'ory-keto-client/configuration'
|
|
18
18
|
|
19
19
|
# Models
|
20
20
|
require 'ory-keto-client/models/add_ory_access_control_policy_role_members_body'
|
21
|
+
require 'ory-keto-client/models/add_ory_access_control_policy_role_members_internal_server_error_body'
|
21
22
|
require 'ory-keto-client/models/authorization_result'
|
23
|
+
require 'ory-keto-client/models/delete_ory_access_control_policy_internal_server_error_body'
|
24
|
+
require 'ory-keto-client/models/delete_ory_access_control_policy_role_internal_server_error_body'
|
25
|
+
require 'ory-keto-client/models/do_ory_access_control_policies_allow_internal_server_error_body'
|
26
|
+
require 'ory-keto-client/models/get_ory_access_control_policy_internal_server_error_body'
|
27
|
+
require 'ory-keto-client/models/get_ory_access_control_policy_not_found_body'
|
28
|
+
require 'ory-keto-client/models/get_ory_access_control_policy_role_internal_server_error_body'
|
29
|
+
require 'ory-keto-client/models/get_ory_access_control_policy_role_not_found_body'
|
22
30
|
require 'ory-keto-client/models/health_not_ready_status'
|
23
31
|
require 'ory-keto-client/models/health_status'
|
24
32
|
require 'ory-keto-client/models/inline_response500'
|
33
|
+
require 'ory-keto-client/models/is_instance_alive_internal_server_error_body'
|
34
|
+
require 'ory-keto-client/models/list_ory_access_control_policies_internal_server_error_body'
|
35
|
+
require 'ory-keto-client/models/list_ory_access_control_policy_roles_internal_server_error_body'
|
25
36
|
require 'ory-keto-client/models/ory_access_control_policy'
|
26
37
|
require 'ory-keto-client/models/ory_access_control_policy_allowed_input'
|
27
38
|
require 'ory-keto-client/models/ory_access_control_policy_role'
|
39
|
+
require 'ory-keto-client/models/remove_ory_access_control_policy_role_members_internal_server_error_body'
|
40
|
+
require 'ory-keto-client/models/upsert_ory_access_control_policy_internal_server_error_body'
|
41
|
+
require 'ory-keto-client/models/upsert_ory_access_control_policy_role_internal_server_error_body'
|
28
42
|
require 'ory-keto-client/models/version'
|
29
43
|
|
30
44
|
# APIs
|