ory-oathkeeper-client 0.38.20.beta1 → 0.38.22.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139c837c257308679cf37c4e888ce94910d30e53395e305f5b45a0e471747882
-  data.tar.gz: 730ec2a00adb0c8e0e137aa31a9d8647783edcb0b5411091aa2f2c4e862f773a
+  metadata.gz: 8ea741f2e08fc61fcc9fdbb19984cd62573082b07fc4001d337b297dc39c0d1a
+  data.tar.gz: f5b9cda6eaaf86b8644dc1761509858c54498532bdf5d68eb70ab404d11f84b8
 SHA512:
-  metadata.gz: 5369125fab065b0c7320bd2db2344e4a8da5040fd6d8dd6713687f77bd3c772b48d504e7e53d1f6824c9acc7a30d7cf02be00db582703ed99fc0e0a076f4339c
-  data.tar.gz: 8ed261e465a67d6db3118eeb3628908041e1dc603e68a84eeddb100232ca15868d26eba5680935d12664dfd344200781b1223e7e704240278ee3fde9526f63db
+  metadata.gz: 12339470038b0dec7859233490f08d5a4c877974897aef02392f7b542fc388760e5d898421b7c9060bfd6d21d30f80e6dae1381646ae6275c5fb8c7c95af4565
+  data.tar.gz: 57e567f0398df97aa9ae6ba44c68510ff61de9f847ba2e77cc8b80ffa87ccd8a4572a92a935c1429a6f3bdc32114b13ad000aa932368289ca04f774cfa1c71aa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ory-oathkeeper-client (0.38.20.beta1)
+    ory-oathkeeper-client (0.38.22.beta1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -17,7 +17,7 @@ GEM
     jaro_winkler (1.5.4)
     method_source (1.0.0)
     parallel (1.21.0)
-    parser (3.1.0.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)

data/README.md

@@ -1,15 +1,15 @@
 # ory-oathkeeper-client
 
-OryOathkeeperClient - the Ruby gem for the Ory Oathkeeper API
-
-Documentation for all of Ory Oathkeeper's APIs.
+OryOathkeeperClient - the Ruby gem for the ORY Oathkeeper
 
+ORY Oathkeeper is a reverse proxy that checks the HTTP Authorization for validity against a set of rules. This service uses Hydra to validate access tokens and policies.
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v0.38.20-beta.1
-- Package version: v0.38.20-beta.1
+- API version: v0.38.22-beta.1
+- Package version: v0.38.22-beta.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.ory.am](https://www.ory.am)
 
 ## Installation
 
@@ -24,16 +24,16 @@ gem build ory-oathkeeper-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ory-oathkeeper-client-v0.38.20-beta.1.gem
+gem install ./ory-oathkeeper-client-v0.38.22-beta.1.gem
 ```
 
-(for development, run `gem install --dev ./ory-oathkeeper-client-v0.38.20-beta.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ory-oathkeeper-client-v0.38.22-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.20-beta.1'
+    gem 'ory-oathkeeper-client', '~> v0.38.22-beta.1'
 
 ### Install from Git
 
@@ -75,22 +75,19 @@ All URIs are relative to *http://localhost*
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *OryOathkeeperClient::ApiApi* | [**decisions**](docs/ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
-*OryOathkeeperClient::ApiApi* | [**get_rule**](docs/ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a Rule
-*OryOathkeeperClient::ApiApi* | [**get_well_known_json_web_keys**](docs/ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists Cryptographic Keys
-*OryOathkeeperClient::ApiApi* | [**list_rules**](docs/ApiApi.md#list_rules) | **GET** /rules | List All Rules
-*OryOathkeeperClient::MetadataApi* | [**get_version**](docs/MetadataApi.md#get_version) | **GET** /version | Return Running Software Version.
-*OryOathkeeperClient::MetadataApi* | [**is_alive**](docs/MetadataApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status
-*OryOathkeeperClient::MetadataApi* | [**is_ready**](docs/MetadataApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status
+*OryOathkeeperClient::ApiApi* | [**get_rule**](docs/ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
+*OryOathkeeperClient::ApiApi* | [**get_version**](docs/ApiApi.md#get_version) | **GET** /version | Get service version
+*OryOathkeeperClient::ApiApi* | [**get_well_known_json_web_keys**](docs/ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
+*OryOathkeeperClient::ApiApi* | [**is_instance_alive**](docs/ApiApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
+*OryOathkeeperClient::ApiApi* | [**is_instance_ready**](docs/ApiApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
+*OryOathkeeperClient::ApiApi* | [**list_rules**](docs/ApiApi.md#list_rules) | **GET** /rules | List all rules
 
 
 ## Documentation for Models
 
- - [OryOathkeeperClient::GenericError](docs/GenericError.md)
  - [OryOathkeeperClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
  - [OryOathkeeperClient::HealthStatus](docs/HealthStatus.md)
- - [OryOathkeeperClient::InlineResponse200](docs/InlineResponse200.md)
- - [OryOathkeeperClient::InlineResponse2001](docs/InlineResponse2001.md)
- - [OryOathkeeperClient::InlineResponse503](docs/InlineResponse503.md)
+ - [OryOathkeeperClient::InlineResponse500](docs/InlineResponse500.md)
  - [OryOathkeeperClient::JsonWebKey](docs/JsonWebKey.md)
  - [OryOathkeeperClient::JsonWebKeySet](docs/JsonWebKeySet.md)
  - [OryOathkeeperClient::Rule](docs/Rule.md)

data/docs/ApiApi.md

@@ -5,9 +5,12 @@ 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 |
+| [**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
@@ -74,7 +77,7 @@ No authorization required
 
 > <Rule> get_rule(id)
 
-Retrieve a Rule
+Retrieve a rule
 
 Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.
 
@@ -88,7 +91,7 @@ api_instance = OryOathkeeperClient::ApiApi.new
 id = 'id_example' # String | 
 
 begin
-  # Retrieve a Rule
+  # Retrieve a rule
   result = api_instance.get_rule(id)
   p result
 rescue OryOathkeeperClient::ApiError => e
@@ -104,7 +107,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Retrieve a Rule
+  # Retrieve a rule
   data, status_code, headers = api_instance.get_rule_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -134,11 +137,72 @@ 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 = OryOathkeeperClient::ApiApi.new
+
+begin
+  # Get service version
+  result = api_instance.get_version
+  p result
+rescue OryOathkeeperClient::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 OryOathkeeperClient::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
 
-Lists Cryptographic Keys
+Lists cryptographic keys
 
 This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.
 
@@ -151,7 +215,7 @@ require 'ory-oathkeeper-client'
 api_instance = OryOathkeeperClient::ApiApi.new
 
 begin
-  # Lists Cryptographic Keys
+  # Lists cryptographic keys
   result = api_instance.get_well_known_json_web_keys
   p result
 rescue OryOathkeeperClient::ApiError => e
@@ -167,7 +231,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Lists Cryptographic Keys
+  # Lists cryptographic keys
   data, status_code, headers = api_instance.get_well_known_json_web_keys_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -195,11 +259,133 @@ 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 = OryOathkeeperClient::ApiApi.new
+
+begin
+  # Check alive status
+  result = api_instance.is_instance_alive
+  p result
+rescue OryOathkeeperClient::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 OryOathkeeperClient::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 = OryOathkeeperClient::ApiApi.new
+
+begin
+  # Check readiness status
+  result = api_instance.is_instance_ready
+  p result
+rescue OryOathkeeperClient::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 OryOathkeeperClient::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<Rule>> list_rules(opts)
 
-List All Rules
+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.
 
@@ -216,7 +402,7 @@ opts = {
 }
 
 begin
-  # List All Rules
+  # List all rules
   result = api_instance.list_rules(opts)
   p result
 rescue OryOathkeeperClient::ApiError => e
@@ -232,7 +418,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # List All Rules
+  # List all rules
   data, status_code, headers = api_instance.list_rules_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/InlineResponse500.md

@@ -0,0 +1,28 @@
+# OryOathkeeperClient::InlineResponse500
+
+## 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-oathkeeper-client'
+
+instance = OryOathkeeperClient::InlineResponse500.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
+```
+

data/docs/JsonWebKey.md

@@ -5,22 +5,22 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **alg** | **String** | The \"alg\" (algorithm) parameter identifies the algorithm intended for use with the key.  The values used should either be registered in the IANA \"JSON Web Signature and Encryption Algorithms\" registry established by [JWA] or be a value that contains a Collision- Resistant Name. | [optional] |
-| **crv** | **String** | crv | [optional] |
-| **d** | **String** | d | [optional] |
-| **dp** | **String** | dp | [optional] |
-| **dq** | **String** | dq | [optional] |
-| **e** | **String** | e | [optional] |
-| **k** | **String** | k | [optional] |
+| **crv** | **String** |  | [optional] |
+| **d** | **String** |  | [optional] |
+| **dp** | **String** |  | [optional] |
+| **dq** | **String** |  | [optional] |
+| **e** | **String** |  | [optional] |
+| **k** | **String** |  | [optional] |
 | **kid** | **String** | The \"kid\" (key ID) parameter is used to match a specific key.  This is used, for instance, to choose among a set of keys within a JWK Set during key rollover.  The structure of the \"kid\" value is unspecified.  When \"kid\" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct \"kid\" values.  (One example in which different keys might use the same \"kid\" value is if they have different \"kty\" (key type) values but are considered to be equivalent alternatives by the application using them.)  The \"kid\" value is a case-sensitive string. | [optional] |
 | **kty** | **String** | The \"kty\" (key type) parameter identifies the cryptographic algorithm family used with the key, such as \"RSA\" or \"EC\". \"kty\" values should either be registered in the IANA \"JSON Web Key Types\" registry established by [JWA] or be a value that contains a Collision- Resistant Name.  The \"kty\" value is a case-sensitive string. | [optional] |
-| **n** | **String** | n | [optional] |
-| **p** | **String** | p | [optional] |
-| **q** | **String** | q | [optional] |
-| **qi** | **String** | qi | [optional] |
+| **n** | **String** |  | [optional] |
+| **p** | **String** |  | [optional] |
+| **q** | **String** |  | [optional] |
+| **qi** | **String** |  | [optional] |
 | **use** | **String** | The \"use\" (public key use) parameter identifies the intended use of the public key. The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly \"sig\" (signature) or \"enc\" (encryption). | [optional] |
-| **x** | **String** | x | [optional] |
+| **x** | **String** |  | [optional] |
 | **x5c** | **Array<String>** | The \"x5c\" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280].  The certificate chain is represented as a JSON array of certificate value strings.  Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. | [optional] |
-| **y** | **String** | y | [optional] |
+| **y** | **String** |  | [optional] |
 
 ## Example