Class: GrapeOAS::ApiModelBuilders::Response

Inherits:
Object
  • Object
show all
Includes:
Concerns::ContentTypeResolver, Concerns::OasUtilities
Defined in:
lib/grape_oas/api_model_builders/response.rb

Constant Summary collapse

DEFAULT_PARSERS =

Default response parsers in priority order DocumentationResponsesParser has highest priority (most comprehensive) HttpCodesParser handles legacy grape-swagger formats and desc blocks DefaultResponseParser is the fallback

[
  ResponseParsers::DocumentationResponsesParser,
  ResponseParsers::HttpCodesParser,
  ResponseParsers::DefaultResponseParser
].freeze

Constants included from Concerns::OasUtilities

Concerns::OasUtilities::VALID_CONSTANT_PATTERN

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Concerns::OasUtilities

extract_extensions, #extract_extensions, pluralize, #pluralize, underscore, #underscore, valid_constant_name?, #valid_constant_name?

Constructor Details

#initialize(api:, route:, app: nil) ⇒ Response

Returns a new instance of Response.



33
34
35
36
37
 
# File 'lib/grape_oas/api_model_builders/response.rb', line 33

def initialize(api:, route:, app: nil)
  @api = api
  @route = route
  @app = app
end

Class Attribute Details

.parsers ⇒ Object 



22
23
24
 
# File 'lib/grape_oas/api_model_builders/response.rb', line 22

def parsers
  @parsers ||= DEFAULT_PARSERS.dup
end

Instance Attribute Details

#api ⇒ Object (readonly)

Returns the value of attribute api.



31
32
33
 
# File 'lib/grape_oas/api_model_builders/response.rb', line 31

def api
  @api
end

#app ⇒ Object (readonly)

Returns the value of attribute app.



31
32
33
 
# File 'lib/grape_oas/api_model_builders/response.rb', line 31

def app
  @app
end

#route ⇒ Object (readonly)

Returns the value of attribute route.



31
32
33
 
# File 'lib/grape_oas/api_model_builders/response.rb', line 31

def route
  @route
end

Class Method Details

.reset_parsers! ⇒ Object 



26
27
28
 
# File 'lib/grape_oas/api_model_builders/response.rb', line 26

def reset_parsers!
  @parsers = DEFAULT_PARSERS.dup
end

Instance Method Details

#build ⇒ Object 



39
40
41
42
43
 
# File 'lib/grape_oas/api_model_builders/response.rb', line 39

def build
  specs = response_specs
  grouped = group_specs_by_status(specs)
  grouped.map { |_code, group_specs| build_response_from_group(group_specs) }
end