ory-oathkeeper-client 0.38.4.beta1 → 0.38.12.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c177685dff43323f2219abaea0fe7a1212144be4047c0113a3b984bd8ae61e14
-  data.tar.gz: ffe4e4ac664cf377d63be9dee03a5eb9e7e77a17ccaf0c4dab974b6fe3edff67
+  metadata.gz: ef4136e014b85115b5a31de4eea591e09bce5d42821ae09a2728975d5ea09cd9
+  data.tar.gz: 014b6b59236586029100d597659e62fcd7023ad97bd985c62736f41f6a43477d
 SHA512:
-  metadata.gz: 600172ee27099dbe42ec6bf8927cab2a7f965512633da5eb21e900a6711b1431f62cde6a5ad101c5f448056bbba628922976c487885d65469e39ad1d3753c7db
-  data.tar.gz: 8690f5aea83a20254358c8d0810e28e089ecc2cb30343c1e991fcc183a009a9e728ceb02583d0ca96303be2a1d5107451428fe603aeb1ac200d1f6cb6ab083ac
+  metadata.gz: 759892daa04f78dd611a8ee42170b44a1d3d543528a184ce4999c3a2a1738ff02892867541d2082430939ae5e3267e7b9d3e3118a2bcce57cc8cd05a1f34ae69
+  data.tar.gz: b6fc3bcf3ccdf3ccbe2c92642241fbcb23b46b7463d28fcbbc373bf1660f16a28ec2aa1eeb71638fb19ec9b8b9603dfccaadcb2b1c77b3ce736b65ef65eb2e77

data/README.md

@@ -6,8 +6,8 @@ ORY Oathkeeper is a reverse proxy that checks the HTTP Authorization for validit
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v0.38.4-beta.1
-- Package version: v0.38.4-beta.1
+- API version: v0.38.12-beta.1
+- Package version: v0.38.12-beta.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.ory.am](https://www.ory.am)
 
@@ -24,16 +24,16 @@ gem build ory-oathkeeper-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ory-oathkeeper-client-v0.38.4-beta.1.gem
+gem install ./ory-oathkeeper-client-v0.38.12-beta.1.gem
 ```
 
-(for development, run `gem install --dev ./ory-oathkeeper-client-v0.38.4-beta.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ory-oathkeeper-client-v0.38.12-beta.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ory-oathkeeper-client', '~> v0.38.4-beta.1'
+    gem 'ory-oathkeeper-client', '~> v0.38.12-beta.1'
 
 ### Install from Git
 
@@ -76,11 +76,11 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *OryHydraClient::ApiApi* | [**decisions**](docs/ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
 *OryHydraClient::ApiApi* | [**get_rule**](docs/ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
+*OryHydraClient::ApiApi* | [**get_version**](docs/ApiApi.md#get_version) | **GET** /version | Get service version
 *OryHydraClient::ApiApi* | [**get_well_known_json_web_keys**](docs/ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
+*OryHydraClient::ApiApi* | [**is_instance_alive**](docs/ApiApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
+*OryHydraClient::ApiApi* | [**is_instance_ready**](docs/ApiApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
 *OryHydraClient::ApiApi* | [**list_rules**](docs/ApiApi.md#list_rules) | **GET** /rules | List all rules
-*OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
-*OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
-*OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
 
 
 ## Documentation for Models

data/docs/ApiApi.md

@@ -2,13 +2,15 @@
 
 All URIs are relative to *http://localhost*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**decisions**](ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
-[**get_rule**](ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
-[**get_well_known_json_web_keys**](ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
-[**list_rules**](ApiApi.md#list_rules) | **GET** /rules | List all rules
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**decisions**](ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API |
+| [**get_rule**](ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule |
+| [**get_version**](ApiApi.md#get_version) | **GET** /version | Get service version |
+| [**get_well_known_json_web_keys**](ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys |
+| [**is_instance_alive**](ApiApi.md#is_instance_alive) | **GET** /health/alive | Check alive status |
+| [**is_instance_ready**](ApiApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status |
+| [**list_rules**](ApiApi.md#list_rules) | **GET** /rules | List all rules |
 
 
 ## decisions
@@ -19,19 +21,37 @@ Access Control Decision API
 
 > This endpoint works with all HTTP Methods (GET, POST, PUT, ...) and matches every path prefixed with /decision.  This endpoint mirrors the proxy capability of ORY Oathkeeper's proxy functionality but instead of forwarding the request to the upstream server, returns 200 (request should be allowed), 401 (unauthorized), or 403 (forbidden) status codes. This endpoint can be used to integrate with other API Proxies like Ambassador, Kong, Envoy, and many more.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-oathkeeper-client'
 
 api_instance = OryHydraClient::ApiApi.new
 
 begin
-  #Access Control Decision API
+  # Access Control Decision API
   api_instance.decisions
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling ApiApi->decisions: #{e}"
+  puts "Error when calling ApiApi->decisions: #{e}"
+end
+```
+
+#### Using the decisions_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> decisions_with_http_info
+
+```ruby
+begin
+  # Access Control Decision API
+  data, status_code, headers = api_instance.decisions_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->decisions_with_http_info: #{e}"
 end
 ```
 
@@ -55,36 +75,53 @@ No authorization required
 
 ## get_rule
 
-> Rule get_rule(id)
+> <Rule> get_rule(id)
 
 Retrieve a rule
 
 Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-oathkeeper-client'
 
 api_instance = OryHydraClient::ApiApi.new
 id = 'id_example' # String | 
 
 begin
-  #Retrieve a rule
+  # Retrieve a rule
   result = api_instance.get_rule(id)
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling ApiApi->get_rule: #{e}"
+  puts "Error when calling ApiApi->get_rule: #{e}"
 end
 ```
 
-### Parameters
+#### Using the get_rule_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**|  | 
+> <Array(<Rule>, Integer, Hash)> get_rule_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve a rule
+  data, status_code, headers = api_instance.get_rule_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Rule>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->get_rule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
 
 ### Return type
 
@@ -100,28 +137,107 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_version
+
+> <Version> get_version
+
+Get service version
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-oathkeeper-client'
+
+api_instance = OryHydraClient::ApiApi.new
+
+begin
+  # Get service version
+  result = api_instance.get_version
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->get_version: #{e}"
+end
+```
+
+#### Using the get_version_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Version>, Integer, Hash)> get_version_with_http_info
+
+```ruby
+begin
+  # Get service version
+  data, status_code, headers = api_instance.get_version_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Version>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->get_version_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Version**](Version.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_well_known_json_web_keys
 
-> JsonWebKeySet get_well_known_json_web_keys
+> <JsonWebKeySet> get_well_known_json_web_keys
 
 Lists cryptographic keys
 
 This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-oathkeeper-client'
 
 api_instance = OryHydraClient::ApiApi.new
 
 begin
-  #Lists cryptographic keys
+  # Lists cryptographic keys
   result = api_instance.get_well_known_json_web_keys
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling ApiApi->get_well_known_json_web_keys: #{e}"
+  puts "Error when calling ApiApi->get_well_known_json_web_keys: #{e}"
+end
+```
+
+#### Using the get_well_known_json_web_keys_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JsonWebKeySet>, Integer, Hash)> get_well_known_json_web_keys_with_http_info
+
+```ruby
+begin
+  # Lists cryptographic keys
+  data, status_code, headers = api_instance.get_well_known_json_web_keys_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JsonWebKeySet>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->get_well_known_json_web_keys_with_http_info: #{e}"
 end
 ```
 
@@ -143,42 +259,181 @@ No authorization required
 - **Accept**: application/json
 
 
+## 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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-oathkeeper-client'
+
+api_instance = OryHydraClient::ApiApi.new
+
+begin
+  # Check alive status
+  result = api_instance.is_instance_alive
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->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 ApiApi->is_instance_alive_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**HealthStatus**](HealthStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## 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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-oathkeeper-client'
+
+api_instance = OryHydraClient::ApiApi.new
+
+begin
+  # Check readiness status
+  result = api_instance.is_instance_ready
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->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 ApiApi->is_instance_ready_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**HealthStatus**](HealthStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_rules
 
-> Array&lt;Rule&gt; list_rules(opts)
+> <Array<Rule>> list_rules(opts)
 
 List all rules
 
 This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full view of what rules you have currently in place.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-oathkeeper-client'
 
 api_instance = OryHydraClient::ApiApi.new
 opts = {
-  limit: 56, # Integer | The maximum amount of rules returned.
-  offset: 56 # Integer | The offset from where to start looking.
+  limit: 789, # Integer | The maximum amount of rules returned.
+  offset: 789 # Integer | The offset from where to start looking.
 }
 
 begin
-  #List all rules
+  # List all rules
   result = api_instance.list_rules(opts)
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling ApiApi->list_rules: #{e}"
+  puts "Error when calling ApiApi->list_rules: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_rules_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Rule>>, Integer, Hash)> list_rules_with_http_info(opts)
+
+```ruby
+begin
+  # List all rules
+  data, status_code, headers = api_instance.list_rules_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Rule>>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->list_rules_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| The maximum amount of rules returned. | [optional] 
- **offset** | **Integer**| The offset from where to start looking. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | The maximum amount of rules returned. | [optional] |
+| **offset** | **Integer** | The offset from where to start looking. | [optional] |
 
 ### Return type