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 



267
268
269
 
# File 'lib/useless/doc/dsl.rb', line 267

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

#body(&block) ⇒ Object 



281
282
283
 
# File 'lib/useless/doc/dsl.rb', line 281

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

#default_attributes ⇒ Object 



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

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

#description(description) ⇒ Object 



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

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

#header(key, description) ⇒ Object 



276
277
278
279
 
# File 'lib/useless/doc/dsl.rb', line 276

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

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



271
272
273
274
 
# File 'lib/useless/doc/dsl.rb', line 271

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 



285
286
287
288
 
# File 'lib/useless/doc/dsl.rb', line 285

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