Class: Useless::Doc::DSL::Request

Inherits:
Object
  • Object
show all
Includes:
Member
Defined in:
lib/useless/doc/dsl.rb

Instance Method Summary collapse

Methods included from Member

#generate, included, #initialize

Instance Method Details

#body(&block) ⇒ Object



163
164
165
# File 'lib/useless/doc/dsl.rb', line 163

def body(&block)
  @attributes[:body] = Body.build({}, &block)
end

#default_attributesObject



149
150
151
# File 'lib/useless/doc/dsl.rb', line 149

def default_attributes
  { parameters: [], headers: [] }
end

#header(key, description) ⇒ Object



158
159
160
161
# File 'lib/useless/doc/dsl.rb', line 158

def header(key, description)
  header = Doc::Header.new key: key, description: description
  @attributes[:headers] << header
end

#parameter(key, description, attributes = {}) ⇒ Object



153
154
155
156
# File 'lib/useless/doc/dsl.rb', line 153

def parameter(key, description, attributes = {})
  parameter = Doc::Request::Parameter.new attributes.merge(key: key, description: description)
  @attributes[:parameters] << parameter
end