ory-kratos-client 0.6.2.alpha1 → 0.7.1.alpha2

data/docs/LoginFlow.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **active** | **String** | and so on. | [optional] |
+| **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated. |  |
 | **forced** | **Boolean** | Forced stores whether this login flow should enforce re-authentication. | [optional] |
 | **id** | **String** |  |  |
@@ -12,6 +13,7 @@
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
 | **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
+| **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 
 ## Example
 
@@ -20,13 +22,15 @@ require 'ory-kratos-client'
 
 instance = OryHydraClient::LoginFlow.new(
   active: null,
+  created_at: null,
   expires_at: null,
   forced: null,
   id: null,
   issued_at: null,
   request_url: null,
   type: null,
-  ui: null
+  ui: null,
+  updated_at: null
 )
 ```
 

data/docs/Meta.md

@@ -1,4 +1,4 @@
-# OryHydraClient::Meta
+# OryKratosClient::Meta
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::Meta.new(
+instance = OryKratosClient::Meta.new(
   label: null
 )
 ```

data/docs/MetadataApi.md

@@ -0,0 +1,254 @@
+# OryKratosClient::MetadataApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_version**](MetadataApi.md#get_version) | **GET** /version | Return Running Software Version. |
+| [**is_alive**](MetadataApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status |
+| [**is_ready**](MetadataApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status |
+| [**prometheus**](MetadataApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so: |
+
+
+## get_version
+
+> <InlineResponse2001> get_version
+
+Return Running Software Version.
+
+This endpoint returns the version of Ory Kratos.  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 version will never refer to the cluster state, only to a single instance.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-kratos-client'
+
+api_instance = OryKratosClient::MetadataApi.new
+
+begin
+  # Return Running Software Version.
+  result = api_instance.get_version
+  p result
+rescue OryKratosClient::ApiError => e
+  puts "Error when calling MetadataApi->get_version: #{e}"
+end
+```
+
+#### Using the get_version_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse2001>, Integer, Hash)> get_version_with_http_info
+
+```ruby
+begin
+  # Return Running Software Version.
+  data, status_code, headers = api_instance.get_version_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse2001>
+rescue OryKratosClient::ApiError => e
+  puts "Error when calling MetadataApi->get_version_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## is_alive
+
+> <InlineResponse200> is_alive
+
+Check HTTP Server Status
+
+This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working.  If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.  Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-kratos-client'
+
+api_instance = OryKratosClient::MetadataApi.new
+
+begin
+  # Check HTTP Server Status
+  result = api_instance.is_alive
+  p result
+rescue OryKratosClient::ApiError => e
+  puts "Error when calling MetadataApi->is_alive: #{e}"
+end
+```
+
+#### Using the is_alive_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse200>, Integer, Hash)> is_alive_with_http_info
+
+```ruby
+begin
+  # Check HTTP Server Status
+  data, status_code, headers = api_instance.is_alive_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse200>
+rescue OryKratosClient::ApiError => e
+  puts "Error when calling MetadataApi->is_alive_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## is_ready
+
+> <InlineResponse200> is_ready
+
+Check HTTP Server and Database Status
+
+This endpoint returns a HTTP 200 status code when Ory Kratos 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 Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-kratos-client'
+
+api_instance = OryKratosClient::MetadataApi.new
+
+begin
+  # Check HTTP Server and Database Status
+  result = api_instance.is_ready
+  p result
+rescue OryKratosClient::ApiError => e
+  puts "Error when calling MetadataApi->is_ready: #{e}"
+end
+```
+
+#### Using the is_ready_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse200>, Integer, Hash)> is_ready_with_http_info
+
+```ruby
+begin
+  # Check HTTP Server and Database Status
+  data, status_code, headers = api_instance.is_ready_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse200>
+rescue OryKratosClient::ApiError => e
+  puts "Error when calling MetadataApi->is_ready_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## prometheus
+
+> prometheus
+
+Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
+
+``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-kratos-client'
+
+api_instance = OryKratosClient::MetadataApi.new
+
+begin
+  # Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
+  api_instance.prometheus
+rescue OryKratosClient::ApiError => e
+  puts "Error when calling MetadataApi->prometheus: #{e}"
+end
+```
+
+#### Using the prometheus_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> prometheus_with_http_info
+
+```ruby
+begin
+  # Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
+  data, status_code, headers = api_instance.prometheus_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryKratosClient::ApiError => e
+  puts "Error when calling MetadataApi->prometheus_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/Plugin.md

@@ -1,4 +1,4 @@
-# OryHydraClient::Plugin
+# OryKratosClient::Plugin
 
 ## Properties
 
@@ -16,7 +16,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::Plugin.new(
+instance = OryKratosClient::Plugin.new(
   config: null,
   enabled: null,
   id: null,

data/docs/PluginConfig.md

@@ -1,4 +1,4 @@
-# OryHydraClient::PluginConfig
+# OryKratosClient::PluginConfig
 
 ## Properties
 
@@ -26,7 +26,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::PluginConfig.new(
+instance = OryKratosClient::PluginConfig.new(
   args: null,
   description: null,
   docker_version: null,

data/docs/PluginConfigArgs.md

@@ -1,4 +1,4 @@
-# OryHydraClient::PluginConfigArgs
+# OryKratosClient::PluginConfigArgs
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::PluginConfigArgs.new(
+instance = OryKratosClient::PluginConfigArgs.new(
   description: null,
   name: null,
   settable: null,

data/docs/PluginConfigInterface.md

@@ -1,4 +1,4 @@
-# OryHydraClient::PluginConfigInterface
+# OryKratosClient::PluginConfigInterface
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::PluginConfigInterface.new(
+instance = OryKratosClient::PluginConfigInterface.new(
   socket: null,
   types: null
 )

data/docs/PluginConfigLinux.md

@@ -1,4 +1,4 @@
-# OryHydraClient::PluginConfigLinux
+# OryKratosClient::PluginConfigLinux
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::PluginConfigLinux.new(
+instance = OryKratosClient::PluginConfigLinux.new(
   allow_all_devices: null,
   capabilities: null,
   devices: null

data/docs/PluginConfigNetwork.md

@@ -1,4 +1,4 @@
-# OryHydraClient::PluginConfigNetwork
+# OryKratosClient::PluginConfigNetwork
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::PluginConfigNetwork.new(
+instance = OryKratosClient::PluginConfigNetwork.new(
   type: null
 )
 ```

data/docs/PluginConfigRootfs.md

@@ -1,4 +1,4 @@
-# OryHydraClient::PluginConfigRootfs
+# OryKratosClient::PluginConfigRootfs
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::PluginConfigRootfs.new(
+instance = OryKratosClient::PluginConfigRootfs.new(
   diff_ids: null,
   type: null
 )

data/docs/PluginConfigUser.md

@@ -1,4 +1,4 @@
-# OryHydraClient::PluginConfigUser
+# OryKratosClient::PluginConfigUser
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::PluginConfigUser.new(
+instance = OryKratosClient::PluginConfigUser.new(
   gid: null,
   uid: null
 )

data/docs/PluginDevice.md

@@ -1,4 +1,4 @@
-# OryHydraClient::PluginDevice
+# OryKratosClient::PluginDevice
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::PluginDevice.new(
+instance = OryKratosClient::PluginDevice.new(
   description: null,
   name: null,
   path: null,

data/docs/PluginEnv.md

@@ -1,4 +1,4 @@
-# OryHydraClient::PluginEnv
+# OryKratosClient::PluginEnv
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'ory-kratos-client'
 
-instance = OryHydraClient::PluginEnv.new(
+instance = OryKratosClient::PluginEnv.new(
   description: null,
   name: null,
   settable: null,