RubyGems - ory-oathkeeper-client - Versions diffs - 0.38.20.beta1 → 0.38.22.beta1 - Mend

ory-oathkeeper-client 0.38.20.beta1 → 0.38.22.beta1

Files changed (141) hide show

data/docs/MetadataApi.md DELETED Viewed

@@ -1,193 +0,0 @@
-# OryOathkeeperClient::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 |
-## get_version
-> <InlineResponse2001> get_version
-Return Running Software Version.
-This endpoint returns the version of Ory Oathkeeper.  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-oathkeeper-client'
-api_instance = OryOathkeeperClient::MetadataApi.new
-begin
-  # Return Running Software Version.
-  result = api_instance.get_version
-  p result
-rescue OryOathkeeperClient::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 OryOathkeeperClient::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 Oathkeeper 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-oathkeeper-client'
-api_instance = OryOathkeeperClient::MetadataApi.new
-begin
-  # Check HTTP Server Status
-  result = api_instance.is_alive
-  p result
-rescue OryOathkeeperClient::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 OryOathkeeperClient::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 Oathkeeper 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 Oathkeeper, the health status will never refer to the cluster state, only to a single instance.
-### Examples
-```ruby
-require 'time'
-require 'ory-oathkeeper-client'
-api_instance = OryOathkeeperClient::MetadataApi.new
-begin
-  # Check HTTP Server and Database Status
-  result = api_instance.is_ready
-  p result
-rescue OryOathkeeperClient::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 OryOathkeeperClient::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

data/lib/ory-oathkeeper-client/api/metadata_api.rb DELETED Viewed

@@ -1,193 +0,0 @@
-=begin
-#Ory Oathkeeper API
-#Documentation for all of Ory Oathkeeper's APIs.
-The version of the OpenAPI document: v0.38.20-beta.1
-Contact: hi@ory.sh
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
-=end
-require 'cgi'
-module OryOathkeeperClient
-  class MetadataApi
-    attr_accessor :api_client
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Return Running Software Version.
-    # This endpoint returns the version of Ory Oathkeeper.  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.
-    # @param [Hash] opts the optional parameters
-    # @return [InlineResponse2001]
-    def get_version(opts = {})
-      data, _status_code, _headers = get_version_with_http_info(opts)
-      data
-    end
-    # Return Running Software Version.
-    # This endpoint returns the version of Ory Oathkeeper.  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 version will never refer to the cluster state, only to a single instance.
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse2001, Integer, Hash)>] InlineResponse2001 data, response status code and response headers
-    def get_version_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MetadataApi.get_version ...'
-      end
-      # resource path
-      local_var_path = '/version'
-      # query parameters
-      query_params = opts[:query_params] || {}
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # form parameters
-      form_params = opts[:form_params] || {}
-      # http body (model)
-      post_body = opts[:debug_body]
-      # return_type
-      return_type = opts[:debug_return_type] || 'InlineResponse2001'
-      # auth_names
-      auth_names = opts[:debug_auth_names] || []
-      new_options = opts.merge(
-        :operation => :"MetadataApi.get_version",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: MetadataApi#get_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Check HTTP Server Status
-    # This endpoint returns a HTTP 200 status code when Ory Oathkeeper 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.
-    # @param [Hash] opts the optional parameters
-    # @return [InlineResponse200]
-    def is_alive(opts = {})
-      data, _status_code, _headers = is_alive_with_http_info(opts)
-      data
-    end
-    # Check HTTP Server Status
-    # This endpoint returns a HTTP 200 status code when Ory Oathkeeper 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 &#x60;X-Forwarded-Proto&#x60; header to be set.  Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
-    def is_alive_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MetadataApi.is_alive ...'
-      end
-      # resource path
-      local_var_path = '/health/alive'
-      # query parameters
-      query_params = opts[:query_params] || {}
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # form parameters
-      form_params = opts[:form_params] || {}
-      # http body (model)
-      post_body = opts[:debug_body]
-      # return_type
-      return_type = opts[:debug_return_type] || 'InlineResponse200'
-      # auth_names
-      auth_names = opts[:debug_auth_names] || []
-      new_options = opts.merge(
-        :operation => :"MetadataApi.is_alive",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: MetadataApi#is_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Check HTTP Server and Database Status
-    # This endpoint returns a HTTP 200 status code when Ory Oathkeeper 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 Oathkeeper, the health status will never refer to the cluster state, only to a single instance.
-    # @param [Hash] opts the optional parameters
-    # @return [InlineResponse200]
-    def is_ready(opts = {})
-      data, _status_code, _headers = is_ready_with_http_info(opts)
-      data
-    end
-    # Check HTTP Server and Database Status
-    # This endpoint returns a HTTP 200 status code when Ory Oathkeeper 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 Ory Oathkeeper, the health status will never refer to the cluster state, only to a single instance.
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
-    def is_ready_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MetadataApi.is_ready ...'
-      end
-      # resource path
-      local_var_path = '/health/ready'
-      # query parameters
-      query_params = opts[:query_params] || {}
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # form parameters
-      form_params = opts[:form_params] || {}
-      # http body (model)
-      post_body = opts[:debug_body]
-      # return_type
-      return_type = opts[:debug_return_type] || 'InlineResponse200'
-      # auth_names
-      auth_names = opts[:debug_auth_names] || []
-      new_options = opts.merge(
-        :operation => :"MetadataApi.is_ready",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: MetadataApi#is_ready\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end

data/lib/ory-oathkeeper-client/models/inline_response200.rb DELETED Viewed

@@ -1,224 +0,0 @@
-=begin
-#Ory Oathkeeper API
-#Documentation for all of Ory Oathkeeper's APIs.
-The version of the OpenAPI document: v0.38.20-beta.1
-Contact: hi@ory.sh
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
-=end
-require 'date'
-require 'time'
-module OryOathkeeperClient
-  class InlineResponse200
-    # Always \"ok\".
-    attr_accessor :status
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'status' => :'status'
-      }
-    end
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      attribute_map.values
-    end
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'status' => :'String'
-      }
-    end
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-      ])
-    end
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `OryOathkeeperClient::InlineResponse200` initialize method"
-      end
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `OryOathkeeperClient::InlineResponse200`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
-      end
-    end
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      if @status.nil?
-        invalid_properties.push('invalid value for "status", status cannot be nil.')
-      end
-      invalid_properties
-    end
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      return false if @status.nil?
-      true
-    end
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          status == o.status
-    end
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [status].hash
-    end
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end
-      end
-      self
-    end
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = OryOathkeeperClient.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-  end
-end