ory-oathkeeper-client 0.38.9.beta1 → 0.38.10.beta2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f55377676e044a41f1496f05f58335497dbb14f7aba78e374400cab081323b5c
4
- data.tar.gz: 3162661e0ecfcf1601f6f4f7f7ac5ce9abbe1534c89e532696392f07e96cc69b
3
+ metadata.gz: 55753e98ae037e333774419908ccf2290a8d1a27f8641cb3c7d6f9e87a9491e5
4
+ data.tar.gz: 101a5b637f036b61e272d826a24e53c8c2f25b052a9d13c5bcaaf9f12db31c90
5
5
  SHA512:
6
- metadata.gz: 7324011eb52ec71c144d1e58ee4226cc0f57f343c863d6a8b154598cb29dd7c671584dd31f70a0eec9d2bee4fd4d8ec51ac7814a614c8729f1c3efa07ec6356b
7
- data.tar.gz: bc0dc287f563a49f7e47f72224ca9c33cd8d95162c9903e10ce5826023b4c356d284b8f50a27e998d717e8a8d599b22c9a0bd7620f0f4fb71624d43ac5cd7926
6
+ metadata.gz: 8b93790aacd2a888528cda19beb876c3d60df39b333f8ea0b48f0fcdccc1b5a0dc4d7a711680e83972ea7be2927be3ef930786522049ab02e71902ac293191c9
7
+ data.tar.gz: e65b0b7901cc42d934147ccba537eb31047a605af22425d1f8f602a7975a3f91bc5e92803a3a798644ca580908951fee56cb514b27e915b6329ae5f2a0f20488
data/README.md CHANGED
@@ -6,8 +6,8 @@ ORY Oathkeeper is a reverse proxy that checks the HTTP Authorization for validit
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
- - API version: v0.38.9-beta.1
10
- - Package version: v0.38.9-beta.1
9
+ - API version: v0.38.10-beta.2
10
+ - Package version: v0.38.10-beta.2
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://www.ory.am](https://www.ory.am)
13
13
 
@@ -24,16 +24,16 @@ gem build ory-oathkeeper-client.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ory-oathkeeper-client-v0.38.9-beta.1.gem
27
+ gem install ./ory-oathkeeper-client-v0.38.10-beta.2.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ory-oathkeeper-client-v0.38.9-beta.1.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ory-oathkeeper-client-v0.38.10-beta.2.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'ory-oathkeeper-client', '~> v0.38.9-beta.1'
36
+ gem 'ory-oathkeeper-client', '~> v0.38.10-beta.2'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -76,11 +76,11 @@ Class | Method | HTTP request | Description
76
76
  ------------ | ------------- | ------------- | -------------
77
77
  *OryHydraClient::ApiApi* | [**decisions**](docs/ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
78
78
  *OryHydraClient::ApiApi* | [**get_rule**](docs/ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
79
+ *OryHydraClient::ApiApi* | [**get_version**](docs/ApiApi.md#get_version) | **GET** /version | Get service version
79
80
  *OryHydraClient::ApiApi* | [**get_well_known_json_web_keys**](docs/ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
81
+ *OryHydraClient::ApiApi* | [**is_instance_alive**](docs/ApiApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
82
+ *OryHydraClient::ApiApi* | [**is_instance_ready**](docs/ApiApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
80
83
  *OryHydraClient::ApiApi* | [**list_rules**](docs/ApiApi.md#list_rules) | **GET** /rules | List all rules
81
- *OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
82
- *OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
83
- *OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
84
84
 
85
85
 
86
86
  ## Documentation for Models
data/docs/ApiApi.md CHANGED
@@ -6,7 +6,10 @@ All URIs are relative to *http://localhost*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**decisions**](ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API |
8
8
  | [**get_rule**](ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule |
9
+ | [**get_version**](ApiApi.md#get_version) | **GET** /version | Get service version |
9
10
  | [**get_well_known_json_web_keys**](ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys |
11
+ | [**is_instance_alive**](ApiApi.md#is_instance_alive) | **GET** /health/alive | Check alive status |
12
+ | [**is_instance_ready**](ApiApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status |
10
13
  | [**list_rules**](ApiApi.md#list_rules) | **GET** /rules | List all rules |
11
14
 
12
15
 
@@ -134,6 +137,67 @@ No authorization required
134
137
  - **Accept**: application/json
135
138
 
136
139
 
140
+ ## get_version
141
+
142
+ > <Version> get_version
143
+
144
+ Get service version
145
+
146
+ 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.
147
+
148
+ ### Examples
149
+
150
+ ```ruby
151
+ require 'time'
152
+ require 'ory-oathkeeper-client'
153
+
154
+ api_instance = OryHydraClient::ApiApi.new
155
+
156
+ begin
157
+ # Get service version
158
+ result = api_instance.get_version
159
+ p result
160
+ rescue OryHydraClient::ApiError => e
161
+ puts "Error when calling ApiApi->get_version: #{e}"
162
+ end
163
+ ```
164
+
165
+ #### Using the get_version_with_http_info variant
166
+
167
+ This returns an Array which contains the response data, status code and headers.
168
+
169
+ > <Array(<Version>, Integer, Hash)> get_version_with_http_info
170
+
171
+ ```ruby
172
+ begin
173
+ # Get service version
174
+ data, status_code, headers = api_instance.get_version_with_http_info
175
+ p status_code # => 2xx
176
+ p headers # => { ... }
177
+ p data # => <Version>
178
+ rescue OryHydraClient::ApiError => e
179
+ puts "Error when calling ApiApi->get_version_with_http_info: #{e}"
180
+ end
181
+ ```
182
+
183
+ ### Parameters
184
+
185
+ This endpoint does not need any parameter.
186
+
187
+ ### Return type
188
+
189
+ [**Version**](Version.md)
190
+
191
+ ### Authorization
192
+
193
+ No authorization required
194
+
195
+ ### HTTP request headers
196
+
197
+ - **Content-Type**: Not defined
198
+ - **Accept**: application/json
199
+
200
+
137
201
  ## get_well_known_json_web_keys
138
202
 
139
203
  > <JsonWebKeySet> get_well_known_json_web_keys
@@ -195,6 +259,128 @@ No authorization required
195
259
  - **Accept**: application/json
196
260
 
197
261
 
262
+ ## is_instance_alive
263
+
264
+ > <HealthStatus> is_instance_alive
265
+
266
+ Check alive status
267
+
268
+ 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.
269
+
270
+ ### Examples
271
+
272
+ ```ruby
273
+ require 'time'
274
+ require 'ory-oathkeeper-client'
275
+
276
+ api_instance = OryHydraClient::ApiApi.new
277
+
278
+ begin
279
+ # Check alive status
280
+ result = api_instance.is_instance_alive
281
+ p result
282
+ rescue OryHydraClient::ApiError => e
283
+ puts "Error when calling ApiApi->is_instance_alive: #{e}"
284
+ end
285
+ ```
286
+
287
+ #### Using the is_instance_alive_with_http_info variant
288
+
289
+ This returns an Array which contains the response data, status code and headers.
290
+
291
+ > <Array(<HealthStatus>, Integer, Hash)> is_instance_alive_with_http_info
292
+
293
+ ```ruby
294
+ begin
295
+ # Check alive status
296
+ data, status_code, headers = api_instance.is_instance_alive_with_http_info
297
+ p status_code # => 2xx
298
+ p headers # => { ... }
299
+ p data # => <HealthStatus>
300
+ rescue OryHydraClient::ApiError => e
301
+ puts "Error when calling ApiApi->is_instance_alive_with_http_info: #{e}"
302
+ end
303
+ ```
304
+
305
+ ### Parameters
306
+
307
+ This endpoint does not need any parameter.
308
+
309
+ ### Return type
310
+
311
+ [**HealthStatus**](HealthStatus.md)
312
+
313
+ ### Authorization
314
+
315
+ No authorization required
316
+
317
+ ### HTTP request headers
318
+
319
+ - **Content-Type**: Not defined
320
+ - **Accept**: application/json
321
+
322
+
323
+ ## is_instance_ready
324
+
325
+ > <HealthStatus> is_instance_ready
326
+
327
+ Check readiness status
328
+
329
+ 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.
330
+
331
+ ### Examples
332
+
333
+ ```ruby
334
+ require 'time'
335
+ require 'ory-oathkeeper-client'
336
+
337
+ api_instance = OryHydraClient::ApiApi.new
338
+
339
+ begin
340
+ # Check readiness status
341
+ result = api_instance.is_instance_ready
342
+ p result
343
+ rescue OryHydraClient::ApiError => e
344
+ puts "Error when calling ApiApi->is_instance_ready: #{e}"
345
+ end
346
+ ```
347
+
348
+ #### Using the is_instance_ready_with_http_info variant
349
+
350
+ This returns an Array which contains the response data, status code and headers.
351
+
352
+ > <Array(<HealthStatus>, Integer, Hash)> is_instance_ready_with_http_info
353
+
354
+ ```ruby
355
+ begin
356
+ # Check readiness status
357
+ data, status_code, headers = api_instance.is_instance_ready_with_http_info
358
+ p status_code # => 2xx
359
+ p headers # => { ... }
360
+ p data # => <HealthStatus>
361
+ rescue OryHydraClient::ApiError => e
362
+ puts "Error when calling ApiApi->is_instance_ready_with_http_info: #{e}"
363
+ end
364
+ ```
365
+
366
+ ### Parameters
367
+
368
+ This endpoint does not need any parameter.
369
+
370
+ ### Return type
371
+
372
+ [**HealthStatus**](HealthStatus.md)
373
+
374
+ ### Authorization
375
+
376
+ No authorization required
377
+
378
+ ### HTTP request headers
379
+
380
+ - **Content-Type**: Not defined
381
+ - **Accept**: application/json
382
+
383
+
198
384
  ## list_rules
199
385
 
200
386
  > <Array<Rule>> list_rules(opts)
data/docs/HealthApi.md CHANGED
@@ -2,52 +2,35 @@
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 |
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
+
9
10
 
10
11
 
11
12
  ## is_instance_alive
12
13
 
13
- > <HealthStatus> is_instance_alive
14
+ > HealthStatus is_instance_alive
14
15
 
15
16
  Check alive status
16
17
 
17
18
  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.
18
19
 
19
- ### Examples
20
+ ### Example
20
21
 
21
22
  ```ruby
22
- require 'time'
23
+ # load the gem
23
24
  require 'ory-oathkeeper-client'
24
25
 
25
26
  api_instance = OryHydraClient::HealthApi.new
26
27
 
27
28
  begin
28
- # Check alive status
29
+ #Check alive status
29
30
  result = api_instance.is_instance_alive
30
31
  p result
31
32
  rescue OryHydraClient::ApiError => e
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}"
33
+ puts "Exception when calling HealthApi->is_instance_alive: #{e}"
51
34
  end
52
35
  ```
53
36
 
@@ -71,44 +54,26 @@ No authorization required
71
54
 
72
55
  ## is_instance_ready
73
56
 
74
- > <HealthStatus> is_instance_ready
57
+ > HealthStatus is_instance_ready
75
58
 
76
59
  Check readiness status
77
60
 
78
61
  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.
79
62
 
80
- ### Examples
63
+ ### Example
81
64
 
82
65
  ```ruby
83
- require 'time'
66
+ # load the gem
84
67
  require 'ory-oathkeeper-client'
85
68
 
86
69
  api_instance = OryHydraClient::HealthApi.new
87
70
 
88
71
  begin
89
- # Check readiness status
72
+ #Check readiness status
90
73
  result = api_instance.is_instance_ready
91
74
  p result
92
75
  rescue OryHydraClient::ApiError => e
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}"
76
+ puts "Exception when calling HealthApi->is_instance_ready: #{e}"
112
77
  end
113
78
  ```
114
79
 
data/docs/VersionApi.md CHANGED
@@ -2,51 +2,34 @@
2
2
 
3
3
  All URIs are relative to *http://localhost*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_version**](VersionApi.md#get_version) | **GET** /version | Get service version |
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_version**](VersionApi.md#get_version) | **GET** /version | Get service version
8
+
8
9
 
9
10
 
10
11
  ## get_version
11
12
 
12
- > <Version> get_version
13
+ > Version get_version
13
14
 
14
15
  Get service version
15
16
 
16
17
  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.
17
18
 
18
- ### Examples
19
+ ### Example
19
20
 
20
21
  ```ruby
21
- require 'time'
22
+ # load the gem
22
23
  require 'ory-oathkeeper-client'
23
24
 
24
25
  api_instance = OryHydraClient::VersionApi.new
25
26
 
26
27
  begin
27
- # Get service version
28
+ #Get service version
28
29
  result = api_instance.get_version
29
30
  p result
30
31
  rescue OryHydraClient::ApiError => e
31
- puts "Error when calling VersionApi->get_version: #{e}"
32
- end
33
- ```
34
-
35
- #### Using the get_version_with_http_info variant
36
-
37
- This returns an Array which contains the response data, status code and headers.
38
-
39
- > <Array(<Version>, Integer, Hash)> get_version_with_http_info
40
-
41
- ```ruby
42
- begin
43
- # Get service version
44
- data, status_code, headers = api_instance.get_version_with_http_info
45
- p status_code # => 2xx
46
- p headers # => { ... }
47
- p data # => <Version>
48
- rescue OryHydraClient::ApiError => e
49
- puts "Error when calling VersionApi->get_version_with_http_info: #{e}"
32
+ puts "Exception when calling VersionApi->get_version: #{e}"
50
33
  end
51
34
  ```
52
35
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -30,8 +30,6 @@ require 'ory-oathkeeper-client/models/version'
30
30
 
31
31
  # APIs
32
32
  require 'ory-oathkeeper-client/api/api_api'
33
- require 'ory-oathkeeper-client/api/health_api'
34
- require 'ory-oathkeeper-client/api/version_api'
35
33
 
36
34
  module OryHydraClient
37
35
  class << self
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -139,6 +139,63 @@ module OryHydraClient
139
139
  return data, status_code, headers
140
140
  end
141
141
 
142
+ # Get service version
143
+ # 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.
144
+ # @param [Hash] opts the optional parameters
145
+ # @return [Version]
146
+ def get_version(opts = {})
147
+ data, _status_code, _headers = get_version_with_http_info(opts)
148
+ data
149
+ end
150
+
151
+ # Get service version
152
+ # This endpoint returns the service version typically notated using semantic versioning. 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.
153
+ # @param [Hash] opts the optional parameters
154
+ # @return [Array<(Version, Integer, Hash)>] Version data, response status code and response headers
155
+ def get_version_with_http_info(opts = {})
156
+ if @api_client.config.debugging
157
+ @api_client.config.logger.debug 'Calling API: ApiApi.get_version ...'
158
+ end
159
+ # resource path
160
+ local_var_path = '/version'
161
+
162
+ # query parameters
163
+ query_params = opts[:query_params] || {}
164
+
165
+ # header parameters
166
+ header_params = opts[:header_params] || {}
167
+ # HTTP header 'Accept' (if needed)
168
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
169
+
170
+ # form parameters
171
+ form_params = opts[:form_params] || {}
172
+
173
+ # http body (model)
174
+ post_body = opts[:debug_body]
175
+
176
+ # return_type
177
+ return_type = opts[:debug_return_type] || 'Version'
178
+
179
+ # auth_names
180
+ auth_names = opts[:debug_auth_names] || []
181
+
182
+ new_options = opts.merge(
183
+ :operation => :"ApiApi.get_version",
184
+ :header_params => header_params,
185
+ :query_params => query_params,
186
+ :form_params => form_params,
187
+ :body => post_body,
188
+ :auth_names => auth_names,
189
+ :return_type => return_type
190
+ )
191
+
192
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
193
+ if @api_client.config.debugging
194
+ @api_client.config.logger.debug "API called: ApiApi#get_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
195
+ end
196
+ return data, status_code, headers
197
+ end
198
+
142
199
  # Lists cryptographic keys
143
200
  # This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.
144
201
  # @param [Hash] opts the optional parameters
@@ -196,6 +253,120 @@ module OryHydraClient
196
253
  return data, status_code, headers
197
254
  end
198
255
 
256
+ # Check alive status
257
+ # 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.
258
+ # @param [Hash] opts the optional parameters
259
+ # @return [HealthStatus]
260
+ def is_instance_alive(opts = {})
261
+ data, _status_code, _headers = is_instance_alive_with_http_info(opts)
262
+ data
263
+ end
264
+
265
+ # Check alive status
266
+ # 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.
267
+ # @param [Hash] opts the optional parameters
268
+ # @return [Array<(HealthStatus, Integer, Hash)>] HealthStatus data, response status code and response headers
269
+ def is_instance_alive_with_http_info(opts = {})
270
+ if @api_client.config.debugging
271
+ @api_client.config.logger.debug 'Calling API: ApiApi.is_instance_alive ...'
272
+ end
273
+ # resource path
274
+ local_var_path = '/health/alive'
275
+
276
+ # query parameters
277
+ query_params = opts[:query_params] || {}
278
+
279
+ # header parameters
280
+ header_params = opts[:header_params] || {}
281
+ # HTTP header 'Accept' (if needed)
282
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
283
+
284
+ # form parameters
285
+ form_params = opts[:form_params] || {}
286
+
287
+ # http body (model)
288
+ post_body = opts[:debug_body]
289
+
290
+ # return_type
291
+ return_type = opts[:debug_return_type] || 'HealthStatus'
292
+
293
+ # auth_names
294
+ auth_names = opts[:debug_auth_names] || []
295
+
296
+ new_options = opts.merge(
297
+ :operation => :"ApiApi.is_instance_alive",
298
+ :header_params => header_params,
299
+ :query_params => query_params,
300
+ :form_params => form_params,
301
+ :body => post_body,
302
+ :auth_names => auth_names,
303
+ :return_type => return_type
304
+ )
305
+
306
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
307
+ if @api_client.config.debugging
308
+ @api_client.config.logger.debug "API called: ApiApi#is_instance_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
309
+ end
310
+ return data, status_code, headers
311
+ end
312
+
313
+ # Check readiness status
314
+ # 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.
315
+ # @param [Hash] opts the optional parameters
316
+ # @return [HealthStatus]
317
+ def is_instance_ready(opts = {})
318
+ data, _status_code, _headers = is_instance_ready_with_http_info(opts)
319
+ data
320
+ end
321
+
322
+ # Check readiness status
323
+ # 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.
324
+ # @param [Hash] opts the optional parameters
325
+ # @return [Array<(HealthStatus, Integer, Hash)>] HealthStatus data, response status code and response headers
326
+ def is_instance_ready_with_http_info(opts = {})
327
+ if @api_client.config.debugging
328
+ @api_client.config.logger.debug 'Calling API: ApiApi.is_instance_ready ...'
329
+ end
330
+ # resource path
331
+ local_var_path = '/health/ready'
332
+
333
+ # query parameters
334
+ query_params = opts[:query_params] || {}
335
+
336
+ # header parameters
337
+ header_params = opts[:header_params] || {}
338
+ # HTTP header 'Accept' (if needed)
339
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
340
+
341
+ # form parameters
342
+ form_params = opts[:form_params] || {}
343
+
344
+ # http body (model)
345
+ post_body = opts[:debug_body]
346
+
347
+ # return_type
348
+ return_type = opts[:debug_return_type] || 'HealthStatus'
349
+
350
+ # auth_names
351
+ auth_names = opts[:debug_auth_names] || []
352
+
353
+ new_options = opts.merge(
354
+ :operation => :"ApiApi.is_instance_ready",
355
+ :header_params => header_params,
356
+ :query_params => query_params,
357
+ :form_params => form_params,
358
+ :body => post_body,
359
+ :auth_names => auth_names,
360
+ :return_type => return_type
361
+ )
362
+
363
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
364
+ if @api_client.config.debugging
365
+ @api_client.config.logger.debug "API called: ApiApi#is_instance_ready\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
366
+ end
367
+ return data, status_code, headers
368
+ end
369
+
199
370
  # List all rules
200
371
  # 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.
201
372
  # @param [Hash] opts the optional parameters
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.5-beta.1
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 4.3.1
10
10
 
11
11
  =end
12
12
 
@@ -51,16 +51,15 @@ module OryHydraClient
51
51
  form_params = opts[:form_params] || {}
52
52
 
53
53
  # http body (model)
54
- post_body = opts[:debug_body]
54
+ post_body = opts[:body]
55
55
 
56
56
  # return_type
57
- return_type = opts[:debug_return_type] || 'HealthStatus'
57
+ return_type = opts[:return_type] || 'HealthStatus'
58
58
 
59
59
  # auth_names
60
- auth_names = opts[:debug_auth_names] || []
60
+ auth_names = opts[:auth_names] || []
61
61
 
62
62
  new_options = opts.merge(
63
- :operation => :"HealthApi.is_instance_alive",
64
63
  :header_params => header_params,
65
64
  :query_params => query_params,
66
65
  :form_params => form_params,
@@ -108,16 +107,15 @@ module OryHydraClient
108
107
  form_params = opts[:form_params] || {}
109
108
 
110
109
  # http body (model)
111
- post_body = opts[:debug_body]
110
+ post_body = opts[:body]
112
111
 
113
112
  # return_type
114
- return_type = opts[:debug_return_type] || 'HealthStatus'
113
+ return_type = opts[:return_type] || 'HealthStatus'
115
114
 
116
115
  # auth_names
117
- auth_names = opts[:debug_auth_names] || []
116
+ auth_names = opts[:auth_names] || []
118
117
 
119
118
  new_options = opts.merge(
120
- :operation => :"HealthApi.is_instance_ready",
121
119
  :header_params => header_params,
122
120
  :query_params => query_params,
123
121
  :form_params => form_params,
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.5-beta.1
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 4.3.1
10
10
 
11
11
  =end
12
12
 
@@ -51,16 +51,15 @@ module OryHydraClient
51
51
  form_params = opts[:form_params] || {}
52
52
 
53
53
  # http body (model)
54
- post_body = opts[:debug_body]
54
+ post_body = opts[:body]
55
55
 
56
56
  # return_type
57
- return_type = opts[:debug_return_type] || 'Version'
57
+ return_type = opts[:return_type] || 'Version'
58
58
 
59
59
  # auth_names
60
- auth_names = opts[:debug_auth_names] || []
60
+ auth_names = opts[:auth_names] || []
61
61
 
62
62
  new_options = opts.merge(
63
- :operation => :"VersionApi.get_version",
64
63
  :header_params => header_params,
65
64
  :query_params => query_params,
66
65
  :form_params => form_params,
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -307,7 +307,7 @@ module OryHydraClient
307
307
  case auth_setting[:in]
308
308
  when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
309
309
  when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
310
- else fail ArgumentError, 'Authentication token must be in `query` of `header`'
310
+ else fail ArgumentError, 'Authentication token must be in `query` or `header`'
311
311
  end
312
312
  end
313
313
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -197,11 +197,13 @@ module OryHydraClient
197
197
 
198
198
  # Gets API key (with prefix if set).
199
199
  # @param [String] param_name the parameter name of API key auth
200
- def api_key_with_prefix(param_name)
200
+ def api_key_with_prefix(param_name, param_alias = nil)
201
+ key = @api_key[param_name]
202
+ key = @api_key.fetch(param_alias, key) unless param_alias.nil?
201
203
  if @api_key_prefix[param_name]
202
- "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
204
+ "#{@api_key_prefix[param_name]} #{key}"
203
205
  else
204
- @api_key[param_name]
206
+ key
205
207
  end
206
208
  end
207
209
 
@@ -220,7 +222,7 @@ module OryHydraClient
220
222
  def server_settings
221
223
  [
222
224
  {
223
- url: "/",
225
+ url: "",
224
226
  description: "No description provided",
225
227
  }
226
228
  ]
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,13 +3,13 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: 0.38.9.beta1
6
+ The version of the OpenAPI document: 0.38.10.beta2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
13
13
  module OryHydraClient
14
- VERSION = '0.38.9.beta1'
14
+ VERSION = '0.38.10.beta2'
15
15
  end
@@ -5,10 +5,10 @@
5
5
 
6
6
  #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.
7
7
 
8
- The version of the OpenAPI document: v0.38.9-beta.1
8
+ The version of the OpenAPI document: v0.38.10-beta.2
9
9
  Contact: hi@ory.am
10
10
  Generated by: https://openapi-generator.tech
11
- OpenAPI Generator version: 5.0.0
11
+ OpenAPI Generator version: 5.1.0
12
12
 
13
13
  =end
14
14
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
data/spec/spec_helper.rb CHANGED
@@ -3,10 +3,10 @@
3
3
 
4
4
  #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.
5
5
 
6
- The version of the OpenAPI document: v0.38.9-beta.1
6
+ The version of the OpenAPI document: v0.38.10-beta.2
7
7
  Contact: hi@ory.am
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ory-oathkeeper-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.38.9.beta1
4
+ version: 0.38.10.beta2
5
5
  platform: ruby
6
6
  authors:
7
7
  - ORY GmbH
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-17 00:00:00.000000000 Z
11
+ date: 2021-05-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus