Module: Grape::DSL::Desc
Instance Attribute Summary
Attributes included from Settings
#inheritable_setting, #top_level_setting
Instance Method Summary collapse
-
#desc(description, options = {}) { ... } ⇒ Object
Add a description to the next namespace or function.
-
#desc_container(endpoint_configuration) ⇒ Object
Returns an object which configures itself via an instance-context DSL.
- #description_field(field, value = nil) ⇒ Object
- #unset_description_field(field) ⇒ Object
Methods included from Settings
#api_class_setting, #get_or_set, #global_setting, #namespace_end, #namespace_inheritable, #namespace_inheritable_to_nil, #namespace_reverse_stackable, #namespace_reverse_stackable_with_hash, #namespace_setting, #namespace_stackable, #namespace_stackable_with_hash, #namespace_start, #route_end, #route_setting, #unset, #unset_api_class_setting, #unset_global_setting, #unset_namespace_inheritable, #unset_namespace_setting, #unset_namespace_stackable, #unset_route_setting, #within_namespace
Instance Method Details
#desc(description, options = {}) { ... } ⇒ Object
Add a description to the next namespace or function.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/grape/dsl/desc.rb', line 50 def desc(description, = {}, &config_block) if block_given? configuration = defined?(configuration) && configuration.respond_to?(:evaluate) ? configuration.evaluate : {} config_class = desc_container(configuration) config_class.configure do description description end config_class.configure(&config_block) unless .empty? warn '[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.' end = config_class.settings else = .merge(description: description) end namespace_setting :description, route_setting :description, end |
#desc_container(endpoint_configuration) ⇒ Object
Returns an object which configures itself via an instance-context DSL.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/grape/dsl/desc.rb', line 88 def desc_container(endpoint_configuration) Module.new do include Grape::Util::StrictHashConfiguration.module( :summary, :description, :detail, :params, :entity, :http_codes, :named, :body_name, :headers, :hidden, :deprecated, :is_array, :nickname, :produces, :consumes, :security, :tags ) config_context.define_singleton_method(:configuration) do endpoint_configuration end def config_context.success(*args) entity(*args) end def config_context.failure(*args) http_codes(*args) end end end |
#description_field(field, value = nil) ⇒ Object
72 73 74 75 76 77 78 79 80 |
# File 'lib/grape/dsl/desc.rb', line 72 def description_field(field, value = nil) description = route_setting(:description) if value description ||= route_setting(:description, {}) description[field] = value elsif description description[field] end end |
#unset_description_field(field) ⇒ Object
82 83 84 85 |
# File 'lib/grape/dsl/desc.rb', line 82 def unset_description_field(field) description = route_setting(:description) description.delete(field) if description end |