Class: Swagger::Blocks::OperationNode

Inherits:
Node
  • Object
show all
Defined in:
lib/swagger/blocks.rb

Overview

v1.2: goo.gl/PvwUXj#523-operation-object v2.0: github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operation-object

Instance Attribute Summary

Attributes inherited from Node

#name, #version

Instance Method Summary collapse

Methods inherited from Node

#as_json, call, #data, #is_swagger_1_2?, #is_swagger_2_0?, #key

Instance Method Details

#authorization(name, &block) ⇒ Object

Raises:



511
512
513
514
515
516
517
 
# File 'lib/swagger/blocks.rb', line 511

def authorization(name, &block)
  raise NotSupportedError unless is_swagger_1_2?

  self.data[:authorizations] ||= Swagger::Blocks::ApiAuthorizationsNode.new
  self.data[:authorizations].version = version
  self.data[:authorizations].authorization(name, &block)
end

#externalDocs(&block) ⇒ Object

Raises:



533
534
535
536
537
 
# File 'lib/swagger/blocks.rb', line 533

def externalDocs(&block)
  raise NotSupportedError unless is_swagger_2_0?

  self.data[:externalDocs] = Swagger::Blocks::ExternalDocsNode.call(version: version, &block)
end

#items(&block) ⇒ Object

Raises:



519
520
521
522
523
 
# File 'lib/swagger/blocks.rb', line 519

def items(&block)
  raise NotSupportedError unless is_swagger_1_2?

  self.data[:items] = Swagger::Blocks::ItemsNode.call(version: version, &block)
end

#parameter(&block) ⇒ Object 



499
500
501
502
 
# File 'lib/swagger/blocks.rb', line 499

def parameter(&block)
  self.data[:parameters] ||= []
  self.data[:parameters] << Swagger::Blocks::ParameterNode.call(version: version, &block)
end

#response(resp, &block) ⇒ Object

Raises:



525
526
527
528
529
530
531
 
# File 'lib/swagger/blocks.rb', line 525

def response(resp, &block)
  raise NotSupportedError unless is_swagger_2_0?

  # TODO validate 'resp' is as per spec
  self.data[:responses] ||= {}
  self.data[:responses][resp] = Swagger::Blocks::ResponseNode.call(version: version, &block)
end

#response_message(&block) ⇒ Object

Raises:



504
505
506
507
508
509
 
# File 'lib/swagger/blocks.rb', line 504

def response_message(&block)
  raise NotSupportedError unless is_swagger_1_2?

  self.data[:responseMessages] ||= []
  self.data[:responseMessages] << Swagger::Blocks::Node.call(version: version, &block)
end

#security(&block) ⇒ Object

Raises:



539
540
541
542
543
544
 
# File 'lib/swagger/blocks.rb', line 539

def security(&block)
  raise NotSupportedError unless is_swagger_2_0?

  self.data[:security] ||= []
  self.data[:security] << Swagger::Blocks::SecurityRequirementNode.call(version: version, &block)
end