Class: GrapeSwagger::DocMethods::Extensions
- Inherits:
-
Object
- Object
- GrapeSwagger::DocMethods::Extensions
- Defined in:
- lib/grape-swagger/doc_methods/extensions.rb
Class Method Summary collapse
- .add(path, definitions, route) ⇒ Object
- .add_extension_to(part, extensions) ⇒ Object
- .add_extensions_to_definition(settings, path, definitions) ⇒ Object
- .add_extensions_to_path(settings, path) ⇒ Object
- .concatenate(extensions) ⇒ Object
- .extended?(part, identifier = :x) ⇒ Boolean
- .extension(part, identifier = :x) ⇒ Object
- .find_definition(status, path) ⇒ Object
- .method ⇒ Object
- .setup_definition(def_extension, path, definitions) ⇒ Object
Class Method Details
.add(path, definitions, route) ⇒ Object
5 6 7 8 9 10 11 12 13 14 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 5 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_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) ⇒ Object
46 47 48 49 50 51 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 46 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) ⇒ Object
20 21 22 23 24 25 26 27 28 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 20 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_path(settings, path) ⇒ Object
16 17 18 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 16 def add_extensions_to_path(settings, path) add_extension_to(path, extension(settings, :x_path)) end |
.concatenate(extensions) ⇒ Object
53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 53 def concatenate(extensions) result = {} extensions.values.each do |extension| extension.each do |key, value| result["x-#{key}"] = value end end result end |
.extended?(part, identifier = :x) ⇒ Boolean
65 66 67 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 65 def extended?(part, identifier = :x) !extension(part, identifier).empty? end |
.extension(part, identifier = :x) ⇒ Object
69 70 71 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 69 def extension(part, identifier = :x) part.select { |x| x == identifier } end |
.find_definition(status, path) ⇒ Object
38 39 40 41 42 43 44 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 38 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') return response[:schema]['items']['$ref'].split('/').last if response[:schema].key?('items') end |
.method ⇒ Object
73 74 75 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 73 def method @route.request_method.downcase.to_sym end |
.setup_definition(def_extension, path, definitions) ⇒ Object
30 31 32 33 34 35 36 |
# File 'lib/grape-swagger/doc_methods/extensions.rb', line 30 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 |