Class: Useless::Doc::DSL::Request
- Inherits:
-
Object
- Object
- Useless::Doc::DSL::Request
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
268
269
270
|
# File 'lib/useless/doc/dsl.rb', line 268
def authentication_required(value = nil)
@attributes[:authentication_required] = value.nil? ? true : value
end
|
#body(&block) ⇒ Object
282
283
284
|
# File 'lib/useless/doc/dsl.rb', line 282
def body(&block)
@attributes[:body] = Body.build({}, &block)
end
|
#default_attributes ⇒ Object
260
261
262
|
# File 'lib/useless/doc/dsl.rb', line 260
def default_attributes
{ parameters: [], headers: [], responses: [] }
end
|
#description(description) ⇒ Object
264
265
266
|
# File 'lib/useless/doc/dsl.rb', line 264
def description(description)
@attributes[:description] = description
end
|
277
278
279
280
|
# File 'lib/useless/doc/dsl.rb', line 277
def (key, description)
= Doc::Core::Header.new key: key, description: description
@attributes[:headers] <<
end
|
#parameter(key, description, attributes = {}) ⇒ Object
272
273
274
275
|
# File 'lib/useless/doc/dsl.rb', line 272
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
286
287
288
289
|
# File 'lib/useless/doc/dsl.rb', line 286
def response(code, description, &block)
response = Response.build({ code: code, description: description }, &block)
@attributes[:responses] << response
end
|