Class: OpenAPIParser::Schemas::Components

Inherits:

Base

• Object
• Base
• OpenAPIParser::Schemas::Components

Defined in:

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

Instance Attribute Summary

• #headers ⇒ Hash{String => Header}^? readonly

  Header objects.

• #parameters ⇒ Hash{String => Parameter}^? readonly
• #request_bodies ⇒ Hash{String => RequestBody}^? readonly
• #responses ⇒ Hash{String => Response}^? readonly

Attributes inherited from Base

#object_reference, #parent, #raw_schema, #root

Method Summary

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

#headers ⇒ Hash{String => Header}^? (readonly)

Returns header objects.

Returns:

• (Hash{String => Header}, nil) —

  header objects

# File 'lib/openapi_parser/schemas/components.rb', line 26

openapi_attr_hash_object :headers, Header, reference: true

#parameters ⇒ Hash{String => Parameter}^? (readonly)

Returns:

• (Hash{String => Parameter}, nil)

# File 'lib/openapi_parser/schemas/components.rb', line 10

openapi_attr_hash_object :parameters, Parameter, reference: true

#request_bodies ⇒ Hash{String => RequestBody}^? (readonly)

Returns:

• (Hash{String => RequestBody}, nil)

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

openapi_attr_hash_object :request_bodies, RequestBody, reference: true, schema_key: :requestBodies

#responses ⇒ Hash{String => Response}^? (readonly)

Returns:

• (Hash{String => Response}, nil)

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

openapi_attr_hash_object :responses, Response, reference: true