ory-oathkeeper-client 0.0.0.alpha38

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b93ef1ad66f5c46755a34127a5e80f14ba8c8c357c1632351fd67b96ec457e64
+  data.tar.gz: c43cd62f7e28b45841525aaed8d0567c5fd9cc150b35dede81833c1cf42821a7
+SHA512:
+  metadata.gz: 532f5f2cf772d936e402ad1cca84971d102343a9331fbc3401ff261836cb893735fc83e531a6211c7927de6694e39efe4f62357ce359ec2788c5dda2e500e3f0
+  data.tar.gz: 0f998b2fd70fa56bbe20fd6df2d164f727d3381494097bd579b7917a9082de5b370a6d392991885d2208a976121fd46eb102cdb4a88ef04f32f0a13ff73fcc75

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,184 @@
+# ory-oathkeeper-client
+
+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.0.0-alpha.38
+- Package version: v0.0.0-alpha.38
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.ory.am](https://www.ory.am)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build ory-oathkeeper-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./ory-oathkeeper-client-v0.0.0-alpha.38.gem
+```
+
+(for development, run `gem install --dev ./ory-oathkeeper-client-v0.0.0-alpha.38.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.0.0-alpha.38'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/ory/sdk, then add the following in the Gemfile:
+
+    gem 'ory-oathkeeper-client', :git => 'https://github.com/ory/sdk.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'ory-oathkeeper-client'
+
+api_instance = OryOathkeeperClient::ApiApi.new
+
+begin
+  #Access Control Decision API
+  api_instance.decisions
+rescue OryOathkeeperClient::ApiError => e
+  puts "Exception when calling ApiApi->decisions: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+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_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::CreateRuleCreated](docs/CreateRuleCreated.md)
+ - [OryOathkeeperClient::CreateRuleForbidden](docs/CreateRuleForbidden.md)
+ - [OryOathkeeperClient::CreateRuleForbiddenBody](docs/CreateRuleForbiddenBody.md)
+ - [OryOathkeeperClient::CreateRuleInternalServerError](docs/CreateRuleInternalServerError.md)
+ - [OryOathkeeperClient::CreateRuleInternalServerErrorBody](docs/CreateRuleInternalServerErrorBody.md)
+ - [OryOathkeeperClient::CreateRuleUnauthorized](docs/CreateRuleUnauthorized.md)
+ - [OryOathkeeperClient::CreateRuleUnauthorizedBody](docs/CreateRuleUnauthorizedBody.md)
+ - [OryOathkeeperClient::DecisionsForbidden](docs/DecisionsForbidden.md)
+ - [OryOathkeeperClient::DecisionsForbiddenBody](docs/DecisionsForbiddenBody.md)
+ - [OryOathkeeperClient::DecisionsInternalServerError](docs/DecisionsInternalServerError.md)
+ - [OryOathkeeperClient::DecisionsInternalServerErrorBody](docs/DecisionsInternalServerErrorBody.md)
+ - [OryOathkeeperClient::DecisionsNotFound](docs/DecisionsNotFound.md)
+ - [OryOathkeeperClient::DecisionsNotFoundBody](docs/DecisionsNotFoundBody.md)
+ - [OryOathkeeperClient::DecisionsUnauthorized](docs/DecisionsUnauthorized.md)
+ - [OryOathkeeperClient::DecisionsUnauthorizedBody](docs/DecisionsUnauthorizedBody.md)
+ - [OryOathkeeperClient::DeleteRuleForbidden](docs/DeleteRuleForbidden.md)
+ - [OryOathkeeperClient::DeleteRuleForbiddenBody](docs/DeleteRuleForbiddenBody.md)
+ - [OryOathkeeperClient::DeleteRuleInternalServerError](docs/DeleteRuleInternalServerError.md)
+ - [OryOathkeeperClient::DeleteRuleInternalServerErrorBody](docs/DeleteRuleInternalServerErrorBody.md)
+ - [OryOathkeeperClient::DeleteRuleNotFound](docs/DeleteRuleNotFound.md)
+ - [OryOathkeeperClient::DeleteRuleNotFoundBody](docs/DeleteRuleNotFoundBody.md)
+ - [OryOathkeeperClient::DeleteRuleUnauthorized](docs/DeleteRuleUnauthorized.md)
+ - [OryOathkeeperClient::DeleteRuleUnauthorizedBody](docs/DeleteRuleUnauthorizedBody.md)
+ - [OryOathkeeperClient::GetRuleForbidden](docs/GetRuleForbidden.md)
+ - [OryOathkeeperClient::GetRuleForbiddenBody](docs/GetRuleForbiddenBody.md)
+ - [OryOathkeeperClient::GetRuleInternalServerError](docs/GetRuleInternalServerError.md)
+ - [OryOathkeeperClient::GetRuleInternalServerErrorBody](docs/GetRuleInternalServerErrorBody.md)
+ - [OryOathkeeperClient::GetRuleNotFound](docs/GetRuleNotFound.md)
+ - [OryOathkeeperClient::GetRuleNotFoundBody](docs/GetRuleNotFoundBody.md)
+ - [OryOathkeeperClient::GetRuleOK](docs/GetRuleOK.md)
+ - [OryOathkeeperClient::GetRuleUnauthorized](docs/GetRuleUnauthorized.md)
+ - [OryOathkeeperClient::GetRuleUnauthorizedBody](docs/GetRuleUnauthorizedBody.md)
+ - [OryOathkeeperClient::GetWellKnownForbidden](docs/GetWellKnownForbidden.md)
+ - [OryOathkeeperClient::GetWellKnownForbiddenBody](docs/GetWellKnownForbiddenBody.md)
+ - [OryOathkeeperClient::GetWellKnownJSONWebKeysInternalServerError](docs/GetWellKnownJSONWebKeysInternalServerError.md)
+ - [OryOathkeeperClient::GetWellKnownJSONWebKeysInternalServerErrorBody](docs/GetWellKnownJSONWebKeysInternalServerErrorBody.md)
+ - [OryOathkeeperClient::GetWellKnownJSONWebKeysOK](docs/GetWellKnownJSONWebKeysOK.md)
+ - [OryOathkeeperClient::GetWellKnownOK](docs/GetWellKnownOK.md)
+ - [OryOathkeeperClient::GetWellKnownUnauthorized](docs/GetWellKnownUnauthorized.md)
+ - [OryOathkeeperClient::GetWellKnownUnauthorizedBody](docs/GetWellKnownUnauthorizedBody.md)
+ - [OryOathkeeperClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
+ - [OryOathkeeperClient::HealthStatus](docs/HealthStatus.md)
+ - [OryOathkeeperClient::InlineResponse500](docs/InlineResponse500.md)
+ - [OryOathkeeperClient::IsInstanceAliveInternalServerError](docs/IsInstanceAliveInternalServerError.md)
+ - [OryOathkeeperClient::IsInstanceAliveInternalServerErrorBody](docs/IsInstanceAliveInternalServerErrorBody.md)
+ - [OryOathkeeperClient::IsInstanceAliveOK](docs/IsInstanceAliveOK.md)
+ - [OryOathkeeperClient::JsonWebKey](docs/JsonWebKey.md)
+ - [OryOathkeeperClient::JsonWebKeySet](docs/JsonWebKeySet.md)
+ - [OryOathkeeperClient::JudgeForbidden](docs/JudgeForbidden.md)
+ - [OryOathkeeperClient::JudgeForbiddenBody](docs/JudgeForbiddenBody.md)
+ - [OryOathkeeperClient::JudgeInternalServerError](docs/JudgeInternalServerError.md)
+ - [OryOathkeeperClient::JudgeInternalServerErrorBody](docs/JudgeInternalServerErrorBody.md)
+ - [OryOathkeeperClient::JudgeNotFound](docs/JudgeNotFound.md)
+ - [OryOathkeeperClient::JudgeNotFoundBody](docs/JudgeNotFoundBody.md)
+ - [OryOathkeeperClient::JudgeUnauthorized](docs/JudgeUnauthorized.md)
+ - [OryOathkeeperClient::JudgeUnauthorizedBody](docs/JudgeUnauthorizedBody.md)
+ - [OryOathkeeperClient::ListRulesForbidden](docs/ListRulesForbidden.md)
+ - [OryOathkeeperClient::ListRulesForbiddenBody](docs/ListRulesForbiddenBody.md)
+ - [OryOathkeeperClient::ListRulesInternalServerError](docs/ListRulesInternalServerError.md)
+ - [OryOathkeeperClient::ListRulesInternalServerErrorBody](docs/ListRulesInternalServerErrorBody.md)
+ - [OryOathkeeperClient::ListRulesOK](docs/ListRulesOK.md)
+ - [OryOathkeeperClient::ListRulesUnauthorized](docs/ListRulesUnauthorized.md)
+ - [OryOathkeeperClient::ListRulesUnauthorizedBody](docs/ListRulesUnauthorizedBody.md)
+ - [OryOathkeeperClient::Rule](docs/Rule.md)
+ - [OryOathkeeperClient::RuleHandler](docs/RuleHandler.md)
+ - [OryOathkeeperClient::RuleMatch](docs/RuleMatch.md)
+ - [OryOathkeeperClient::SwaggerCreateRuleParameters](docs/SwaggerCreateRuleParameters.md)
+ - [OryOathkeeperClient::SwaggerGetRuleParameters](docs/SwaggerGetRuleParameters.md)
+ - [OryOathkeeperClient::SwaggerHealthStatus](docs/SwaggerHealthStatus.md)
+ - [OryOathkeeperClient::SwaggerJSONWebKey](docs/SwaggerJSONWebKey.md)
+ - [OryOathkeeperClient::SwaggerJSONWebKeySet](docs/SwaggerJSONWebKeySet.md)
+ - [OryOathkeeperClient::SwaggerListRulesParameters](docs/SwaggerListRulesParameters.md)
+ - [OryOathkeeperClient::SwaggerNotReadyStatus](docs/SwaggerNotReadyStatus.md)
+ - [OryOathkeeperClient::SwaggerRule](docs/SwaggerRule.md)
+ - [OryOathkeeperClient::SwaggerRuleHandler](docs/SwaggerRuleHandler.md)
+ - [OryOathkeeperClient::SwaggerRuleMatch](docs/SwaggerRuleMatch.md)
+ - [OryOathkeeperClient::SwaggerRuleResponse](docs/SwaggerRuleResponse.md)
+ - [OryOathkeeperClient::SwaggerRulesResponse](docs/SwaggerRulesResponse.md)
+ - [OryOathkeeperClient::SwaggerUpdateRuleParameters](docs/SwaggerUpdateRuleParameters.md)
+ - [OryOathkeeperClient::SwaggerVersion](docs/SwaggerVersion.md)
+ - [OryOathkeeperClient::UpdateRuleForbidden](docs/UpdateRuleForbidden.md)
+ - [OryOathkeeperClient::UpdateRuleForbiddenBody](docs/UpdateRuleForbiddenBody.md)
+ - [OryOathkeeperClient::UpdateRuleInternalServerError](docs/UpdateRuleInternalServerError.md)
+ - [OryOathkeeperClient::UpdateRuleInternalServerErrorBody](docs/UpdateRuleInternalServerErrorBody.md)
+ - [OryOathkeeperClient::UpdateRuleNotFound](docs/UpdateRuleNotFound.md)
+ - [OryOathkeeperClient::UpdateRuleNotFoundBody](docs/UpdateRuleNotFoundBody.md)
+ - [OryOathkeeperClient::UpdateRuleOK](docs/UpdateRuleOK.md)
+ - [OryOathkeeperClient::UpdateRuleUnauthorized](docs/UpdateRuleUnauthorized.md)
+ - [OryOathkeeperClient::UpdateRuleUnauthorizedBody](docs/UpdateRuleUnauthorizedBody.md)
+ - [OryOathkeeperClient::Upstream](docs/Upstream.md)
+ - [OryOathkeeperClient::Version](docs/Version.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/ApiApi.md

@@ -0,0 +1,450 @@
+# OryOathkeeperClient::ApiApi
+
+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_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
+
+> decisions
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-oathkeeper-client'
+
+api_instance = OryOathkeeperClient::ApiApi.new
+
+begin
+  # Access Control Decision API
+  api_instance.decisions
+rescue OryOathkeeperClient::ApiError => 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 OryOathkeeperClient::ApiError => e
+  puts "Error when calling ApiApi->decisions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_rule
+
+> <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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-oathkeeper-client'
+
+api_instance = OryOathkeeperClient::ApiApi.new
+id = 'id_example' # String | 
+
+begin
+  # Retrieve a rule
+  result = api_instance.get_rule(id)
+  p result
+rescue OryOathkeeperClient::ApiError => e
+  puts "Error when calling ApiApi->get_rule: #{e}"
+end
+```
+
+#### Using the get_rule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <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 OryOathkeeperClient::ApiError => e
+  puts "Error when calling ApiApi->get_rule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Rule**](Rule.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **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
+
+This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-oathkeeper-client'
+
+api_instance = OryOathkeeperClient::ApiApi.new
+
+begin
+  # Lists cryptographic keys
+  result = api_instance.get_well_known_json_web_keys
+  p result
+rescue OryOathkeeperClient::ApiError => 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 OryOathkeeperClient::ApiError => e
+  puts "Error when calling ApiApi->get_well_known_json_web_keys_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**JsonWebKeySet**](JsonWebKeySet.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **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
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-oathkeeper-client'
+
+api_instance = OryOathkeeperClient::ApiApi.new
+opts = {
+  limit: 789, # Integer | The maximum amount of rules returned.
+  offset: 789 # Integer | The offset from where to start looking.
+}
+
+begin
+  # List all rules
+  result = api_instance.list_rules(opts)
+  p result
+rescue OryOathkeeperClient::ApiError => e
+  puts "Error when calling ApiApi->list_rules: #{e}"
+end
+```
+
+#### 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 OryOathkeeperClient::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] |
+
+### Return type
+
+[**Array&lt;Rule&gt;**](Rule.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+