ory-oathkeeper-client 0.38.5.beta1 → 0.38.9.beta1

data/docs/SwaggerCreateRuleParameters.md

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

data/docs/SwaggerGetRuleParameters.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | in: path | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | in: path |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerGetRuleParameters.new(id: null)
+instance = OryHydraClient::SwaggerGetRuleParameters.new(
+  id: null
+)
 ```
 
-

data/docs/SwaggerHealthStatus.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-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerHealthStatus.new(status: null)
+instance = OryHydraClient::SwaggerHealthStatus.new(
+  status: null
+)
 ```
 
-

data/docs/SwaggerJSONWebKey.md

@@ -2,48 +2,49 @@
 
 ## Properties
 
-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] 
-**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] 
-**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] 
-**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] 
+| 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] |
+| **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] |
+| **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] |
+| **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] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerJSONWebKey.new(alg: null,
-                                 crv: null,
-                                 d: null,
-                                 dp: null,
-                                 dq: null,
-                                 e: null,
-                                 k: null,
-                                 kid: null,
-                                 kty: null,
-                                 n: null,
-                                 p: null,
-                                 q: null,
-                                 qi: null,
-                                 use: null,
-                                 x: null,
-                                 x5c: null,
-                                 y: null)
+instance = OryHydraClient::SwaggerJSONWebKey.new(
+  alg: null,
+  crv: null,
+  d: null,
+  dp: null,
+  dq: null,
+  e: null,
+  k: null,
+  kid: null,
+  kty: null,
+  n: null,
+  p: null,
+  q: null,
+  qi: null,
+  use: null,
+  x: null,
+  x5c: null,
+  y: null
+)
 ```
 
-

data/docs/SwaggerJSONWebKeySet.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**keys** | [**Array<SwaggerJSONWebKey>**](SwaggerJSONWebKey.md) | The value of the \"keys\" parameter is an array of JWK values.  By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keys** | [**Array<SwaggerJSONWebKey>**](SwaggerJSONWebKey.md) | The value of the \"keys\" parameter is an array of JWK values.  By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerJSONWebKeySet.new(keys: null)
+instance = OryHydraClient::SwaggerJSONWebKeySet.new(
+  keys: null
+)
 ```
 
-

data/docs/SwaggerListRulesParameters.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**limit** | **Integer** | The maximum amount of rules returned. in: query | [optional] 
-**offset** | **Integer** | The offset from where to start looking. in: query | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | The maximum amount of rules returned. in: query | [optional] |
+| **offset** | **Integer** | The offset from where to start looking. in: query | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerListRulesParameters.new(limit: null,
-                                 offset: null)
+instance = OryHydraClient::SwaggerListRulesParameters.new(
+  limit: null,
+  offset: null
+)
 ```
 
-

data/docs/SwaggerNotReadyStatus.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-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerNotReadyStatus.new(errors: null)
+instance = OryHydraClient::SwaggerNotReadyStatus.new(
+  errors: null
+)
 ```
 
-

data/docs/SwaggerRule.md

@@ -2,28 +2,29 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**authenticators** | [**Array<SwaggerRuleHandler>**](SwaggerRuleHandler.md) | Authenticators is a list of authentication handlers that will try and authenticate the provided credentials. Authenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive result will be the one used.  If you want the rule to first check a specific authenticator  before \"falling back\" to others, have that authenticator as the first item in the array. | [optional] 
-**authorizer** | [**SwaggerRuleHandler**](SwaggerRuleHandler.md) |  | [optional] 
-**description** | **String** | Description is a human readable description of this rule. | [optional] 
-**id** | **String** | ID is the unique id of the rule. It can be at most 190 characters long, but the layout of the ID is up to you. You will need this ID later on to update or delete the rule. | [optional] 
-**match** | [**SwaggerRuleMatch**](SwaggerRuleMatch.md) |  | [optional] 
-**mutators** | [**Array<SwaggerRuleHandler>**](SwaggerRuleHandler.md) | Mutators is a list of mutation handlers that transform the HTTP request. A common use case is generating a new set of credentials (e.g. JWT) which then will be forwarded to the upstream server.  Mutations are performed iteratively from index 0 to n and should all succeed in order for the HTTP request to be forwarded. | [optional] 
-**upstream** | [**Upstream**](Upstream.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authenticators** | [**Array<SwaggerRuleHandler>**](SwaggerRuleHandler.md) | Authenticators is a list of authentication handlers that will try and authenticate the provided credentials. Authenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive result will be the one used.  If you want the rule to first check a specific authenticator  before \"falling back\" to others, have that authenticator as the first item in the array. | [optional] |
+| **authorizer** | [**SwaggerRuleHandler**](SwaggerRuleHandler.md) |  | [optional] |
+| **description** | **String** | Description is a human readable description of this rule. | [optional] |
+| **id** | **String** | ID is the unique id of the rule. It can be at most 190 characters long, but the layout of the ID is up to you. You will need this ID later on to update or delete the rule. | [optional] |
+| **match** | [**SwaggerRuleMatch**](SwaggerRuleMatch.md) |  | [optional] |
+| **mutators** | [**Array<SwaggerRuleHandler>**](SwaggerRuleHandler.md) | Mutators is a list of mutation handlers that transform the HTTP request. A common use case is generating a new set of credentials (e.g. JWT) which then will be forwarded to the upstream server.  Mutations are performed iteratively from index 0 to n and should all succeed in order for the HTTP request to be forwarded. | [optional] |
+| **upstream** | [**Upstream**](Upstream.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerRule.new(authenticators: null,
-                                 authorizer: null,
-                                 description: null,
-                                 id: null,
-                                 match: null,
-                                 mutators: null,
-                                 upstream: null)
+instance = OryHydraClient::SwaggerRule.new(
+  authenticators: null,
+  authorizer: null,
+  description: null,
+  id: null,
+  match: null,
+  mutators: null,
+  upstream: null
+)
 ```
 
-

data/docs/SwaggerRuleHandler.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**config** | [**Object**](.md) | Config contains the configuration for the handler. Please read the user guide for a complete list of each handler's available settings. | [optional] 
-**handler** | **String** | Handler identifies the implementation which will be used to handle this specific request. Please read the user guide for a complete list of available handlers. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | **Object** | Config contains the configuration for the handler. Please read the user guide for a complete list of each handler's available settings. | [optional] |
+| **handler** | **String** | Handler identifies the implementation which will be used to handle this specific request. Please read the user guide for a complete list of available handlers. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerRuleHandler.new(config: null,
-                                 handler: null)
+instance = OryHydraClient::SwaggerRuleHandler.new(
+  config: null,
+  handler: null
+)
 ```
 
-

data/docs/SwaggerRuleMatch.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**methods** | **Array<String>** | An array of HTTP methods (e.g. GET, POST, PUT, DELETE, ...). When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the HTTP method of the incoming request with the HTTP methods of each rules. If a match is found, the rule is considered a partial match. If the matchesUrl field is satisfied as well, the rule is considered a full match. | [optional] 
-**url** | **String** | This field represents the URL pattern this rule matches. When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the full request URL (e.g. https://mydomain.com/api/resource) without query parameters of the incoming request with this field. If a match is found, the rule is considered a partial match. If the matchesMethods field is satisfied as well, the rule is considered a full match.  You can use regular expressions in this field to match more than one url. Regular expressions are encapsulated in brackets < and >. The following example matches all paths of the domain `mydomain.com`: `https://mydomain.com/<.*>`. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **methods** | **Array<String>** | An array of HTTP methods (e.g. GET, POST, PUT, DELETE, ...). When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the HTTP method of the incoming request with the HTTP methods of each rules. If a match is found, the rule is considered a partial match. If the matchesUrl field is satisfied as well, the rule is considered a full match. | [optional] |
+| **url** | **String** | This field represents the URL pattern this rule matches. When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the full request URL (e.g. https://mydomain.com/api/resource) without query parameters of the incoming request with this field. If a match is found, the rule is considered a partial match. If the matchesMethods field is satisfied as well, the rule is considered a full match.  You can use regular expressions in this field to match more than one url. Regular expressions are encapsulated in brackets < and >. The following example matches all paths of the domain `mydomain.com`: `https://mydomain.com/<.*>`. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerRuleMatch.new(methods: null,
-                                 url: null)
+instance = OryHydraClient::SwaggerRuleMatch.new(
+  methods: null,
+  url: null
+)
 ```
 
-

data/docs/SwaggerRuleResponse.md

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

data/docs/SwaggerRulesResponse.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**body** | [**Array<SwaggerRule>**](SwaggerRule.md) | in: body type: array | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**Array<SwaggerRule>**](SwaggerRule.md) | in: body type: array | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerRulesResponse.new(body: null)
+instance = OryHydraClient::SwaggerRulesResponse.new(
+  body: null
+)
 ```
 
-

data/docs/SwaggerUpdateRuleParameters.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**body** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] 
-**id** | **String** | in: path | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] |
+| **id** | **String** | in: path |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::SwaggerUpdateRuleParameters.new(body: null,
-                                 id: null)
+instance = OryHydraClient::SwaggerUpdateRuleParameters.new(
+  body: null,
+  id: null
+)
 ```
 
-

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
+)
 ```
 
-