Class: OpenAPIParser::Schemas::Operation

Inherits:

Base

• Object
• Base
• OpenAPIParser::Schemas::Operation

Includes:

ParameterValidatable

Defined in:

lib/openapi_parser/schemas/classes.rb,
lib/openapi_parser/schemas/operation.rb

Instance Attribute Summary

• #request_body ⇒ OpenAPIParser::Schemas::RequestBody^? readonly

  Return OpenAPI3 object.

• #responses ⇒ OpenAPIParser::Schemas::Responses^? readonly

  Return OpenAPI3 object.

Attributes inherited from Base

#object_reference, #parent, #raw_schema, #root

Instance Method Summary

• #validate_request_body(content_type, params, options) ⇒ Object
• #validate_response(response_body, response_validate_options) ⇒ Object

Methods included from ParameterValidatable

#validate_path_params, #validate_request_parameter

Methods inherited from Base

#after_init, #initialize, #inspect

Methods included from Expandable

#expand_reference

Methods included from Findable

#find_object, #purge_object_cache

Methods included from Parser

#_openapi_all_child_objects, #_update_child_object, included, #load_data

Constructor Details

This class inherits a constructor from OpenAPIParser::Schemas::Base

Instance Attribute Details

#request_body ⇒ OpenAPIParser::Schemas::RequestBody^? (readonly)

Return OpenAPI3 object

Returns:

• (OpenAPIParser::Schemas::RequestBody, nil) —

  return OpenAPI3 object

# File 'lib/openapi_parser/schemas/operation.rb', line 18

openapi_attr_object :request_body, RequestBody, reference: true, schema_key: :requestBody

#responses ⇒ OpenAPIParser::Schemas::Responses^? (readonly)

Return OpenAPI3 object

Returns:

• (OpenAPIParser::Schemas::Responses, nil) —

  return OpenAPI3 object

# File 'lib/openapi_parser/schemas/operation.rb', line 22

openapi_attr_object :responses, Responses, reference: false

Instance Method Details

#validate_request_body(content_type, params, options) ⇒ Object

# File 'lib/openapi_parser/schemas/operation.rb', line 24

def validate_request_body(content_type, params, options)
  request_body&.validate_request_body(content_type, params, options)
end

#validate_response(response_body, response_validate_options) ⇒ Object

Parameters:

• response_body (OpenAPIParser::RequestOperation::ValidatableResponseBody)
• response_validate_options (OpenAPIParser::SchemaValidator::ResponseValidateOptions)

# File 'lib/openapi_parser/schemas/operation.rb', line 30

def validate_response(response_body, response_validate_options)
  responses&.validate(response_body, response_validate_options)
end