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

#authentication_required(value = nil) ⇒ Object 



244
245
246
 
# File 'lib/useless/doc/dsl.rb', line 244

def authentication_required(value = nil)
  @attributes[:authentication_required] = value.nil? ? true : value
end

#body(&block) ⇒ Object 



258
259
260
 
# File 'lib/useless/doc/dsl.rb', line 258

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

#default_attributes ⇒ Object 



236
237
238
 
# File 'lib/useless/doc/dsl.rb', line 236

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

#description(description) ⇒ Object 



240
241
242
 
# File 'lib/useless/doc/dsl.rb', line 240

def description(description)
  @attributes[:description] = description
end

#header(key, description) ⇒ Object 



253
254
255
256
 
# File 'lib/useless/doc/dsl.rb', line 253

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

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



248
249
250
251
 
# File 'lib/useless/doc/dsl.rb', line 248

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

#response(code, description, &block) ⇒ Object 



262
263
264
265
 
# File 'lib/useless/doc/dsl.rb', line 262

def response(code, description, &block)
  response = Response.build({ code: code, description: description }, &block)
  @attributes[:responses] << response
end