class Swagger::Blocks::Nodes::RootNode

Public Instance Methods

extension(name, inline_keys = nil, &block) click to toggle source
# File lib/swagger/blocks/nodes/root_node.rb, line 58
def extension(name, inline_keys = nil, &block)
  raise NotSupportedError unless is_openapi_3_0?

  self.data[name] ||= []
  self.data[name] << Swagger::Blocks::Nodes::VendorExtensionNode.call(version: version, inline_keys: inline_keys, &block)
end
externalDocs(inline_keys = nil, &block) click to toggle source
# File lib/swagger/blocks/nodes/root_node.rb, line 40
def externalDocs(inline_keys = nil, &block)
  self.data[:externalDocs] = Swagger::Blocks::Nodes::ExternalDocsNode.call(version: version, inline_keys: inline_keys, &block)
end
info(inline_keys = nil, &block) click to toggle source
# File lib/swagger/blocks/nodes/root_node.rb, line 6
def info(inline_keys = nil, &block)
  self.data[:info] = Swagger::Blocks::Nodes::InfoNode.call(version: version, inline_keys: inline_keys, &block)
end
parameter(param, inline_keys = nil, &block) click to toggle source
# File lib/swagger/blocks/nodes/root_node.rb, line 10
def parameter(param, inline_keys = nil, &block)
  raise NotSupportedError unless is_swagger_2_0?

  # TODO validate 'param' is as per spec
  self.data[:parameters] ||= {}
  self.data[:parameters][param] = Swagger::Blocks::Nodes::ParameterNode.call(version: version, inline_keys: inline_keys, &block)
end
response(resp, inline_keys = nil, &block) click to toggle source
# File lib/swagger/blocks/nodes/root_node.rb, line 18
def response(resp, inline_keys = nil, &block)
  raise NotSupportedError unless is_swagger_2_0?

  # TODO validate 'resp' is as per spec
  self.data[:responses] ||= {}
  self.data[:responses][resp] = Swagger::Blocks::Nodes::ResponseNode.call(version: version, inline_keys: inline_keys, &block)
end
security(inline_keys = nil, &block) click to toggle source
# File lib/swagger/blocks/nodes/root_node.rb, line 33
def security(inline_keys = nil, &block)
  raise NotSupportedError unless is_swagger_2_0? || is_openapi_3_0?

  self.data[:security] ||= []
  self.data[:security] << Swagger::Blocks::Nodes::SecurityRequirementNode.call(version: version, inline_keys: inline_keys, &block)
end
security_definition(name, inline_keys = nil, &block) click to toggle source
# File lib/swagger/blocks/nodes/root_node.rb, line 26
def security_definition(name, inline_keys = nil, &block)
  raise NotSupportedError unless is_swagger_2_0?

  self.data[:securityDefinitions] ||= {}
  self.data[:securityDefinitions][name] = Swagger::Blocks::Nodes::SecuritySchemeNode.call(version: version, inline_keys: inline_keys, &block)
end
server(inline_keys = nil, &block) click to toggle source
# File lib/swagger/blocks/nodes/root_node.rb, line 51
def server(inline_keys = nil, &block)
  raise NotSupportedError unless is_openapi_3_0?

  self.data[:servers] ||= []
  self.data[:servers] << Swagger::Blocks::Nodes::ServerNode.call(version: version, inline_keys: inline_keys, &block)
end
tag(inline_keys = nil, &block) click to toggle source
# File lib/swagger/blocks/nodes/root_node.rb, line 44
def tag(inline_keys = nil, &block)
  raise NotSupportedError unless is_swagger_2_0? || is_openapi_3_0?

  self.data[:tags] ||= []
  self.data[:tags] << Swagger::Blocks::Nodes::TagNode.call(version: version, inline_keys: inline_keys, &block)
end
Also aliased as: tags
tags(inline_keys = nil, &block)

Use 'tag' instead. @deprecated

Alias for: tag