Module: OpenApi::Tags::Controller::ClassMethods

Defined in:
lib/open-api/tags.rb

Instance Method Summary collapse

Instance Method Details

#open_api_tag(tag, metadata = nil) ⇒ Object 



123
124
125
126
127
128
129
130
131
 
# File 'lib/open-api/tags.rb', line 123

def open_api_tag(tag, metadata = nil)
  fail 'Valid tag argument required!' unless tag.respond_to?(:to_s)
  return (@open_api_tags_metadata || {})[tag.to_s].deep_dup if metadata.blank?
  fail 'Expected Hash argument for open_api_tag()!' unless metadata.is_a?(Hash)
  metadata = { name: tag.to_s }.merge(metadata) unless metadata.include?(:name)
  tag_metadata = ((@open_api_tags_metadata ||= {})[tag.to_s] ||= {})
  OpenApi::Tags.merge_metadata(tag_metadata, metadata)
  nil
end

#open_api_tag_metadata(tag, opts = {}) ⇒ Object 



133
134
135
136
137
138
139
140
141
 
# File 'lib/open-api/tags.rb', line 133

def open_api_tag_metadata(tag, opts = {})
  controller_class_hierarchy = OpenApi::Utils.controller_class_hierarchy(self)
  aggr_metadata = {}
  controller_class_hierarchy.each do |controller_class|
    OpenApi::Tags.merge_metadata(aggr_metadata,
        controller_class.send(:open_api_tag, tag), opts)
  end
  aggr_metadata
end

#open_api_tags(metadata = nil) ⇒ Object 



115
116
117
118
119
120
121
 
# File 'lib/open-api/tags.rb', line 115

def open_api_tags(metadata = nil)
  return (@open_api_tags_metadata || {}).deep_dup if metadata.blank?
  fail 'Expected Hash argument for open_api_tags()!' unless metadata.is_a?(Hash)
  metadata.each { |tag, tag_metadata| open_api_tag(tag, tag_metadata) }
  (@open_api_tags_metadata || {})
  nil
end