ory-keto-client 0.5.4.alpha1 → 0.6.0.alpha6

data/docs/ExpandTree.md

@@ -0,0 +1,22 @@
+# OryHydraClient::ExpandTree
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **children** | [**Array<ExpandTree>**](ExpandTree.md) |  | [optional] |
+| **subject** | **String** |  |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ory-keto-client'
+
+instance = OryHydraClient::ExpandTree.new(
+  children: null,
+  subject: null,
+  type: null
+)
+```
+

data/docs/GetCheckResponse.md

@@ -0,0 +1,18 @@
+# OryHydraClient::GetCheckResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed** | **Boolean** | whether the relation tuple is allowed |  |
+
+## Example
+
+```ruby
+require 'ory-keto-client'
+
+instance = OryHydraClient::GetCheckResponse.new(
+  allowed: null
+)
+```
+

data/docs/GetRelationTuplesResponse.md

@@ -0,0 +1,20 @@
+# OryHydraClient::GetRelationTuplesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_page_token** | **String** | The opaque token to provide in a subsequent request to get the next page. It is the empty string iff this is the last page. | [optional] |
+| **relation_tuples** | [**Array<InternalRelationTuple>**](InternalRelationTuple.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-keto-client'
+
+instance = OryHydraClient::GetRelationTuplesResponse.new(
+  next_page_token: null,
+  relation_tuples: null
+)
+```
+

data/docs/HealthApi.md

@@ -2,35 +2,52 @@
 
 All URIs are relative to *http://localhost*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**is_instance_alive**](HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
-[**is_instance_ready**](HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**is_instance_alive**](HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status |
+| [**is_instance_ready**](HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status |
 
 
 ## is_instance_alive
 
-> HealthStatus is_instance_alive
+> <HealthStatus> is_instance_alive
 
 Check alive status
 
 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.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-keto-client'
 
 api_instance = OryHydraClient::HealthApi.new
 
 begin
-  #Check alive status
+  # Check alive status
   result = api_instance.is_instance_alive
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling HealthApi->is_instance_alive: #{e}"
+  puts "Error when calling HealthApi->is_instance_alive: #{e}"
+end
+```
+
+#### Using the is_instance_alive_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HealthStatus>, Integer, Hash)> is_instance_alive_with_http_info
+
+```ruby
+begin
+  # Check alive status
+  data, status_code, headers = api_instance.is_instance_alive_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HealthStatus>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling HealthApi->is_instance_alive_with_http_info: #{e}"
 end
 ```
 
@@ -54,26 +71,44 @@ No authorization required
 
 ## is_instance_ready
 
-> HealthStatus is_instance_ready
+> <HealthStatus> is_instance_ready
 
 Check readiness status
 
 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.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-keto-client'
 
 api_instance = OryHydraClient::HealthApi.new
 
 begin
-  #Check readiness status
+  # Check readiness status
   result = api_instance.is_instance_ready
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling HealthApi->is_instance_ready: #{e}"
+  puts "Error when calling HealthApi->is_instance_ready: #{e}"
+end
+```
+
+#### Using the is_instance_ready_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HealthStatus>, Integer, Hash)> is_instance_ready_with_http_info
+
+```ruby
+begin
+  # Check readiness status
+  data, status_code, headers = api_instance.is_instance_ready_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HealthStatus>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling HealthApi->is_instance_ready_with_http_info: #{e}"
 end
 ```
 

data/docs/HealthNotReadyStatus.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-keto-client'
 
-instance = OryHydraClient::HealthNotReadyStatus.new(errors: null)
+instance = OryHydraClient::HealthNotReadyStatus.new(
+  errors: null
+)
 ```
 
-

data/docs/HealthStatus.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **String** | Status always contains \"ok\". | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Status always contains \"ok\". | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-keto-client'
 
-instance = OryHydraClient::HealthStatus.new(status: null)
+instance = OryHydraClient::HealthStatus.new(
+  status: null
+)
 ```
 
-

data/docs/InlineResponse400.md

@@ -0,0 +1,28 @@
+# OryHydraClient::InlineResponse400
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **details** | **Array<Object>** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **reason** | **String** |  | [optional] |
+| **request** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-keto-client'
+
+instance = OryHydraClient::InlineResponse400.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+

data/docs/InlineResponse500.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Integer** |  | [optional] 
-**details** | **Array<Hash<String, Object>>** |  | [optional] 
-**message** | **String** |  | [optional] 
-**reason** | **String** |  | [optional] 
-**request** | **String** |  | [optional] 
-**status** | **String** |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **details** | **Array<Object>** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **reason** | **String** |  | [optional] |
+| **request** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-keto-client'
 
-instance = OryHydraClient::InlineResponse500.new(code: null,
-                                 details: null,
-                                 message: null,
-                                 reason: null,
-                                 request: null,
-                                 status: null)
+instance = OryHydraClient::InlineResponse500.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
 ```
 
-

data/docs/InternalRelationTuple.md

@@ -0,0 +1,24 @@
+# OryHydraClient::InternalRelationTuple
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Relation Tuple  in: query |  |
+| **object** | **String** | Object of the Relation Tuple  in: query |  |
+| **relation** | **String** | Relation of the Relation Tuple  in: query |  |
+| **subject** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ory-keto-client'
+
+instance = OryHydraClient::InternalRelationTuple.new(
+  namespace: null,
+  object: null,
+  relation: null,
+  subject: null
+)
+```
+

data/docs/OryAccessControlPolicy.md

@@ -2,28 +2,29 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**actions** | **Array<String>** | Actions is an array representing all the actions this ORY Access Policy applies to. | [optional] 
-**conditions** | **Hash<String, Object>** | Conditions represents a keyed object of conditions under which this ORY Access Policy is active. | [optional] 
-**description** | **String** | Description is an optional, human-readable description. | [optional] 
-**effect** | **String** | Effect is the effect of this ORY Access Policy. It can be \"allow\" or \"deny\". | [optional] 
-**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] 
-**resources** | **Array<String>** | Resources is an array representing all the resources this ORY Access Policy applies to. | [optional] 
-**subjects** | **Array<String>** | Subjects is an array representing all the subjects this ORY Access Policy applies to. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **actions** | **Array<String>** | Actions is an array representing all the actions this ORY Access Policy applies to. | [optional] |
+| **conditions** | **Object** | Conditions represents a keyed object of conditions under which this ORY Access Policy is active. | [optional] |
+| **description** | **String** | Description is an optional, human-readable description. | [optional] |
+| **effect** | **String** | Effect is the effect of this ORY Access Policy. It can be \"allow\" or \"deny\". | [optional] |
+| **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] |
+| **resources** | **Array<String>** | Resources is an array representing all the resources this ORY Access Policy applies to. | [optional] |
+| **subjects** | **Array<String>** | Subjects is an array representing all the subjects this ORY Access Policy applies to. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-keto-client'
 
-instance = OryHydraClient::OryAccessControlPolicy.new(actions: null,
-                                 conditions: null,
-                                 description: null,
-                                 effect: null,
-                                 id: null,
-                                 resources: null,
-                                 subjects: null)
+instance = OryHydraClient::OryAccessControlPolicy.new(
+  actions: null,
+  conditions: null,
+  description: null,
+  effect: null,
+  id: null,
+  resources: null,
+  subjects: null
+)
 ```
 
-

data/docs/OryAccessControlPolicyAllowedInput.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**action** | **String** | Action is the action that is requested on the resource. | [optional] 
-**context** | **Hash<String, Object>** | Context is the request's environmental context. | [optional] 
-**resource** | **String** | Resource is the resource that access is requested to. | [optional] 
-**subject** | **String** | Subject is the subject that is requesting access. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | Action is the action that is requested on the resource. | [optional] |
+| **context** | **Object** | Context is the request's environmental context. | [optional] |
+| **resource** | **String** | Resource is the resource that access is requested to. | [optional] |
+| **subject** | **String** | Subject is the subject that is requesting access. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-keto-client'
 
-instance = OryHydraClient::OryAccessControlPolicyAllowedInput.new(action: null,
-                                 context: null,
-                                 resource: null,
-                                 subject: null)
+instance = OryHydraClient::OryAccessControlPolicyAllowedInput.new(
+  action: null,
+  context: null,
+  resource: null,
+  subject: null
+)
 ```
 
-

data/docs/OryAccessControlPolicyRole.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | ID is the role's unique id. | [optional] 
-**members** | **Array<String>** | Members is who belongs to the role. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID is the role's unique id. | [optional] |
+| **members** | **Array<String>** | Members is who belongs to the role. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-keto-client'
 
-instance = OryHydraClient::OryAccessControlPolicyRole.new(id: null,
-                                 members: null)
+instance = OryHydraClient::OryAccessControlPolicyRole.new(
+  id: null,
+  members: null
+)
 ```
 
-