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

data/docs/SwaggerVersion.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**version** | **String** | Version is the service's version. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | Version is the service's version. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerVersion.new(version: null)
+instance = OryHydraClient::SwaggerVersion.new(
+  version: null
+)
 ```
 
-

data/docs/UpdateRuleForbidden.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payload** | [**UpdateRuleForbiddenBody**](UpdateRuleForbiddenBody.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**UpdateRuleForbiddenBody**](UpdateRuleForbiddenBody.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::UpdateRuleForbidden.new(payload: null)
+instance = OryHydraClient::UpdateRuleForbidden.new(
+  payload: null
+)
 ```
 
-

data/docs/UpdateRuleForbiddenBody.md

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

data/docs/UpdateRuleInternalServerError.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payload** | [**UpdateRuleInternalServerErrorBody**](UpdateRuleInternalServerErrorBody.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**UpdateRuleInternalServerErrorBody**](UpdateRuleInternalServerErrorBody.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::UpdateRuleInternalServerError.new(payload: null)
+instance = OryHydraClient::UpdateRuleInternalServerError.new(
+  payload: null
+)
 ```
 
-

data/docs/UpdateRuleInternalServerErrorBody.md

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

data/docs/UpdateRuleNotFound.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payload** | [**UpdateRuleNotFoundBody**](UpdateRuleNotFoundBody.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**UpdateRuleNotFoundBody**](UpdateRuleNotFoundBody.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::UpdateRuleNotFound.new(payload: null)
+instance = OryHydraClient::UpdateRuleNotFound.new(
+  payload: null
+)
 ```
 
-

data/docs/UpdateRuleNotFoundBody.md

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

data/docs/UpdateRuleOK.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payload** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::UpdateRuleOK.new(payload: null)
+instance = OryHydraClient::UpdateRuleOK.new(
+  payload: null
+)
 ```
 
-

data/docs/UpdateRuleUnauthorized.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payload** | [**UpdateRuleUnauthorizedBody**](UpdateRuleUnauthorizedBody.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**UpdateRuleUnauthorizedBody**](UpdateRuleUnauthorizedBody.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::UpdateRuleUnauthorized.new(payload: null)
+instance = OryHydraClient::UpdateRuleUnauthorized.new(
+  payload: null
+)
 ```
 
-

data/docs/UpdateRuleUnauthorizedBody.md

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

data/docs/Upstream.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**preserve_host** | **Boolean** | PreserveHost, if false (the default), tells ORY Oathkeeper to set the upstream request's Host header to the hostname of the API's upstream's URL. Setting this flag to true instructs ORY Oathkeeper not to do so. | [optional] 
-**strip_path** | **String** | StripPath if set, replaces the provided path prefix when forwarding the requested URL to the upstream URL. | [optional] 
-**url** | **String** | URL is the URL the request will be proxied to. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preserve_host** | **Boolean** | PreserveHost, if false (the default), tells ORY Oathkeeper to set the upstream request's Host header to the hostname of the API's upstream's URL. Setting this flag to true instructs ORY Oathkeeper not to do so. | [optional] |
+| **strip_path** | **String** | StripPath if set, replaces the provided path prefix when forwarding the requested URL to the upstream URL. | [optional] |
+| **url** | **String** | URL is the URL the request will be proxied to. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::Upstream.new(preserve_host: null,
-                                 strip_path: null,
-                                 url: null)
+instance = OryHydraClient::Upstream.new(
+  preserve_host: null,
+  strip_path: null,
+  url: null
+)
 ```
 
-

data/docs/Version.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**version** | **String** | Version is the service's version. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | Version is the service's version. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::Version.new(version: null)
+instance = OryHydraClient::Version.new(
+  version: null
+)
 ```
 
-

data/lib/ory-oathkeeper-client.rb

@@ -3,10 +3,10 @@
 
 #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.
 
-The version of the OpenAPI document: v0.38.4-beta.1
+The version of the OpenAPI document: v0.38.12-beta.1
 Contact: hi@ory.am
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -30,8 +30,6 @@ require 'ory-oathkeeper-client/models/version'
 
 # APIs
 require 'ory-oathkeeper-client/api/api_api'
-require 'ory-oathkeeper-client/api/health_api'
-require 'ory-oathkeeper-client/api/version_api'
 
 module OryHydraClient
   class << self

data/lib/ory-oathkeeper-client/api/api_api.rb

@@ -3,10 +3,10 @@
 
 #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.
 
-The version of the OpenAPI document: v0.38.4-beta.1
+The version of the OpenAPI document: v0.38.12-beta.1
 Contact: hi@ory.am
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -51,15 +51,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"ApiApi.decisions",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -113,15 +114,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'Rule' 
+      return_type = opts[:debug_return_type] || 'Rule'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"ApiApi.get_rule",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -137,6 +139,63 @@ module OryHydraClient
       return data, status_code, headers
     end
 
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @return [Version]
+    def get_version(opts = {})
+      data, _status_code, _headers = get_version_with_http_info(opts)
+      data
+    end
+
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Version, Integer, Hash)>] Version data, response status code and response headers
+    def get_version_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiApi.get_version ...'
+      end
+      # resource path
+      local_var_path = '/version'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Version'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ApiApi.get_version",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiApi#get_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Lists cryptographic keys
     # This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.
     # @param [Hash] opts the optional parameters
@@ -169,15 +228,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'JsonWebKeySet' 
+      return_type = opts[:debug_return_type] || 'JsonWebKeySet'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"ApiApi.get_well_known_json_web_keys",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -193,6 +253,120 @@ module OryHydraClient
       return data, status_code, headers
     end
 
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @return [HealthStatus]
+    def is_instance_alive(opts = {})
+      data, _status_code, _headers = is_instance_alive_with_http_info(opts)
+      data
+    end
+
+    # 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 &#x60;X-Forwarded-Proto&#x60; 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.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(HealthStatus, Integer, Hash)>] HealthStatus data, response status code and response headers
+    def is_instance_alive_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiApi.is_instance_alive ...'
+      end
+      # resource path
+      local_var_path = '/health/alive'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'HealthStatus'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ApiApi.is_instance_alive",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiApi#is_instance_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @return [HealthStatus]
+    def is_instance_ready(opts = {})
+      data, _status_code, _headers = is_instance_ready_with_http_info(opts)
+      data
+    end
+
+    # 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 &#x60;X-Forwarded-Proto&#x60; 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.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(HealthStatus, Integer, Hash)>] HealthStatus data, response status code and response headers
+    def is_instance_ready_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiApi.is_instance_ready ...'
+      end
+      # resource path
+      local_var_path = '/health/ready'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'HealthStatus'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ApiApi.is_instance_ready",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiApi#is_instance_ready\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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.
     # @param [Hash] opts the optional parameters
@@ -231,15 +405,16 @@ module OryHydraClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'Array<Rule>' 
+      return_type = opts[:debug_return_type] || 'Array<Rule>'
 
       # auth_names
-      auth_names = opts[:auth_names] || []
+      auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
+        :operation => :"ApiApi.list_rules",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,