Class: OpenAPIParser::RequestOperation

Inherits:

Object

• Object
• OpenAPIParser::RequestOperation

Defined in:

lib/openapi_parser/request_operation.rb

Overview

binding request data and operation object

Defined Under Namespace

Classes: ValidatableResponseBody

Instance Attribute Summary

• #config ⇒ OpenAPIParser::Config readonly
• #http_method ⇒ String readonly
• #operation_object ⇒ OpenAPIParser::Schemas::Operation readonly
• #original_path ⇒ String readonly
• #path_item ⇒ Object readonly

  Returns the value of attribute path_item.

• #path_params ⇒ Hash{String => String} readonly

Class Method Summary

• .create(http_method, request_path, path_item_finder, config) ⇒ OpenAPIParser::RequestOperation^?

Instance Method Summary

• #initialize(http_method, result, config) ⇒ RequestOperation constructor

  A new instance of RequestOperation.

• #validate_path_params(options = nil) ⇒ Object
• #validate_request_body(content_type, params, options = nil) ⇒ Object
• #validate_request_parameter(params, headers, options = nil) ⇒ Object
• #validate_response_body(response_body, response_validate_options = nil) ⇒ Object

Constructor Details

#initialize(http_method, result, config) ⇒ RequestOperation

Returns a new instance of RequestOperation.

Parameters:

• http_method (String)
• result (OpenAPIParser::PathItemFinder::Result)
• config (OpenAPIParser::Config)

# File 'lib/openapi_parser/request_operation.rb', line 33

def initialize(http_method, result, config)
  @http_method = http_method.to_s
  @original_path = result.original_path
  @operation_object = result.operation_object
  @path_params = result.path_params || {}
  @path_item = result.path_item_object
  @config = config
end

Instance Attribute Details

#config ⇒ OpenAPIParser::Config (readonly)

Returns:

• (OpenAPIParser::Config)

# File 'lib/openapi_parser/request_operation.rb', line 28

attr_reader :operation_object, :path_params, :config, :http_method, :original_path, :path_item

#http_method ⇒ String (readonly)

Returns:

• (String)

# File 'lib/openapi_parser/request_operation.rb', line 28

attr_reader :operation_object, :path_params, :config, :http_method, :original_path, :path_item

#operation_object ⇒ OpenAPIParser::Schemas::Operation (readonly)

Returns:

• (OpenAPIParser::Schemas::Operation)

# File 'lib/openapi_parser/request_operation.rb', line 28

def operation_object
  @operation_object
end

#original_path ⇒ String (readonly)

Returns:

• (String)

# File 'lib/openapi_parser/request_operation.rb', line 28

attr_reader :operation_object, :path_params, :config, :http_method, :original_path, :path_item

#path_item ⇒ Object (readonly)

Returns the value of attribute path_item.

# File 'lib/openapi_parser/request_operation.rb', line 28

attr_reader :operation_object, :path_params, :config, :http_method, :original_path, :path_item

#path_params ⇒ Hash{String => String} (readonly)

Returns:

• (Hash{String => String})

# File 'lib/openapi_parser/request_operation.rb', line 28

attr_reader :operation_object, :path_params, :config, :http_method, :original_path, :path_item

Class Method Details

.create(http_method, request_path, path_item_finder, config) ⇒ OpenAPIParser::RequestOperation^?

Parameters:

• config (OpenAPIParser::Config)
• path_item_finder (OpenAPIParser::PathItemFinder)

Returns:

• (OpenAPIParser::RequestOperation, nil)

# File 'lib/openapi_parser/request_operation.rb', line 8

def create(http_method, request_path, path_item_finder, config)
  result = path_item_finder.operation_object(http_method, request_path)
  return nil unless result

  self.new(http_method, result, config)
end

Instance Method Details

#validate_path_params(options = nil) ⇒ Object

# File 'lib/openapi_parser/request_operation.rb', line 42

def validate_path_params(options = nil)
  options ||= config.path_params_options
  operation_object&.validate_path_params(path_params, options)
end

#validate_request_body(content_type, params, options = nil) ⇒ Object

Parameters:

• content_type (String)
• params (Hash)
• options (OpenAPIParser::SchemaValidator::Options) (defaults to: nil)

# File 'lib/openapi_parser/request_operation.rb', line 50

def validate_request_body(content_type, params, options = nil)
  options ||= config.request_body_options
  operation_object&.validate_request_body(content_type, params, options)
end

#validate_request_parameter(params, headers, options = nil) ⇒ Object

Parameters:

• params (Hash) —

  parameter hash

• headers (Hash) —

  headers hash

• options (OpenAPIParser::SchemaValidator::Options) (defaults to: nil) —

  request validator options

# File 'lib/openapi_parser/request_operation.rb', line 66

def validate_request_parameter(params, headers, options = nil)
  options ||= config.request_validator_options
  path_item&.validate_request_parameter(params, headers, options)
  operation_object&.validate_request_parameter(params, headers, options)
end

#validate_response_body(response_body, response_validate_options = nil) ⇒ Object

Parameters:

• response_body (OpenAPIParser::RequestOperation::ValidatableResponseBody)
• response_validate_options (OpenAPIParser::SchemaValidator::ResponseValidateOptions) (defaults to: nil)

# File 'lib/openapi_parser/request_operation.rb', line 57

def validate_response_body(response_body, response_validate_options = nil)
  response_validate_options ||= config.response_validate_options

  operation_object&.validate_response(response_body, response_validate_options)
end