Class: Swagger::Data::Path

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

Overview

github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

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

Instance Attribute Details

#ref ⇒ Object

Returns the value of attribute ref.



107
108
109
 
# File 'lib/ruby-swagger/data/path.rb', line 107

def ref
  @ref
end

Class Method Details

.parse(path) ⇒ Object

Raises:

  • (ArgumentError) 


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

def self.parse(path)
  raise ArgumentError.new('Swagger::Data::Path - path is nil') unless path

  res = Swagger::Data::Path.new.bulk_set(path)
  res.ref = path['$ref'] if path['$ref']
  res
end

Instance Method Details

#all_methods ⇒ Object 



19
20
21
 
# File 'lib/ruby-swagger/data/path.rb', line 19

def all_methods
  [@get, @put, @post, @delete, @options, @head, @patch].compact
end

#as_swagger ⇒ Object 



109
110
111
112
113
 
# File 'lib/ruby-swagger/data/path.rb', line 109

def as_swagger
  res = super
  res['$ref'] = @ref if @ref
  res
end

#delete=(new_delete) ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lib/ruby-swagger/data/path.rb', line 48

def delete=(new_delete)
  return nil unless new_delete
  unless new_delete.is_a?(Swagger::Data::Operation)
    new_delete = Swagger::Data::Operation.parse(new_delete)
  end
  @delete = new_delete
end

#get=(new_get) ⇒ Object 



23
24
25
26
27
28
29
30
 
# File 'lib/ruby-swagger/data/path.rb', line 23

def get=(new_get)
  return nil unless new_get
  unless new_get.is_a?(Swagger::Data::Operation)
    new_get = Swagger::Data::Operation.parse(new_get)
  end

  @get = new_get
end

#head=(new_head) ⇒ Object 



64
65
66
67
68
69
70
71
 
# File 'lib/ruby-swagger/data/path.rb', line 64

def head=(new_head)
  return nil unless new_head
  unless new_head.is_a?(Swagger::Data::Operation)
    new_head = Swagger::Data::Operation.parse(new_head)
  end

  @head = new_head
end

#options=(new_options) ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/ruby-swagger/data/path.rb', line 56

def options=(new_options)
  return nil unless new_options
  unless new_options.is_a?(Swagger::Data::Operation)
    new_options = Swagger::Data::Operation.parse(new_options)
  end
  @options = new_options
end

#parameters=(new_parameters) ⇒ Object

Raises:

  • (ArgumentError) 


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/ruby-swagger/data/path.rb', line 81

def parameters=(new_parameters)
  return nil unless new_parameters
  raise ArgumentError.new('Swagger::Data::Path#parameters= - parameters is not an array') unless new_parameters.is_a?(Array)

  @parameters = []

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

    @parameters.push(new_param)
  end
end

#patch=(new_patch) ⇒ Object 



73
74
75
76
77
78
79
 
# File 'lib/ruby-swagger/data/path.rb', line 73

def patch=(new_patch)
  return nil unless new_patch
  unless new_patch.is_a?(Swagger::Data::Operation)
    new_patch = Swagger::Data::Operation.parse(new_patch)
  end
  @patch = new_patch
end

#post=(new_post) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/ruby-swagger/data/path.rb', line 40

def post=(new_post)
  return nil unless new_post
  unless new_post.is_a?(Swagger::Data::Operation)
    new_post = Swagger::Data::Operation.parse(new_post)
  end
  @post = new_post
end

#put=(new_put) ⇒ Object 



32
33
34
35
36
37
38
 
# File 'lib/ruby-swagger/data/path.rb', line 32

def put=(new_put)
  return nil unless new_put
  unless new_put.is_a?(Swagger::Data::Operation)
    new_put = Swagger::Data::Operation.parse(new_put)
  end
  @put = new_put
end