Class: Swagger::DSL::Operation

Inherits:
Hash
  • Object
show all
Defined in:
lib/swagger/dsl/operation.rb

Constant Summary collapse

FORMAT_TYPE = 
{
  json: "application/json",
  xml: "application/xml",
  plain: "text/plain",
  html: "text/html",
  csv: "text/csv",
  form: "application/x-www-form-urlencoded",
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(operation_id, format: :json, &block) ⇒ Operation

Returns a new instance of Operation.



17
18
19
20
21
22
23
24
 
# File 'lib/swagger/dsl/operation.rb', line 17

def initialize(operation_id, format: :json, &block)
  self["operationId"] = operation_id
  self["responses"] = {}
  self["parameters"] = []
  self["tags"] = []
  @format = format
  instance_eval(&block)
end

Instance Method Details

#body(format: @format, dsl: nil, &block) ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/swagger/dsl/operation.rb', line 42

def body(format: @format, dsl: nil, &block)
  formats(format).each do |f|
    self["requestBody"] ||= { "required" => true }
    self["requestBody"]["content"] ||= {}
    self["requestBody"]["content"][f] = { "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block) }
  end
end

#body_description(body_description = nil) ⇒ Object 



50
51
52
53
 
# File 'lib/swagger/dsl/operation.rb', line 50

def body_description(body_description = nil)
  self["requestBody"] ||= { "required" => true }
  self["requestBody"]["description"] = body_description
end

#body_optional(optional = true) ⇒ Object 



55
56
57
58
 
# File 'lib/swagger/dsl/operation.rb', line 55

def body_optional(optional = true)
  self["requestBody"] ||= {}
  self["requestBody"]["required"] = optional
end

#description(text) ⇒ Object 



30
31
32
 
# File 'lib/swagger/dsl/operation.rb', line 30

def description(text)
  self["description"] = text
end

#params(default_required: Swagger::DSL.current.config.default_required, &block) ⇒ Object 



38
39
40
 
# File 'lib/swagger/dsl/operation.rb', line 38

def params(default_required: Swagger::DSL.current.config.default_required, &block)
  self["parameters"] = Parameters.new(default_required: default_required, &block)
end

#render(code = 200, format: @format, dsl: nil, &block) ⇒ Object 



60
61
62
63
64
65
 
# File 'lib/swagger/dsl/operation.rb', line 60

def render(code = 200, format: @format, dsl: nil, &block)
  self["responses"][code] ||= { "content" => {}, "description" => "#{code}" }
  formats(format).each do |f|
    self["responses"][code]["content"][f] = { "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block) }
  end
end

#summary(text) ⇒ Object 



26
27
28
 
# File 'lib/swagger/dsl/operation.rb', line 26

def summary(text)
  self["summary"] = text
end

#tags(*tags) ⇒ Object 



34
35
36
 
# File 'lib/swagger/dsl/operation.rb', line 34

def tags(*tags)
  self["tags"].concat(tags.flatten(1))
end