ory-oathkeeper-client 0.38.5.beta1 → 0.38.9.beta1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/docs/ApiApi.md +106 -37
- data/docs/CreateRuleCreated.md +8 -7
- data/docs/CreateRuleForbidden.md +8 -7
- data/docs/CreateRuleForbiddenBody.md +18 -17
- data/docs/CreateRuleInternalServerError.md +8 -7
- data/docs/CreateRuleInternalServerErrorBody.md +18 -17
- data/docs/CreateRuleUnauthorized.md +8 -7
- data/docs/CreateRuleUnauthorizedBody.md +18 -17
- data/docs/DecisionsForbidden.md +8 -7
- data/docs/DecisionsForbiddenBody.md +18 -17
- data/docs/DecisionsInternalServerError.md +8 -7
- data/docs/DecisionsInternalServerErrorBody.md +18 -17
- data/docs/DecisionsNotFound.md +8 -7
- data/docs/DecisionsNotFoundBody.md +18 -17
- data/docs/DecisionsUnauthorized.md +8 -7
- data/docs/DecisionsUnauthorizedBody.md +18 -17
- data/docs/DeleteRuleForbidden.md +8 -7
- data/docs/DeleteRuleForbiddenBody.md +18 -17
- data/docs/DeleteRuleInternalServerError.md +8 -7
- data/docs/DeleteRuleInternalServerErrorBody.md +18 -17
- data/docs/DeleteRuleNotFound.md +8 -7
- data/docs/DeleteRuleNotFoundBody.md +18 -17
- data/docs/DeleteRuleUnauthorized.md +8 -7
- data/docs/DeleteRuleUnauthorizedBody.md +18 -17
- data/docs/GetRuleForbidden.md +8 -7
- data/docs/GetRuleForbiddenBody.md +18 -17
- data/docs/GetRuleInternalServerError.md +8 -7
- data/docs/GetRuleInternalServerErrorBody.md +18 -17
- data/docs/GetRuleNotFound.md +8 -7
- data/docs/GetRuleNotFoundBody.md +18 -17
- data/docs/GetRuleOK.md +8 -7
- data/docs/GetRuleUnauthorized.md +8 -7
- data/docs/GetRuleUnauthorizedBody.md +18 -17
- data/docs/GetWellKnownForbidden.md +8 -7
- data/docs/GetWellKnownForbiddenBody.md +18 -17
- data/docs/GetWellKnownJSONWebKeysInternalServerError.md +8 -7
- data/docs/GetWellKnownJSONWebKeysInternalServerErrorBody.md +18 -17
- data/docs/GetWellKnownJSONWebKeysOK.md +8 -7
- data/docs/GetWellKnownOK.md +8 -7
- data/docs/GetWellKnownUnauthorized.md +8 -7
- data/docs/GetWellKnownUnauthorizedBody.md +18 -17
- data/docs/HealthApi.md +50 -15
- data/docs/HealthNotReadyStatus.md +8 -7
- data/docs/HealthStatus.md +8 -7
- data/docs/InlineResponse500.md +18 -17
- data/docs/IsInstanceAliveInternalServerError.md +8 -7
- data/docs/IsInstanceAliveInternalServerErrorBody.md +18 -17
- data/docs/IsInstanceAliveOK.md +8 -7
- data/docs/JsonWebKey.md +40 -39
- data/docs/JsonWebKeySet.md +8 -7
- data/docs/JudgeForbidden.md +8 -7
- data/docs/JudgeForbiddenBody.md +18 -17
- data/docs/JudgeInternalServerError.md +8 -7
- data/docs/JudgeInternalServerErrorBody.md +18 -17
- data/docs/JudgeNotFound.md +8 -7
- data/docs/JudgeNotFoundBody.md +18 -17
- data/docs/JudgeUnauthorized.md +8 -7
- data/docs/JudgeUnauthorizedBody.md +18 -17
- data/docs/ListRulesForbidden.md +8 -7
- data/docs/ListRulesForbiddenBody.md +18 -17
- data/docs/ListRulesInternalServerError.md +8 -7
- data/docs/ListRulesInternalServerErrorBody.md +18 -17
- data/docs/ListRulesOK.md +8 -7
- data/docs/ListRulesUnauthorized.md +8 -7
- data/docs/ListRulesUnauthorizedBody.md +18 -17
- data/docs/Rule.md +20 -19
- data/docs/RuleHandler.md +10 -9
- data/docs/RuleMatch.md +10 -9
- data/docs/SwaggerCreateRuleParameters.md +8 -7
- data/docs/SwaggerGetRuleParameters.md +8 -7
- data/docs/SwaggerHealthStatus.md +8 -7
- data/docs/SwaggerJSONWebKey.md +40 -39
- data/docs/SwaggerJSONWebKeySet.md +8 -7
- data/docs/SwaggerListRulesParameters.md +10 -9
- data/docs/SwaggerNotReadyStatus.md +8 -7
- data/docs/SwaggerRule.md +20 -19
- data/docs/SwaggerRuleHandler.md +10 -9
- data/docs/SwaggerRuleMatch.md +10 -9
- data/docs/SwaggerRuleResponse.md +8 -7
- data/docs/SwaggerRulesResponse.md +8 -7
- data/docs/SwaggerUpdateRuleParameters.md +10 -9
- data/docs/SwaggerVersion.md +8 -7
- data/docs/UpdateRuleForbidden.md +8 -7
- data/docs/UpdateRuleForbiddenBody.md +18 -17
- data/docs/UpdateRuleInternalServerError.md +8 -7
- data/docs/UpdateRuleInternalServerErrorBody.md +18 -17
- data/docs/UpdateRuleNotFound.md +8 -7
- data/docs/UpdateRuleNotFoundBody.md +18 -17
- data/docs/UpdateRuleOK.md +8 -7
- data/docs/UpdateRuleUnauthorized.md +8 -7
- data/docs/UpdateRuleUnauthorizedBody.md +18 -17
- data/docs/Upstream.md +12 -11
- data/docs/Version.md +8 -7
- data/docs/VersionApi.md +26 -9
- data/lib/ory-oathkeeper-client.rb +2 -2
- data/lib/ory-oathkeeper-client/api/api_api.rb +18 -14
- data/lib/ory-oathkeeper-client/api/health_api.rb +10 -8
- data/lib/ory-oathkeeper-client/api/version_api.rb +6 -5
- data/lib/ory-oathkeeper-client/api_client.rb +50 -48
- data/lib/ory-oathkeeper-client/api_error.rb +2 -2
- data/lib/ory-oathkeeper-client/configuration.rb +34 -7
- data/lib/ory-oathkeeper-client/models/create_rule_created.rb +20 -8
- data/lib/ory-oathkeeper-client/models/create_rule_forbidden.rb +20 -8
- data/lib/ory-oathkeeper-client/models/create_rule_forbidden_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/create_rule_internal_server_error.rb +20 -8
- data/lib/ory-oathkeeper-client/models/create_rule_internal_server_error_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/create_rule_unauthorized.rb +20 -8
- data/lib/ory-oathkeeper-client/models/create_rule_unauthorized_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/decisions_forbidden.rb +20 -8
- data/lib/ory-oathkeeper-client/models/decisions_forbidden_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/decisions_internal_server_error.rb +20 -8
- data/lib/ory-oathkeeper-client/models/decisions_internal_server_error_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/decisions_not_found.rb +20 -8
- data/lib/ory-oathkeeper-client/models/decisions_not_found_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/decisions_unauthorized.rb +20 -8
- data/lib/ory-oathkeeper-client/models/decisions_unauthorized_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/delete_rule_forbidden.rb +20 -8
- data/lib/ory-oathkeeper-client/models/delete_rule_forbidden_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/delete_rule_internal_server_error.rb +20 -8
- data/lib/ory-oathkeeper-client/models/delete_rule_internal_server_error_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/delete_rule_not_found.rb +20 -8
- data/lib/ory-oathkeeper-client/models/delete_rule_not_found_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/delete_rule_unauthorized.rb +20 -8
- data/lib/ory-oathkeeper-client/models/delete_rule_unauthorized_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/get_rule_forbidden.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_rule_forbidden_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/get_rule_internal_server_error.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_rule_internal_server_error_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/get_rule_not_found.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_rule_not_found_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/get_rule_ok.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_rule_unauthorized.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_rule_unauthorized_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/get_well_known_forbidden.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_well_known_forbidden_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/get_well_known_json_web_keys_internal_server_error.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_well_known_json_web_keys_internal_server_error_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/get_well_known_json_web_keys_ok.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_well_known_ok.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_well_known_unauthorized.rb +20 -8
- data/lib/ory-oathkeeper-client/models/get_well_known_unauthorized_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/health_not_ready_status.rb +20 -8
- data/lib/ory-oathkeeper-client/models/health_status.rb +20 -8
- data/lib/ory-oathkeeper-client/models/inline_response500.rb +20 -8
- data/lib/ory-oathkeeper-client/models/is_instance_alive_internal_server_error.rb +20 -8
- data/lib/ory-oathkeeper-client/models/is_instance_alive_internal_server_error_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/is_instance_alive_ok.rb +20 -8
- data/lib/ory-oathkeeper-client/models/json_web_key.rb +20 -8
- data/lib/ory-oathkeeper-client/models/json_web_key_set.rb +20 -8
- data/lib/ory-oathkeeper-client/models/judge_forbidden.rb +20 -8
- data/lib/ory-oathkeeper-client/models/judge_forbidden_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/judge_internal_server_error.rb +20 -8
- data/lib/ory-oathkeeper-client/models/judge_internal_server_error_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/judge_not_found.rb +20 -8
- data/lib/ory-oathkeeper-client/models/judge_not_found_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/judge_unauthorized.rb +20 -8
- data/lib/ory-oathkeeper-client/models/judge_unauthorized_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/list_rules_forbidden.rb +20 -8
- data/lib/ory-oathkeeper-client/models/list_rules_forbidden_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/list_rules_internal_server_error.rb +20 -8
- data/lib/ory-oathkeeper-client/models/list_rules_internal_server_error_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/list_rules_ok.rb +20 -8
- data/lib/ory-oathkeeper-client/models/list_rules_unauthorized.rb +20 -8
- data/lib/ory-oathkeeper-client/models/list_rules_unauthorized_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/rule.rb +20 -8
- data/lib/ory-oathkeeper-client/models/rule_handler.rb +20 -8
- data/lib/ory-oathkeeper-client/models/rule_match.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_create_rule_parameters.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_get_rule_parameters.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_health_status.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_json_web_key.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_json_web_key_set.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_list_rules_parameters.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_not_ready_status.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_rule.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_rule_handler.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_rule_match.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_rule_response.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_rules_response.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_update_rule_parameters.rb +20 -8
- data/lib/ory-oathkeeper-client/models/swagger_version.rb +20 -8
- data/lib/ory-oathkeeper-client/models/update_rule_forbidden.rb +20 -8
- data/lib/ory-oathkeeper-client/models/update_rule_forbidden_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/update_rule_internal_server_error.rb +20 -8
- data/lib/ory-oathkeeper-client/models/update_rule_internal_server_error_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/update_rule_not_found.rb +20 -8
- data/lib/ory-oathkeeper-client/models/update_rule_not_found_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/update_rule_ok.rb +20 -8
- data/lib/ory-oathkeeper-client/models/update_rule_unauthorized.rb +20 -8
- data/lib/ory-oathkeeper-client/models/update_rule_unauthorized_body.rb +21 -9
- data/lib/ory-oathkeeper-client/models/upstream.rb +20 -8
- data/lib/ory-oathkeeper-client/models/version.rb +20 -8
- data/lib/ory-oathkeeper-client/version.rb +3 -3
- data/ory-oathkeeper-client.gemspec +4 -5
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +81 -101
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**code** | **Integer** | code | [optional]
|
8
|
-
**details** | **Array<
|
9
|
-
**message** | **String** | message | [optional]
|
10
|
-
**reason** | **String** | reason | [optional]
|
11
|
-
**request** | **String** | request | [optional]
|
12
|
-
**status** | **String** | status | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **Integer** | code | [optional] |
|
8
|
+
| **details** | **Array<Object>** | details | [optional] |
|
9
|
+
| **message** | **String** | message | [optional] |
|
10
|
+
| **reason** | **String** | reason | [optional] |
|
11
|
+
| **request** | **String** | request | [optional] |
|
12
|
+
| **status** | **String** | status | [optional] |
|
13
13
|
|
14
|
-
##
|
14
|
+
## Example
|
15
15
|
|
16
16
|
```ruby
|
17
|
-
require '
|
17
|
+
require 'ory-oathkeeper-client'
|
18
18
|
|
19
|
-
instance = OryHydraClient::GetRuleUnauthorizedBody.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
19
|
+
instance = OryHydraClient::GetRuleUnauthorizedBody.new(
|
20
|
+
code: null,
|
21
|
+
details: null,
|
22
|
+
message: null,
|
23
|
+
reason: null,
|
24
|
+
request: null,
|
25
|
+
status: null
|
26
|
+
)
|
25
27
|
```
|
26
28
|
|
27
|
-
|
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**payload** | [**GetWellKnownForbiddenBody**](GetWellKnownForbiddenBody.md) | | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **payload** | [**GetWellKnownForbiddenBody**](GetWellKnownForbiddenBody.md) | | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'ory-oathkeeper-client'
|
13
13
|
|
14
|
-
instance = OryHydraClient::GetWellKnownForbidden.new(
|
14
|
+
instance = OryHydraClient::GetWellKnownForbidden.new(
|
15
|
+
payload: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**code** | **Integer** | code | [optional]
|
8
|
-
**details** | **Array<
|
9
|
-
**message** | **String** | message | [optional]
|
10
|
-
**reason** | **String** | reason | [optional]
|
11
|
-
**request** | **String** | request | [optional]
|
12
|
-
**status** | **String** | status | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **Integer** | code | [optional] |
|
8
|
+
| **details** | **Array<Object>** | details | [optional] |
|
9
|
+
| **message** | **String** | message | [optional] |
|
10
|
+
| **reason** | **String** | reason | [optional] |
|
11
|
+
| **request** | **String** | request | [optional] |
|
12
|
+
| **status** | **String** | status | [optional] |
|
13
13
|
|
14
|
-
##
|
14
|
+
## Example
|
15
15
|
|
16
16
|
```ruby
|
17
|
-
require '
|
17
|
+
require 'ory-oathkeeper-client'
|
18
18
|
|
19
|
-
instance = OryHydraClient::GetWellKnownForbiddenBody.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
19
|
+
instance = OryHydraClient::GetWellKnownForbiddenBody.new(
|
20
|
+
code: null,
|
21
|
+
details: null,
|
22
|
+
message: null,
|
23
|
+
reason: null,
|
24
|
+
request: null,
|
25
|
+
status: null
|
26
|
+
)
|
25
27
|
```
|
26
28
|
|
27
|
-
|
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**payload** | [**GetWellKnownJSONWebKeysInternalServerErrorBody**](GetWellKnownJSONWebKeysInternalServerErrorBody.md) | | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **payload** | [**GetWellKnownJSONWebKeysInternalServerErrorBody**](GetWellKnownJSONWebKeysInternalServerErrorBody.md) | | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'ory-oathkeeper-client'
|
13
13
|
|
14
|
-
instance = OryHydraClient::GetWellKnownJSONWebKeysInternalServerError.new(
|
14
|
+
instance = OryHydraClient::GetWellKnownJSONWebKeysInternalServerError.new(
|
15
|
+
payload: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**code** | **Integer** | code | [optional]
|
8
|
-
**details** | **Array<
|
9
|
-
**message** | **String** | message | [optional]
|
10
|
-
**reason** | **String** | reason | [optional]
|
11
|
-
**request** | **String** | request | [optional]
|
12
|
-
**status** | **String** | status | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **Integer** | code | [optional] |
|
8
|
+
| **details** | **Array<Object>** | details | [optional] |
|
9
|
+
| **message** | **String** | message | [optional] |
|
10
|
+
| **reason** | **String** | reason | [optional] |
|
11
|
+
| **request** | **String** | request | [optional] |
|
12
|
+
| **status** | **String** | status | [optional] |
|
13
13
|
|
14
|
-
##
|
14
|
+
## Example
|
15
15
|
|
16
16
|
```ruby
|
17
|
-
require '
|
17
|
+
require 'ory-oathkeeper-client'
|
18
18
|
|
19
|
-
instance = OryHydraClient::GetWellKnownJSONWebKeysInternalServerErrorBody.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
19
|
+
instance = OryHydraClient::GetWellKnownJSONWebKeysInternalServerErrorBody.new(
|
20
|
+
code: null,
|
21
|
+
details: null,
|
22
|
+
message: null,
|
23
|
+
reason: null,
|
24
|
+
request: null,
|
25
|
+
status: null
|
26
|
+
)
|
25
27
|
```
|
26
28
|
|
27
|
-
|
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**payload** | [**SwaggerJSONWebKeySet**](SwaggerJSONWebKeySet.md) | | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **payload** | [**SwaggerJSONWebKeySet**](SwaggerJSONWebKeySet.md) | | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'ory-oathkeeper-client'
|
13
13
|
|
14
|
-
instance = OryHydraClient::GetWellKnownJSONWebKeysOK.new(
|
14
|
+
instance = OryHydraClient::GetWellKnownJSONWebKeysOK.new(
|
15
|
+
payload: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
data/docs/GetWellKnownOK.md
CHANGED
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**payload** | [**SwaggerJSONWebKeySet**](SwaggerJSONWebKeySet.md) | | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **payload** | [**SwaggerJSONWebKeySet**](SwaggerJSONWebKeySet.md) | | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'ory-oathkeeper-client'
|
13
13
|
|
14
|
-
instance = OryHydraClient::GetWellKnownOK.new(
|
14
|
+
instance = OryHydraClient::GetWellKnownOK.new(
|
15
|
+
payload: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**payload** | [**GetWellKnownUnauthorizedBody**](GetWellKnownUnauthorizedBody.md) | | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **payload** | [**GetWellKnownUnauthorizedBody**](GetWellKnownUnauthorizedBody.md) | | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'ory-oathkeeper-client'
|
13
13
|
|
14
|
-
instance = OryHydraClient::GetWellKnownUnauthorized.new(
|
14
|
+
instance = OryHydraClient::GetWellKnownUnauthorized.new(
|
15
|
+
payload: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**code** | **Integer** | code | [optional]
|
8
|
-
**details** | **Array<
|
9
|
-
**message** | **String** | message | [optional]
|
10
|
-
**reason** | **String** | reason | [optional]
|
11
|
-
**request** | **String** | request | [optional]
|
12
|
-
**status** | **String** | status | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **Integer** | code | [optional] |
|
8
|
+
| **details** | **Array<Object>** | details | [optional] |
|
9
|
+
| **message** | **String** | message | [optional] |
|
10
|
+
| **reason** | **String** | reason | [optional] |
|
11
|
+
| **request** | **String** | request | [optional] |
|
12
|
+
| **status** | **String** | status | [optional] |
|
13
13
|
|
14
|
-
##
|
14
|
+
## Example
|
15
15
|
|
16
16
|
```ruby
|
17
|
-
require '
|
17
|
+
require 'ory-oathkeeper-client'
|
18
18
|
|
19
|
-
instance = OryHydraClient::GetWellKnownUnauthorizedBody.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
19
|
+
instance = OryHydraClient::GetWellKnownUnauthorizedBody.new(
|
20
|
+
code: null,
|
21
|
+
details: null,
|
22
|
+
message: null,
|
23
|
+
reason: null,
|
24
|
+
request: null,
|
25
|
+
status: null
|
26
|
+
)
|
25
27
|
```
|
26
28
|
|
27
|
-
|
data/docs/HealthApi.md
CHANGED
@@ -2,35 +2,52 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**is_instance_alive**](HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
|
8
|
-
[**is_instance_ready**](HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
|
9
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**is_instance_alive**](HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status |
|
8
|
+
| [**is_instance_ready**](HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status |
|
10
9
|
|
11
10
|
|
12
11
|
## is_instance_alive
|
13
12
|
|
14
|
-
> HealthStatus is_instance_alive
|
13
|
+
> <HealthStatus> is_instance_alive
|
15
14
|
|
16
15
|
Check alive status
|
17
16
|
|
18
17
|
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.
|
19
18
|
|
20
|
-
###
|
19
|
+
### Examples
|
21
20
|
|
22
21
|
```ruby
|
23
|
-
|
22
|
+
require 'time'
|
24
23
|
require 'ory-oathkeeper-client'
|
25
24
|
|
26
25
|
api_instance = OryHydraClient::HealthApi.new
|
27
26
|
|
28
27
|
begin
|
29
|
-
#Check alive status
|
28
|
+
# Check alive status
|
30
29
|
result = api_instance.is_instance_alive
|
31
30
|
p result
|
32
31
|
rescue OryHydraClient::ApiError => e
|
33
|
-
puts "
|
32
|
+
puts "Error when calling HealthApi->is_instance_alive: #{e}"
|
33
|
+
end
|
34
|
+
```
|
35
|
+
|
36
|
+
#### Using the is_instance_alive_with_http_info variant
|
37
|
+
|
38
|
+
This returns an Array which contains the response data, status code and headers.
|
39
|
+
|
40
|
+
> <Array(<HealthStatus>, Integer, Hash)> is_instance_alive_with_http_info
|
41
|
+
|
42
|
+
```ruby
|
43
|
+
begin
|
44
|
+
# Check alive status
|
45
|
+
data, status_code, headers = api_instance.is_instance_alive_with_http_info
|
46
|
+
p status_code # => 2xx
|
47
|
+
p headers # => { ... }
|
48
|
+
p data # => <HealthStatus>
|
49
|
+
rescue OryHydraClient::ApiError => e
|
50
|
+
puts "Error when calling HealthApi->is_instance_alive_with_http_info: #{e}"
|
34
51
|
end
|
35
52
|
```
|
36
53
|
|
@@ -54,26 +71,44 @@ No authorization required
|
|
54
71
|
|
55
72
|
## is_instance_ready
|
56
73
|
|
57
|
-
> HealthStatus is_instance_ready
|
74
|
+
> <HealthStatus> is_instance_ready
|
58
75
|
|
59
76
|
Check readiness status
|
60
77
|
|
61
78
|
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.
|
62
79
|
|
63
|
-
###
|
80
|
+
### Examples
|
64
81
|
|
65
82
|
```ruby
|
66
|
-
|
83
|
+
require 'time'
|
67
84
|
require 'ory-oathkeeper-client'
|
68
85
|
|
69
86
|
api_instance = OryHydraClient::HealthApi.new
|
70
87
|
|
71
88
|
begin
|
72
|
-
#Check readiness status
|
89
|
+
# Check readiness status
|
73
90
|
result = api_instance.is_instance_ready
|
74
91
|
p result
|
75
92
|
rescue OryHydraClient::ApiError => e
|
76
|
-
puts "
|
93
|
+
puts "Error when calling HealthApi->is_instance_ready: #{e}"
|
94
|
+
end
|
95
|
+
```
|
96
|
+
|
97
|
+
#### Using the is_instance_ready_with_http_info variant
|
98
|
+
|
99
|
+
This returns an Array which contains the response data, status code and headers.
|
100
|
+
|
101
|
+
> <Array(<HealthStatus>, Integer, Hash)> is_instance_ready_with_http_info
|
102
|
+
|
103
|
+
```ruby
|
104
|
+
begin
|
105
|
+
# Check readiness status
|
106
|
+
data, status_code, headers = api_instance.is_instance_ready_with_http_info
|
107
|
+
p status_code # => 2xx
|
108
|
+
p headers # => { ... }
|
109
|
+
p data # => <HealthStatus>
|
110
|
+
rescue OryHydraClient::ApiError => e
|
111
|
+
puts "Error when calling HealthApi->is_instance_ready_with_http_info: #{e}"
|
77
112
|
end
|
78
113
|
```
|
79
114
|
|
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'ory-oathkeeper-client'
|
13
13
|
|
14
|
-
instance = OryHydraClient::HealthNotReadyStatus.new(
|
14
|
+
instance = OryHydraClient::HealthNotReadyStatus.new(
|
15
|
+
errors: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|