Class: Swagger::Data::Operation

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-swagger/data/operation.rb

Overview

github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

attr_swagger, #bulk_set, #swagger_attributes, #to_json, #to_swagger, #to_yaml

Class Method Details

.parse(operation) ⇒ Object 



12
13
14
15
16
 
# File 'lib/ruby-swagger/data/operation.rb', line 12

def self.parse(operation)
  return unless operation

  Swagger::Data::Operation.new.bulk_set(operation)
end

Instance Method Details

#add_parameter(new_parameter) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ruby-swagger/data/operation.rb', line 62

def add_parameter(new_parameter)
  @parameters ||= []

  if new_parameter.is_a?(Hash)

    new_parameter = if new_parameter['$ref']
                      # it's a reference object
                      Swagger::Data::Reference.parse(new_parameter)
                    else
                      # it's a parameter object
                      Swagger::Data::Parameter.parse(new_parameter)
                    end

  end

  @parameters.push(new_parameter)
end

#externalDocs=(newDoc) ⇒ Object 



18
19
20
21
22
23
24
25
26
 
# File 'lib/ruby-swagger/data/operation.rb', line 18

def externalDocs=(newDoc)
  return nil unless newDoc

  unless newDoc.is_a?(Swagger::Data::ExternalDocumentation)
    newDoc = Swagger::Data::ExternalDocumentation.parse(newDoc)
  end

  @externalDocs = newDoc
end

#parameters=(newParams) ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'lib/ruby-swagger/data/operation.rb', line 52

def parameters=(newParams)
  return nil unless newParams

  @parameters = []

  newParams.each do |parameter|
    add_parameter(parameter)
  end
end

#responses=(newResp) ⇒ Object 



28
29
30
31
32
33
34
35
36
 
# File 'lib/ruby-swagger/data/operation.rb', line 28

def responses=(newResp)
  return nil unless newResp

  unless newResp.is_a?(Swagger::Data::Responses)
    newResp = Swagger::Data::Responses.parse(newResp)
  end

  @responses = newResp
end

#security=(newSecurity) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ruby-swagger/data/operation.rb', line 38

def security=(newSecurity)
  return nil unless newSecurity

  @security = []

  newSecurity.each do |sec_object|
    unless sec_object.is_a?(Swagger::Data::SecurityRequirement)
      sec_object = Swagger::Data::SecurityRequirement.parse(sec_object)
    end

    @security.push(sec_object)
  end
end