class GrapeSwagger::DocMethods::Extensions
Public Class Methods
add(path, definitions, route)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 7 def add(path, definitions, route) @route = route description = route.settings[:description] add_extension_to(path[method], extension(description)) if description && extended?(description, :x) settings = route.settings add_extensions_to_operation(settings, path, route) if settings && extended?(settings, :x_operation) add_extensions_to_path(settings, path) if settings && extended?(settings, :x_path) add_extensions_to_definition(settings, path, definitions) if settings && extended?(settings, :x_def) end
add_extension_to(part, extensions)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 63 def add_extension_to(part, extensions) return if part.nil? concatenate(extensions).each do |key, value| part[key] = value unless key.start_with?('x-for') end end
add_extensions_to_definition(settings, path, definitions)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 35 def add_extensions_to_definition(settings, path, definitions) def_extension = extension(settings, :x_def) if def_extension[:x_def].is_a?(Array) def_extension[:x_def].each { |extension| setup_definition(extension, path, definitions) } else setup_definition(def_extension[:x_def], path, definitions) end end
add_extensions_to_info(settings, info)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 23 def add_extensions_to_info(settings, info) add_extension_to(info, extension(settings)) if extended?(settings, :x) end
add_extensions_to_operation(settings, path, route)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 27 def add_extensions_to_operation(settings, path, route) add_extension_to(path[route.request_method.downcase.to_sym], extension(settings, :x_operation)) end
add_extensions_to_path(settings, path)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 31 def add_extensions_to_path(settings, path) add_extension_to(path, extension(settings, :x_path)) end
add_extensions_to_root(settings, object)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 19 def add_extensions_to_root(settings, object) add_extension_to(object, extension(settings)) if extended?(settings, :x) end
concatenate(extensions)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 71 def concatenate(extensions) result = {} extensions.each_value do |extension| extension.each do |key, value| result["x-#{key}"] = value end end result end
extended?(part, identifier = :x)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 83 def extended?(part, identifier = :x) !extension(part, identifier).empty? end
extension(part, identifier = :x)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 87 def extension(part, identifier = :x) part.select { |x| x == identifier } end
find_definition(status, path)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 54 def find_definition(status, path) response = path[method][:responses][status] return if response.nil? return response[:schema]['$ref'].split('/').last if response[:schema].key?('$ref') response[:schema]['items']['$ref'].split('/').last if response[:schema].key?('items') end
method(*args)
click to toggle source
Calls superclass method
# File lib/grape-swagger/doc_methods/extensions.rb, line 91 def method(*args) # We're shadowing Object.method(:symbol) here so we provide # a compatibility layer for code that introspects the methods # of this class return super if args.size.positive? @route.request_method.downcase.to_sym end
setup_definition(def_extension, path, definitions)
click to toggle source
# File lib/grape-swagger/doc_methods/extensions.rb, line 45 def setup_definition(def_extension, path, definitions) return unless def_extension.key?(:for) status = def_extension[:for] definition = find_definition(status, path) add_extension_to(definitions[definition], x_def: def_extension) end