Module: RspecApiDocumentation::DSL

Defined in:
lib/rspec_api_documentation/dsl.rb,
lib/rspec_api_documentation/dsl/callback.rb,
lib/rspec_api_documentation/dsl/endpoint.rb,
lib/rspec_api_documentation/dsl/resource.rb,
lib/rspec_api_documentation/dsl/endpoint/params.rb,
lib/rspec_api_documentation/dsl/endpoint/set_param.rb

Defined Under Namespace

Modules: Callback, Endpoint, Resource

Instance Method Summary collapse

Instance Method Details

#resource(*args, &block) ⇒ Object

Custom describe block that sets metadata to enable the rest of RAD

resource "Orders", :meta => :data do
  # ...
end

Params:

args

Glob of RSpec’s ‘describe` arguments

block

Block to pass into describe



20
21
22
23
24
25
26
27
 
# File 'lib/rspec_api_documentation/dsl.rb', line 20

def resource(*args, &block)
  options = args.last.is_a?(Hash) ? args.pop : {}
  options[:api_doc_dsl] = :resource
  options[:resource_name] = args.first.to_s
  options[:document] = :all unless options.key?(:document)
  args.push(options)
  describe(*args, &block)
end